Class BasemapLayerListDirective

When added to a VMC view tree as the <vmc-basemap-layer-list> element, adds the Esri BasemapLayerList widget to the map.

Usage example:

<vmc-map>
  <vmc-basemap-layer-list></vmc-basemap-layer-list>
</vmc-map>

Hierarchy

  • BasemapLayerListDirective

Implements

  • OnInit
  • OnDestroy

Constructors

constructor

Properties

_basemapLayerList$ _properties$ basemapLayerList$ basemapLayerListExpand basemapLayerListService destroy$ esriEventer expand position renderer triggerAction view$ viewBase

Events

basemapLayerListAdded basemapLayerListExpandAdded basemapLayerListExpandReady basemapLayerListReady

Accessors

basemapLayerList properties

Methods

ngOnDestroy ngOnInit render

Constructors

constructor

Properties

Private _basemapLayerList$

_basemapLayerList$: BehaviorSubject<null | BasemapLayerList> = ...

Private Readonly _properties$

_properties$: BehaviorSubject<null | BasemapLayerListProperties> = ...

Readonly basemapLayerList$

basemapLayerList$: Observable<null | BasemapLayerList> = ...

An observable stream of the Esri BasemapLayerList widget that's used by this class.

basemapLayerListExpand

basemapLayerListExpand: null | Expand = null

A reference to the directives active Esri BasemapLayerList widget.

Private basemapLayerListService

basemapLayerListService: BasemapLayerListService

Private destroy$

destroy$: Observable<null>

Private esriEventer

esriEventer: EsriEventer

expand

expand: boolean = false

If true, the BasemapLayerList widget is added to an Esri Expand widget.

position

position: VmcWidgetPosition | UIAddPosition = ...

An Input property indicating the Esri UIAddPosition, describing where in the Map's UI the widget should be placed.

Private renderer

renderer: Renderer2

triggerAction

triggerAction: Observable<BasemapLayerListTriggerActionEvent> = ...

Emits when the Esri BasemapLayerList trigger-action event

Readonly view$

view$: Observable<null | MapView | SceneView> = ...

An observable stream of the VMC View Tree's reference to the [Esri MapView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html) or [Esri SceneView`](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html), depending on the component type at the top of the VMC view tree.

Private viewBase

viewBase: ViewBase

Events

basemapLayerListAdded

basemapLayerListAdded: EventEmitter<BasemapLayerList> = ...

Emits a reference to the Esri BasemapLayerList widget when it is added to the map.

basemapLayerListExpandAdded

basemapLayerListExpandAdded: EventEmitter<null | Expand> = ...

Emits a reference to the Esri Expand widget. when it is added to the map.

basemapLayerListExpandReady

basemapLayerListExpandReady: EventEmitter<Expand> = ...

Emits a reference to the Esri Expand widget. when its when callback is invoked, indicating the widget has loaded.

basemapLayerListReady

basemapLayerListReady: EventEmitter<BasemapLayerList> = ...

Emits a reference to the Esri BasemapLayerList widget when its when callback is invoked, indicating the widget has loaded.

Accessors

basemapLayerList

  • get basemapLayerList(): null | BasemapLayerList

  • Get a reference to the Esri BasemapLayerList widget as a class property.

    Returns null | BasemapLayerList

  • set basemapLayerList(val: null | BasemapLayerList): void

  • Set the class's reference to the Esri BasemapLayerList widget.

    Parameters

    • val: null | BasemapLayerList

    Returns void

properties

  • set properties(val: null | BasemapLayerListProperties): void

  • A component input that accepts BasemapLayerList properties to use for widget initialization.

    Parameters

    • val: null | BasemapLayerListProperties

    Returns void

Methods

Private ngOnDestroy

  • Private

    Returns void

Private ngOnInit

  • Private

    Returns void

Private render

  • Parameters

    • view: MapView | SceneView
    • props: null | BasemapLayerListProperties

    Returns void

Settings

Member Visibility

Theme

Generated using TypeDoc