@vertigis/arcgis-extensions 48.4.0 → 48.5.0

package/json/LayerDefinitionJson.d.ts

@@ -21,74 +21,74 @@ export interface LayerDefinitionJson {
      * Boolean value indicating whether the geometry of the features in the
      * layer can be edited.
      */
-    allowGeometryUpdates?: boolean;
+    allowGeometryUpdates?: boolean | null;
     /**
      * A comma-separated string listing which editing operations are allowed on
      * an editable feature service. Available operations include: Create |
      * Delete | Query | Update | Editing.
      */
-    capabilities?: string;
+    capabilities?: string | null;
     /**
      * String value for the copyright text information for the layer.
      */
-    copyrightText?: string;
+    copyrightText?: string | null;
     /**
      * Numeric value indicating the server version of the layer.
      */
-    currentVersion?: number;
+    currentVersion?: number | null;
     /**
      * Boolean value indicating whether the layer's visibility is turned on.
      */
-    defaultVisibility?: boolean;
+    defaultVisibility?: boolean | null;
     /**
      * Stores interactive filters.
      */
-    definitionEditor?: DefinitionEditorJson;
+    definitionEditor?: DefinitionEditorJson | null;
     /**
      * An optional SQL-based definition expression that narrows down the data to
      * be displayed in the layer. Used with ArcGIS Server map services.
      */
-    definitionExpression?: string;
+    definitionExpression?: string | null;
     /**
      * String value of the layer as defined in the map service.
      */
-    description?: string;
+    description?: string | null;
     /**
      * The name of the field that best summarizes the feature. Values from this
      * field are used by default as the titles for pop-up windows.
      */
-    displayField?: string;
+    displayField?: string | null;
     /**
      * A drawingInfo object containing drawing, labeling, and transparency
      * information for the layer.
      */
-    drawingInfo?: DrawingInfoJson;
+    drawingInfo?: DrawingInfoJson | null;
     /**
      * Specifies how graphics are placed on the vertical axis (z). This property
      * may only be used in a SceneView.
      */
-    elevationInfo?: ElevationInfoJson;
+    elevationInfo?: ElevationInfoJson | null;
     /**
      * The rectangular map extent that should be requested from the service,
      * given in the format [[xmin, ymin],[xmax,ymax]].
      */
-    extent?: ExtentJson;
+    extent?: ExtentJson | null;
     /**
      * Feature reductions declutter the screen by hiding features that would
      * otherwise intersect with other features on screen.
      */
-    featureReduction?: FeatureReductionJson;
+    featureReduction?: FeatureReductionJson | null;
     /**
      * The layer-specific overrides of field properties. Used by
      * SubtypeGroupLayer to modify field information for each subtype. Any field
      * missing from this array should be hidden.
      */
-    fieldOverrides?: FieldOverrideJson[];
+    fieldOverrides?: FieldOverrideJson[] | null;
     /**
      * An array of Field objects containing information about the attribute
      * fields for the feature collection or layer.
      */
-    fields?: FieldJson[];
+    fields?: FieldJson[] | null;
     /**
      * Contains floor-awareness information for the layer. See
      * {@link https://developers.arcgis.com/web-map-specification/objects/layerFloorInfo/}.
@@ -99,131 +99,131 @@ export interface LayerDefinitionJson {
          * for floor filtering.
          */
         floorField: string;
-    };
+    } | null;
     /**
      * The type of geometry used in the layer definition. One of the
      * GeometryType constants.
      */
-    geometryType?: string;
+    geometryType?: string | null;
     /**
      * The unique identifier for a feature or table row within a geodatabase.
      */
-    globalIdField?: string;
+    globalIdField?: string | null;
     /**
      * Indicates whether attachments should be loaded for the layer.
      */
-    hasAttachments?: boolean;
+    hasAttachments?: boolean | null;
     /**
      * Boolean value indicating whether layer has M values.
      */
-    hasM?: boolean;
+    hasM?: boolean | null;
     /**
      * Boolean value indicating whether data changes. True if it does not.
      */
-    hasStaticData?: boolean;
+    hasStaticData?: boolean | null;
     /**
      * Boolean value indicating whether layer has Z values.
      */
-    hasZ?: boolean;
+    hasZ?: boolean | null;
     /**
      * String value indicating the HTML popup type. Possible values are listed
      * in the htmlPopupType table below.
      */
