Class default

Extended sketch view model for sketch.

Hierarchy

SketchViewModel
- default

Constructors

constructor

new default(properties?: SketchViewModelProperties): default
Parameters
- Optionalproperties: SketchViewModelProperties
Returns default
Overrides SketchViewModel.constructor
- Defined in src/components/Sketch/Sketch.ts:135

Properties

`Readonly`activeCreateToolDrawMode

activeCreateToolDrawMode: "hybrid" | "click" | nullish | "freehand"

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

`Readonly`activeTool

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

`Readonly`activeTooltip

activeTooltip: nullish | Tooltip

The tooltip currently being displayed for the activeTool.

`Readonly`createGraphic

createGraphic: nullish | Graphic

The graphic that is being created.

creationMode

creationMode: "update" | "single" | "continuous"

Defines the default behavior once the create operation is completed.

Default

"single"

declaredClass

declaredClass: string

defaultCreateOptions

defaultCreateOptions: SketchViewModelDefaultCreateOptions

Default create options set for the SketchViewModel.

defaultUpdateOptions

defaultUpdateOptions: SketchViewModelDefaultUpdateOptions

Default update options set for the SketchViewModel.

destroyed

destroyed: boolean

`Protected`graphicsCount

graphicsCount: number = 0

initialized

initialized: boolean

layer

layer: GraphicsLayer = ...

The GraphicsLayer associated with the SketchViewModel.

layers

layers: GroupLayer = ...

point

point: GraphicsLayer = ...

pointView

pointView: GraphicsLayerView

polygon

polygon: GraphicsLayer = ...

polygonView

polygonView: GraphicsLayerView

polyline

polyline: GraphicsLayer = ...

polylineView

polylineView: GraphicsLayerView

`Readonly`state

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

The sketch view model's state.

Default

"disabled"

text

text: GraphicsLayer = ...

textSymbol

textSymbol: TextSymbol = TEXT_SYMBOL

textView

textView: GraphicsLayerView

`Readonly`updateGraphics

updateGraphics: Collection<Graphic>

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

updateOnGraphicClick

updateOnGraphicClick: boolean = false

Indicates if a graphic can be selected to be updated.

view

view: nullish | MapView | SceneView

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

Accessors

activeFillSymbol

get activeFillSymbol(): nullish | SimpleFillSymbol | CIMSymbol
The SimpleFillSymbol displayed when actively creating a new polygon graphic using the polygon tool.

Read more...

Returns nullish | SimpleFillSymbol | CIMSymbol
Inherited from SketchViewModel.activeFillSymbol
- Defined in node_modules/@arcgis/core/interfaces.d.ts:131202
set activeFillSymbol(
    value:
        | nullish
        | SimpleFillSymbolProperties & { type: "simple-fill" }
        | CIMSymbolProperties & { type: "cim" },
): void
Parameters
- value:
      | nullish
      | SimpleFillSymbolProperties & { type: "simple-fill" }
      | CIMSymbolProperties & { type: "cim" }
Returns void
Inherited from SketchViewModel.activeFillSymbol
- Defined in node_modules/@arcgis/core/interfaces.d.ts:131203

labelOptions

get labelOptions(): SketchLabelOptions
Options to configure the sketch labels shown next to each segment of the geometry being created or updated.

Read more...

Returns SketchLabelOptions
Inherited from SketchViewModel.labelOptions
- Defined in node_modules/@arcgis/core/interfaces.d.ts:131209
set labelOptions(value: SketchLabelOptionsProperties): void
Parameters
- value: SketchLabelOptionsProperties
Returns void
Inherited from SketchViewModel.labelOptions
- Defined in node_modules/@arcgis/core/interfaces.d.ts:131210

pointSymbol

get pointSymbol(): | PictureMarkerSymbol
| SimpleMarkerSymbol
| TextSymbol
| CIMSymbol
| PointSymbol3D
| WebStyleSymbol
A SimpleMarkerSymbol, PointSymbol3D, TextSymbol, CIMSymbol, or WebStyleSymbol used for representing the point geometry that is being drawn.

