Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface SketchViewModel

Hierarchy

Index

Properties

activeFillSymbol

activeFillSymbol: SimpleFillSymbol

The SimpleFillSymbol displayed when actively creating a new polygon graphic using the polygon tool.

Read more...

Readonly activeTool

activeTool: "polygon" | "point" | "multipoint" | "polyline" | "circle" | "rectangle" | "move" | "transform" | "reshape"

When creating new graphics (for example after create() has been called), this property reflects the create tool being used.

Read more...

Readonly createGraphic

createGraphic: Graphic

The graphic that is being created.

Read more...

declaredClass

declaredClass: string

defaultCreateOptions

Default create options set for the SketchViewModel.

Read more...

defaultUpdateOptions

Default update options set for the SketchViewModel.

Read more...

destroyed

destroyed: boolean

initialized

initialized: boolean

layer

The GraphicsLayer associated with the SketchViewModel.

Read more...

pointSymbol

A SimpleMarkerSymbol or PointSymbol3D used for representing the point geometry that is being drawn.

Read more...

polygonSymbol

A SimpleFillSymbol or PolygonSymbol3D used for representing the polygon geometry that is being drawn.

Read more...

polylineSymbol

polylineSymbol: SimpleLineSymbol | LineSymbol3D

A SimpleLineSymbol or LineSymbol3D used for representing the polyline geometry that is being drawn.

Read more...

snappingOptions

snappingOptions: SnappingOptions

Options for snapping while sketching.

Read more...

Readonly state

state: "disabled" | "ready" | "active"

The sketch view model's state.

Read more...

Readonly updateGraphics

updateGraphics: Collection<Graphic>

An array of graphics that are being updated by the SketchViewModel.

Read more...

updateOnGraphicClick

updateOnGraphicClick: boolean

Indicates if a graphic can be selected to be updated.

Read more...

view

The view in which geometries will be sketched by the user.

Read more...

Methods

Protected _get

  • _get(propertyName: string): any
  • _get<T>(propertyName: string): T
  • Parameters

    • propertyName: string

    Returns any

  • Type parameters

    • T

    Parameters

    • propertyName: string

    Returns T

Protected _set

  • Type parameters

    • T

    Parameters

    • propertyName: string
    • value: T

    Returns SketchViewModel

cancel

  • cancel(): void
  • Cancels the active operation and fires the create or update event If called in the middle of a create operation, cancel() discards the partially created graphic.

    Read more...

    Returns void

complete

  • complete(): void
  • Completes the active operation and fires the create or update event and changes the event's state to complete.

    Read more...

    Returns void

create

  • Create a graphic with the geometry specified in the tool parameter.

    Read more...

    Parameters

    Returns void

delete

  • delete(): void
  • Deletes the selected graphics used in the update workflow.

    Read more...

    Returns void

destroy

  • destroy(): void
  • Destroys the view model instance.

    Read more...

    Returns void

emit

  • emit(type: string, event?: any): boolean
  • Emits an event on the instance.

    Read more...

    Parameters

    • type: string
    • Optional event: any

    Returns boolean

get

  • get<T>(propertyName: string): T
  • get(propertyName: string): any
  • Type parameters

    • T

    Parameters

    • propertyName: string

    Returns T

  • Parameters

    • propertyName: string

    Returns any

hasEventListener

  • hasEventListener(type: string): boolean
  • Indicates whether there is an event listener on the instance that matches the provided event name.

    Read more...

    Parameters

    • type: string

    Returns boolean

Protected notifyChange

  • notifyChange(propertyName: string): void
  • Parameters

    • propertyName: string

    Returns void

on

redo

  • redo(): void
  • Incrementally redo actions recorded in the stack.

    Read more...

    Returns void

set

  • Type parameters

    • T

    Parameters

    • propertyName: string
    • value: T

    Returns SketchViewModel

  • Parameters

    Returns SketchViewModel

undo

  • undo(): void
  • Incrementally undo actions recorded in the stack.

    Read more...

    Returns void

update

watch

  • Parameters

    • path: string | string[]
    • callback: WatchCallback
    • Optional sync: boolean

    Returns WatchHandle

Generated using TypeDoc