BuildingSublayer | References | ArcGIS Maps SDK for JavaScript

import BuildingSublayer from "@arcgis/core/layers/buildingSublayers/BuildingSublayer.js";

Inheritance:: BuildingSublayer→Accessor

Subclasses:: BuildingComponentSublayer, BuildingGroupSublayer

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

Constructors

Constructor

Parameters

Parameter	Type	Description	Required
properties	`BuildingSublayerProperties`

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

Properties

Any properties can be set, retrieved or listened to. See the Watch for changes topic.

Property	Type	Class
`declaredClass` readonly inherited	`string`	Accessor
`id` readonly	`number`
`isEmpty` readonly	`boolean \| null \| undefined`
`modelName` readonly	`string \| null \| undefined`
`opacity`	`number`
`title`	`string \| null \| undefined`
`uid` readonly inherited	`string`	IdentifiableMixin
`visible`	`boolean`

declaredClass

readonlyinherited Property

Type: string

Inherited from: Accessor

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

id

readonly Property

Type: number

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

Default value: -1

isEmpty

readonly Property

Type: boolean | null | undefined

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

readonly Property

Type: string | null | undefined

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