Options
All
  • Public
  • Public/Protected
  • All
Menu

Class LayerSelector

Hierarchy

  • LayerSelector

Index

Constructors

Properties

Methods

Constructors

constructor

  • Creates a new instance of the (@link LayerSelector} class.

    Parameters

    • appInfo: AppInfo

      The {@link gis.AppInfo} that the layer selector belongs to

    • Optional options: LayerSelectorConfiguration

      Optional. An object containing options to configure the layer selector

    Returns LayerSelector

Properties

Protected _infrastructureLibraryId

_infrastructureLibraryId: string

Protected _suspendLayerStateChangeHandler

_suspendLayerStateChangeHandler: boolean

Protected _unfilteredItems

_unfilteredItems: LayerSelectorItem[]

Protected _userAddedLayersFolder

_userAddedLayersFolder: LayerSelectorFolderItem

Placeholder folder for user-added layers

appInfo

appInfo: AppInfo

disableAllLayersHandler

disableAllLayersHandler: function

Type declaration

    • (): void

    • Returns void

enableAllLayersHandler

enableAllLayersHandler: function

Type declaration

    • (): void

    • Returns void

filteredLayerSelectorLayerItems

filteredLayerSelectorLayerItems: (LayerSelectorLayerItem | LayerSelectorServiceLayerItem)[]

A flat list of the filtered LayerSelectorServiceLayer and LayerSelectorLayer items.

initialized

initialized: boolean

itemTypes

itemTypes: object

Type declaration

  • FOLDER: string
  • LAYER: string
  • SERVICELAYER: string

items

items: ObservableCollection<LayerSelectorItem>

layerFilter

layerFilter: function

Type declaration

layerStateChangeHandler

layerStateChangeHandler: function

Type declaration

onInitializedHandler

onInitializedHandler: function

Type declaration

onLayerSelectorFolderItemCreated

onLayerSelectorFolderItemCreated: function

Called when a new LayerSelectorFolderItem is created.

param

The item created.

Type declaration

onLayerSelectorLayerItemCreated

onLayerSelectorLayerItemCreated: function

Called when a new LayerSelectorLayerItem is created.

param

The item created.

Type declaration

onLayerSelectorServiceLayerItemCreated

onLayerSelectorServiceLayerItemCreated: function

Called when a new LayerSelectorServiceLayerItem is created.

param

The item created.

Type declaration

unfilteredLayerSelectorLayerItems

unfilteredLayerSelectorLayerItems: (LayerSelectorLayerItem | LayerSelectorServiceLayerItem)[]

A flat list of the unfiltered LayerSelectorServiceLayer and LayerSelectorLayer items.

Methods

Protected _creatFolderItemFromServiceLayer

Protected _createFolderItemFromRestItem

  • _createFolderItemFromRestItem(item: RestLayerListItem, isEnabled: boolean, isExpanded: boolean): LayerSelectorFolderItem

  • Parameters

    • item: RestLayerListItem
    • isEnabled: boolean
    • isExpanded: boolean

    Returns LayerSelectorFolderItem

Protected _createLayerItemFromLayer

Protected _createServiceLayerItemFromServiceLayer

Protected _generateItemCloneForFilter

  • Generates a clone of a folder or service layer item, set to enabled and minus its items. This is so we can filter items with children based on any filter that's applied without actually modifying the original layer/folder item.

    Parameters

    Returns LayerSelectorItem

Protected _loadLayerSelectorItems

  • _loadLayerSelectorItems(): void

  • Returns void

Protected _loadSelectorItemsNotInLayerList

  • _loadSelectorItemsNotInLayerList(): void

  • Returns void

Protected _removeItemFromUnfilteredCollections

  • Parameters

    Returns void

Protected _setTooltips

  • Parameters

    Returns void

addUserAddedServiceLayer

applyFilter

  • applyFilter(itemFilter?: function): void

disableAllLayers

  • disableAllLayers(): void

  • Returns void

enableAllLayers

  • enableAllLayers(): void

  • Returns void

initialize

  • initialize(): void

  • Returns void

reapplyFilter

  • reapplyFilter(): void

  • Reapply the last used layer filter.

    Returns void

removeServiceLayer

setDisableAllLayersHandler

  • setDisableAllLayersHandler(disableAllLayersHandler?: function): void

  • Parameters

    • Optional disableAllLayersHandler: function
        • (): void

        • Returns void

    Returns void

setEnableAllLayersHandler

  • setEnableAllLayersHandler(enableAllLayersHandler?: function): void

  • Parameters

    • Optional enableAllLayersHandler: function
        • (): void

        • Returns void

    Returns void

setLayerStateChangeHandler

  • setLayerStateChangeHandler(layerStateChangeHandler?: function): void

updateServiceLayer