-    htmlPopupType?: "esriServerHTMLPopupTypeAsHTMLText" | "esriServerHTMLPopupTypeAsURL" | "esriServerHTMLPopupTypeNone";
+    htmlPopupType?: "esriServerHTMLPopupTypeAsHTMLText" | "esriServerHTMLPopupTypeAsURL" | "esriServerHTMLPopupTypeNone" | null;
     /**
      * The identifier assigned to the layer.
      */
-    id?: string;
+    id?: string | number | null;
     /**
      * Boolean value indicating whether the data is versioned.
      */
-    isDataVersioned?: boolean;
+    isDataVersioned?: boolean | null;
     /**
      * Numeric value indicating the maximum number of records that will be
      * returned at once for a query.
      */
-    maxRecordCount?: number;
+    maxRecordCount?: number | null;
     /**
      * A number representing the maximum scale at which the layer definition
      * will be applied. The number is the scale's denominator; thus, a value of
      * 2400 represents a scale of 1/2,400. A value of 0 indicates that the layer
      * definition will be applied no matter how far you zoom in.
      */
-    maxScale?: number;
+    maxScale?: number | null;
     /**
      * A number representing the minimum scale at which the layer definition
      * will be applied. The number is the scale's denominator; thus, a value of
      * 2400 represents a scale of 1/2,400.
      */
-    minScale?: number;
+    minScale?: number | null;
     /**
      * A string containing a unique name for the layer that could be displayed
      * in a legend.
      */
-    name?: string;
+    name?: string | null;
     /**
      * Indicates the name of the object ID field in the dataset.
      */
-    objectIdField?: string;
+    objectIdField?: string | null;
     /**
      * Determines the display order of features on the map.
      */
-    orderBy?: OrderByClauseJson[];
+    orderBy?: OrderByClauseJson[] | null;
     /**
      * Dictates whether a client can support having an end user modify symbols
      * on individual features.
      */
-    overrideSymbols?: boolean;
+    overrideSymbols?: boolean | null;
     /**
      * Indicates range information.
      */
-    rangeInfos?: RangeInfoJson[];
+    rangeInfos?: RangeInfoJson[] | null;
     /**
      * An object indicating the layerDefinition's layer source. See
      * {@link https://developers.arcgis.com/web-map-specification/objects/source/}
      * {@link https://developers.arcgis.com/web-scene-specification/objects/source/}.
      */
-    source?: DynamicDataLayerJson | DynamicMapLayerJson;
+    source?: DynamicDataLayerJson | DynamicMapLayerJson | null;
     /**
      * An object containing the WKID or WKT identifying the spatial reference of
      * the layer's geometry.
      */
-    spatialReference?: SpatialReferenceJson;
+    spatialReference?: SpatialReferenceJson | null;
     /**
      * String value indicating the output formats that are supported in a query.
      */
-    supportedQueryFormats?: string;
+    supportedQueryFormats?: string | null;
     /**
      * Boolean value indicating whether the layer supports orderByFields in a
      * query operation.
      */
-    supportsAdvancedQueries?: boolean;
+    supportsAdvancedQueries?: boolean | null;
     /**
      * Boolean value indicating whether the layer supports uploading attachments
      * with the Uploads operation. This can be then used in the Add Attachment
      * and Update Attachment operations.
      */
-    supportsAttachmentsByUploadId?: boolean;
+    supportsAttachmentsByUploadId?: boolean | null;
     /**
      * Boolean value indicating whether the layer supports the Calculate REST
      * operation when updating features.
      */
-    supportsCalculate?: boolean;
+    supportsCalculate?: boolean | null;
     /**
      * Boolean value indicating whether the layer supports rolling back edits
      * made on a feature layer if some of the edits fail.
      */
-    supportsRollbackOnFailureParameter?: boolean;
+    supportsRollbackOnFailureParameter?: boolean | null;
     /**
      * Boolean value indicating whether feature layer query operations support
      * statistical functions.
      */
-    supportsStatistics?: boolean;
+    supportsStatistics?: boolean | null;
     /**
      * Boolean value indicating whether the validateSQL operation is supported
      * across a feature service layer.
      */
-    supportsValidateSql?: boolean;
+    supportsValidateSql?: boolean | null;
     /**
      * An array of template objects describing features that can be created in
      * this layer. Templates are used with map notes, other feature collections,
@@ -234,23 +234,23 @@ export interface LayerDefinitionJson {
      * are no types defined; otherwise, templates are defined as properties of
      * the types.
      */
