BuildingSublayer

AMD: require(["esri/layers/buildingSublayers/BuildingSublayer"], (BuildingSublayer) => { /* code goes here */ });
ESM: import BuildingSublayer from "@arcgis/core/layers/buildingSublayers/BuildingSublayer.js";
Class: esri/layers/buildingSublayers/BuildingSublayer
Inheritance: BuildingSublayer Accessor
Since: ArcGIS Maps SDK 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

The name of the class.

Accessor

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

BuildingSublayer

Indicates if this sublayer is empty.

BuildingSublayer

The modelName is a standard name for each sublayer.

BuildingSublayer

Opacity of the sublayer.

BuildingSublayer

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

BuildingSublayer

Indicates if the sublayer is visible in the view.

BuildingSublayer

Property Details

declaredClass

Inherited
Property
declaredClass Stringreadonly
Inherited from Accessor

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

id

Property
id Numberreadonly

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

isEmpty

Property
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

Property
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

Property
opacity Number

Opacity of the sublayer.

Default Value:1

title

Property
title String

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

visible

Property
visible Boolean

Indicates if the sublayer is visible in the view.

Default Value:true

Method Overview

Show inherited methods Hide inherited methods
Name Return Type Summary Class

Adds one or more handles which are to be tied to the lifecycle of the object.

Accessor

Returns true if a named group of handles exist.

Accessor

Removes a group of handles owned by the object.

Accessor

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.

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

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

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