SceneLayer | API Reference | ArcGIS Maps SDK for JavaScript 4.31

Overview
Publishing a SceneLayer
Data Visualization
Filtering data
Popups
Querying
Get geometry/extent of SceneLayers
Editing

Overview

The SceneLayer is a layer type designed for on-demand streaming and displaying large amounts of data in a SceneView. SceneLayers support two geometry types: Point and 3D Objects (e.g. Buildings).

You can find many samples of SceneLayers in ArcGIS Online by searching the gallery.

Publishing a SceneLayer

The SceneLayer displays data coming from a Scene Service. Scene Services can hold large volumes of features in an open format that is suitable for web streaming. The SceneLayer loads these features progressively, starting from coarse representations and refines them to higher detail as necessary for close-up views.

Scene Services can be hosted on ArcGIS Online or ArcGIS Enterprise by uploading a Scene Layer Package (.slpk) or by publishing it from ArcGIS Pro. Depending on how you publish a SceneLayer, there are two types of layers: SceneLayers with an associated feature layer and SceneLayers with cached attributes only. For more information see the Publishing section of the Scene layer guide topic.

The Scene Service is identified by the URL or portalItem of the ArcGIS Server REST resource:

let sceneLayer = new SceneLayer({
  url: "https://services.arcgis.com/V6ZHFr6zdgNZuVG0/arcgis/rest/services/Paris_3D_Local_WSL2/SceneServer/layers/0"
});

let sceneLayer = new SceneLayer({
 portalItem: {
   id: "b8138adb2ba7479cadba52d382b34c3b"
 }
});

Most of the times it's better to create the SceneLayer from a portal item rather than a scene service url, because the information about an associated feature service is stored at the item level and not at the service level.

If the scene service is requested from a different domain, a CORS enabled server or a proxy is required.

Although the internal logic of displaying a SceneLayer is technically advanced, its usage within the API follows the same model as other layers. You can use renderers to style the SceneLayer and popups to retrieve attribute information and display it to the user.

Data Visualization

Just like other layers, SceneLayers can be visualized using renderers. 3D Objects can be styled using MeshSymbol3D. A FillSymbol3DLayer can be added to MeshSymbol3D to visualize 3D Objects from a SceneLayer:

let symbol = {
  type: "mesh-3d",  // autocasts as new MeshSymbol3D()
  symbolLayers: [{
    type: "fill",  // autocasts as new FillSymbol3DLayer()
    material: { color: "red" }
  }]
};

sceneLayer.renderer = {
  type: "simple",  // autocasts as new SimpleRenderer()
  symbol: symbol
};

SceneLayers also support visual variables, which allow you to easily visualize numeric data in the layer with continuous color. For example, the service used in the image below represents building features containing a numeric attribute storing the number of residents in each building. The renderer for the layer uses the color visual variable to shade each feature along a continuous white to blue color ramp based on the value of the given field. White features represent buildings that are farther away from a public transport station and deep blue features represent buildings that are very close to one (less than 1 minute walking time). Buildings with values between the low and high values are assigned intermediate colors. To improve the perception of shapes of 3D Object SceneLayers, they can also be visualized with edges. See the Visualization overview topic to learn more about data visualization techniques.

Attributes used in data-driven visualizations with visual variables must be accessible to a SceneLayer's cache. For both SceneLayers with cached attributes only and SceneLayer with associated feature layer the attribute values come from the cache. Therefore if the attributes on the feature layer change, the visualization will not update. Keeping the number of cached attributes to a minimum improves the performance of the SceneLayer. Therefore it is best practice to be judicious with the attributes you make available through the layer's cache.

Filtering data

SceneLayers can be filtered using an SQL where clause. Filtering is implemented with the definitionExpression property. This property is evaluated on the client using SceneLayer cached attributes and it only supports standardized SQL.

let layer = new SceneLayer({
 url: "https://services.arcgis.com/V6ZHFr6zdgNZuVG0/arcgis/rest/services/Paris_3D_Local_WSL2/SceneServer/layers/0",
 definitionExpression: "Type_Toit = 'plat' AND H_MAX <= 20"
});

Another way to filter data is to use a FeatureFilter on the SceneLayerView. This will only display the features that satisfy the filter conditions. Setting a geometry and a spatialRelationship allows you to filter features based on the spatialRelationship with the geometry you pass in. Currently only spatial relationships of type contains, intersects or disjoint are supported.

Alternatively you can also use a SceneFilter on the filter property directly on the layer. It works similar to the FeatureFilter, but you can define more than just one geometry object. This filter is also persisted in WebScenes and when the layer is saved.

For more information see the Filter SceneLayer with FeatureFilter or the Filter SceneLayer with SceneFilter sample.

Popups

Point and 3D Object SceneLayers can have customized popup content using the popupTemplate property. A SceneLayer with associated feature layer will query the associated feature layer for attributes. For a SceneLayer with cached attributes only, attributes come from the cache. Arcade expressions for expressionInfo in a popupTemplate are also supported.

custom-popups

Querying

The SceneLayer and the SceneLayerView both support queries, but act differently.

Querying a SceneLayer retrieves results from the attributes in the associated feature layer. If the layer doesn't have an associated feature layer, then the query will be rejected with an error. Queries on the layer are powerful because they are made on all the features in the SceneLayer and they also support advanced queries. Spatial queries are supported when the spatialRelationship is set to intersects, contains, or disjoint.

For making attribute based queries on a SceneLayerView you need to specify the required fields in the outFields property of the SceneLayer to ensure that attribute values are available on the client for querying. You can use availableFields to inspect which fields are available on the client. On a SceneLayerView spatial queries are possible by setting the geometry and the spatialRelationship of the query. Note that for 3D Object SceneLayers these spatial relationships are evaluated based on the Extent and not the footprint of the feature. The queries on the SceneLayerView return results for features that are currently loaded in the view.

Query method	SceneLayer (only works if it has an associated feature layer)	SceneLayerView (works on all scene layers)
queryExtent	returns the 2D extent of all features that satisfy the query	returns the 3D extent of currently loaded features that satisfy the query
queryFeatureCount	returns the number of all features that satisfy the query	returns the number of currently loaded features that satisfy the query
queryFeatures	returns all the features that satisfy the query	returns the currently loaded features that satisfy the query
queryObjectIds	returns objectIds of all the features that satisfy the query	returns the objectIds of currently loaded features that satisfy the query

Known Limitations

Spatial queries have the same limitations as those listed in the projection engine documentation.
Spatial queries use the Extent of the feature and not the footprint when calculating the spatial relationship with the query geometry. This means that a feature might be returned from the query, even though its footprint is not in a spatial relationship with the geometry.
Currently only intersects, contains, and disjoint spatialRelationships are supported on spatial queries.
Spatial queries are not currently supported if the SceneLayer has any of the following SpatialReferences:
- GDM 2000 (4742) - Malaysia
- Gsterberg (Ferro) (8042) - Austria/Czech Republic
- ISN2016 (8086) - Iceland
- SVY21 (4757) - Singapore

Get geometry/extent of SceneLayers

3D Object SceneLayers do not return the raw geometry as this is a binary format. To obtain spatial information you can query the 2D extent or 3D extent of features in a SceneLayer. The 2D extent can be retrieved for all features (even the ones that are not loaded yet) with queryExtent() method on the SceneLayer. This method only succeeds if the layer has an associated feature layer. The 3D extent can only be queried for the features that are already loaded, by using the queryExtent() method on the SceneLayerView.

Point SceneLayers return geometry when setting returnGeometry to true on any of the query methods. Additionally, the 2D extent of multiple points can be retrieved using queryExtent() on the SceneLayer. It is not possible to get the extent for a SceneLayer with cached attributes only.

Editing

In version 4.27, support for Scene Layer geometry add, update, and delete was released. For an example see: Sample - SceneLayer upload 3D models and applyEdits. For the Scene Layer edit operations, geometry is represented using mesh geometry. This expands attribute editing, which got released with version 4.18. The simplest way to use this new functionality is to use the Editor widget which includes all workflows out of the box. The prerequisite for an editable SceneLayer is an associated FeatureLayer with editing and change tracking enabled. Geometry can be edited when in global viewingMode and the layer spatial reference is a GCS or when in local viewingMode and the layer spatial reference is a PCS and matches the spatial reference of the view. For more information about publishing, see the Publishing section of the scene layer guide topic

Edits to scene layers are applied directly from their associated feature service and support a limited amount of edits until you need to rebuild the cache. For example, features with edited attributes are rendered with the updated attributes until the number of edited features exceeds 50,000. After that, the edited attributes are not retrieved, and the features are rendered with the cached, outdated attributes.

Limits for uploading models to create new features depend on complexity and size of the uploaded models. Scene layer caches are optimized for displaying large amounts of 3D data in a scene, and it is critical to manage the cache as appropriate for your workflows.

A use case for scene layer attribute updates is to change status and types, check this sample: Sample - SceneLayer attribute editing In this sample, the editable feature layer is shared to everyone. Therefore, everyone will be able to modify this data. In a real use case, only an authorized editor would be able to edit the layer. In such circumstances, the associated feature layer is not shared publicly, and will only be accessible to the editor. To make the edits visible to the scene layer user, it is necessary to rebuild the cache.

When working with meshes and Scene Layers, mesh georeferencing affects when non-cached layer can be edited and edits are visible. See mesh api for details.