-    templates?: TemplateJson[];
+    templates?: TemplateJson[] | null;
     /**
      * The time info metadata of the layer. May be set for feature layers inside
      * a feature collection item.
      */
-    timeInfo?: LayerTimeInfoJson;
+    timeInfo?: LayerTimeInfoJson | null;
     /**
      * Indicates whether the layerDefinition applies to a "Feature Layer" or a
      * "Table".
      */
-    type?: string;
+    type?: string | null;
     /**
      * The name of the field holding the type ID for the features, if types
      * exist for the dataset. Each available type has an ID, and each feature's
      * typeIdField can be read to determine the type for each feature.
      */
-    typeIdField?: string;
+    typeIdField?: string | null;
     /**
      * An array of Type objects available for the dataset. This is used when the
      * typeIdField is populated.
@@ -259,14 +259,14 @@ export interface LayerDefinitionJson {
      * allowed for features in the dataset. Each feature in the dataset can have
      * a type, indicated in its typeIdField.
      */
-    types?: TypeJson[];
+    types?: TypeJson[] | null;
     /**
      * String value indicating the attribute field that is used to control the
      * visibility of a feature. If applicable, when rendering a feature the
      * client should use this field to control visibility. The field's values
      * are 0 = do not display, 1 = display.
      */
-    visibilityField?: string;
+    visibilityField?: string | null;
 }
 /**
  * Defines overridden properties on a field for a specific view of the data. See
@@ -276,15 +276,15 @@ export interface FieldOverrideJson {
     /**
      * A string containing the overridden field alias.
      */
-    alias?: string;
+    alias?: string | null;
     /**
      * A Boolean determining whether users can edit this field.
      */
-    editable?: boolean;
+    editable?: boolean | null;
     /**
      * A string containing the field name as defined by the service.
      */
-    name?: string;
+    name?: string | null;
 }
 /**
  * Time info if the layer/table supports querying and exporting maps based on
@@ -295,32 +295,32 @@ export interface LayerTimeInfoJson {
     /**
      * The name of the attribute field that contains the end time information.
      */
-    endTimeField?: string;
+    endTimeField?: string | null;
     /**
      * The default time-related export options for this layer.
      */
-    exportOptions?: TimeInfoExportOptionsJson;
+    exportOptions?: TimeInfoExportOptionsJson | null;
     /**
      * Indicates whether service has live data.
      */
-    hasLiveData?: boolean;
+    hasLiveData?: boolean | null;
     /**
      * The name of the attribute field that contains the start time information.
      */
-    startTimeField?: string;
+    startTimeField?: string | null;
     /**
      * The time extent for all the data in the layer.
      */
-    timeExtent?: [number, number];
+    timeExtent?: [number, number] | null;
     /**
      * Time interval of the data in the layer. Typically used for the TimeSlider
      * when animating the layer.
      */
-    timeInterval?: number;
+    timeInterval?: number | null;
     /**
      * Temporal unit in which the time interval is measured.
      */
-    timeIntervalUnits?: TemporalUnitJsonType;
+    timeIntervalUnits?: TemporalUnitJsonType | null;
     /**
      * Defines information about daylight savings time and the time zone in
      * which data was collected. See
@@ -335,8 +335,8 @@ export interface LayerTimeInfoJson {
         /**
          * The time zone in which the data was captured.
          */
-        timeZone?: string;
-    };
+        timeZone?: string | null;
+    } | null;
     /**
      * The field that contains the trackId.
      */
@@ -350,20 +350,20 @@ export interface TimeInfoExportOptionsJson {
     /**
      * If true, draw all the features from the beginning of time for that data.
      */
-    timeDataCumulative?: boolean;
+    timeDataCumulative?: boolean | null;
     /**
      * Time offset value for this layer so that it can be overlaid on the top of
      * a previous or future time period.
      */
-    timeOffset?: number;
+    timeOffset?: number | null;
     /**
      * Temporal unit in which the time offset is measured.
      */
-    timeOffsetUnits?: TemporalUnitJsonType;
+    timeOffsetUnits?: TemporalUnitJsonType | null;
     /**
      * If true, use the time extent specified by the time parameter.
      */
-    useTime?: boolean;
+    useTime?: boolean | null;
 }
 /**
  * Temporal units in which a time value can be measured.
@@ -376,7 +376,7 @@ export interface OrderByClauseJson {
     /**
      * The number or date field whose values will be used to sort features.
      */
