Options
All
  • Public
  • Public/Protected
  • All
Menu

An item in the layer list that corresponds to a layer.

Hierarchy

Index

Constructors

constructor

Properties

_deferredVisibilitySetting

_deferredVisibilitySetting: boolean

The deferred visibility to be applied to this item after the complete layer list model is set up and ready - i.e. after processing all visibilities, startup workflows, parameters etc. This will be applied and then the variable deleted, when the applyDeferredInitialVisibility function is called.

_displayItemBindingToken

_displayItemBindingToken: string

Binding token for LayerListItem.displayItem (if any), used by the LayerListItemCollection class.

_forceSetAncestorVisibilityOperationActive

_forceSetAncestorVisibilityOperationActive: boolean

_visibilityBindingToken

_visibilityBindingToken: string

Visibility binding token (if any), used by the LayerListItemCollection class to manage visibilities

allAncestorsVisible

allAncestorsVisible: boolean

Indicates if all ancestors of this item are visible or not. This item will be effectively visible only if all its ancestors are visible as well.

canAdjustOpacity

canAdjustOpacity: Observable<boolean>

Determines if the opacity of this item can be adjusted or not.

canDisplayItem

canDisplayItem: Observable<boolean>

Determines whether the item can be displayed in the layer list.

canNotAssignVisibility

canNotAssignVisibility: Observable<boolean>

Determines whether or not the visibility of a LayerList item can be controlled. False by default

children

A LayerListItemCollection object, representing the current node's children

currentUserClickOriginator

currentUserClickOriginator: boolean

A boolean indicating that this item is the originator of the current user click. It will remain false at all other times.

displayItem

displayItem: Observable<boolean>

Observable indicating whether this LayerListItem is to be displayed in the layer list or not

enableLayerActions

enableLayerActions: boolean

A boolean which indicates whether this item should be setup to handle layer actions. False by default.

enableMapServiceActions

enableMapServiceActions: boolean

A boolean which indicates whether this item should be setup to handle map service actions. False by default.

expandLegend

expandLegend: Observable<boolean>

Indicates whether the legend items for this item are displayed or not

hasDisplayedChildren

hasDisplayedChildren: Observable<boolean>

Indicates whether this item has one or more children that are displayed in the layer list.

hasRadioToggle

hasRadioToggle: Observable<boolean>

Indicates whether this item should have a radio toggle control next to it instead of a checkbox. In some rare cases, an item may be configured as mutually exclusive (see isMutuallyExclusive), yet should still show with a check box. For example, when there is only one visible item in a mutually exclusive group.

iconTooltip

iconTooltip: Observable<string>

Tooltip for this Layer's icon, if any

iconUri

iconUri: Observable<string>

The icon Uri for this layer (if applicable). Will be set if available during mapService / layer addition.

id

id: Observable<string>

The unique identifier for this layer list item. Will be "GCXLayerListRootNode-[random string]" if this is the root node.

inActiveTheme

inActiveTheme: Observable<boolean>

Observable indicating whether this LayerListItem is in the active theme or not.

inVisibleScaleRange

inVisibleScaleRange: Observable<boolean>

Indicates if this item is visible at the current map scale.

isEffectivelyVisible

isEffectivelyVisible: Observable<boolean>

Indicates whether this LayerListItem is currently effectively visible. An item is only effectively visible if it, and all it's ancestors are set visible

isExpanded

isExpanded: Observable<boolean>

Indicates whether this LayerListItem is expanded or not.

isMutuallyExclusive

isMutuallyExclusive: Observable<boolean>

Indicates whether this item is mutually exclusive, i.e. whether toggling the visibility of this item on will toggle off the visibility of its siblings.

isUserCreated

isUserCreated: boolean

A boolean which indicates whether this item represents a layer or service that was created by the user at runtime. False by default.

isVisible

isVisible: Observable<boolean>

Indicates whether this LayerListItem is currently set to visible or not.

layer

layer: LayerInfo

layerActionsTooltip

layerActionsTooltip: Observable<string>

Description of layer actions element with name of layer.

layerFolderToggleTooltip

layerFolderToggleTooltip: Observable<string>

Description of layer folder expand/collapse button with name of layer.

layerList

layerList: LayerList

A reference to the {@link infrastructure.layerList.LayerList} object that contains this LayerListItem

layerToggleTooltip

layerToggleTooltip: Observable<string>

Description of toggle button with name of layer.

legendHasMultipleItems

legendHasMultipleItems: Observable<boolean>