Troubleshooting mesh georeferencing

If meshes are not being displayed, then chances are that this is due a configuration which the API does not support for display and editing.

First check the viewingMode, Scene Layers spatialReference and vertex space of the mesh geometry involved and consult the console of the javascript debugger. If the API rejects display of SceneLayer edits, a warning message is printed.
If it is determined that an unsupported configuration is used, consider switching the viewingMode in your application.
Alternatively, consider rebuilding the cache. Rebuilding the I3S cache will do some of the projects we won't allow on the client and extent the cases in which 3D object feature edits are displayed.
If there is no other option, consider changing the data by switching to a supported spatial reference for the required viewingMode.

Known Limitation

Layers with very complex geometries might not load correctly in Firefox because of size restriction when transferring data to workers.

See also

Constructors

SceneLayer Constructor new SceneLayer(properties)

Parameter

properties Object

optional

See the properties for a list of all the properties that may be passed into the constructor.

Example

// Typical usage
let layer = new SceneLayer({
  // URL to the service
  url: "https://services.arcgis.com/V6ZHFr6zdgNZuVG0/arcgis/rest/services/Paris_3D_Local_WSL2/SceneServer/layers/0"
});

Property Overview

Any properties can be set, retrieved or listened to. See the Working with Properties topic.

Show inherited properties

Hide inherited properties

Type	Summary	Class
String\|null\|undefined	An authorization string used to access a resource or service.	SceneLayer
Capabilities	Describes the layer's supported capabilities.	SceneLayer
String	The copyright text as defined by the scene service.	SceneLayer
Object\|null\|undefined	A list of custom parameters appended to the URL of all resources fetched by the layer.	SceneLayer
String	The name of the class.	Accessor
String\|null\|undefined	The SQL where clause used to filter features.	SceneLayer
Capabilities	Describes effective capabilities of the layer taking in to consideration privileges of the currently signed-in user.	SceneLayer
Object	Specifies how features are placed on the vertical axis (z).	SceneLayer
Collection<number>	List of ObjectIDs not being displayed in the view.	SceneLayer
FeatureReductionSelection	Configures the method for decluttering overlapping features in the view.	SceneLayer
Field []	An array of fields accessible in the layer.	SceneLayer
FieldsIndex	A convenient property that can be used to make case-insensitive lookups for a field by name.	SceneLayer
SceneFilter	A collection of polygons geometries which will mask out different parts of the layer.	SceneLayer
LayerFloorInfo	When a scene layer is configured as floor-aware, it has a floorInfo property defined.	SceneLayer
Extent\|null\|undefined	The full extent of the layer.	Layer
String	The geometry type of features in the layer.	SceneLayer
String	The unique ID assigned to the layer.	Layer
LabelClass []\|null\|undefined	The label definition for this layer, specified as an array of LabelClass.	SceneLayer
Boolean	Indicates whether to display labels for this layer.	SceneLayer
Number	The layer ID, or layer index, of a Scene Service layer.	SceneLayer
Boolean	Indicates whether the layer will be included in the legend.	SceneLayer
String	Indicates how the layer should display in the LayerList widget.	Layer
Error	The Error object returned if an error occurred while loading.	Layer
String	Represents the status of a load operation.	Layer
Object []	A list of warnings which occurred while loading.	Layer
Boolean	Indicates whether the layer's resources have loaded.	Layer
Number	The maximum scale (most zoomed in) at which the layer is visible in the view.	SceneLayer
Number	The minimum scale (most zoomed out) at which the layer is visible in the view.	SceneLayer
String	The name of the field containing each graphic's Object ID.	SceneLayer
Number	The opacity of the layer.	Layer
String []	An array of field names from the service to include with each feature.	SceneLayer
Map\|Basemap\|Ground\|GroupLayer\|CatalogDynamicGroupLayer\|CatalogLayer	The parent to which the layer belongs.	Layer
Boolean	When `true`, the layer can be persisted.	Layer
Boolean	Indicates whether to display popups when features in the layer are clicked.	SceneLayer
PopupTemplate	The popup template for the layer.	SceneLayer
PortalItem\|null\|undefined	The portal item from which the layer is loaded.	SceneLayer
Relationship []	Array of relationships set up for the layer.	SceneLayer
Renderer	The renderer assigned to the layer.	SceneLayer
Boolean	Apply perspective scaling to screen-size point symbols in a SceneView.	SceneLayer
SpatialReference	The spatial reference of the layer.	SceneLayer
TimeExtent	The layer's time extent.	SceneLayer
TimeInfo	TimeInfo provides information such as date fields that store start and end time for each feature and the fullTimeExtent for the layer.	SceneLayer
TimeInterval	A temporary offset of the time data based on a certain TimeInterval.	SceneLayer
String\|null\|undefined	The title of the layer used to identify it in places such as the Legend and LayerList widgets.	SceneLayer
String	For SceneLayer the type is always "scene".	SceneLayer
String	The URL of the REST endpoint of the layer or scene service.	SceneLayer
Boolean	Determines if the layer will update its temporal data based on the view's timeExtent.	useViewTime
Object	The version of the scene service specification used for this service.	SceneLayer
TimeExtent\|null\|undefined	Specifies a fixed time extent during which a layer should be visible.	Layer
Boolean	Indicates if the layer is visible in the View.	Layer

Property Details

apiKey Property apiKey String |null |undefined Since: ArcGIS Maps SDK for JavaScript 4.20 SceneLayer since 4.27, apiKey added at 4.20.

An authorization string used to access a resource or service. API keys are generated and managed in the portal. An API key is tied explicitly to an ArcGIS account; it is also used to monitor service usage. Setting a fine-grained API key on a specific class overrides the global API key.

Example

// set the api key to access a protected service
const layer = new FeatureLayer({
  url: serviceUrl,
  apiKey: "YOUR_API_KEY"
});

capabilities Property capabilities Capabilitiesreadonly

Describes the layer's supported capabilities.

copyright Property copyright String

The copyright text as defined by the scene service.

customParameters Property customParameters Object |null |undefined Since: ArcGIS Maps SDK for JavaScript 4.18 SceneLayer since 4.27, customParameters added at 4.18.

A list of custom parameters appended to the URL of all resources fetched by the layer. It's an object with key-value pairs where value is a string. The layer's refresh() method needs to be called if the customParameters are updated at runtime.

Example

// send a custom parameter to your special service
let layer = new MapImageLayer({
  url: serviceUrl,
  customParameters: {
    "key": "my-special-key"
  }
});

declaredClass Inherited Property declaredClass Stringreadonly Inherited from Accessor Since: ArcGIS Maps SDK for JavaScript 4.7 Accessor since 4.0, declaredClass added at 4.7.

The name of the class. The declared class name is formatted as esri.folder.className.

definitionExpression Property definitionExpression String |null |undefined Since: ArcGIS Maps SDK for JavaScript 4.3 SceneLayer since 4.27, definitionExpression added at 4.3.

The SQL where clause used to filter features. Only the features that satisfy the definition expression are kept on the client and displayed in the View. Setting a definition expression is useful when only a subset of the data in the layer should be displayed.

Setting the definition expression of a layer automatically updates all layer views.

If the definition expression is set after the layer has been added to the map, the view will automatically refresh itself to display the features that satisfy the new definition expression.

Deprecation warning

In the future, setting definitionExpression will load all the nodes on the client and discard the features that don't match the filter. This uses less memory, but the filter updates will be slower than in the current version. A definitionExpression should only be used if the filter changes rarely, and removing the filtered features is desired to free up memory for other data in the scene.

For fast client-side filters use the where property of SceneLayerView.filter instead.

Example

let layer = new SceneLayer({
   url: "https://services.arcgis.com/V6ZHFr6zdgNZuVG0/arcgis/rest/services/Paris_3D_Local_WSL2/SceneServer/layers/0",
   definitionExpression: "Type_Toit = 'plat' AND H_MAX <= 20"
 });

effectiveCapabilities Property effectiveCapabilities Capabilitiesreadonly Since: ArcGIS Maps SDK for JavaScript 4.28 SceneLayer since 4.27, effectiveCapabilities added at 4.28.

Describes effective capabilities of the layer taking in to consideration privileges of the currently signed-in user.

elevationInfo Property elevationInfo Object

Specifies how features are placed on the vertical axis (z). See the ElevationInfo sample for an example of how this property may be used.

The relative-to-scene mode does not affect 3D Object SceneLayers. SceneLayers with Point geometries support all the elevation modes listed below.

If the elevation info is not specified, the effective elevation depends on the context and could vary per graphic.

Properties: mode String

Defines how the feature is placed with respect to the terrain surface. See the table below for a list of possible values.

Mode Description

on-the-ground Features are draped on the terrain surface. This is the default value for features with Point geometries rendered with ObjectSymbol3DLayers.

relative-to-ground Features are placed at an elevation relative to the terrain surface. The features's elevation is determined by summing up the terrain elevation, the offset value and the geometry's z-value (if present). This is the default value for Point geometries rendered with IconSymbol3DLayers.

absolute-height Features are placed at an absolute elevation (z-value) above sea level. This z-value is determined by summing up the offset value and the geometry's z-value (if present). It doesn't take the elevation of the terrain into account. This is the default value for features with 3D Object geometries and Point geometries where hasZ is true.