-    field?: string;
+    field?: string | null;
     /**
      * The [Arcade
      * expression](https://developers.arcgis.com/javascript/latest/arcade/)
@@ -386,11 +386,11 @@ export interface OrderByClauseJson {
      * [Read
      * more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-OrderedLayer.html#orderBy).
      */
-    valueExpression?: string;
+    valueExpression?: string | null;
     /**
      * The sort order.
      */
-    order?: "asc" | "desc";
+    order?: "asc" | "desc" | null;
 }
 /**
  * Defines how the graphic is placed with respect to the terrain surface.
@@ -433,28 +433,28 @@ export interface ElevationInfoJson {
      * Deprecated with 1.8, use featureExpressionInfo instead. Ignores geometry
      * z-values.
      */
-    featureExpression?: unknown;
+    featureExpression?: unknown | null;
     /**
      * Sets the offset distance, type and other parameters.
      */
-    featureExpressionInfo?: FeatureExpressionInfoJson;
+    featureExpressionInfo?: FeatureExpressionInfoJson | null;
     /**
      * Determines how the service elevation values are combined with the basemap
      * elevation.
      */
-    mode?: ElevationModeJsonType;
+    mode?: ElevationModeJsonType | null;
     /**
      * Offset is always added to the result of the above logic except for
      * `"onTheGround"` where offset is ignored.
      */
-    offset?: number;
+    offset?: number | null;
     /**
      * A string value indicating the unit for the values in elevationInfo.
      * Applies to both offset and featureExpressionInfo. Defaults to meter if
      * not set. Supported units: "foot", "kilometer", "meter", "mile",
      * "us-foot", "yard".
      */
-    unit?: string;
+    unit?: string | null;
 }
 /**
  * An object that defines an expression for per-feature elevation. If not set,
@@ -466,11 +466,11 @@ export interface FeatureExpressionInfoJson {
      * An Arcade expression evaluating to a number. Value of "0" does not use
      * geometry.z values.
      */
-    expression?: string;
+    expression?: string | null;
     /**
      * Title of the expression.
      */
-    title?: string;
+    title?: string | null;
 }
 /**
  * Range Information.
@@ -482,19 +482,19 @@ export interface RangeInfoJson {
     /**
      * Contains the min and max values within which the features are visible.
      */
-    currentRangeExtent?: [number, number];
+    currentRangeExtent?: [number, number] | null;
     /**
      * Field name to used for the range.
      */
-    field?: string;
+    field?: string | null;
     /**
      * Contains the min and max values of all the features for this rangeInfo.
      */
-    fullRangeExtent?: [number, number];
+    fullRangeExtent?: [number, number] | null;
     /**
      * A unique name that can be referenced by webMap.activeRanges.
      */
-    name?: string;
+    name?: string | null;
     /**
      * Type of range object. Value of this property must be rangeInfo.
      */
