arcgis-maps-kotlin/com.arcgismaps.mapping.layers.buildingscene/BuildingGroupSublayer

BuildingGroupSublayer

class BuildingGroupSublayer : BuildingSublayer

A group that manages a hierarchy of sublayers. This is used to group BuildingComponentSublayer into disciplines. This sublayer could contain the components in this group and additional groups.

Since

300.0.0

Properties

sublayers

val sublayers: List<BuildingSublayer>

A collection of sublayers.

Inherited properties

canChangeVisibility

open override val canChangeVisibility: Boolean

A flag indicating whether the layer content's visibility can be changed. A flag indicating whether the layer content visibility can be changed. Will return false if an error occurs.

discipline

val discipline: BuildingSublayerDiscipline

The building discipline (such as Architectural, Mechanical, or Structural) that this sublayer represents.

isVisible

open override var isVisible: Boolean

The layer content's visibility. The layer content visibility. Will return false if an error occurs.

loadStatus

open override val loadStatus: StateFlow<LoadStatus>

The load status.

modelName

val modelName: String

The name that identifies the building entity (such as Floors, Ceiling, Casework) that this sublayer represents. This may be used to define behavior or visualization properties specific to a given building component.

name

open override val name: String

The layer content's name. The layer content name.

opacity

var opacity: Float

The opacity of this sublayer. The valid opacity values range from 0.0 (fully transparent) to 1.0 (fully opaque).

showInLegend

open override var showInLegend: Boolean

A flag indicating whether the layer content participates in the legend. A flag indicating whether the layer content is shown in the legend.

subLayerContents

open override val subLayerContents: StateFlow<List<LayerContent>>

The sub layer contents of a layer content.

sublayerId

val sublayerId: Int

The sublayer's layer ID as defined by the scene service.

Inherited functions

cancelLoad

open override fun cancelLoad()

Cancels loading metadata for the Loadable object.

fetchLegendInfos

open suspend override fun fetchLegendInfos(): Result<List<LegendInfo>>

Fetches the list of legend info.

isVisibleAtScale

open override fun isVisibleAtScale(scale: Double): Boolean

Returns the layer content's effective visibility at the specified scale. Returns the effective layer content visibility. This effective visibility takes care of the effective visibility of the parents at the specified scale. Will return false if an error occurs.

load

open suspend override fun load(): Result<Unit>

Loads the metadata for the object.

retryLoad

open suspend override fun retryLoad(): Result<Unit>

Loads or retries loading metadata for the object.