relative-to-scene Features are aligned to buildings and other objects part of 3D Object SceneLayer or IntegratedMeshLayer or IntegratedMesh3DTilesLayer, depending on which has higher elevation. If the graphic is not directly above a building or any other feature, it is aligned to the terrain surface elevation. If present, the geometry's z-value is added to the elevation.

Possible Values:"on-the-ground"|"relative-to-ground"|"absolute-height"|"relative-to-scene"

offset Number|null|undefined

optional
An elevation offset which is added to the vertical position of the feature. When mode = "on-the-ground", this property has no effect.

unit ElevationUnit|null|undefined

optional
The unit for offset values.

excludeObjectIds Property excludeObjectIds Collection<number> Since: ArcGIS Maps SDK for JavaScript 4.23 SceneLayer since 4.27, excludeObjectIds added at 4.23.

List of ObjectIDs not being displayed in the view.

featureReduction Property featureReduction FeatureReductionSelectionautocast Since: ArcGIS Maps SDK for JavaScript 4.4 SceneLayer since 4.27, featureReduction added at 4.4.

Configures the method for decluttering overlapping features in the view. If this property is not set (or set to null), every feature is drawn individually.

This property is only supported for point scene layers with non-draped Icon or Text symbol layers.

Known Limitation

When applying featureReduction on a point SceneLayer layer updates are slow. This will be addressed in upcoming releases.

See also

Sample: Point styles for cities

Example

layer.featureReduction = {
  type: "selection"
};

fields Property fields Field[]readonly

An array of fields accessible in the layer. Depending on the scene service, fields may have limited support for certain capabilities. Use getFieldUsageInfo() to query the contexts (rendering, labeling, popups or querying) for which a particular field may be used.

fieldsIndex Property fieldsIndex FieldsIndexreadonly Since: ArcGIS Maps SDK for JavaScript 4.12 SceneLayer since 4.27, fieldsIndex added at 4.12.

A convenient property that can be used to make case-insensitive lookups for a field by name. It can also provide a list of the date fields in a layer.

Example

// lookup a field by name. name is case-insensitive
const field = layer.fieldsIndex.get("SoMeFiEld");

if (field) {
  console.log(field.name); // SomeField
}

filter Property filter SceneFilter Since: ArcGIS Maps SDK for JavaScript 4.24 SceneLayer since 4.27, filter added at 4.24.

A collection of polygons geometries which will mask out different parts of the layer. With the spatialRelationship property you can define if the content inside or outside of the polygons should be masked.

See also

SceneFilter

Example

const layer = new SceneLayer({ ... })

// create a polygon
const polygon = new Polygon({ ... });

// create the masking
const filter = new SceneFilter({ geometries: [polygon], spatialRelationship: "contains" });

// add the mask to the SceneLayer
layer.filter = filter;

floorInfo Property floorInfo LayerFloorInfoautocast Since: ArcGIS Maps SDK for JavaScript 4.19 SceneLayer since 4.27, floorInfo added at 4.19.

When a scene layer is configured as floor-aware, it has a floorInfo property defined. A floor-aware layer is a layer that contains indoor GIS data representing features that can be located on a specific floor of a building.

fullExtent Inherited Property fullExtent Extent |null |undefinedautocast Inherited from Layer

The full extent of the layer. By default, this is worldwide. This property may be used to set the extent of the view to match a layer's extent so that its features appear to fill the view. See the sample snippet below.

Example

// Once the layer loads, set the view's extent to the layer's fullextent
layer.when(function(){
  view.extent = layer.fullExtent;
});

geometryType Property geometryType String

The geometry type of features in the layer.

Possible Values:"point" |"mesh"

id Inherited Property id String Inherited from Layer

The unique ID assigned to the layer. If not set by the developer, it is automatically generated when the layer is loaded.

labelingInfo Property labelingInfo LabelClass[] |null |undefined

The label definition for this layer, specified as an array of LabelClass. Use this property to specify labeling properties for the layer such as label expression, placement, and size.

Known Limitations

Each feature can have only one label. Multiple Label classes with different where clauses can be used to have different label styles on different features that belong to the same layer (for example blue labels for lakes and green labels for parks).

See also

labelsVisible

Example

let statesLabelClass = new LabelClass({
  labelExpressionInfo: { expression: "$feature.NAME" },
  symbol: {
    type: "label-3d",  // autocasts as new LabelSymbol3D()
    symbolLayers: [{
      type: "text",  // autocasts as new TextSymbol3DLayer()
      material: { color: [ 49,163,84 ] },
      size: 12  // points
    }]
  }
});

sceneLayer.labelingInfo = [ statesLabelClass ];

labelsVisible Property labelsVisible Boolean

Indicates whether to display labels for this layer. If true, labels will appear as defined in the labelingInfo property.

Default Value:true

See also

labelingInfo

layerId Property layerId Number

The layer ID, or layer index, of a Scene Service layer. This is particularly useful when loading a single layer with the portalItem property from a service containing multiple layers. You can specify this value in one of two scenarios:

When loading the layer via the portalItem property.
When pointing the layer url directly to the Scene Service.

If a layerId is not specified in either of the above scenarios, then the first layer in the service (layerId = 0) is selected.

Examples

// while these examples use a SceneLayer, the same pattern can be
// used for other layers that may be loaded from portalItem ids

// loads the third layer in the given Portal Item
let layer = new SceneLayer({
  portalItem: {
    id: "73df987984b24094b848d580eb83b0fb"
  },
  layerId: 2
});

// If not specified, the first layer (layerId: 0) will be returned
let layer = new SceneLayer({
  portalItem: {
    id: "73df987984b24094b848d580eb83b0fb"
  }
});

// Can also be used if URL points to service and not layer
let layer = new SceneLayer({
  url: "https://scenesampleserverdev.arcgis.com/arcgis/rest/services/Hosted/DevA_Trees/SceneServer",
  layerId: 0  // Notice that the url doesn't end with /2
});

// This code returns the same layer as the previous snippet
let layer = new SceneLayer({
  url: "https://scenesampleserverdev.arcgis.com/arcgis/rest/services/Hosted/DevA_Trees/SceneServer/layers/0",
  // The layer id is specified in the URL
});

legendEnabled Property legendEnabled Boolean

Indicates whether the layer will be included in the legend.

Default Value:true

listMode Inherited Property listMode String Inherited from Layer

Indicates how the layer should display in the LayerList widget. The possible values are listed below.

Value	Description
show	The layer is visible in the table of contents.
hide	The layer is hidden in the table of contents.
hide-children	If the layer is a GroupLayer, BuildingSceneLayer, KMLLayer, MapImageLayer, TileLayer or WMSLayer, hide the children layers from the table of contents.

Possible Values:"show" |"hide" |"hide-children"

Default Value:"show"

loadError Inherited Property loadError Errorreadonly Inherited from Layer

The Error object returned if an error occurred while loading.

Default Value:null

loadStatus Inherited Property loadStatus Stringreadonly Inherited from Layer

Represents the status of a load operation.

Value	Description
not-loaded	The object's resources have not loaded.
loading	The object's resources are currently loading.
loaded	The object's resources have loaded without errors.
failed	The object's resources failed to load. See loadError for more details.

Possible Values:"not-loaded" |"loading" |"failed" |"loaded"

Default Value:"not-loaded"

loadWarnings Inherited Property loadWarnings Object[]readonly Inherited from Layer

A list of warnings which occurred while loading.

loaded Inherited Property loaded Booleanreadonly Inherited from Layer

Indicates whether the layer's resources have loaded. When true, all the properties of the object can be accessed.

Default Value:false

maxScale Property maxScale Number

The maximum scale (most zoomed in) at which the layer is visible in the view. If the map is zoomed in beyond this scale, the layer will not be visible. A value of 0 means the layer does not have a maximum scale. The maxScale value should always be smaller than the minScale value, and greater than or equal to the service specification.

Default Value:0

Examples

// The layer will not be visible when the view is zoomed in beyond a scale of 1:1,000
layer.maxScale = 1000;

// The layer's visibility is not restricted to a maximum scale.
layer.maxScale = 0;

minScale Property minScale Number

The minimum scale (most zoomed out) at which the layer is visible in the view. If the map is zoomed out beyond this scale, the layer will not be visible. A value of 0 means the layer does not have a minimum scale. The minScale value should always be larger than the maxScale value, and lesser than or equal to the service specification.

Default Value:0

Examples

// The layer will not be visible when the view is zoomed out beyond a scale of 1:3,000,000
layer.minScale = 3000000;

// The layer's visibility is not restricted to a minimum scale.
layer.minScale = 0;

objectIdField Property objectIdField String

The name of the field containing each graphic's Object ID. If this is not explicitly specified, this is automatically derived from the fields of the service by taking the first field of type oid.

See also

fields

opacity Inherited Property opacity Number Inherited from Layer

The opacity of the layer. This value can range between 1 and 0, where 0 is 100 percent transparent and 1 is completely opaque.

Default Value:1

Example

// Makes the layer 50% transparent
layer.opacity = 0.5;

outFields Property outFields String[] Since: ArcGIS Maps SDK for JavaScript 4.12 SceneLayer since 4.27, outFields added at 4.12.

An array of field names from the service to include with each feature. To fetch the values from all fields in the layer, use ["*"]. Fields specified in outFields will be requested alongside with required fields for rendering, labeling and setting the elevation info for the layer. The required fields and outFields are used to populate SceneLayerView.availableFields. Set this property to include the fields that will be used for client-side queries if the fields are not part of required fields used for rendering.

