rest-js-types

For feature layers only.

For feature layers only.

Statistical operation to perform.

Parameters to be used along with statisticType. Currently only applicable for percentile-continuous (continuous percentile) and percentile-discrete (discrete percentile).

Field on which to perform the statistical operation.

Field name for the returned statistic field.

If outStatisticFieldName is empty or missing, the server will assign one. A valid field name can only contain alphanumeric characters and an underscore. If outStatisticFieldName is a reserved keyword of the underlying DBMS, the operation can fail. Try specifying an alternative outStatisticFieldName.

Only applicable when specified as a client-side graphic.

A string defining the field name.

A string defining the field type.

A string defining the field alias.

The domain objects if applicable.

A Boolean defining whether this field is editable.

A Boolean defining whether or not the field is an exact match.

A number defining how many characters are allowed in a string. field.

A Boolean defining whether this field can have a null value.

The value written in for new records by default.

An array of bandIds that are visible, can specify bands to export or rearrange band order(from image service).

Controls how much loss the image will be subjected to by the compression algorithm (from image service).

Stores interactive filters.

Boolean property indicating whether to ignore popups defined by the service item.

String value representing image format.

The algorithm used for interpolation.

This is applicable if used as a baseMapLayer. A boolean value indicating whether or not the baseMapLayer draws on top (true) of other layers, including operationalLayers , or below (false).

A layerDefinition object defining the attribute schema and drawing information for the layer.

String indicating the layer type. Value of this property must be ArcGISImageServiceLayer

Specifies the mosaic rule when defining how individual images should be mosaicked.

The pixel value that represents no information.

A string value of interpretation of noData setting. Default is 'esriNoDataMatchAny' when noData is a number, and 'esriNoDataMatchAll' when noData is an array.

Pertains to the type of values stored in the raster, such as signed integer, unsigned integer, or floating point.

A popupInfo object defining the content of popup windows when you click or query a feature.

Refresh interval of the layer in minutes. Non-zero value indicates automatic layer refresh at the specified interval. Value of 0 indicates auto refresh is not enabled.

Specifies the rendering rule for how the requested image should be rendered.

The default value that is automatically given if nothing is provided.

A string value representing the name of the field to query.

Number given to uniquely identify the specified parameter.

The field type for the specified field parameter.

An integer value representing exact UNIX time used when defaultValue is a date string.

A string value representing a hint for the input.

An array of parameter objects.

A string value representing the prompt for the input.

Only used for feature collections with a renderer. The feature's symbol is defined by the layer's renderer.

An object defining the properties used for labeling the layer.

An object defined which provides the symbology for the layer.

Boolean property indicating whether symbols should stay the same size in screen units as you zoom in. A value of true means the symbols stay the same size in screen units regardless of the map scale.

Defines whether labels should be shown or not. This is only valid for sublayers.

Number value ranging between 0 (no transparency) to 100 (completely transparent).

Boolean value indicating whether the geometry of the features in the layer can be edited.

A comma separated list of supported capabilities, e.g. Query, Editing.

String value for the copyright text information for the layer.

Numeric value indicating the server version of the layer.

Boolean value indicating whether the layer's visibility is turned on.

Stores interactive filters.

SQL-based definition expression string that narrows the data to be displayed in the layer.

String value of the layer as defined in the map service.

A string value that summarizes the feature.

Contains drawing, labeling, and transparency information.

An object defining the rectangular area.

An object defining the editing info (last edit date).

Feature reductions declutter the screen by hiding features that would otherwise intersect with other features on screen.

An array of field objects containing information about the attribute fields for the feature collection or layer.

A string defining the type of geometry. Possible geometry types are: esriGeometryPoint, esriGeometryMultipoint, esriGeometryPolyline, esriGeometryPolygon, and esriGeometryEnvelope.

The unique identifier for a feature or table row within a geodatabase.

Indicates whether attachments should be loaded for the layer.

Boolean value indicating whether data changes. True if it does not.