Read more...

Returns
    | PictureMarkerSymbol
    | SimpleMarkerSymbol
    | TextSymbol
    | CIMSymbol
    | PointSymbol3D
    | WebStyleSymbol
Inherited from SketchViewModel.pointSymbol
- Defined in node_modules/@arcgis/core/interfaces.d.ts:131216
set pointSymbol(
    value:
        | SimpleMarkerSymbolProperties & { type: "simple-marker" }
        | PictureMarkerSymbolProperties & { type: "picture-marker" }
        | PointSymbol3DProperties & { type: "point-3d" }
        | TextSymbolProperties & { type: "text" }
        | CIMSymbolProperties & { type: "cim" }
        | WebStyleSymbolProperties & { type: "web-style" },
): void
Parameters
- value:
      | SimpleMarkerSymbolProperties & { type: "simple-marker" }
      | PictureMarkerSymbolProperties & { type: "picture-marker" }
      | PointSymbol3DProperties & { type: "point-3d" }
      | TextSymbolProperties & { type: "text" }
      | CIMSymbolProperties & { type: "cim" }
      | WebStyleSymbolProperties & { type: "web-style" }
Returns void
Inherited from SketchViewModel.pointSymbol
- Defined in node_modules/@arcgis/core/interfaces.d.ts:131222

polygonSymbol

get polygonSymbol(): SimpleFillSymbol | CIMSymbol | PolygonSymbol3D
A SimpleFillSymbol, PolygonSymbol3D, or CIMSymbol used for representing the polygon geometry that is being drawn.

Read more...

Returns SimpleFillSymbol | CIMSymbol | PolygonSymbol3D
Inherited from SketchViewModel.polygonSymbol
- Defined in node_modules/@arcgis/core/interfaces.d.ts:131233
set polygonSymbol(
    value:
        | SimpleFillSymbolProperties & { type: "simple-fill" }
        | PolygonSymbol3DProperties & { type: "polygon-3d" }
        | CIMSymbolProperties & { type: "cim" },
): void
Parameters
- value:
      | SimpleFillSymbolProperties & { type: "simple-fill" }
      | PolygonSymbol3DProperties & { type: "polygon-3d" }
      | CIMSymbolProperties & { type: "cim" }
Returns void
Inherited from SketchViewModel.polygonSymbol
- Defined in node_modules/@arcgis/core/interfaces.d.ts:131234

polylineSymbol

get polylineSymbol(): SimpleLineSymbol | CIMSymbol | LineSymbol3D
A SimpleLineSymbol, LineSymbol3D, or CIMSymbol used for representing the polyline geometry that is being drawn.

Read more...

Returns SimpleLineSymbol | CIMSymbol | LineSymbol3D
Inherited from SketchViewModel.polylineSymbol
- Defined in node_modules/@arcgis/core/interfaces.d.ts:131242
set polylineSymbol(
    value:
        | SimpleLineSymbolProperties & { type: "simple-line" }
        | LineSymbol3DProperties & { type: "line-3d" }
        | CIMSymbolProperties & { type: "cim" },
): void
Parameters
- value:
      | SimpleLineSymbolProperties & { type: "simple-line" }
      | LineSymbol3DProperties & { type: "line-3d" }
      | CIMSymbolProperties & { type: "cim" }
Returns void
Inherited from SketchViewModel.polylineSymbol
- Defined in node_modules/@arcgis/core/interfaces.d.ts:131243

snappingOptions

get snappingOptions(): SnappingOptions
The SnappingOptions for sketching.

Read more...

Returns SnappingOptions
Inherited from SketchViewModel.snappingOptions
- Defined in node_modules/@arcgis/core/interfaces.d.ts:131251
set snappingOptions(value: SnappingOptionsProperties): void
Parameters
- value: SnappingOptionsProperties
Returns void
Inherited from SketchViewModel.snappingOptions
- Defined in node_modules/@arcgis/core/interfaces.d.ts:131252

tooltipOptions

get tooltipOptions(): SketchTooltipOptions
Options to configure the tooltip shown next to the cursor when creating or updating graphics.