Default Value:null

See also

Examples

// Includes all fields from the service in the layer
sl.outFields = ["*"];

// Get the specified fields from the service in the layer
// These fields will be added to SceneLayerView.availableFields
// along with rendering and labeling fields. Use these fields
// for client-side querying.
sl.outFields = ["NAME", "POP_2010", "FIPS", "AREA"];

// set the outFields for the layer coming from webscene
webscene.when(function () {
  layer = webscene.layers.at(1);
  layer.outFields = ["*"];
});

The parent to which the layer belongs.

persistenceEnabled Inherited Property persistenceEnabled Boolean Inherited from Layer Since: ArcGIS Maps SDK for JavaScript 4.28 Layer since 4.0, persistenceEnabled added at 4.28.

When true, the layer can be persisted. This property only has an effect for layers that are part of the WebMap or WebScene spec.

Default Value:false

popupEnabled Property popupEnabled Boolean

Indicates whether to display popups when features in the layer are clicked. The layer needs to have a popupTemplate to define what information should be displayed in the popup. Alternatively, a default popup template may be automatically used if Popup.defaultPopupTemplateEnabled is set to true.

Default Value:true

See also

createPopupTemplate
View

popupTemplate Property popupTemplate PopupTemplateautocast

The popup template for the layer. When set on the layer, the popupTemplate allows users to access attributes and display their values in the view's popup when a feature is selected using text and/or charts. See the PopupTemplate sample for an example of how PopupTemplate interacts with a FeatureLayer. Setting a PopupTemplate on this layer type is done in the same way as a FeatureLayer.

A default popup template is automatically used if no popupTemplate has been defined when Popup.defaultPopupTemplateEnabled is set to true.

See also

createPopupTemplate
View

portalItem Property portalItem PortalItem |null |undefined

The portal item from which the layer is loaded. If the portal item references a Feature Service or Scene Service, then you can specify a single layer to load with the layerId property.

Beginning with version 4.17, it is possible to load tables from feature service items hosted in ArcGIS Online and ArcGIS Enterprise. This only applies to feature layers, and will successfully load if FeatureLayer.isTable returns true.

Examples

// While this example uses FeatureLayer, this same pattern can be
// used for other layers that may be loaded from portalItem ids.
const layer = new FeatureLayer({
  portalItem: {  // autocasts as new PortalItem()
    id: "caa9bd9da1f4487cb4989824053bb847"
  }  // the first layer in the service is returned
});

// Set hostname when using an on-premise portal (default is ArcGIS Online)
// esriConfig.portalUrl = "http://myHostName.esri.com/arcgis";

// While this example uses FeatureLayer, this same pattern can be
// used for SceneLayers.
const layer = new FeatureLayer({
  portalItem: {  // autocasts as new PortalItem()
    id: "8d26f04f31f642b6828b7023b84c2188"
  },
  // loads the third item in the given feature service
  layerId: 2
});