String value indicating the HTML popup type.

The identifier assigned to the layer.

Boolean value indicating whether the data is versioned.

Numeric value indicating tbe maximum number of records that will be returned at once for a query.

Represents the maximum scale at which the layer definition will be applied. This does not apply to layers of type: ArcGISMapServiceLayer, ImageServiceVectorLayer or ImageServiceLayer.

Represents the minimum scale at which the layer definition will be applied. This does not apply to layers of type: ArcGISMapServiceLayer, ImageServiceVectorLayer or ImageServiceLayer.

Contains a unique name for the layer that can be displayed in a legend.

Indicates the name of the object ID field in the dataset.

Dictates whether a client can support having an end user modify symbols on individual features.

Indicates range information

An object indicating the layerDefinition's layer source.

An object containing the WKID or WKT identifying the spatial reference of the layer's geometry.

String value indicating the output formats that are supported in a query.

Boolean value indicating whether the layer supports orderByFields in a query operation.

Boolean value indicating whether the layer supports uploading attachments with the Uploads operation. This can then be used in the Add Attachment and Update Attachment operations.

Boolean value indicating whether the layer supports the Calculate REST operation when updating features.

Boolean value indicating whether the layer supports rolling back edits made on a feature layer if some of the edits fail.

Boolean value indicating whether feature layer query operations support statistical functions.

Boolean value indicating whether the validateSQL operation is supported across a feature service layer.

A property of the layer definition when there are no types defined; otherwise, templates are defined as properties of the types.

The time info metadata of the layer. May be set for feature layers inside a feature collection item.

Indicates whether the layerDefinition applies to a Feature Layer or a Table.

Contains the name of the field holding the type ID for the features.

Contains information about an attribute field.

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.

A string value containing a detailed description of the template.

An optional string that can define a client-side drawing tool to be used with this feature. For example, map notes used by the Online Map Viewer use this to represent the viewer's different drawing tools.

A string containing a user-friendly name for the template.

A feature object representing a prototypical feature for the template.

Applicable if used as a baseMapLayer. A boolean value indicating whether or not the baseMapLayer draws on top (true) of other layers, including operationalLayers , or below (false).

String indicating the layer type. Value of this property must be ArcGISTiledImageServiceLayer

Refresh interval of the layer in minutes. Non-zero value indicates automatic layer refresh at the specified interval. Value of 0 indicates auto refresh is not enabled.

Applicable if used as a baseMapLayer. A boolean value indicating whether or not the baseMapLayer draws on top (true) of other layers, including operationalLayers , or below (false).

String indicating the layer type. Value of this property must be WCS

Object that defines and provides information about coverages in a WCS service.

Refresh interval of the layer in minutes. Non-zero value indicates automatic layer refresh at the specified interval. Value of 0 indicates auto refresh is not enabled.

A comma-separated string listing which editing operations are allowed on an editable feature service.

Stores interactive filters.

Indicates whether to allow a client to ignore popups defined by the service item.

A featureCollection object defining a layer of features whose geometry and attributes are either stored directly within the web map or with an item. Feature Collections can be created from CSVs, shapefiles, GPX, or map notes.

Indicates the type of features in the feature collection. If featureCollectionType is missing, it means the feature collection is a regular single-layer or multi-layer feature collection.

A layerDefinition object defining the attribute schema and drawing information for the layer.

String indicating the layer type.

0 is snapshot mode. 1 is on-demand mode. 2 is selection-only mode. Used with ArcGIS feature services and individual layers in ArcGIS map services.

A popupInfo object defining the content of popup windows when you click or query a feature.

Refresh interval of the layer in minutes. Non-zero value indicates automatic layer refresh at the specified interval. Value of 0 indicates auto refresh is not enabled.

Labels will display if this property is set to true and the layer also has a labelingInfo property associated with it. This property can get stored in the web map config and in the item/data.

An array of sublayer ids that should appear visible. Used with feature layers that are based on feature collections.