Whether the legend has multiple items or not to display. Used to determine whether legend element should be tabbable or not.

legendIsVisible

legendIsVisible: Observable<boolean>

Indicates whether the legend swatch for this LayerListItem is visible when the "onlyShowSwatchesOnVisibleLayers" configuration option has been selected.

legendItems

A Collection of legends associated with this Layer List item

legendSwatch

legendSwatch: Observable<string>

The legend icon Uri or swatch element - if there is only one legend item associated with this item, then this will be the swatch element for that legend item

legendTooltip

legendTooltip: Observable<string>

Tooltip for the icon representing the legend item(s), if any

mapService

mapService: ServiceLayerInfo

The mapService associated with the current node - if any

mapServiceActionsTooltip

mapServiceActionsTooltip: Observable<string>

Description of map service actions element with name of service.

name

name: Observable<string>

The name of this item as it appears in the layer list.

onDemandItemCollection

onDemandItemCollection: ObservableCollection<LayerListItem>

A collection of child items that are populated on the fly - only when the user expands a given folder. This is for memory and performance reasons

opacity

opacity: Observable<number>

The current opacity of the associated mapService. This will remain undefined unless the opacity of this LayerList item can be adjusted.

parent

The current node's parent - if any

parentEffectivelyVisible

parentEffectivelyVisible: Observable<boolean>

Indicates whether this item's parent is currently effectively visible or not

radioGroup

radioGroup: Observable<string>

The name of the mutually exclusive group that this item belongs to, if any. Toggling on an item within this group will toggle off other mutually exclusive items that belong to the same group.

type

The type of item this object represents

Methods

_applyDeferredInitialVisibility

  • _applyDeferredInitialVisibility(): void
  • Applies the previously deferred visibility (if any) to this item after the complete layer list model is set up and ready

    Returns void

Protected _setTooltips

  • _setTooltips(): void
  • Set up the descriptive tooltips to include the name of the layer and to state whether the layer is in visible range. This is done for WCAG purposes.

    Returns void

_setupOpacityBindings

  • _setupOpacityBindings(): void

Protected _updateDisplayItem

  • _updateDisplayItem(): void

Protected _updateFilterControlComponent

  • _updateFilterControlComponent(): void

bindToActiveTheme

  • bindToActiveTheme(): void

cleanUp

  • cleanUp(): void

displayInLayerList

  • Returns true if a given layer list item is either not a folder but in the active theme, or if it is a folder, has at least one non-folder item in it's sub tree which is in the active theme and can be displayed in the layer list OR is hidden but participates in the layer list.

    Parameters

    • Optional item: LayerListItem

      Optional parameter. If specified, will perform computation on the given item, otherwise will defau8lt to this layer list item.

    Returns boolean

getAncestors

getDescendants

getRoot

getSelfAndAncestors

getSelfAndDescendants

getSiblings

  • Gets all of this node's siblings, in the order that they appear in the layer list.

    Parameters

    • Optional includeSelf: boolean

    Returns LayerListNode[]

notifyActiveThemeChanged

  • notifyActiveThemeChanged(childrenInActiveTheme: boolean): void

populateMapServicesInParentFolders

  • populateMapServicesInParentFolders(): void

refreshOnDemandItemCollection

  • refreshOnDemandItemCollection(expanded?: boolean): void
  • Manages the on demand item collection. This collection is only populated when the needed - i.e. when the respective layer list folder is expanded. When not needed, it's pulled out from the collection and from the dom. This has a slight insignificant penalty for smaller layer lists but a huge benefit for large ones

    Parameters

    • Optional expanded: boolean

    Returns void

setAncestorVisibility

  • setAncestorVisibility(ancestorVisibility: boolean): void
  • Sets the ancestor visibility. This should be set to true only if all ancestors are set visible NOTE: This function call will not check to see if all ancestors are actually visible or not. Use with caution.

    Parameters

    • ancestorVisibility: boolean

    Returns void

setItemVisibility

  • setItemVisibility(visible: boolean): void
  • Set the visibility of this item in the layer list. This is a special function which should be called in preference to setting isVisible directly, since it also keeps track of whether this item is the originator of the current user click.

    Parameters

    • visible: boolean

    Returns void

setVisibility

  • setVisibility(visible: boolean, forceSetAncestorVisibility?: boolean): void

unbindFromActiveTheme

  • unbindFromActiveTheme(): void

updateDisplayItem

  • updateDisplayItem(): void

updateLegendItems

  • updateLegendItems(): void
  • Updates the legend items including the legend swatch for a layer item.

    Returns void