// Initialize GeoJSONLayer by referencing a portalItem id pointing to geojson file.
const layer = new GeoJSONLayer({
  portalItem: new PortalItem({
    id: "81e769cd7031482797e1b0768f23c7e1",
    // optionally define the portal, of the item.
    // if not specified, the default portal defined is used.
    // see https://developers.arcgis.com/javascript/latest/api-reference/esri-config.html#portalUrl
    portal: new Portal({
      url: "https://jsapi.maps.arcgis.com/"
    })
  }
});

// This snippet loads a table hosted in ArcGIS Online.
const table = new FeatureLayer({
  portalItem: { // autocasts as esri/portal/PortalItem
    id: "123f4410054b43d7a0bacc1533ceb8dc"
  }
});

// Before adding the table to the map, it must first be loaded and confirm it is the right type.
table.load().then(function() {
  if (table.isTable) {
    map.tables.add(table);
  }
});

relationships Property relationships Relationship[]readonly Since: ArcGIS Maps SDK for JavaScript 4.28 SceneLayer since 4.27, relationships added at 4.28.

Array of relationships set up for the layer. Each object in the array describes the layer's relationship with another layer or table. This property is read from the associated feature layer if available.

See also

queryRelatedFeatures

Example

// print out layer's relationship length and each relationship info to console
layer.when(function () {
  console.log("layer relationships", layer.relationships.length);

  layer.relationships.forEach(function (relationship) {
    console.log("relationship id:", relationship.id)
    console.log("relationship cardinality:", relationship.cardinality)
    console.log("relationship key field:", relationship.keyField)
    console.log("relationship name:", relationship.name)
    console.log("relationship relatedTableId:", relationship.relatedTableId)
  });
});

renderer Property renderer Rendererautocast

The renderer assigned to the layer. The renderer defines how to visualize each feature in the layer. Depending on the renderer type, features may be visualized with the same symbol, or with varying symbols based on the values of provided attribute fields or functions.

See also

Styles and data visualization

Example

// all features in the layer will be visualized with
// a blue color
layer.renderer = {
  type: "simple",  // autocasts as new SimpleRenderer()
  symbol: {
    type: "mesh-3d",  // autocasts as new MeshSymbol3D()
    symbolLayers: [{
      type: "fill",  // autocasts as new FillSymbol3DLayer()
      material: { color: "blue" }
    }]
  }
};

screenSizePerspectiveEnabled Property screenSizePerspectiveEnabled Boolean Since: ArcGIS Maps SDK for JavaScript 4.4 SceneLayer since 4.27, screenSizePerspectiveEnabled added at 4.4.

Apply perspective scaling to screen-size point symbols in a SceneView. When true, screen sized objects such as icons, labels or callouts integrate better in the 3D scene by applying a certain perspective projection to the sizing of features. This only applies when using a SceneView.

layer.screenSizePerspectiveEnabled = true

screen-size-perspective

layer.screenSizePerspectiveEnabled = false

no-screen-size-perspective

Known Limitations

Screen size perspective is currently not optimized for situations where the camera is very near the ground, or for scenes with point features located far from the ground surface. In these cases it may be better to turn off screen size perspective. As screen size perspective changes the size based on distance to the camera, it should be set to false when using size visual variables.

Default Value:true

See also

Sample: Point styles for cities

spatialReference Property spatialReference SpatialReferenceautocast

The spatial reference of the layer.

timeExtent Property timeExtent TimeExtentautocast Since: ArcGIS Maps SDK for JavaScript 4.30 SceneLayer since 4.27, timeExtent added at 4.30.

The layer's time extent. When the layer's useViewTime is false, the layer instructs the view to show data from the layer based on this time extent. If the useViewTime is true, and both layer and view time extents are set, then features that fall within the intersection of the view and layer time extents will be displayed. For example, if the layer's time extent is set to display features between 1970 and 1975 and the view has a time extent set to 1972-1980, the effective time on the feature layer will be 1972-1975.

Examples

if (!layer.useViewTime) {
  if (layer.timeExtent) {
    console.log("Current timeExtent:", layer.timeExtent.start, " - ", layer.timeExtent.end}
  } else {
    console.log("The layer will display data within the view's timeExtent.");
    console.log("Current view.timeExtent:", view.timeExtent.start, " - ", view.timeExtent.end}
  }
}

// set the timeExtent on the layer and useViewTime false
// In this case, the layer will honor its timeExtent and ignore
// the view's timeExtent
const layer = new SceneLayer({
  url: "https://services.arcgis.com/V6ZHFr6zdgNZuVG0/arcgis/rest/services/Paris_3D_Local_WSL2/SceneServer",
  timeExtent: {
    start: new Date(2014, 4, 18),
    end: new Date(2014, 4, 19)
  },
  useViewTime: false
});

// timeExtent is set on the layer and the view
// In this case, the layer will display features that fall
// within the intersection of view and layer time extents
// features within Jan 1, 1976 - Jan 1, 1981 will be displayed
const view = new SceneView({
  timeExtent: {
    start: new Date(1976, 0, 1),
    end: new Date(2002, 0, 1)
  }
});
const layer = new SceneLayer({
  url: myUrl,
  timeExtent: {
    start: new Date(1974, 0, 1),
    end: new Date(1981, 0, 1)
  }
});

timeInfo Property timeInfo TimeInfoautocast Since: ArcGIS Maps SDK for JavaScript 4.30 SceneLayer since 4.27, timeInfo added at 4.30.

TimeInfo provides information such as date fields that store start and end time for each feature and the fullTimeExtent for the layer.

If timeInfo configuration exists on the service it gets read and used from there. A developer can overwrite or create a timeInfo configuration on initialization. The timeInfo parameters cannot be changed after the layer is loaded.

TimeInfo's startField and endField can be date, date-only or timestamp-offset field type for SceneLayer and BuildingComponentSublayer.

timeOffset Property timeOffset TimeIntervalautocast Since: ArcGIS Maps SDK for JavaScript 4.30 SceneLayer since 4.27, timeOffset added at 4.30.

A temporary offset of the time data based on a certain TimeInterval. This allows users to overlay features from two or more time-aware layers with different time extents. For example, if a layer has data recorded for the year 1970, an offset value of 2 years would temporarily shift the data to 1972. You can then overlay this data with data recorded in 1972. A time offset can be used for display purposes only. The query and selection are not affected by the offset.

title Property title String |null |undefined

The title of the layer used to identify it in places such as the Legend and LayerList widgets.

When loading a layer by service url, the title is derived from the service name. If the service has several layers, then the title of each layer will be the concatenation of the service name and the layer name. When the layer is loaded from a portal item, the title of the portal item will be used instead. Finally, if a layer is loaded as part of a webmap or a webscene, then the title of the layer as stored in the webmap/webscene will be used.

type Property type Stringreadonly

For SceneLayer the type is always "scene".

url Property url String

The URL of the REST endpoint of the layer or scene service. The URL may either point to a resource on ArcGIS Enterprise or ArcGIS Online.

The layer may be specified using the layerId property when the url points directly to a service and not a specific layer. If layerId is not specified, then it will default to the first layer in the service.

Examples

// Layer from Scene Service on ArcGIS Server
let sceneLayer = new SceneLayer({
  url: "https://services.arcgis.com/V6ZHFr6zdgNZuVG0/arcgis/rest/services/Paris_3D_Local_WSL2/SceneServer/layers/0"
});

// Can also be used if URL points to service and not layer
let layer = new SceneLayer({
  // Notice that the url doesn't end with /0
  url: "https://scenesampleserverdev.arcgis.com/arcgis/rest/services/Hosted/DevA_Trees/SceneServer",
  layerId: 0
});

useViewTime Property useViewTime Booleanautocastinner Since: ArcGIS Maps SDK for JavaScript 4.30 useViewTime since 4.27, useViewTime added at 4.30.

Determines if the layer will update its temporal data based on the view's timeExtent. When false, the layer will display its temporal data based on the layer's timeExtent, regardless of changes to the view. If both view and layer time extents are set while this property is true, then the features that fall within the intersection of the view and layer time extents will be displayed. For example, if a layer's time extent is set to display features between 1970 and 1975 and the view has a time extent set to 1972-1980, the effective time on the feature layer will be 1972-1975.

Default Value:true

Example

if (layer.useViewTime) {
  console.log("Displaying data between:", view.timeExtent.start, " - ", view.timeExtent.end);
}

version Property version Objectreadonly

The version of the scene service specification used for this service.

Properties

major Number

The major version of the scene layer.

minor Number

The minor version of the scene layer.

versionString String

The complete version string of the scene layer.

See also

https://github.com/Esri/i3s-spec

Example

// Prints the version to the console - e.g. 1.4, 1.5, etc.
console.log(layer.version.versionString);

visibilityTimeExtent Inherited Property visibilityTimeExtent TimeExtent |null |undefinedautocast Inherited from Layer Since: ArcGIS Maps SDK for JavaScript 4.30 Layer since 4.0, visibilityTimeExtent added at 4.30.

Specifies a fixed time extent during which a layer should be visible. This property can be used to configure a layer that does not have time values stored in an attribute field to work with time. Once configured, the TimeSlider widget will display the layer within the set time extent. In the case that only one of the start or end date values are available, the layer remains visible indefinitely in the direction where there is no time value.

Aerial imagery can capture seasonal variations in vegetation, water bodies, and land use patterns. For example, in agricultural regions, aerial imageries taken during different growing seasons provide insights into crop health and productivity. Defining a fixed time extent on imageries from specific time periods provides temporal context and facilitates focused analysis based on specific time periods or events.

Default Value:null

See also

Sample - GraphicsLayer with visibilityTimeExtent

visible Inherited Property visible Boolean Inherited from Layer

Indicates if the layer is visible in the View. When false, the layer may still be added to a Map instance that is referenced in a view, but its features will not be visible in the view.

Default Value:true

Example

// The layer is no longer visible in the view
layer.visible = false;

// Watch for changes in the layer's visibility
// and set the visibility of another layer when it changes
reactiveUtils.watch(
  () => layer.visible,
  (visible) => {
    if (visible) {
      anotherLayer.visible = true;
    } else {
      anotherLayer.visible = false;
    }
  }
);

Method Overview

Show inherited methods

Hide inherited methods

Return Type	Summary	Class
	Adds one or more handles which are to be tied to the lifecycle of the object.	Accessor
Promise<EditsResult>	Applies edits to the features in the associated FeatureLayer.	SceneLayer
	Cancels a load() operation if it is already in progress.	Layer
this	Creates a deep clone of this object.	SceneLayer
Promise<Mesh>	Converts a file or list of files to mesh geometry.	SceneLayer
Promise<LayerView>	Called by the views, such as MapView and SceneView, when the layer is added to the Map.layers collection and a layer view must be created for it.	Layer
PopupTemplate	Creates a default popup template for the layer, populated with all the fields of the layer.	SceneLayer
Query	Creates a query object that can be used to fetch features that satisfy the layer's current definition expression.	SceneLayer
	Destroys the layer and any associated resources (including its portalItem, if it is a property on the layer).	Layer
Boolean	Emits an event on the instance.	Layer
Promise<Object>	Fetches custom attribution data for the layer when it becomes available.	Layer
Field	Returns the Field instance for a field name (case-insensitive).	SceneLayer
Domain	Returns the Domain associated with the given field name.	SceneLayer
Object	Gets field usage information.	SceneLayer
Boolean	Indicates whether there is an event listener on the instance that matches the provided event name.	Layer
Boolean	Returns true if a named group of handles exist.	Accessor
Boolean	`isFulfilled()` may be used to verify if creating an instance of the class is fulfilled (either resolved or rejected).	Layer
Boolean	`isRejected()` may be used to verify if creating an instance of the class is rejected.	Layer
Boolean	`isResolved()` may be used to verify if creating an instance of the class is resolved.	Layer
Promise	Loads the resources referenced by this class.	Layer
Object	Registers an event handler on the instance.	Layer
Promise<Object>	Query information about attachments associated with features.	SceneLayer
Object	Queries cached statistics from the service for a given field.	SceneLayer
Promise<Object>	Executes a Query against the associated feature service and returns the 2D Extent of features that satisfy the query.	SceneLayer
Promise<Number>	Executes a Query against the associated feature service and returns the number of features that satisfy the query.	SceneLayer
Promise<FeatureSet>	Executes a Query against the associated feature service and returns a FeatureSet.	SceneLayer
Promise<Number []>	Executes a Query against the associated feature service and returns an array of ObjectIDs of the features that satisfy the input query.	SceneLayer
Promise<Object>	Executes a RelationshipQuery against the feature service associated with the scene layer and returns FeatureSets grouped by source layer or table objectIds.	SceneLayer
Promise<Object>	Executes a RelationshipQuery against the feature service associated with the scene layer and when resolved, it returns an `object` containing key value pairs.	SceneLayer
	Removes a group of handles owned by the object.	Accessor
Promise<PortalItem>	Saves the layer to its existing portal item in the Portal authenticated within the user's current session.	SceneLayer
Promise<PortalItem>	Saves the layer to a new portal item in the Portal authenticated within the user's current session.	SceneLayer
Promise	`when()` may be leveraged once an instance of the class is created.	Layer

Method Details

addHandles Inherited Method addHandles(handleOrHandles, groupKey) Inherited from Accessor Since: ArcGIS Maps SDK for JavaScript 4.25 Accessor since 4.0, addHandles added at 4.25.

Adds one or more handles which are to be tied to the lifecycle of the object. The handles will be removed when the object is destroyed.

// Manually manage handles
const handle = reactiveUtils.when(
  () => !view.updating,
  () => {
    wkidSelect.disabled = false;
  },
  { once: true }
);

this.addHandles(handle);

// Destroy the object
this.destroy();

Parameters

handleOrHandles WatchHandle|WatchHandle []

Handles marked for removal once the object is destroyed.

groupKey *

optional

Key identifying the group to which the handles should be added. All the handles in the group can later be removed with Accessor.removeHandles(). If no key is provided the handles are added to a default group.

applyEdits Method applyEdits(edits, options){Promise<EditsResult>}

Applies edits to the features in the associated FeatureLayer. The prerequisite for an editable SceneLayer is an associated FeatureLayer with editing and change tracking enabled. Editing capabilities depend on the capabilities of the associated FeatureLayer. Adding, updating and deleting feature geometry is only available with an associated feature layer that has GLB format enabled.

Features with edits are rendered with updated geometry and attributes and deleted features are hidden when displaying the layer in a SceneView unless there are too many edits. In this case the scene layer cache should be updated to contain the latest changes. The following limitations apply:

The number of features with attribute updates needs to be smaller than 50,000
The time it takes to extract what has been edited exceeds 10 seconds

Support for Scene Layer geometry add/update/delete was released at version 4.27. (For an example see SceneLayer upload 3D models and applyEdits) Support for Scene Layer attribute editing was released at version 4.18.

Parameters

Specification

edits Object

Object containing features to be updated.

Specification

addFeatures Graphic []|Collection<Graphic>

optional

An array or a collection of features to be added. Feature geometries must be of type Mesh. Values of non nullable fields must be provided when adding new features. Date fields must have numeric values representing universal time.

updateFeatures Graphic []|Collection<Graphic>

optional

An array or a collection of features to be updated. Each feature must have a valid objectId or globalId for attribute updates, while geometry updates must always use a valid globalId. Values of non nullable fields must be provided when updating features. Date fields must have numeric values representing universal time.

deleteFeatures Graphic []|Collection<Graphic>|FeatureIdentifier []

optional

An array or a collection of features, or an array of objects with globalId of each feature to be deleted. When an array or collection of features is passed, each feature must have a valid globalId. When an array of objects is used, each object must have a valid value set for the globalId property.

options Object

optional

Additional edit options to specify when editing features.

Specification

rollbackOnFailureEnabled Boolean

optional

Indicates whether the edits should be applied only if all submitted edits succeed. If false, the server will apply the edits that succeed even if some of the submitted edits fail. If true, the server will apply the edits only if all edits succeed. The layer's capabilities.editing.supportsRollbackOnFailure property must be true if using this parameter. If supportsRollbackOnFailure is false for a layer, then rollbackOnFailureEnabled will always be true, regardless of how the parameter is set.

globalIdUsed Boolean

optional

Indicates whether the edits can be applied using globalIds of features. This parameter applies only if the layer's capabilities.editing.supportsGlobalId property is true. Edits on layers with an associated 3D Object feature layer must always use global ids and this option will be ignored (is forced to be true). When false, globalIds submitted with the features are ignored and the service assigns new globalIds to the new features. When true, the globalIds must be submitted with the new features. For updates and deletes, globalIdUsed determines whether to use the provided feature globalId or objectId to match features to be updated or deleted.

Returns

Type	Description
Promise<EditsResult>	When resolved, an EditsResult object is returned.

cancelLoad Inherited Method cancelLoad() Inherited from Layer

Cancels a load() operation if it is already in progress.

clone Method clone(){this}

Creates a deep clone of this object. Any properties that store values by reference will be assigned copies of the referenced values on the cloned instance.

Returns

Type	Description
this	A deep clone of the class instance that invoked this method.

convertMesh Method convertMesh(files, options){Promise<Mesh>} Since: ArcGIS Maps SDK for JavaScript 4.29 SceneLayer since 4.27, convertMesh added at 4.29.

Converts a file or list of files to mesh geometry. These files can be of any file format supported by the layer. The mesh will be placed at [0, 0, 0] if no location is provided with the additional options argument.

Passing files which represent multiple meshes (e.g. multiple obj files) will result in an error as those cannot to be represented by a single mesh.

Note that the vertex space of the converted mesh will depend on the spatial reference of the layer.

Parameters

files File []

The files from which to create the mesh.

options ConvertMeshOptions

optional

Options to configure the conversion.

Returns

Type	Description
Promise<Mesh>	A promise that resolves to the conversion result.

createLayerView Inherited Method createLayerView(view, options){Promise<LayerView>} Inherited from Layer

Called by the views, such as MapView and SceneView, when the layer is added to the Map.layers collection and a layer view must be created for it. This method is used internally and there is no use case for invoking it directly.

Parameters

view *

The parent view.

options Object

optional

An object specifying additional options. See the object specification table below for the required properties of this object.

Specification

signal AbortSignal

optional

A signal to abort the creation of the layerview.

Returns

Type	Description
Promise<LayerView>	Resolves with a LayerView instance.

See also

Sample - Custom WebGL layer view

createPopupTemplate Method createPopupTemplate(options){PopupTemplate} Since: ArcGIS Maps SDK for JavaScript 4.11 SceneLayer since 4.27, createPopupTemplate added at 4.11.

Creates a default popup template for the layer, populated with all the fields of the layer.

Starting with version 4.28, date fields are formatted using the short-date-short-time preset dateFormat rather than long-month-day-year in popup templates created with the createPopupTemplate() method. For example, previously a date that may have appeared as "December 30, 1997" will now appear as "12/30/1997 6:00 PM".

Parameter

options CreatePopupTemplateOptions

optional

Options for creating the popup template.

Returns

Type	Description
PopupTemplate	The popup template, or `null` if the layer does not have any fields.

createQuery Method createQuery(){Query} Since: ArcGIS Maps SDK for JavaScript 4.3 SceneLayer since 4.27, createQuery added at 4.3.

Creates a query object that can be used to fetch features that satisfy the layer's current definition expression. The query should only be used on the layer and not on the layer view.

Returns

Type	Description
Query	The query object representing the layer's definition expression.

destroy Inherited Method destroy() Inherited from Layer Since: ArcGIS Maps SDK for JavaScript 4.17 Layer since 4.0, destroy added at 4.17.

Destroys the layer and any associated resources (including its portalItem, if it is a property on the layer). The layer can no longer be used once it has been destroyed.

The destroyed layer will be removed from its parent object like Map, WebMap, WebScene, Basemap, Ground, or GroupLayer.

See also

emit Inherited Method emit(type, event){Boolean} Inherited from Layer Since: ArcGIS Maps SDK for JavaScript 4.5 Layer since 4.0, emit added at 4.5.

Emits an event on the instance. This method should only be used when creating subclasses of this class.

Parameters

type String

The name of the event.

event Object

optional

The event payload.

Returns

Type	Description
Boolean	`true` if a listener was notified

fetchAttributionData Inherited Method fetchAttributionData(){Promise<Object>} Inherited from Layer

Fetches custom attribution data for the layer when it becomes available.

Returns

Type	Description
Promise<Object>	Resolves to an object containing custom attribution data for the layer.

getField Method getField(fieldName){Field} Since: ArcGIS Maps SDK for JavaScript 4.12 SceneLayer since 4.27, getField added at 4.12.

Returns the Field instance for a field name (case-insensitive).

Parameter

fieldName String

Name of the field.

Returns

Type	Description
Field	the matching field or `undefined`

See also

fields

getFieldDomain Method getFieldDomain(fieldName, options){Domain} Since: ArcGIS Maps SDK for JavaScript 4.12 SceneLayer since 4.27, getFieldDomain added at 4.12.

Returns the Domain associated with the given field name. The domain can be either a CodedValueDomain or RangeDomain.

Parameters

fieldName String

Name of the field.

options Object

optional

An object specifying additional options. See the object specification table below for the required properties of this object.

Specification

feature Graphic

The feature to which the Domain is assigned.

Returns

Type	Description
Domain	The Domain object associated with the given field name for the given feature.

getFieldUsageInfo Method getFieldUsageInfo(fieldName){Object}

Gets field usage information. The usage of a field depends on whether it is stored as part of the scene service cache. The returned object contains the following usage information:

Property	Type	Description
supportsRenderer	boolean	Indicates that a field can be used in a renderer (e.g. in visual variables), see renderer.
supportsLabelingInfo	boolean	Indicates that a field can be used for labeling, see labelingInfo.
supportsPopupTemplate	boolean	Indicates that a field can be used in a popup template, see popupTemplate.
supportsLayerQuery	boolean	Indicates that a field can be used in layer queries, see queryFeatures().

Parameter

fieldName String

The name of the field to get usage info for.

Returns

Type	Description
Object	the field usage.

hasEventListener Inherited Method hasEventListener(type){Boolean} Inherited from Layer

Indicates whether there is an event listener on the instance that matches the provided event name.

Parameter

type String

The name of the event.

Returns

Type	Description
Boolean	Returns true if the class supports the input event.

hasHandles Inherited Method hasHandles(groupKey){Boolean} Inherited from Accessor Since: ArcGIS Maps SDK for JavaScript 4.25 Accessor since 4.0, hasHandles added at 4.25.

Returns true if a named group of handles exist.

Parameter

groupKey *

optional

A group key.

Returns

Type	Description
Boolean	Returns `true` if a named group of handles exist.

Example

// Remove a named group of handles if they exist.
if (obj.hasHandles("watch-view-updates")) {
  obj.removeHandles("watch-view-updates");
}

isFulfilled Inherited Method isFulfilled(){Boolean} Inherited from Layer

isFulfilled() may be used to verify if creating an instance of the class is fulfilled (either resolved or rejected). If it is fulfilled, true will be returned.

Returns

Type	Description
Boolean	Indicates whether creating an instance of the class has been fulfilled (either resolved or rejected).

isRejected Inherited Method isRejected(){Boolean} Inherited from Layer

isRejected() may be used to verify if creating an instance of the class is rejected. If it is rejected, true will be returned.

Returns

Type	Description
Boolean	Indicates whether creating an instance of the class has been rejected.

isResolved Inherited Method isResolved(){Boolean} Inherited from Layer

isResolved() may be used to verify if creating an instance of the class is resolved. If it is resolved, true will be returned.

Returns

Type	Description
Boolean	Indicates whether creating an instance of the class has been resolved.

load Inherited Method load(signal){Promise} Inherited from Layer

Loads the resources referenced by this class. This method automatically executes for a View and all of the resources it references in Map if the view is constructed with a map instance.

This method must be called by the developer when accessing a resource that will not be loaded in a View.

The load() method only triggers the loading of the resource the first time it is called. The subsequent calls return the same promise.

It's possible to provide a signal to stop being interested into a Loadable instance load status. When the signal is aborted, the instance does not stop its loading process, only cancelLoad can abort it.

Parameter

signal AbortSignal

optional

Signal object that can be used to abort the asynchronous task. The returned promise will be rejected with an Error named AbortError when an abort is signaled. See also AbortController for more information on how to construct a controller that can be used to deliver abort signals.

Returns

Type	Description
Promise	Resolves when the resources have loaded.

on Inherited Method on(type, listener){Object} Inherited from Layer

Registers an event handler on the instance. Call this method to hook an event with a listener.

Parameters

type String|String []

An event or an array of events to listen for.

listener Function

The function to call when the event fires.

Returns

Type Description

Object

Returns an event handler with a remove() method that should be called to stop listening for the event(s).

Property	Type	Description
remove	Function	When called, removes the listener from the event.

Example

view.on("click", function(event){
  // event is the event handle returned after the event fires.
  console.log(event.mapPoint);
});

queryAttachments Method queryAttachments(attachmentQuery, options){Promise<Object>} Since: ArcGIS Maps SDK for JavaScript 4.28 SceneLayer since 4.27, queryAttachments added at 4.28.

Query information about attachments associated with features. It will return an error if the layer's capabilities.data.supportsAttachment property is false. Attachments for multiple features can be queried if the layer's capabilities.operations.supportsQueryAttachments is true.

Known Limitations

When the layer'scapabilities.operations.supportsQueryAttachments property is false, AttachmentQuery.objectIds property only accepts a single objectId.

Parameters

attachmentQuery AttachmentQuery autocast

Autocasts from Object

Specifies the attachment parameters for query.

options Object

optional

An object with the following properties.

Specification

signal AbortSignal

optional

Returns

Type	Description
Promise<Object>	When resolved, returns an object containing AttachmentInfos grouped by the source feature objectIds.

See also

capabilities.data.supportsAttachment
capabilities.operations.supportsQueryAttachments

queryCachedStatistics Method queryCachedStatistics(fieldName, options){Object} Since: ArcGIS Maps SDK for JavaScript 4.13 SceneLayer since 4.27, queryCachedStatistics added at 4.13.

Queries cached statistics from the service for a given field. Check for the response details the I3S SceneLayer Specification

Parameters

fieldName String

The name of the field to query statistics for.

options Object

optional

An object with the following properties.

Specification

signal AbortSignal

optional

Returns

Type	Description
Object	The statistics document.

Example

layer.queryCachedStatistics("FIELDNAME")
 .then(function(statistics) {
   console.log(statistics);
});

queryExtent Method queryExtent(query, options){Promise<Object>}

Executes a Query against the associated feature service and returns the 2D Extent of features that satisfy the query. At the moment the 3D Extent can be returned by using SceneLayerView.queryExtent(), but this will return the 3D extent only for features currently in the view. The query succeeds only if the SceneLayer has an associated feature layer. If an associated feature layer is not available, then an error with the name scenelayer:query-not-available is thrown. Read more about queries in the Querying section of the class description above.

Parameters

query Query autocast

optional

Autocasts from Object

Specifies the query parameters.

options Object

optional

An object with the following properties.

Specification

signal AbortSignal

optional

Returns

Type

Description

Promise<Object>

When resolved, returns the extent and count of the features that satisfy the input query. See the object specification table below for details.

Property	Type	Description
count	Number	The number of features that satisfy the input query.
extent	Extent	The extent of the features that satisfy the query.

See also

FeatureLayer.queryExtent

queryFeatureCount Method queryFeatureCount(query, options){Promise<Number>}

Executes a Query against the associated feature service and returns the number of features that satisfy the query. The query succeeds only if the layer's supportsLayerQuery capability is enabled. Use the getFieldUsageInfo() method to check if the layer supports queries. If querying is not enabled, then an error with the name scenelayer:query-not-available is thrown. Read more about queries in the Querying section of the class description above.

Parameters

query Query autocast

optional

Autocasts from Object

Specifies the query parameters.

options Object

optional

An object with the following properties.

Specification

signal AbortSignal

optional

Returns

Type	Description
Promise<Number>	Resolves to the count of the features satisfying the query.

See also

FeatureLayer.queryFeatureCount

queryFeatures Method queryFeatures(query, options){Promise<FeatureSet>}

Executes a Query against the associated feature service and returns a FeatureSet. The query succeeds only if the layer's supportsLayerQuery capability is enabled. Use the getFieldUsageInfo() method to check if the layer supports queries. If querying is not enabled, then an error with the name scenelayer:query-not-available is thrown. Read more about queries in the Querying section of the class description above.

Parameters

query Query autocast

optional

Autocasts from Object

Specifies the query parameters.

options Object

optional

An object with the following properties.

Specification

signal AbortSignal

optional

Returns

Type	Description
Promise<FeatureSet>	Resolves to a FeatureSet which contains the features satisfying the query.

See also

FeatureLayer.queryFeatures

queryObjectIds Method queryObjectIds(query, options){Promise<Number[]>}

Executes a Query against the associated feature service and returns an array of ObjectIDs of the features that satisfy the input query. The query succeeds only if the layer's supportsLayerQuery capability is enabled. Use the getFieldUsageInfo() method to check if the layer supports queries. If querying is not enabled, then an error with the name scenelayer:query-not-available is thrown. Read more about queries in the Querying section of the class description above.

Parameters

query Query autocast

optional

Autocasts from Object

Specifies the query parameters.

options Object

optional

An object with the following properties.

Specification

signal AbortSignal

optional

Returns

Type	Description
Promise<Number []>	Resolves to an array of numbers representing the object IDs of the features satisfying the query.

See also

FeatureLayer.queryObjectIds

queryRelatedFeatures Method queryRelatedFeatures(relationshipQuery, options){Promise<Object>} Since: ArcGIS Maps SDK for JavaScript 4.28 SceneLayer since 4.27, queryRelatedFeatures added at 4.28.

Executes a RelationshipQuery against the feature service associated with the scene layer and returns FeatureSets grouped by source layer or table objectIds.

Parameters

relationshipQuery RelationshipQuery autocast

Autocasts from Object

Specifies relationship parameters for querying related features or records from a layer or a table.

options Object

optional

An object with the following properties.

Specification

signal AbortSignal

optional

Returns

Type	Description
Promise<Object>	When resolved, returns FeatureSets grouped by source layer/table objectIds. Each FeatureSet contains an array of Graphic features including the values of the fields requested by the user.

See also

relationships property

Example

const objectIds = [385, 416];

// relationship query parameter
const query = {
  outFields: ["*"],
  relationshipId: relationshipId,
  objectIds: objectIds
}

// query related features for given objectIds
layer.queryRelatedFeatures(query).then(function (result) {
  objectIds.forEach(function (objectId) {
    // print out the attributes of related features if the result
    // is returned for the specified objectId
    if (result[objectId]) {
      console.group("relationship for feature:", objectId)
      result[objectId].features.forEach(function (feature) {
        console.log("attributes", JSON.stringify(feature.attributes));
      });
      console.groupEnd();
    }
  });
}).catch(function (error) {
  console.log("error from queryRelatedFeatures", error);
});

queryRelatedFeaturesCount Method queryRelatedFeaturesCount(relationshipQuery, options){Promise<Object>} Since: ArcGIS Maps SDK for JavaScript 4.28 SceneLayer since 4.27, queryRelatedFeaturesCount added at 4.28.

Executes a RelationshipQuery against the feature service associated with the scene layer and when resolved, it returns an object containing key value pairs. Key in this case is the objectId of the feature and value is the number of related features associated with the feature.

Parameters

relationshipQuery RelationshipQuery autocast

Autocasts from Object

Specifies relationship parameters for querying related features or records from a layer or a table.

options Object

optional

An object with the following properties.

Specification

signal AbortSignal

optional

Returns

Type	Description
Promise<Object>	When resolved, returns an object containing key value pairs. Key in this case is the `objectId` of the feature and value is the number of related features.

See also

relationships property

Example

const objectIds = [385, 416];

// relationship query parameter
const query = {
  outFields: ["*"],
  relationshipId: relationshipId,
  objectIds: objectIds
}

// query related features for given objectIds
layer.queryRelatedFeaturesCount(query).then(function (count) {
  console.log("queryRelatedFeaturesCount", count);
  // this will print out
  // {385: 91, 416: 23}
}).catch(function (error) {
  console.log("error from queryRelatedFeatures", error);
});

removeHandles Inherited Method removeHandles(groupKey) Inherited from Accessor Since: ArcGIS Maps SDK for JavaScript 4.25 Accessor since 4.0, removeHandles added at 4.25.

Removes a group of handles owned by the object.

Parameter

groupKey *

optional

A group key or an array or collection of group keys to remove.

Example

obj.removeHandles(); // removes handles from default group

obj.removeHandles("handle-group");
obj.removeHandles("other-handle-group");

save Method save(){Promise<PortalItem>} Since: ArcGIS Maps SDK for JavaScript 4.31 SceneLayer since 4.27, save added at 4.31.

Saves the layer to its existing portal item in the Portal authenticated within the user's current session. If the layer is not saved to a PortalItem, then you should use saveAs.

Returns

Type	Description
Promise<PortalItem>	When resolved, returns the portal item to which the layer is saved.

See also

saveAs()

Example

const portalItem = await layer.save();

saveAs Method saveAs(portalItem, options){Promise<PortalItem>} Since: ArcGIS Maps SDK for JavaScript 4.31 SceneLayer since 4.27, saveAs added at 4.31.

Saves the layer to a new portal item in the Portal authenticated within the user's current session.

Parameters

portalItem PortalItem

The portal item to which the layer will be saved.

options Object

optional

additional save options

Specification

folder PortalFolder

optional

the folder where to save the item.

Returns

Type	Description
Promise<PortalItem>	When resolved, returns the portal item to which the layer is saved.

See also

save()

Example

const portalItem = new PortalItem();
await layer.saveAs(portalItem);

when Inherited Method when(callback, errback){Promise} Inherited from Layer Since: ArcGIS Maps SDK for JavaScript 4.6 Layer since 4.0, when added at 4.6.

when() may be leveraged once an instance of the class is created. This method takes two input parameters: a callback function and an errback function. The callback executes when the instance of the class loads. The errback executes if the instance of the class fails to load.

Parameters

callback Function

optional

The function to call when the promise resolves.

errback Function

optional

The function to execute when the promise fails.

Returns

Type	Description
Promise	Returns a new promise for the result of `callback` that may be used to chain additional functions.

Example

// Although this example uses MapView, any class instance that is a promise may use when() in the same way
let view = new MapView();
view.when(function(){
  // This function will execute once the promise is resolved
}, function(error){
  // This function will execute if the promise is rejected due to an error
});

Type Definitions

Capabilities Type Definition Capabilities Object

Describes the layer's supported capabilities.

Properties

query Object

Describes query operations that can be performed on features in the layer.

Specification: maxRecordCount Number|undefined

The maximum number of records that will be returned for a given query.

supportsCentroid Boolean

Indicates if the geometry centroid associated with each polygon feature can be returned. This operation is only supported in ArcGIS Online hosted feature services.

supportsDistance Boolean

Indicates if the layer's query operation supports a buffer distance for input geometries.

supportsDistinct Boolean

Indicates if the layer supports queries for distinct values based on fields specified in the outFields.

supportsDisjointSpatialRelationship Boolean

Indicates if the query operation supports disjoint spatial relationship. This is valid only for hosted feature services.

supportsCacheHint Boolean

Indicates if the query operation supports a cache hint. This is valid only for hosted feature services.

supportsExtent Boolean

Indicates if the layer's query response includes the extent of features. At 10.3, this option is only available for hosted feature services. At 10.3.1, it is available for hosted and non-hosted feature services.

supportsGeometryProperties Boolean

Indicates if the layer's query response contains geometry attributes, including shape area and length attributes. This operation is supported in ArcGIS Online hosted feature services created since December 2016 and ArcGIS Enterprise feature services since version 10.7.

supportsHavingClause Boolean

Indicates if the layer supports the having clause on the service. Requires an ArcGIS Server service 10.6.1 or greater.

supportsOrderBy Boolean

Indicates if features returned in the query response can be ordered by one or more fields. Requires an ArcGIS Server service 10.3 or greater.

supportsPagination Boolean

Indicates if the query response supports pagination. Requires an ArcGIS Server service 10.3 or greater.

supportsPercentileStatistics Boolean

Indicates if the layer supports percentile statisticType. Requires an ArcGIS Server service 10.7 or greater.

supportsQueryGeometry Boolean

Indicates if the query response includes the query geometry. This is valid only for hosted feature services.

supportsQuantization Boolean

Indicates if the query operation supports the projection of geometries onto a virtual grid. Requires an ArcGIS Server service 10.6.1 or greater.

supportsQuantizationEditMode Boolean

Indicates if the query operation supports quantization designed to be used in edit mode (highest resolution at the given spatial reference). Requires an ArcGIS Server service 10.6.1 or greater.

supportsResultType Boolean

Indicates if the number of features returned by the query operation can be controlled.

supportsSqlExpression Boolean

Indicates if the query operation supports SQL expressions.

supportsStandardizedQueriesOnly Boolean

Indicates if the query operation supports using standardized queries. Learn more about standardized queries here.

supportsStatistics Boolean

Indicates if the layer supports field-based statistical functions. Requires ArcGIS Server service 10.1 or greater.

supportsHistoricMoment Boolean

Indicates if the layer supports historic moment query. Requires ArcGIS Server service 10.5 or greater.

queryRelated Object

Indicates if the layer's query operation supports querying features or records related to features in the layer.

Specification: supportsCacheHint Boolean

Indicates if the relationship query operation supports a cache hint. This is valid only for hosted feature services.

supportsCount Boolean

Indicates if the layer's query response includes the number of features or records related to features in the layer.

supportsOrderBy Boolean

Indicates if the related features or records returned in the query response can be ordered by one or more fields.

supportsPagination Boolean

Indicates if the query response supports pagination for related features or records.

data Object

Describes characteristics of the data in the layer.

Specification: supportsZ Boolean

Indicates if the features in the layer support z-values. For scene layers this is always true.

supportsAttachment Boolean

Indicates if the attachment is enabled on the layer.

editing Object

Describes editing capabilities that can be performed on the features in the layer via applyEdits().

Specification: supportsGeometryUpdate Boolean

Indicates if the geometry of the features in the layer can be edited.

supportsGlobalId Boolean

Indicates if the globalId values provided by the client are used in applyEdits.

supportsRollbackOnFailure Boolean

Indicates if the rollbackOnFailureEnabled parameter can be set to true or false when editing features.

operations Object

Describes operations that can be performed on features in the layer.

Specification: supportsAdd Boolean

Indicates if new features can be added to the layer.

supportsDelete Boolean

Indicates if features can be deleted from the layer.

supportsUpdate Boolean

Indicates if features in the layer can be updated.

supportsEditing Boolean

Indicates if features in the layer can be edited. Use supportsAdd, supportsUpdate and supportsDelete to determine which editing operations are supported.

supportsQuery Boolean

Indicates if features in the layer can be queried.

supportsQueryAttachments Boolean

Indicates if the layer supports REST API queryAttachments operation. If false, queryAttachments() method can only return attachments for one feature at a time. If true, queryAttachments() can return attachments for array of objectIds.

ConvertMeshOptions Type Definition ConvertMeshOptions Object

Options used to configure mesh conversion.

Properties: location Point

optional
The location of the origin of the model. If the location doesn't contain a z-value, z is assumed to be 0. If not provided, the mesh will be placed at [0, 0, 0].

signal AbortSignal

optional
An AbortSignal to abort the loading process. If canceled, the promise will be rejected with an error named AbortError. See also AbortController.

EditsResult Type Definition EditsResult Object

Results returned from the applyEdits method.

Properties: addFeatureResults FeatureEditResult []

Result of adding features.

updateFeatureResults FeatureEditResult []

Result of updating features.

deleteFeatureResults FeatureEditResult []

Result of deleting features.

FeatureIdentifier Type Definition FeatureIdentifier Object

Alternative representation of features to be deleted with applyEdits.

Properties: objectId Number|Nil

The objectId of the feature to be deleted.

globalId String|Nil

The globalId of the feature to be deleted.

Event Overview

Show inherited events

Hide inherited events

Type	Summary	Class
{addedFeatures: FeatureEditResult [],deletedFeatures: FeatureEditResult [],updatedFeatures: FeatureEditResult [],exceededTransferLimit: Boolean}	Fires after applyEdits() is completed successfully.	SceneLayer
{view: View,layerView: LayerView}	Fires after the layer's LayerView is created and rendered in a view.	Layer
{view: View,error: Error}	Fires when an error emits during the creation of a LayerView after a layer has been added to the map.	Layer
{view: View,layerView: LayerView}	Fires after the layer's LayerView is destroyed and no longer renders in a view.	Layer

Event Details

edits Event edits Since: ArcGIS Maps SDK for JavaScript 4.27 SceneLayer since 4.27, edits added at 4.27.

Fires after applyEdits() is completed successfully. The event payload includes only successful edits, not the failed edits.

Properties

addedFeatures FeatureEditResult []

An array of successfully added features.

deletedFeatures FeatureEditResult []

An array of successfully deleted features.

updatedFeatures FeatureEditResult []

An array of successfully updated features.

exceededTransferLimit Boolean

Returns true when the number of records returned exceeds the maximum number configured on the service.

See also

applyEdits()

Example

// This function will fire each time applyEdits() is completed successfully
sceneLayer.on("edits", function(event) {

  const extractObjectId = function(result) {
    return result.objectId;
  };

  const adds = event.addedFeatures.map(extractObjectId);
  console.log("addedFeatures: ", adds.length, adds);

  const updates = event.updatedFeatures.map(extractObjectId);
  console.log("updatedFeatures: ", updates.length, updates);

  const deletes = event.deletedFeatures.map(extractObjectId);
  console.log("deletedFeatures: ", deletes.length, deletes);
});

layerview-create Inherited Event layerview-create Inherited from Layer

Fires after the layer's LayerView is created and rendered in a view.

Properties

view View

The view in which the layerView was created.

layerView LayerView

The LayerView rendered in the view representing the layer in layer.

See also

View.whenLayerView()

Example

// This function will fire each time a layer view is created for this
// particular view.
layer.on("layerview-create", function(event){
  // The LayerView for the layer that emitted this event
  event.layerView;
});

layerview-create-error Inherited Event layerview-create-error Inherited from Layer

Fires when an error emits during the creation of a LayerView after a layer has been added to the map.

Properties

view View

The view that failed to create a layerview for the layer emitting this event.

error Error

An error object describing why the layer view failed to create.

See also

View.whenLayerView()

Example

// This function fires when an error occurs during the creation of the layer's layerview
layer.on("layerview-create-error", function(event) {
  console.error("LayerView failed to create for layer with the id: ", layer.id, " in this view: ", event.view);
});

layerview-destroy Inherited Event layerview-destroy Inherited from Layer

Fires after the layer's LayerView is destroyed and no longer renders in a view.

Properties: view View

The view in which the layerView was destroyed.

layerView LayerView

The destroyed LayerView representing the layer.