Skip to content

Interface

IFeatureServiceDefinition can also be imported from the following packages:

Use dark colors for code blocksCopy
1
import { IFeatureServiceDefinition } from "@esri/arcgis-rest-feature-service";

Properties

PropertyTypeNotes
advancedEditingCapabilities{}
allowGeometryUpdatesboolean

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

capabilitiesstring

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

copyrightTextstring

String value for the copyright text information for the layer.

currentVersionnumber
descriptionstring

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

documentInfo{}
editorTrackingInfo{ allowOthersToDelete: boolean; allowOthersToUpdate: boolean; enableEditorTracking: boolean; enableOwnershipAccessControl: boolean }
enableZDefaultsboolean
extractChangesCapabilities{ supportsLayerQueries: boolean; supportsReturnAttachments: boolean; supportsReturnExtentOnly: boolean; supportsReturnFeature: boolean; supportsReturnIdsOnly: boolean; supportsSpatialFilter: boolean }
fullExtentIExtent
hasStaticDataboolean

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

hasVersionedDataboolean
initialExtentIExtent
isLocationTrackingServiceboolean
isLocationTrackingViewboolean
layersILayerDefinition[]
maxRecordCountnumber

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

relationships[void]
returnServiceEditsHaveSRboolean
serviceDescriptionstring
spatialReferenceISpatialReference

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

supportedQueryFormatsstring

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

supportsDisconnectedEditingboolean
supportsRelationshipsResourceboolean
supportsReturnDeleteResultsboolean
syncCapabilities{ supportedSyncDataOptions: number; supportsASync: boolean; supportsPerLayerSync: boolean; supportsPerReplicaSync: boolean; supportsRegisteringExistingData: boolean; supportsRollbackOnFailure: boolean; supportsSyncDirectionControl: boolean }
syncEnabledboolean
tablesITable[]
unitsstring
validationSystemLayers{ validationLineErrorlayerId: number; validationObjectErrortableId: number; validationPointErrorlayerId: number; validationPolygonErrorlayerId: number }
zDefaultnumber

advancedEditingCapabilities

Interface Property
advancedEditingCapabilities: {}
Type declaration

    allowGeometryUpdates

    Interface Property
    allowGeometryUpdates: boolean

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

    capabilities

    Interface Property
    capabilities: string

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

    copyrightText

    Interface Property
    copyrightText: string

    String value for the copyright text information for the layer.

    currentVersion

    optional
    Interface Property
    currentVersion: number

    description

    Interface Property
    description: string

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

    documentInfo

    optional
    Interface Property
    documentInfo: {}
    Type declaration

      editorTrackingInfo

      Interface Property
      editorTrackingInfo: { allowOthersToDelete: boolean; allowOthersToUpdate: boolean; enableEditorTracking: boolean; enableOwnershipAccessControl: boolean }
      Type declaration

        enableZDefaults

        optional
        Interface Property
        enableZDefaults: boolean

        extractChangesCapabilities

        Interface Property
        extractChangesCapabilities: { supportsLayerQueries: boolean; supportsReturnAttachments: boolean; supportsReturnExtentOnly: boolean; supportsReturnFeature: boolean; supportsReturnIdsOnly: boolean; supportsSpatialFilter: boolean }
        Type declaration

          fullExtent

          Interface Property
          fullExtent: IExtent

          hasStaticData

          optional
          Interface Property
          hasStaticData: boolean

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

          hasVersionedData

          Interface Property
          hasVersionedData: boolean

          initialExtent

          Interface Property
          initialExtent: IExtent

          isLocationTrackingService

          Interface Property
          isLocationTrackingService: boolean

          isLocationTrackingView

          Interface Property
          isLocationTrackingView: boolean

          layers

          Interface Property

          maxRecordCount

          Interface Property
          maxRecordCount: number

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

          relationships

          Interface Property
          relationships: [void]

          returnServiceEditsHaveSR

          optional
          Interface Property
          returnServiceEditsHaveSR: boolean

          serviceDescription

          Interface Property
          serviceDescription: string

          spatialReference

          Interface Property
          spatialReference: ISpatialReference

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

          supportedQueryFormats

          Interface Property
          supportedQueryFormats: string

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

          supportsDisconnectedEditing

          Interface Property
          supportsDisconnectedEditing: boolean

          supportsRelationshipsResource

          Interface Property
          supportsRelationshipsResource: boolean

          supportsReturnDeleteResults

          Interface Property
          supportsReturnDeleteResults: boolean

          syncCapabilities

          Interface Property
          syncCapabilities: { supportedSyncDataOptions: number; supportsASync: boolean; supportsPerLayerSync: boolean; supportsPerReplicaSync: boolean; supportsRegisteringExistingData: boolean; supportsRollbackOnFailure: boolean; supportsSyncDirectionControl: boolean }
          Type declaration

            syncEnabled

            Interface Property
            syncEnabled: boolean

            tables

            Interface Property
            tables: ITable[]

            units

            Interface Property
            units: string

            validationSystemLayers

            Interface Property
            validationSystemLayers: { validationLineErrorlayerId: number; validationObjectErrortableId: number; validationPointErrorlayerId: number; validationPolygonErrorlayerId: number }
            Type declaration

              zDefault

              optional
              Interface Property
              zDefault: number

              Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.