@@ -513,11 +513,11 @@ export interface DynamicDataLayerJson {
      * {@link https://developers.arcgis.com/web-map-specification/objects/dataSource/}
      * {@link https://developers.arcgis.com/web-scene-specification/objects/dataSource/}.
      */
-    dataSource?: DataSourceJson;
+    dataSource?: DataSourceJson | null;
     /**
      * An array of objects specifying information about an attribute field.
      */
-    fields?: FieldJson[];
+    fields?: FieldJson[] | null;
     /**
      * A string value indicating the type. This value is dataLayer.
      */
@@ -533,11 +533,11 @@ export interface DynamicMapLayerJson {
     /**
      * If applicable, specify this to use an alternate geodatabase version.
      */
-    gdbVersion?: string;
+    gdbVersion?: string | null;
     /**
      * The current map layer's ID.
      */
-    mapLayerId?: number;
+    mapLayerId?: number | null;
     /**
      * A string value indicating the type. This value is mapLayer.
      */
@@ -563,7 +563,7 @@ export interface DataSourceJsonBase {
     /**
      * The unique string value used to identify the data-source's workspace.
      */
-    workspaceId?: string;
+    workspaceId?: string | null;
 }
 /**
  * Join Table data source is the result of a join operation. Nested joins are
@@ -576,25 +576,25 @@ export interface JoinTableDataSourceJson extends DataSourceJsonBase {
     /**
      * The type of join (left outer or left inner).
      */
-    joinType?: JoinJsonType;
+    joinType?: JoinJsonType | null;
     /**
      * Field name from the left table.
      */
-    leftTableKey?: string;
+    leftTableKey?: string | null;
     /**
      * The left source. If the leftTableSource is a table, the resulting
      * joinTable is a table. If the leftTableSource is a layer, the resulting
      * joinTable is a layer.
      */
-    leftTableSource?: DynamicDataLayerJson | DynamicMapLayerJson;
+    leftTableSource?: DynamicDataLayerJson | DynamicMapLayerJson | null;
     /**
      * Field name from the right table.
      */
-    rightTableKey?: string;
+    rightTableKey?: string | null;
     /**
      * The right table source.
      */
-    rightTableSource?: DynamicDataLayerJson | DynamicMapLayerJson;
+    rightTableSource?: DynamicDataLayerJson | DynamicMapLayerJson | null;
     /**
      * @inheritDoc
      */
@@ -614,7 +614,7 @@ export interface QueryTableDataSourceJson extends DataSourceJsonBase {
      * The geometry type. When querying a table that does not have a geometry
      * column, do not include geometryType.
      */
-    geometryType?: "esriGeometryPoint" | "esriGeometryMultipoint" | "esriGeometryPolyline" | "esriGeometryPolygon";
+    geometryType?: "esriGeometryPoint" | "esriGeometryMultipoint" | "esriGeometryPolyline" | "esriGeometryPolygon" | null;
     /**
      * Comma separated list of identifier fields. There are only certain field
      * types that can be used as a unique identifier. These field types include
@@ -624,16 +624,16 @@ export interface QueryTableDataSourceJson extends DataSourceJsonBase {
      * string field or a group of fields is used as the unique identifier, map
      * server maps those unique values to an integer.
      */
-    oidFields?: string;
+    oidFields?: string | null;
     /**
      * The SQL query.
      */
-    query?: string;
+    query?: string | null;
     /**
      * The spatial reference of the geometry column. When querying a table that
      * does not have a geometry column, do not include spatialReference.
      */
-    spatialReference?: SpatialReferenceJson;
+    spatialReference?: SpatialReferenceJson | null;
     /**
      * @inheritDoc
      */
@@ -650,7 +650,7 @@ export interface RasterDataSourceJson extends DataSourceJsonBase {
      * The fully-qualified string value used to specify where the dataSource is
      * derived.
      */
-    dataSourceName?: string;
+    dataSourceName?: string | null;
     /**
      * @inheritDoc
      */
@@ -670,11 +670,11 @@ export interface TableDataSourceJson extends DataSourceJsonBase {
      * The fully-qualified string value used to specify where the dataSource is
      * derived.
      */
-    dataSourceName?: string;
+    dataSourceName?: string | null;
     /**
      * If applicable, the value indicating the version of the geodatabase.
      */
-    gdbVersion?: string;
+    gdbVersion?: string | null;
     /**
      * @inheritDoc
      */
@@ -698,32 +698,32 @@ export interface FeatureReductionClusterJson {
     /**
      * Size of the largest cluster, in screen units (points).
      */
-    clusterMaxSize?: number;
+    clusterMaxSize?: number | null;
     /**
      * Size of the smallest cluster, in screen units (points).
      */
-    clusterMinSize?: number;
+    clusterMinSize?: number | null;
     /**
      * Strength of clustering, in screen units (points).
      */
-    clusterRadius?: number;
+    clusterRadius?: number | null;
     /**
      * Indicates whether to ignore popups defined by the service item.
      */
-    disablePopup?: boolean;
+    disablePopup?: boolean | null;
     /**
      * Contains labeling information for the cluster.
      */
-    drawingInfo?: DrawingInfoJson;
+    drawingInfo?: DrawingInfoJson | null;
     /**
      * Defines the look and feel of popup windows when a user clicks or queries
      * a feature.
      */
-    popupInfo?: PopupInfoJson;
+    popupInfo?: PopupInfoJson | null;
     /**
      * Defines whether labels should be shown in the clusters.
      */
-    showLabels?: boolean;
+    showLabels?: boolean | null;
 }
 /**
  * Feature reduction of type selection declutters the screen by hiding features