LayerListSettings bound to a LayerExtension or SublayerExtension.

Hierarchy (view full)

Constructors

Properties

The LayerExtension or SublayerExtension to which the Layer List settings apply.

_initialChildrenIncluded: boolean
_initialExpanded: boolean
_initialIncluded: boolean

Accessors

  • get _esriLayer():
        | Layer
        | BuildingGroupSublayer
        | BuildingComponentSublayer
        | Sublayer
        | SubtypeSublayer
  • The Layer or Sublayer associated with the extension.

    Returns
        | Layer
        | BuildingGroupSublayer
        | BuildingComponentSublayer
        | Sublayer
        | SubtypeSublayer

  • get _listModePath(): string
  • The path to the listMode property, relative to the extension.

    Returns string

  • get _supportsChildren(): boolean
  • Whether the corresponding Layer/Sublayer Extension supports children.

    Returns boolean

  • get childrenIncluded(): boolean
  • Whether child layers should be included in the layer list. This value may not be set to true, if the associated LayerExtension or SublayerExtension does not support sublayers.

    Returns boolean

  • set childrenIncluded(value): void
  • Whether child layers should be included in the layer list. This value may not be set to true, if the associated LayerExtension or SublayerExtension does not support sublayers.

    Parameters

    • value: boolean

    Returns void

  • get effectivelyIncluded(): boolean
  • Whether this layer is effectively included in the layer list.

    Returns boolean

  • get expanded(): boolean
  • Whether this node is initially expanded to show children. No effect if included is false. This value may not be set to true, if the associated LayerExtension or SublayerExtension does not support sublayers.

    Returns boolean

  • set expanded(value): void
  • Whether this node is initially expanded to show children. No effect if included is false. This value may not be set to true, if the associated LayerExtension or SublayerExtension does not support sublayers.

    Parameters

    • value: boolean

    Returns void

  • get included(): boolean
  • Whether this layer should be included in the layer list.

    Returns boolean

  • set included(value): void
  • Whether this layer should be included in the layer list.

    Parameters

    • value: boolean

    Returns void

  • get initialChildrenIncluded(): boolean
  • Initial value of the childrenIncluded property.

    Returns boolean

  • get initialExpanded(): boolean
  • Initial value of the expanded property.

    Returns boolean

  • get initialIncluded(): boolean
  • Initial value of the included property.

    Returns boolean

Methods

  • Invoked when the parent layer extension is initialized.

    Returns void