ILayerDefinition

Interface

ILayerDefinition can also be imported from the following packages:

Use dark colors for code blocksCopy
1
2
import { ILayerDefinition } from "@esri/arcgis-rest-service-admin";
import { ILayerDefinition } from "@esri/arcgis-rest-feature-service";
Inheritance: ILayerDefinitionIHasZM

Properties

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

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

boolean
{ startArchivingMoment?: number; supportsQueryWithHistoricMoment?: boolean }
string

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

string

String value for the copyright text information for the layer.

number

Numeric value indicating the server version of the layer.

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

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

Stores interactive filters.

string

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

string

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

string

A string value that summarizes the feature.

any

Contains drawing, labeling, and transparency information.

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

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

An object defining the rectangular area.

any

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.

string

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

boolean

Indicates whether attachments should be loaded for the layer.

hasM
inherited
boolean
boolean

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

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

String value indicating the HTML popup type.

number

The identifier assigned to the layer.

any[]
boolean

Boolean value indicating whether the data is versioned.

number

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

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.

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.

string

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

string

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

boolean
boolean

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

boolean
number
any

Indicates range information

any[]
any

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
string

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

boolean

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

boolean
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.

boolean

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

boolean

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

boolean

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

boolean
boolean

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

boolean

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

any

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

"Feature Layer" | "Table"

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

string

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

any

Contains information about an attribute field.

boolean
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

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
    allowGeometryUpdates: boolean

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

    allowTrueCurvesUpdates

    optional
    Interface Property
    allowTrueCurvesUpdates: boolean

    archivingInfo

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

      capabilities

      optional
      Interface Property
      capabilities: string

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

      copyrightText

      optional
      Interface Property
      copyrightText: string

      String value for the copyright text information for the layer.

      currentVersion

      optional
      Interface Property
      currentVersion: number

      Numeric value indicating the server version of the layer.

      dateFieldsTimeReference

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

        defaultVisibility

        optional
        Interface Property
        defaultVisibility: boolean

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

        definitionEditor

        optional
        Interface Property
        definitionEditor: IDefinitionEditor

        Stores interactive filters.

        definitionExpression

        optional
        Interface Property
        definitionExpression: string

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

        description

        optional
        Interface Property
        description: string

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

        displayField

        optional
        Interface Property
        displayField: string

        A string value that summarizes the feature.

        drawingInfo

        optional
        Interface Property
        drawingInfo: any

        Contains drawing, labeling, and transparency information.

        editFieldsInfo

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

          editingInfo

          optional
          Interface Property
          editingInfo: IEditingInfo

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

          extent

          optional
          Interface Property
          extent: IExtent

          An object defining the rectangular area.

          featureReduction

          optional
          Interface Property
          featureReduction: any

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

          fields

          optional
          Interface Property
          fields: IField[]

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

          geometryType

          optional
          Interface Property
          geometryType: GeometryType

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

          globalIdField

          optional
          Interface Property
          globalIdField: string

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

          hasAttachments

          optional
          Interface Property
          hasAttachments: boolean

          Indicates whether attachments should be loaded for the layer.

          hasM

          optionalinherited
          Interface Property
          hasM: boolean
          Inherited from IHasZM.hasM

          hasStaticData

          optional
          Interface Property
          hasStaticData: boolean

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

          hasZ

          optionalinherited
          Interface Property
          hasZ: boolean
          Inherited from IHasZM.hasZ

          htmlPopupType

          optional
          Interface Property
          htmlPopupType: "esriServerHTMLPopupTypeNone" | "esriServerHTMLPopupTypeAsURL" | "esriServerHTMLPopupTypeAsHTMLText"

          String value indicating the HTML popup type.

          id

          optional
          Interface Property
          id: number

          The identifier assigned to the layer.

          indexes

          optional
          Interface Property
          indexes: any[]

          isDataVersioned

          optional
          Interface Property
          isDataVersioned: boolean

          Boolean value indicating whether the data is versioned.

          maxRecordCount

          optional
          Interface Property
          maxRecordCount: number

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

          maxScale

          optional
          Interface Property
          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

          optional
          Interface Property
          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

          optional
          Interface Property
          name: string

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

          objectIdField

          optional
          Interface Property
          objectIdField: string

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

          onlyAllowTrueCurveUpdatesByTrueCurveClients

          optional
          Interface Property
          onlyAllowTrueCurveUpdatesByTrueCurveClients: boolean

          overrideSymbols

          optional
          Interface Property
          overrideSymbols: boolean

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

          ownershipBasedAccessControlForFeatures

          optional
          Interface Property
          ownershipBasedAccessControlForFeatures: boolean

          parentLayerId

          optional
          Interface Property
          parentLayerId: number

          rangeInfos

          optional
          Interface Property
          rangeInfos: any

          Indicates range information

          relationships

          optional
          Interface Property
          relationships: any[]

          source

          optional
          Interface Property
          source: any

          An object indicating the layerDefinition's layer source.

          spatialReference

          optional
          Interface Property
          spatialReference: ISpatialReference

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

          subtypeField

          optional
          Interface Property
          subtypeField: string

          supportedQueryFormats

          optional
          Interface Property
          supportedQueryFormats: string

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

          supportsAdvancedQueries

          optional
          Interface Property
          supportsAdvancedQueries: boolean

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

          supportsApplyEditsWithGlobalIds

          optional
          Interface Property
          supportsApplyEditsWithGlobalIds: boolean

          supportsAttachmentsByUploadId

          optional
          Interface Property
          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

          optional
          Interface Property
          supportsCalculate: boolean

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

          supportsRollbackOnFailureParameter

          optional
          Interface Property
          supportsRollbackOnFailureParameter: boolean

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

          supportsStatistics

          optional
          Interface Property
          supportsStatistics: boolean

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

          supportsValidateSQL

          optional
          Interface Property
          supportsValidateSQL: boolean

          supportsValidateSql

          optional
          Interface Property
          supportsValidateSql: boolean

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

          syncCanReturnChanges

          optional
          Interface Property
          syncCanReturnChanges: boolean

          templates

          optional
          Interface Property
          templates: ITemplate[]

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

          timeInfo

          optional
          Interface Property
          timeInfo: any

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

          type

          optional
          Interface Property
          type: "Feature Layer" | "Table"

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

          typeIdField

          optional
          Interface Property
          typeIdField: string

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

          types

          optional
          Interface Property
          types: any

          Contains information about an attribute field.

          useStandardizedQueries

          optional
          Interface Property
          useStandardizedQueries: boolean

          visibilityField

          optional
          Interface Property
          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.

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