Interface
IHasZM can also be imported from the following packages:
import { IHasZM } from "@esri/arcgis-rest-feature-service";Properties
| Property | Type | Notes |
|---|---|---|
advancedQueryCapabilities | { supportsDistinct?: boolean; supportsOrderBy?: boolean; supportsPagination?: boolean; supportsPercentileStatistics?: boolean; supportsQueryWithDistance?: boolean; supportsReturningQueryExtent?: boolean; supportsSqlExpression?: boolean; supportsStatistics?: boolean; supportsTrueCurve?: boolean } | |
allowGeometryUpdates | boolean | Boolean value indicating whether the geometry of the features in the layer can be edited. |
allowTrueCurvesUpdates | boolean | |
archivingInfo | { startArchivingMoment?: number; supportsQueryWithHistoricMoment?: boolean } | |
capabilities | string | A comma separated list of supported capabilities, e.g. Query,Editing. |
copyrightText | string | String value for the copyright text information for the layer. |
currentVersion | number | Numeric value indicating the server version of the layer. |
dateFieldsTimeReference | { respectsDaylightSaving?: boolean; timeZone?: string } | |
defaultVisibility | boolean | Boolean value indicating whether the layer's visibility is turned on. |
definitionEditor | IDefinitionEditor | Stores interactive filters. |
definitionExpression | string | SQL-based definition expression string that narrows the data to be displayed in the layer. |
description | string | String value of the layer as defined in the map service. |
displayField | string | A string value that summarizes the feature. |
drawingInfo | any | Contains drawing, labeling, and transparency information. |
editFieldsInfo | { creationDateField?: string; creatorField?: string; editDateField?: string; editorField?: string } | |
editingInfo | IEditingInfo | An object defining the editing info (last edit date). |
extent | IExtent | An object defining the rectangular area. |
featureReduction | any | Feature reductions declutter the screen by hiding features that would otherwise intersect with other features on screen. |
fields | IField[] | An array of field objects containing information about the attribute fields for the feature collection or layer. |
geometryType | GeometryType | A string defining the type of geometry. Possible geometry types are: esriGeometryPoint, esriGeometryMultipoint, esriGeometryPolyline, esriGeometryPolygon, and esriGeometryEnvelope. |
globalIdField | string | The unique identifier for a feature or table row within a geodatabase. |
hasAttachments | boolean | Indicates whether attachments should be loaded for the layer. |
hasMinherited | boolean | |
hasStaticData | boolean | Boolean value indicating whether data changes. True if it does not. |
hasZinherited | boolean | |
htmlPopupType | "esriServerHTMLPopupTypeNone" | "esriServerHTMLPopupTypeAsURL" | "esriServerHTMLPopupTypeAsHTMLText" | String value indicating the HTML popup type. |
id | number | The identifier assigned to the layer. |
indexes | any[] | |
isDataVersioned | boolean | Boolean value indicating whether the data is versioned. |
maxRecordCount | number | Numeric value indicating tbe maximum number of records that will be returned at once for a query. |
maxScale | number | Represents the maximum scale at which the layer definition will be applied. This does not apply to layers of type: ArcGISMapServiceLayer, ImageServiceVectorLayer or ImageServiceLayer. |
minScale | number | Represents the minimum scale at which the layer definition will be applied. This does not apply to layers of type: ArcGISMapServiceLayer, ImageServiceVectorLayer or ImageServiceLayer. |
name | string | Contains a unique name for the layer that can be displayed in a legend. |
objectIdField | string | Indicates the name of the object ID field in the dataset. |
onlyAllowTrueCurveUpdatesByTrueCurveClients | boolean | |
overrideSymbols | boolean | Dictates whether a client can support having an end user modify symbols on individual features. |
ownershipBasedAccessControlForFeatures | boolean | |
parentLayerId | number | |
rangeInfos | any | Indicates range information |
relationships | any[] | |
source | any | An object indicating the layerDefinition's layer source. |
spatialReference | ISpatialReference | An object containing the WKID or WKT identifying the spatial reference of the layer's geometry. |
subtypeField | string | |
supportedQueryFormats | string | String value indicating the output formats that are supported in a query. |
supportsAdvancedQueries | boolean | Boolean value indicating whether the layer supports orderByFields in a query operation. |
supportsApplyEditsWithGlobalIds | boolean | |
supportsAttachmentsByUploadId | boolean | 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. |
supportsCalculate | boolean | Boolean value indicating whether the layer supports the Calculate REST operation when updating features. |
supportsExceedsLimitStatistics | boolean | Boolean value indicating whether the layer supports exceedsLimit in a query operation. |
supportsRollbackOnFailureParameter | boolean | Boolean value indicating whether the layer supports rolling back edits made on a feature layer if some of the edits fail. |
supportsStatistics | boolean | Boolean value indicating whether feature layer query operations support statistical functions. |
supportsValidateSql | boolean | Boolean value indicating whether the validateSQL operation is supported across a feature service layer. |
supportsValidateSQL | boolean | |
syncCanReturnChanges | boolean | |
templates | ITemplate[] | A property of the layer definition when there are no types defined; otherwise, templates are defined as properties of the types. |
timeInfo | any | The time info metadata of the layer. May be set for feature layers inside a feature collection item. |
type | "Feature Layer" | "Table" | Indicates whether the layerDefinition applies to a Feature Layer or a Table. |
typeIdField | string | Contains the name of the field holding the type ID for the features. |
types | any | Contains information about an attribute field. |
useStandardizedQueries | boolean | |
visibilityField | string | 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. |
advancedQueryCapabilities
advancedQueryCapabilities: { supportsDistinct?: boolean; supportsOrderBy?: boolean; supportsPagination?: boolean; supportsPercentileStatistics?: boolean; supportsQueryWithDistance?: boolean; supportsReturningQueryExtent?: boolean; supportsSqlExpression?: boolean; supportsStatistics?: boolean; supportsTrueCurve?: boolean }Type declaration
allowGeometryUpdates
allowGeometryUpdates: booleanBoolean value indicating whether the geometry of the features in the layer can be edited.
archivingInfo
archivingInfo: { startArchivingMoment?: number; supportsQueryWithHistoricMoment?: boolean }Type declaration
capabilities
capabilities: stringA comma separated list of supported capabilities, e.g. Query,Editing.
copyrightText
copyrightText: stringString value for the copyright text information for the layer.
currentVersion
currentVersion: numberNumeric value indicating the server version of the layer.
dateFieldsTimeReference
dateFieldsTimeReference: { respectsDaylightSaving?: boolean; timeZone?: string }Type declaration
defaultVisibility
defaultVisibility: booleanBoolean value indicating whether the layer's visibility is turned on.
definitionEditor
definitionEditor: IDefinitionEditorStores interactive filters.
definitionExpression
definitionExpression: stringSQL-based definition expression string that narrows the data to be displayed in the layer.
description
description: stringString value of the layer as defined in the map service.
displayField
displayField: stringA string value that summarizes the feature.
drawingInfo
drawingInfo: anyContains drawing, labeling, and transparency information.
editFieldsInfo
editFieldsInfo: { creationDateField?: string; creatorField?: string; editDateField?: string; editorField?: string }Type declaration
editingInfo
editingInfo: IEditingInfoAn object defining the editing info (last edit date).
extent
extent: IExtentAn object defining the rectangular area.
featureReduction
featureReduction: anyFeature reductions declutter the screen by hiding features that would otherwise intersect with other features on screen.
fields
fields: IField[]An array of field objects containing information about the attribute fields for the feature collection or layer.
geometryType
geometryType: GeometryTypeA string defining the type of geometry. Possible geometry types are: esriGeometryPoint, esriGeometryMultipoint, esriGeometryPolyline, esriGeometryPolygon, and esriGeometryEnvelope.
globalIdField
globalIdField: stringThe unique identifier for a feature or table row within a geodatabase.
hasAttachments
hasAttachments: booleanIndicates whether attachments should be loaded for the layer.
hasM
hasM: booleanhasStaticData
hasStaticData: booleanBoolean value indicating whether data changes. True if it does not.
hasZ
hasZ: booleanhtmlPopupType
htmlPopupType: "esriServerHTMLPopupTypeNone" | "esriServerHTMLPopupTypeAsURL" | "esriServerHTMLPopupTypeAsHTMLText"String value indicating the HTML popup type.
isDataVersioned
isDataVersioned: booleanBoolean value indicating whether the data is versioned.
maxRecordCount
maxRecordCount: numberNumeric value indicating tbe maximum number of records that will be returned at once for a query.
maxScale
maxScale: numberRepresents the maximum scale at which the layer definition will be applied. This does not apply to layers of type: ArcGISMapServiceLayer, ImageServiceVectorLayer or ImageServiceLayer.
minScale
minScale: numberRepresents the minimum scale at which the layer definition will be applied. This does not apply to layers of type: ArcGISMapServiceLayer, ImageServiceVectorLayer or ImageServiceLayer.
name
name: stringContains a unique name for the layer that can be displayed in a legend.
objectIdField
objectIdField: stringIndicates the name of the object ID field in the dataset.
onlyAllowTrueCurveUpdatesByTrueCurveClients
onlyAllowTrueCurveUpdatesByTrueCurveClients: booleanoverrideSymbols
overrideSymbols: booleanDictates whether a client can support having an end user modify symbols on individual features.
ownershipBasedAccessControlForFeatures
ownershipBasedAccessControlForFeatures: booleanspatialReference
spatialReference: ISpatialReferenceAn object containing the WKID or WKT identifying the spatial reference of the layer's geometry.
supportedQueryFormats
supportedQueryFormats: stringString value indicating the output formats that are supported in a query.
supportsAdvancedQueries
supportsAdvancedQueries: booleanBoolean value indicating whether the layer supports orderByFields in a query operation.
supportsAttachmentsByUploadId
supportsAttachmentsByUploadId: booleanBoolean 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.
supportsCalculate
supportsCalculate: booleanBoolean value indicating whether the layer supports the Calculate REST operation when updating features.
supportsExceedsLimitStatistics
supportsExceedsLimitStatistics: booleanBoolean value indicating whether the layer supports exceedsLimit in a query operation.
supportsRollbackOnFailureParameter
supportsRollbackOnFailureParameter: booleanBoolean value indicating whether the layer supports rolling back edits made on a feature layer if some of the edits fail.
supportsStatistics
supportsStatistics: booleanBoolean value indicating whether feature layer query operations support statistical functions.
supportsValidateSql
supportsValidateSql: booleanBoolean value indicating whether the validateSQL operation is supported across a feature service layer.
templates
templates: ITemplate[]A property of the layer definition when there are no types defined; otherwise, templates are defined as properties of the types.
timeInfo
timeInfo: anyThe time info metadata of the layer. May be set for feature layers inside a feature collection item.
type
type: "Feature Layer" | "Table"Indicates whether the layerDefinition applies to a Feature Layer or a Table.
typeIdField
typeIdField: stringContains the name of the field holding the type ID for the features.
visibilityField
visibilityField: stringString 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.