Skip to content

Interface

Inheritance: ILayerDefinitionIHasZM

Properties

Hide inherited properties
PropertyTypeNotes
advancedQueryCapabilities{ supportsDistinct?: boolean; supportsOrderBy?: boolean; supportsPagination?: boolean; supportsPercentileStatistics?: boolean; supportsQueryWithDistance?: boolean; supportsReturningQueryExtent?: boolean; supportsSqlExpression?: boolean; supportsStatistics?: boolean; supportsTrueCurve?: boolean }
allowGeometryUpdatesboolean

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

allowTrueCurvesUpdatesboolean
archivingInfo{ startArchivingMoment?: number; supportsQueryWithHistoricMoment?: boolean }
capabilitiesstring

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

copyrightTextstring

String value for the copyright text information for the layer.

currentVersionnumber

Numeric value indicating the server version of the layer.

dateFieldsTimeReference{ respectsDaylightSaving?: boolean; timeZone?: string }
defaultVisibilityboolean

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

definitionEditorIDefinitionEditor

Stores interactive filters.

definitionExpressionstring

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

descriptionstring

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

displayFieldstring

A string value that summarizes the feature.

drawingInfoany

Contains drawing, labeling, and transparency information.

editFieldsInfo{ creationDateField?: string; creatorField?: string; editDateField?: string; editorField?: string }
editingInfoIEditingInfo

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

extentIExtent

An object defining the rectangular area.

featureReductionany

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

fieldsIField[]

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

geometryTypeGeometryType

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

globalIdFieldstring

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

hasAttachmentsboolean

Indicates whether attachments should be loaded for the layer.

hasM
inherited
boolean
hasStaticDataboolean

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

hasZ
inherited
boolean
htmlPopupType"esriServerHTMLPopupTypeNone" | "esriServerHTMLPopupTypeAsURL" | "esriServerHTMLPopupTypeAsHTMLText"

String value indicating the HTML popup type.

idnumber

The identifier assigned to the layer.

indexesany[]
isDataVersionedboolean

Boolean value indicating whether the data is versioned.

maxRecordCountnumber

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

maxScalenumber

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

minScalenumber

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

namestring

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

objectIdFieldstring

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

onlyAllowTrueCurveUpdatesByTrueCurveClientsboolean
overrideSymbolsboolean

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

ownershipBasedAccessControlForFeaturesboolean
parentLayerIdnumber
rangeInfosany

Indicates range information

relationshipsany[]
sourceany

An object indicating the layerDefinition's layer source.

spatialReferenceISpatialReference

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

subtypeFieldstring
supportedQueryFormatsstring

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

supportsAdvancedQueriesboolean

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

supportsApplyEditsWithGlobalIdsboolean
supportsAttachmentsByUploadIdboolean

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.

supportsCalculateboolean

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

supportsExceedsLimitStatisticsboolean

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

supportsRollbackOnFailureParameterboolean

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

supportsStatisticsboolean

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

supportsValidateSQLboolean
supportsValidateSqlboolean

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

syncCanReturnChangesboolean
templatesITemplate[]

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

timeInfoany

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.

typeIdFieldstring

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

typesany

Contains information about an attribute field.

useStandardizedQueriesboolean
visibilityFieldstring

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

optional
Interface Property
advancedQueryCapabilities: { supportsDistinct?: boolean; supportsOrderBy?: boolean; supportsPagination?: boolean; supportsPercentileStatistics?: boolean; supportsQueryWithDistance?: boolean; supportsReturningQueryExtent?: boolean; supportsSqlExpression?: boolean; supportsStatistics?: boolean; supportsTrueCurve?: boolean }
Type declaration

    allowGeometryUpdates

    optional
    Interface Property

    allowTrueCurvesUpdates

    optional
    Interface Property
    allowTrueCurvesUpdates: boolean

    archivingInfo

    optional
    Interface Property
    archivingInfo: { startArchivingMoment?: number; supportsQueryWithHistoricMoment?: boolean }
    Type declaration

      capabilities

      optional
      Interface Property

      copyrightText

      optional
      Interface Property

      currentVersion

      optional
      Interface Property

      dateFieldsTimeReference

      optional
      Interface Property
      dateFieldsTimeReference: { respectsDaylightSaving?: boolean; timeZone?: string }
      Type declaration

        defaultVisibility

        optional
        Interface Property

        definitionEditor

        optional
        Interface Property

        definitionExpression

        optional
        Interface Property

        description

        optional
        Interface Property

        displayField

        optional
        Interface Property

        drawingInfo

        optional
        Interface Property

        editFieldsInfo

        optional
        Interface Property
        editFieldsInfo: { creationDateField?: string; creatorField?: string; editDateField?: string; editorField?: string }
        Type declaration

          editingInfo

          optional
          Interface Property

          extent

          optional
          Interface Property

          featureReduction

          optional
          Interface Property

          fields

          optional
          Interface Property

          geometryType

          optional
          Interface Property

          globalIdField

          optional
          Interface Property

          hasAttachments

          optional
          Interface Property

          hasM

          optionalinherited
          Interface Property
          hasM: boolean
          Inherited from IHasZM.hasM

          hasStaticData

          optional
          Interface Property

          hasZ

          optionalinherited
          Interface Property
          hasZ: boolean
          Inherited from IHasZM.hasZ

          htmlPopupType

          optional
          Interface Property

          id

          optional
          Interface Property

          indexes

          optional
          Interface Property
          indexes: any[]

          isDataVersioned

          optional
          Interface Property

          maxRecordCount

          optional
          Interface Property

          maxScale

          optional
          Interface Property

          minScale

          optional
          Interface Property

          name

          optional
          Interface Property

          objectIdField

          optional
          Interface Property

          onlyAllowTrueCurveUpdatesByTrueCurveClients

          optional
          Interface Property
          onlyAllowTrueCurveUpdatesByTrueCurveClients: boolean

          overrideSymbols

          optional
          Interface Property

          ownershipBasedAccessControlForFeatures

          optional
          Interface Property
          ownershipBasedAccessControlForFeatures: boolean

          parentLayerId

          optional
          Interface Property
          parentLayerId: number

          rangeInfos

          optional
          Interface Property

          relationships

          optional
          Interface Property
          relationships: any[]

          source

          optional
          Interface Property

          spatialReference

          optional
          Interface Property

          subtypeField

          optional
          Interface Property
          subtypeField: string

          supportedQueryFormats

          optional
          Interface Property

          supportsAdvancedQueries

          optional
          Interface Property

          supportsApplyEditsWithGlobalIds

          optional
          Interface Property
          supportsApplyEditsWithGlobalIds: boolean

          supportsAttachmentsByUploadId

          optional
          Interface Property

          supportsCalculate

          optional
          Interface Property

          supportsExceedsLimitStatistics

          optional
          Interface Property

          supportsRollbackOnFailureParameter

          optional
          Interface Property

          supportsStatistics

          optional
          Interface Property

          supportsValidateSQL

          optional
          Interface Property
          supportsValidateSQL: boolean

          supportsValidateSql

          optional
          Interface Property

          syncCanReturnChanges

          optional
          Interface Property
          syncCanReturnChanges: boolean

          templates

          optional
          Interface Property

          timeInfo

          optional
          Interface Property

          type

          optional
          Interface Property

          typeIdField

          optional
          Interface Property

          types

          optional
          Interface Property

          useStandardizedQueries

          optional
          Interface Property
          useStandardizedQueries: boolean

          visibilityField

          optional
          Interface Property

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