BuildingSublayer

AMD: require(["esri/layers/buildingSublayers/BuildingSublayer"], (BuildingSublayer) => { /* code goes here */ });
ESM: import BuildingSublayer from "@arcgis/core/layers/buildingSublayers/BuildingSublayer";
Class: esri/layers/buildingSublayers/BuildingSublayer
Inheritance: BuildingSublayer Accessor
Since: ArcGIS API for JavaScript 4.10

BuildingSublayer is the base class for sublayers of a BuildingSceneLayer. It can be either a BuildingGroupSublayer which contains nested BuildingSublayers or a BuildingComponentSublayer, which is a layer similar to a 3DObject SceneLayer for one component of the building.

See also:

Property Overview

Any properties can be set, retrieved or listened to. See the Working with Properties topic.
Show inherited properties Hide inherited properties
Name Type Summary Class
Stringmore details

The name of the class.

more detailsAccessor
Numbermore details

The sublayer's layer id as defined by the Scene Service.

more detailsBuildingSublayer
Booleanmore details

Indicates if this sublayer is empty.

more detailsBuildingSublayer
Stringmore details

The modelName is a standard name for each sublayer.

more detailsBuildingSublayer
Numbermore details

Opacity of the sublayer.

more detailsBuildingSublayer
Stringmore details

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

more detailsBuildingSublayer
Booleanmore details

Indicates if the sublayer is visible in the view.

more detailsBuildingSublayer

Property Details

declaredClass Stringreadonly inherited

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

id Numberreadonly

The sublayer's layer id as defined by the Scene Service.

isEmpty Booleanreadonly

Indicates if this sublayer is empty. This property is only read from the service. Empty sublayers are not loaded for rendering and applications can choose to hide them in their UI.

modelName Stringreadonly

The modelName is a standard name for each sublayer. For example the sublayer containing the doors in a building has the modelName "Doors". Use this property to retrieve sublayers in a BuildingSceneLayer.

Example:
// use modelName to identify a sublayer
const doorslayer = buildingSceneLayer.allSublayers.find(function(sublayer) {
  return sublayer.modelName === "Doors";
});
opacity Number

Opacity of the sublayer.

Default Value:1
title String

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

visible Boolean

Indicates if the sublayer is visible in the view.

Default Value:true

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