var sceneLayer = new SceneLayer({
  url: "https://scene.arcgis.com/arcgis/rest/services/Hosted/Building_Hamburg/SceneServer/layers/0"
});

var sceneLayer = new SceneLayer({
 portalItem: {
   id: "6fce72d1a3df4b309a317f1e2faae05e"
 }
});

var 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
};

var layer = new SceneLayer({
 url: "http://scene.arcgis.com/arcgis/rest/services/Hosted/Building_Hamburg/SceneServer/layers/0",
 definitionExpression: "usage = 'Residential' AND totalHeight < 5"
});

Property Overview

Property Details

copyrightString

The copyright text as defined by the scene service.

declaredClassStringreadonly inherited

Since: ArcGIS API for JavaScript 4.7

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

definitionExpressionString

Since: ArcGIS API for JavaScript 4.3

The SQL where clause used to filter features on the client. Only the features that satisfy the definition expression are 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.

Important to note is that the initial loading time of the features remains unchanged, even if they are filtered. This happens because, as opposed to Feature Layers, feature filtering is done client-side. As a result all features need to be downloaded always for filter evaluation.

Example:

var layer = new SceneLayer({
   url: "http://scene.arcgis.com/arcgis/rest/services/Hosted/Building_Hamburg/SceneServer/layers/0",
   definitionExpression: "usage = 'Residential' AND totalHeight < 5"
 });

elevationInfoObject

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

This property only affects 3D Object SceneLayers when using the absolute-height mode. SceneLayers with Point geometries support all the elevation modes listed below.

Properties:

mode String Defines how the graphic is placed with respect to the terrain surface. See the table below for a list of possible values. Mode Description on-the-ground Graphics are draped on the terrain surface. This is the default value for features with Point geometries rendered with ObjectSymbol3DLayers. relative-to-ground The graphic is placed at an elevation relative to the terrain surface. The graphic'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 Graphics are placed at an absolute height above sea level. This height 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 Graphics are aligned to buildings and other objects part of 3D Object SceneLayer or IntegratedMeshLayer, 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, z-values will be ignored.

offset Number optional Default Value:0 An elevation offset which is added to the vertical position of the graphic. When mode = "on-the-ground", this property has no effect.

unit String optional Default Value:meters The unit for offset values. Possible Values: feet | meters | kilometers | miles | us-feet | yards

featureReductionObject

Since: ArcGIS API for JavaScript 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.

Property:

type String Type of the decluttering method. The only supported type at the moment is "selection". In this method, some of the overlapping features are hidden such that none of the remaining features intersect on screen. Label deconfliction also respects this option and hides labels that would overlap with the features of this layer.

See also:

• Sample: Point styles for cities

Example:

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

fieldsField[]

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.

fullExtentExtentautocast inherited

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;
});

geometryTypeString

The geometry type of features in the layer.

Possible Values: point | mesh

idString inherited

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

labelingInfoLabelClass[]

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.

For labels to display in the view, the labelsVisible property of this layer must be set to true.

Known Limitations

This property is only relevant to SceneLayers with Point geometries. This property has no effect on SceneLayers with other geometry types.

Each point 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:

var 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 ];

labelsVisibleBoolean

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

This property is only relevant to SceneLayers with Point geometries. This property has no effect on SceneLayers with other geometry types.

Default Value:true

See also:

• labelingInfo

layerIdNumber

The layer ID, or layer index, of a Scene Service layer. This is particularly useful when loading a single SceneLayer 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:

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

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

// Can also be used if URL points to service and not layer
var 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
var layer = new SceneLayer({
  url: "https://scenesampleserverdev.arcgis.com/arcgis/rest/services/Hosted/DevA_Trees/SceneServer/0",
  // The layer id is specified in the URL
});

legendEnabledBoolean

Indicates whether the layer will be included in the legend.

Default Value:true

listModeString inherited

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, hide the children layers from the table of contents.

