Class LocateDirective

A directive that adds the Esri Locate widget to a VMC [[MapComponent]] or [[WebMapComponent]] tree.

Example usage:

<vmc-map>
  <vmc-locate></vmc-locate>
<vmc-map>

Hierarchy

  • LocateDirective

Implements

  • OnInit
  • OnDestroy

Constructors

constructor

Properties

_locate destroy$ esriEventer expand locate$ locateService position properties$ renderer view$ viewBase

Events

locateAdded locateLocate locateLocateError locateReady

Accessors

locate properties

Methods

ngOnDestroy ngOnInit render

Constructors

constructor

  • Parameters

    • destroy$: Observable<null>
    • esriEventer: EsriEventer
    • locateService: LocateService
    • renderer: Renderer2
    • viewBase: ViewBase

    Returns LocateDirective

Properties

Private _locate

_locate: BehaviorSubject<null | Locate> = ...

Private destroy$

destroy$: Observable<null>

Private esriEventer

esriEventer: EsriEventer

expand

expand: boolean = false

If true, the widget will be created inside of an Esri Expand widget.

Readonly locate$

locate$: Observable<null | Locate> = ...

An observable stream of the Locate or null when no widget is present. Re-renders of the widget will cause this observable to emit null -> new Locate.

Private locateService

locateService: LocateService

position

position: VmcWidgetPosition | UIAddPosition = ...

The initial position of the widget in the MapView.ui

Private Readonly properties$

properties$: BehaviorSubject<null | LocateProperties> = ...

Private renderer

renderer: Renderer2

Readonly view$

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

The [Esri `MapView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html) associated with the map component tree to which this widget belongs.

Private viewBase

viewBase: ViewBase

Events

locateAdded

locateAdded: EventEmitter<Locate> = ...

Emits a reference to the Esri Locate widget when it is added to the MapView.ui

locateLocate

locateLocate: Observable<LocateLocateEvent> = ...

The Esri Locate.locate event exposed as an Angular event.

locateLocateError

locateLocateError: Observable<LocateLocateErrorEvent> = ...

The Esri Locate.locate-error event exposed as an Angular event.

locateReady

locateReady: EventEmitter<Locate> = ...

Emits a reference to the Esri Locate widget when it is fully loaded, as indicated by the Widget's Widget.when method.

Accessors

locate

  • get locate(): null | Locate

  • Get a reference to the Locate widget.

    Returns null | Locate

  • set locate(val: null | Locate): void

  • Set the referenced Locate widget.

    Parameters

    • val: null | Locate

    Returns void

properties

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

  • An object of Locate Widget properties that will be set when initializing the widget.

    Parameters

    • val: null | LocateProperties

    Returns void

Methods

Private ngOnDestroy

  • Private

    Returns void

Private ngOnInit

  • Private

    Returns void

Private render

  • Parameters

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

    Returns void

Settings

Member Visibility

Theme

Generated using TypeDoc