Read more...

Returns SketchTooltipOptions
Inherited from SketchViewModel.tooltipOptions
- Defined in node_modules/@arcgis/core/interfaces.d.ts:131258
set tooltipOptions(value: SketchTooltipOptionsProperties): void
Parameters
- value: SketchTooltipOptionsProperties
Returns void
Inherited from SketchViewModel.tooltipOptions
- Defined in node_modules/@arcgis/core/interfaces.d.ts:131259

valueOptions

get valueOptions(): SketchValueOptions
Options to configure how values are displayed and input when creating or updating graphics.

Read more...

Returns SketchValueOptions
Inherited from SketchViewModel.valueOptions
- Defined in node_modules/@arcgis/core/interfaces.d.ts:131265
set valueOptions(value: SketchValueOptionsProperties): void
Parameters
- value: SketchValueOptionsProperties
Returns void
Inherited from SketchViewModel.valueOptions
- Defined in node_modules/@arcgis/core/interfaces.d.ts:131266

Methods

`Protected`_get

_get(propertyName: string): any
Parameters
- propertyName: string
Returns any
Inherited from SketchViewModel._get
- Defined in node_modules/@arcgis/core/interfaces.d.ts:32
_get<T>(propertyName: string): T
Type Parameters
- T
Parameters
- propertyName: string
Returns T
Inherited from SketchViewModel._get
- Defined in node_modules/@arcgis/core/interfaces.d.ts:33

`Protected`_set

_set<T>(propertyName: string, value: T): this
Type Parameters
- T
Parameters
- propertyName: string
- value: T
Returns this
Inherited from SketchViewModel._set
- Defined in node_modules/@arcgis/core/interfaces.d.ts:34

addGeometry

addGeometry(geometry: Geometry): nullish | Graphic
Parameters
- geometry: Geometry
Returns nullish | Graphic
- Defined in src/components/Sketch/Sketch.ts:242

addHandles

addHandles<T>(
handles: IHandle | IHandle[],
groupKey?: Exclude<T, IHandle>,
): void
Type Parameters
- T
Parameters
- handles: IHandle | IHandle[]
- OptionalgroupKey: Exclude<T, IHandle>
Returns void
Inherited from SketchViewModel.addHandles
- Defined in node_modules/@arcgis/core/interfaces.d.ts:28

addJSON

addJSON(featureJSON: object): nullish | Graphic
Parameters
- featureJSON: object
Returns nullish | Graphic
- Defined in src/components/Sketch/Sketch.ts:254

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
Inherited from SketchViewModel.cancel
- Defined in node_modules/@arcgis/core/interfaces.d.ts:131273

canRedo

canRedo(): boolean
Indicates if it is possible to perform a redo() action in the current update session.

Read more...

Returns boolean
Inherited from SketchViewModel.canRedo
- Defined in node_modules/@arcgis/core/interfaces.d.ts:131279

canUndo

canUndo(): boolean
Indicates if it is possible to perform an undo() action in the current update session.

Read more...

Returns boolean
Inherited from SketchViewModel.canUndo
- Defined in node_modules/@arcgis/core/interfaces.d.ts:131285

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
Inherited from SketchViewModel.complete
- Defined in node_modules/@arcgis/core/interfaces.d.ts:131292

create

create(
    tool:
        | "circle"
        | "polygon"
        | "polyline"
        | "point"
        | "rectangle"
        | "multipoint"
        | "mesh"
        | "freehandPolyline"
        | "freehandPolygon",
    createOptions?: SketchViewModelCreateCreateOptions,
): void
Create a graphic with the geometry specified in the tool parameter.
Parameters
- tool:
      | "circle"
      | "polygon"
      | "polyline"
      | "point"
      | "rectangle"
      | "multipoint"
      | "mesh"
      | "freehandPolyline"
      | "freehandPolygon"
  Name of the create tool. Specifies the geometry for the graphic to be created.
- OptionalcreateOptions: SketchViewModelCreateCreateOptions
  Options for the graphic to be created.
  
  Read more...
