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

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
archivingInfo
 optional 
{ startArchivingMoment?: number; supportsQueryWithHistoricMoment?: boolean }
capabilities
 optional 
string

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

copyrightText
 optional 
string

String value for the copyright text information for the layer.

currentVersion
 optional 
number

Numeric value indicating the server version of the layer.

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

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

definitionEditor
 optional 

Stores interactive filters.

string

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

description
 optional 
string

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

displayField
 optional 
string

A string value that summarizes the feature.

drawingInfo
 optional 
any

Contains drawing, labeling, and transparency information.

editFieldsInfo
 optional 
{ creationDateField?: string; creatorField?: string; editDateField?: string; editorField?: string }
editingInfo
 optional 

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

extent
 optional 

An object defining the rectangular area.

featureReduction
 optional 
any

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

fields
 optional 

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

geometryType
 optional 

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

globalIdField
 optional 
string

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

hasAttachments
 optional 
boolean

Indicates whether attachments should be loaded for the layer.

hasM
 optional 
boolean
hasStaticData
 optional 
boolean

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

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

String value indicating the HTML popup type.

id
 optional 
number

The identifier assigned to the layer.

indexes
 optional 
any[]
isDataVersioned
 optional 
boolean

Boolean value indicating whether the data is versioned.

maxRecordCount
 optional 
number

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

maxScale
 optional 
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 
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 
string

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

objectIdField
 optional 
string

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

boolean
overrideSymbols
 optional 
boolean

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

boolean
parentLayerId
 optional 
number
rangeInfos
 optional 
any

Indicates range information

relationships
 optional 
any[]
source
 optional 
any

An object indicating the layerDefinition's layer source.

spatialReference
 optional 

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

subtypeField
 optional 
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.

supportsCalculate
 optional 
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.

supportsStatistics
 optional 
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
templates
 optional 

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

timeInfo
 optional 
any

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

type
 optional 
"Feature Layer" | "Table"

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

typeIdField
 optional 
string

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

types
 optional 
any

Contains information about an attribute field.

boolean
visibilityField
 optional 
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

advancedQueryCapabilities: { supportsDistinct?: boolean; supportsOrderBy?: boolean; supportsPagination?: boolean; supportsPercentileStatistics?: boolean; supportsQueryWithDistance?: boolean; supportsReturningQueryExtent?: boolean; supportsSqlExpression?: boolean; supportsStatistics?: boolean; supportsTrueCurve?: boolean }

allowGeometryUpdates optional

allowGeometryUpdates: boolean

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

allowTrueCurvesUpdates optional

allowTrueCurvesUpdates: boolean

archivingInfo optional

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

capabilities optional

capabilities: string

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

copyrightText optional

copyrightText: string

String value for the copyright text information for the layer.

currentVersion optional

currentVersion: number

Numeric value indicating the server version of the layer.

dateFieldsTimeReference optional

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

defaultVisibility optional

defaultVisibility: boolean

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

definitionEditor optional

definitionEditor: IDefinitionEditor

Stores interactive filters.

definitionExpression optional

definitionExpression: string

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

description optional

description: string

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

displayField optional

displayField: string

A string value that summarizes the feature.

drawingInfo optional

drawingInfo: any

Contains drawing, labeling, and transparency information.

editFieldsInfo optional

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

editingInfo optional

editingInfo: IEditingInfo

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

extent optional

extent: IExtent

An object defining the rectangular area.

featureReduction optional

featureReduction: any

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

fields optional

fields: IField[]

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

geometryType optional

geometryType: GeometryType

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

globalIdField optional

globalIdField: string

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

hasAttachments optional

hasAttachments: boolean

Indicates whether attachments should be loaded for the layer.

hasM optional

hasM: boolean

hasStaticData optional

hasStaticData: boolean

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

hasZ optional

hasZ: boolean

htmlPopupType optional

htmlPopupType: "esriServerHTMLPopupTypeNone" | "esriServerHTMLPopupTypeAsURL" | "esriServerHTMLPopupTypeAsHTMLText"

String value indicating the HTML popup type.

id optional

id: number

The identifier assigned to the layer.

indexes optional

indexes: any[]

isDataVersioned optional

isDataVersioned: boolean

Boolean value indicating whether the data is versioned.

maxRecordCount optional

maxRecordCount: number

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

maxScale optional

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

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

name: string

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

objectIdField optional

objectIdField: string

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

onlyAllowTrueCurveUpdatesByTrueCurveClients optional

onlyAllowTrueCurveUpdatesByTrueCurveClients: boolean

overrideSymbols optional

overrideSymbols: boolean

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

ownershipBasedAccessControlForFeatures optional

ownershipBasedAccessControlForFeatures: boolean

parentLayerId optional

parentLayerId: number

rangeInfos optional

rangeInfos: any

Indicates range information

relationships optional

relationships: any[]

source optional

source: any

An object indicating the layerDefinition's layer source.

spatialReference optional

spatialReference: ISpatialReference

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

subtypeField optional

subtypeField: string

supportedQueryFormats optional

supportedQueryFormats: string

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

supportsAdvancedQueries optional

supportsAdvancedQueries: boolean

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

supportsApplyEditsWithGlobalIds optional

supportsApplyEditsWithGlobalIds: boolean

supportsAttachmentsByUploadId optional

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

supportsCalculate: boolean

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

supportsRollbackOnFailureParameter optional

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

supportsStatistics: boolean

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

supportsValidateSQL optional

supportsValidateSQL: boolean

supportsValidateSql optional

supportsValidateSql: boolean

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

syncCanReturnChanges optional

syncCanReturnChanges: boolean

templates optional

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

timeInfo: any

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

type optional

type: "Feature Layer" | "Table"

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

typeIdField optional

typeIdField: string

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

types optional

types: any

Contains information about an attribute field.

useStandardizedQueries optional

useStandardizedQueries: boolean

visibilityField optional

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.