Default Value:show

loadedBooleanreadonly inherited

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

Default Value:false

loadErrorErrorreadonly inherited

The Error object returned if an error occurred while loading.

Default Value:null

loadStatusStringreadonly inherited

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.

Default Value:not-loaded

loadWarningsObject[]readonly inherited

A list of warnings which occurred while loading.

objectIdFieldString

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

opacityNumber inherited

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;

popupEnabledBoolean

Indicates whether to display popups when features in the layer are clicked.

Default Value:true

popupTemplatePopupTemplateautocast

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.

portalItemPortalItem

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.

Examples:

// while this example uses FeatureLayer, this same pattern can be
// used for other layers that may be loaded from portalItem ids
var lyr = 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
var lyr = new FeatureLayer({
  portalItem: {  // autocasts as new PortalItem()
    id: "8d26f04f31f642b6828b7023b84c2188"
  },
  // loads the third item in the given feature service
  layerId: 2
});

rendererRendererautocast

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:

• Creating visualizations manually

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" }
    }]
  }
};

screenSizePerspectiveEnabledBoolean

Since: ArcGIS API for JavaScript 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

layer.screenSizePerspectiveEnabled = false

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

spatialReferenceSpatialReferenceautocast

The spatial reference of the layer.

titleString

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.

tokenStringreadonly

Deprecated

• since version 4.8. Will be removed at version 4.10.

Token generated by the token service using the specified userId and password. The recommended approach to pass a token on a layer is to use IdentityManager.registerToken().

typeStringreadonly

For SceneLayer the type is scene.

urlString

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
var sceneLayer = new SceneLayer({
  url: "http://scene.arcgis.com/arcgis/rest/services/Hosted/Building_Hamburg/SceneServer/layers/0"
});

// Can also be used if URL points to service and not layer
var 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
});

versionObjectreadonly

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);

visibleBoolean inherited

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;

Method Overview

Method Details

cancelLoad()inherited

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

createQuery(){Query}

Since: ArcGIS API for JavaScript 4.3

beta

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.

emit(type, event)inherited

Since: ArcGIS API for JavaScript 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 The event payload.

fetchAttributionData(){Promise<Object>}inherited

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.

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(type){Boolean}inherited

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.

isFulfilled(){Boolean}inherited

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(){Boolean}inherited

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(){Boolean}inherited

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(){Promise}inherited

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.

Returns:

Type	Description
Promise	Resolves when the resources have loaded.

on(type, listener){Object}inherited

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

Parameters:

type String The name of event to listen for.

listener Function The function to call when the event is fired.

Returns:

Type	Description
Object	Returns an event handler with a remove() method that can be called to stop listening for the event. Property Type Description remove Function When called, removes the listener from the event.

See also:

• dojo/on

Example:

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

queryExtent(params){Promise<Object>}

Executes a Query against the 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 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 Query section of the class description above.

Parameter:

params Query optional Specifies the query parameters.

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(params){Promise<Number>}

Executes a Query against the service and returns the number of the 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 Query section of the class description above.

Parameter:

params Query optional Specifies the query parameters.

Returns:

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

See also:

• FeatureLayer.queryFeatureCount

queryFeatures(params){Promise<FeatureSet>}

Executes a Query against the 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 Query section of the class description above.

Parameter:

params Query optional Specifies the query parameters.

Returns:

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

See also:

• FeatureLayer.queryFeatures

queryObjectIds(params){Promise<Number[]>}

Executes a Query against the service and returns an array of the ObjectIDs of 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 Query section of the class description above.

Parameter:

params Query optional Specifies the query parameters.

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

when(callback, errback){Promise}inherited

Since: ArcGIS API for JavaScript 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 then() in the same way
var 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
});

Event Overview

{view: View,layerView: LayerView}

{view: View,layerView: LayerView}

Event Details

layerview-createinherited

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-destroyinherited

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.