Returns void
Inherited from SketchViewModel.create
- Defined in node_modules/@arcgis/core/interfaces.d.ts:131301

delete

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

Read more...

Returns void
Inherited from SketchViewModel.delete
- Defined in node_modules/@arcgis/core/interfaces.d.ts:131315

deleteAll

deleteAll(): void
Returns void
- Defined in src/components/Sketch/Sketch.ts:276

destroy

destroy(): void
Returns void
Inherited from SketchViewModel.destroy
- Defined in node_modules/@arcgis/core/interfaces.d.ts:24

duplicate

duplicate(): void
Duplicates current graphics used in the update workflow and automatically adds them to the associated layer.

Read more...

Returns void
Inherited from SketchViewModel.duplicate
- Defined in node_modules/@arcgis/core/interfaces.d.ts:131322

emit

emit(type: string, event?: any): boolean
Emits an event on the instance.
Parameters
- type: string
  The name of the event.
- Optionalevent: any
  The event payload.
  
  Read more...
Returns boolean
Inherited from SketchViewModel.emit
- Defined in node_modules/@arcgis/core/interfaces.d.ts:131331

featureJSON

featureJSON(): { features: object[] }
Returns { features: object[] }
- Defined in src/components/Sketch/Sketch.ts:286

hasEventListener

hasEventListener(type: string): boolean
Indicates whether there is an event listener on the instance that matches the provided event name.
Parameters
- type: string
  The name of the event.
  
  Read more...
Returns boolean
Inherited from SketchViewModel.hasEventListener
- Defined in node_modules/@arcgis/core/interfaces.d.ts:131340

hasHandles

hasHandles<T>(groupKey?: Exclude<T, IHandle>): boolean
Type Parameters
- T
Parameters
- OptionalgroupKey: Exclude<T, IHandle>
Returns boolean
Inherited from SketchViewModel.hasHandles
- Defined in node_modules/@arcgis/core/interfaces.d.ts:30

`Protected`notifyChange

notifyChange(propertyName: string): void
Parameters
- propertyName: string
Returns void
Inherited from SketchViewModel.notifyChange
- Defined in node_modules/@arcgis/core/interfaces.d.ts:31

on

on(name: "delete", eventHandler: SketchViewModelDeleteEventHandler): IHandle
Parameters
- name: "delete"
- eventHandler: SketchViewModelDeleteEventHandler
Returns IHandle
Inherited from SketchViewModel.on
- Defined in node_modules/@arcgis/core/interfaces.d.ts:131371
on(name: "create", eventHandler: SketchViewModelCreateEventHandler): IHandle
Parameters
- name: "create"
- eventHandler: SketchViewModelCreateEventHandler
Returns IHandle
Inherited from SketchViewModel.on
- Defined in node_modules/@arcgis/core/interfaces.d.ts:131372
on(name: "update", eventHandler: SketchViewModelUpdateEventHandler): IHandle
Parameters
- name: "update"
- eventHandler: SketchViewModelUpdateEventHandler
Returns IHandle
Inherited from SketchViewModel.on
- Defined in node_modules/@arcgis/core/interfaces.d.ts:131373
on(name: "redo", eventHandler: SketchViewModelRedoEventHandler): IHandle
Parameters
- name: "redo"
- eventHandler: SketchViewModelRedoEventHandler
Returns IHandle
Inherited from SketchViewModel.on
- Defined in node_modules/@arcgis/core/interfaces.d.ts:131374
on(name: "undo", eventHandler: SketchViewModelUndoEventHandler): IHandle
Parameters
- name: "undo"
- eventHandler: SketchViewModelUndoEventHandler
Returns IHandle
Inherited from SketchViewModel.on
- Defined in node_modules/@arcgis/core/interfaces.d.ts:131375

place

place(geometry: Mesh): void
Allows creation of a graphic similar to create with the difference that the geometry can be provided directly for the graphic being created.
Parameters
- geometry: Mesh
  Geometry to place when creating the graphic. Currently only mesh geometry is supported.
  
  Read more...
Returns void
Inherited from SketchViewModel.place
- Defined in node_modules/@arcgis/core/interfaces.d.ts:131349

