Class SketchDirective

When added to a VMC view tree as the <vmc-sketch> element, adds the Esri Sketch widget to the map.

Usage example:

<vmc-map>
  <vmc-sketch></vmc-sketch>
</vmc-map>

Hierarchy

  • SketchDirective

Implements

  • OnInit
  • OnDestroy

Constructors

constructor

Properties

_sketch containerId destroy$ esriEventer expand graphicsLayer layerProperties$ position properties$ renderer sketch$ sketchExpand sketchService view$ viewBase

Events

sketchAdded sketchCreate sketchCreateComplete sketchDelete sketchEvent sketchExpandAdded sketchExpandReady sketchReady sketchRedo sketchUndo sketchUpdate sketchUpdateComplete

Accessors

layerProperties properties sketch

Methods

ngOnDestroy ngOnInit render

Constructors

constructor

  • Parameters

    • destroy$: Observable<null>
    • sketchService: SketchService
    • esriEventer: EsriEventer
    • renderer: Renderer2
    • viewBase: ViewBase

    Returns SketchDirective

Properties

Private _sketch

_sketch: BehaviorSubject<null | Sketch> = ...

containerId

containerId: null | string = null

A string, representing a DOM element's id attribute. If this input is passed to the component, the sketch widget will be constructed with the passed element. If this value is null, the component will create a new element to host the widget.

Important

If expand is true, the containerId must be null!

Private destroy$

destroy$: Observable<null>

Private esriEventer

esriEventer: EsriEventer

expand

expand: boolean = false

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

graphicsLayer

graphicsLayer: null | GraphicsLayer = null

Get a reference to this widget's Esri GraphicsLayer.

Private Readonly layerProperties$

layerProperties$: BehaviorSubject<null | GraphicsLayerProperties> = ...

position

position: VmcWidgetPosition | UIAddPosition = ...

The Esri UIAddPosition describing where in the Map's UI the widget should be placed.

Private Readonly properties$

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

Private renderer

renderer: Renderer2

Readonly sketch$

sketch$: Observable<null | Sketch> = ...

An observable stream of the component's active Esri Sketch widget.

sketchExpand

sketchExpand: null | Expand = null

A reference to the directives active Esri Expand widget. which contains the Esri Sketch widget.

Private sketchService

sketchService: SketchService

Readonly view$

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

The VMC View Tree's View (scene or map)

Private viewBase

viewBase: ViewBase

Events

sketchAdded

sketchAdded: EventEmitter<Sketch> = ...

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

sketchCreate

sketchCreate: Observable<SketchCreateEvent> = ...

The Esri Sketch "create" event, exposed as an Angular event.

sketchCreateComplete

sketchCreateComplete: Observable<SketchCreateEvent> = ...

The Esri Sketch "create" event, exposed as an Angular event.

Remark

This event only fires if the event.state === 'complete'.

sketchDelete

sketchDelete: Observable<SketchDeleteEvent> = ...

The Esri Sketch "delete" event, exposed as an Angular event.

sketchEvent

sketchEvent: Observable<AnySketchEvent> = ...

All of the Esri Sketch events as a single, combined Angular output event.

sketchExpandAdded

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

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

sketchExpandReady

sketchExpandReady: EventEmitter<Expand> = ...

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

sketchReady

sketchReady: EventEmitter<Sketch> = ...

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

sketchRedo

sketchRedo: Observable<SketchRedoEvent> = ...

The Esri Sketch "redo" event, exposed as an Angular event.

sketchUndo

sketchUndo: Observable<SketchUndoEvent> = ...

The Esri Sketch "undo" event, exposed as an Angular event.

sketchUpdate

sketchUpdate: Observable<SketchUpdateEvent> = ...

The Esri Sketch "update" event, exposed as an Angular event.

sketchUpdateComplete

sketchUpdateComplete: Observable<SketchUpdateEvent> = ...

The Esri Sketch "create" event, exposed as an Angular event.

Remark

This event only fires if the event.state === 'complete'.

Accessors

layerProperties

  • set layerProperties(val: null | GraphicsLayerProperties): void

  • A component input that accepts Esri GraphicsLayer properties. If passed, these properties will be used by the widget to construct its GraphicsLayer reference.

    Parameters

    • val: null | GraphicsLayerProperties

    Returns void

properties

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

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

    Parameters

    • val: null | SketchProperties

    Returns void

sketch

  • get sketch(): null | Sketch

  • Get a reference to the active Esri Sketch widget.

    Returns null | Sketch

  • set sketch(val: null | Sketch): void
  • Private

    Parameters

    • val: null | Sketch

    Returns void

Methods

Private ngOnDestroy

  • Private

    Returns void

Private ngOnInit

  • Private

    Returns void

Private render

  • Parameters

    • view: MapView | SceneView
    • props: null | SketchProperties
    • layerProps: null | GraphicsLayerProperties

    Returns void

Settings

Member Visibility

Theme

Generated using TypeDoc