Skip To ContentArcGIS for DevelopersSign In Dashboard

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.
NameTypeSummaryClass
String

The name of the class.

more details
more detailsAccessor
Number

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

more details
more detailsBuildingSublayer
String

The modelName is a standard name for each sublayer.

more details
more detailsBuildingSublayer
Number

Opacity of the sublayer.

more details
more detailsBuildingSublayer
String

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

more details
more detailsBuildingSublayer
Boolean

Indicates if the sublayer is visible in the view.

more details
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.

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

API Reference search results

NameTypeModule
Loading...