redo

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

Read more...

Returns void
Inherited from SketchViewModel.redo
- Defined in node_modules/@arcgis/core/interfaces.d.ts:131355

removeHandles

removeHandles<T>(groupKey?: Exclude<T, IHandle>): void
Type Parameters
- T
Parameters
- OptionalgroupKey: Exclude<T, IHandle>
Returns void
Inherited from SketchViewModel.removeHandles
- Defined in node_modules/@arcgis/core/interfaces.d.ts:29

set

set<T>(propertyName: string, value: T): this
Type Parameters
- T
Parameters
- propertyName: string
- value: T
Returns this
Inherited from SketchViewModel.set
- Defined in node_modules/@arcgis/core/interfaces.d.ts:25
set(props: HashMap<any>): this
Parameters
- props: HashMap<any>
Returns this
Inherited from SketchViewModel.set
- Defined in node_modules/@arcgis/core/interfaces.d.ts:26

undo

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

Read more...

Returns void
Inherited from SketchViewModel.undo
- Defined in node_modules/@arcgis/core/interfaces.d.ts:131361

update

update(
graphics: Graphic | Graphic[],
updateOptions?: SketchViewModelUpdateUpdateOptions,
): Promise<void>
Initializes an update operation for the specified graphic(s) and fires update event.
Parameters
- graphics: Graphic | Graphic[]
  A graphic or an array of graphics to be updated. Only graphics added to SketchViewModel's layer property can be updated.
- OptionalupdateOptions: SketchViewModelUpdateUpdateOptions
  Update options for the graphics to be updated.
  
  Read more...
Returns Promise<void>
Inherited from SketchViewModel.update
- Defined in node_modules/@arcgis/core/interfaces.d.ts:131370

watch

watch(
    path: string | string[],
    callback: WatchCallback,
    sync?: boolean,
): WatchHandle
Parameters
- path: string | string[]
- callback: WatchCallback
- Optionalsync: boolean
Returns WatchHandle
Inherited from SketchViewModel.watch
- Defined in node_modules/@arcgis/core/interfaces.d.ts:27

Class default

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns default

Properties

ReadonlyactiveCreateToolDrawMode

ReadonlyactiveTool

ReadonlyactiveTooltip

ReadonlycreateGraphic

creationMode

Default

declaredClass

defaultCreateOptions

defaultUpdateOptions

destroyed

ProtectedgraphicsCount

initialized

layer

layers

point

pointView

polygon

polygonView

polyline

polylineView

Readonlystate

Default

text

textSymbol

textView

ReadonlyupdateGraphics

updateOnGraphicClick

view

Accessors

activeFillSymbol

Returns nullish | SimpleFillSymbol | CIMSymbol

Parameters

Returns void

labelOptions

Returns SketchLabelOptions

Parameters

Returns void

pointSymbol

Returns | PictureMarkerSymbol | SimpleMarkerSymbol | TextSymbol | CIMSymbol | PointSymbol3D | WebStyleSymbol

Parameters

Returns void

polygonSymbol

Returns SimpleFillSymbol | CIMSymbol | PolygonSymbol3D

Parameters

Returns void

polylineSymbol

Returns SimpleLineSymbol | CIMSymbol | LineSymbol3D

Parameters

Returns void

snappingOptions

Returns SnappingOptions

Parameters

Returns void

tooltipOptions

Returns SketchTooltipOptions

Parameters

Returns void

valueOptions

Returns SketchValueOptions

Parameters

Returns void

Methods

Protected_get

Parameters

Returns any

Type Parameters

Parameters

Returns T

`Readonly`activeCreateToolDrawMode

`Readonly`activeTool

`Readonly`activeTooltip

`Readonly`createGraphic

`Protected`graphicsCount

`Readonly`state

`Readonly`updateGraphics

Returns
| PictureMarkerSymbol
| SimpleMarkerSymbol
| TextSymbol
| CIMSymbol
| PointSymbol3D
| WebStyleSymbol

`Protected`_get

`Protected`_set

`Protected`notifyChange