Layer preset settings for an individual layer or sublayer.

Hierarchy (view full)

Constructors

Properties

childrenIncludedInLayerList?: boolean

Controls whether sublayers are included or hidden in the layer list.

definitionExpression?: string

DefinitionExpression of the layer.

expanded?: boolean

Whether the layer is expanded in the layer list.

includedInLayerList?: boolean

Controls whether this layer should be included in the layer list.

maxScale?: number

If set, overrides the maximum scale of the layer or sublayer when the preset is applied. No effect if the type of layer or sublayer does not allow changing scale.

minScale?: number

If set, overrides the minimum scale of the layer or sublayer when the preset is applied. No effect if the type of layer or sublayer does not allow changing scale.

opacity?: number

If set, overrides the opacity of the layer or sublayer when the preset is applied. No effect if the type of layer or sublayer does not allow changing opacity.

sublayers: ObservableMap<string | number | SublayerReference, LayerPresetSetting>

LayerPresetSetting that can be applied to the sublayers of the layer this LayerPreset is applied to.

visible?: boolean

Visibility of the layer.

Methods

  • Sets the properties for this item.

    This version will also await any asynchronous logic that is needed to set the properties.

    Parameters

    Returns Promise<void>

  • Waits for all deserialization logic initiated thus far to finish, whether invoked by passing properties into the constructor, or by invoking assignProperties() or assignPropertiesAsync().

    Returns Promise<void>