getLayer

Function

import { getLayer } from '@esri/arcgis-rest-feature-layer';
//
getLayer({
  url: "https://sampleserver6.arcgisonline.com/arcgis/rest/services/ServiceRequest/FeatureServer/0"
})
  .then(response) // { name: "311", id: 0, ... }

Layer (Feature Service) request. See the REST Documentation for more information.

getLayer(options: IGetLayerOptions) : Promise<ILayerDefinition>

Parameters

Parameter	Type	Default	Notes
options Required	IGetLayerOptions		Options for the request.

Returns

A Promise that will resolve with the addFeatures response.

Promise<ILayerDefinition>

Property	Type	Notes
advancedQueryCapabilities Optional	{ supportsDistinct: boolean supportsOrderBy: boolean supportsPagination: boolean supportsPercentileStatistics: boolean supportsQueryWithDistance: boolean supportsReturningQueryExtent: boolean supportsSqlExpression: boolean supportsStatistics: boolean supportsTrueCurve: boolean }
allowGeometryUpdates Optional	boolean	Boolean value indicating whether the geometry of the features in the layer can be edited.
allowTrueCurvesUpdates Optional	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.
dateFieldsTimeReference Optional	{ respectsDaylightSaving: boolean timeZone: string }
defaultVisibility Optional	boolean	Boolean value indicating whether the layer's visibility is turned on.
definitionEditor Optional	IDefinitionEditor	Stores interactive filters.
definitionExpression Optional	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	IEditingInfo	An object defining the editing info (last edit date).
extent Optional	IExtent \| null	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	IField[] \| IField	An array of field objects containing information about the attribute fields for the feature collection or layer.
geometryType Optional	GeometryType	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.
hasStaticData Optional	boolean	Boolean value indicating whether data changes. True if it does not.
htmlPopupType Optional	"esriServerHTMLPopupTypeNone" \| "esriServerHTMLPopupTypeAsURL" \| "esriServerHTMLPopupTypeAsHTMLText"	String value indicating the HTML popup type.
id Optional	number	The identifier assigned to the layer.
indexes Optional	any[] \| 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.
onlyAllowTrueCurveUpdatesByTrueCurveClients Optional	boolean
overrideSymbols Optional	boolean	Dictates whether a client can support having an end user modify symbols on individual features.
ownershipBasedAccessControlForFeatures Optional	boolean
parentLayerId Optional	number
rangeInfos Optional	any	Indicates range information
relationships Optional	any[] \| any
source Optional	any	An object indicating the layerDefinition's layer source.
spatialReference Optional	ISpatialReference	An object containing the WKID or WKT identifying the spatial reference of the layer's geometry.
subtypeField Optional	string
supportedQueryFormats Optional	string	String value indicating the output formats that are supported in a query.
supportsAdvancedQueries Optional	boolean	Boolean value indicating whether the layer supports orderByFields in a query operation.
supportsApplyEditsWithGlobalIds Optional	boolean
supportsAttachmentsByUploadId Optional	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.
supportsRollbackOnFailureParameter Optional	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.
supportsValidateSQL Optional	boolean
supportsValidateSql Optional	boolean	Boolean value indicating whether the validateSQL operation is supported across a feature service layer.
syncCanReturnChanges Optional	boolean
templates Optional	ITemplate[] \| ITemplate	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.
useStandardizedQueries Optional	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.
hasM Optional Inherited	boolean
hasZ Optional Inherited	boolean

Function defined in packages/arcgis-rest-feature-layer/src/getLayer.ts:22