SketchProperties | @types/arcgis-js-api

Hierarchy

WidgetProperties
- SketchProperties

Index

Properties

Optional availableCreateTools

availableCreateTools: string[]

Property controlling the visibility and order of create tool buttons.

Optional container

container: string | HTMLElement

The ID or node representing the DOM element containing the widget.

Optional creationMode

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

Defines the default behavior once the create operation is completed.

Optional defaultCreateOptions

defaultCreateOptions: SketchDefaultCreateOptions

Default create options set for the Sketch widget.

Optional defaultUpdateOptions

defaultUpdateOptions: SketchDefaultUpdateOptions

Default update options set for the Sketch widget.

Optional iconClass

iconClass: string

The Sketch widget's default CSS icon class.

Optional id

id: string

The unique ID assigned to the widget when the widget is created.

Optional label

label: string

The widget's label.

Optional layer

layer: GraphicsLayerProperties

The GraphicsLayer associated with the Sketch widget.

Optional layout

layout: "horizontal" | "vertical"

Determines the layout/orientation of the Sketch widget.

Optional snappingOptions

snappingOptions: SnappingOptionsProperties

The SnappingOptions for sketching.

Optional view

view: (MapViewProperties & { type: "2d" }) | (SceneViewProperties & { type: "3d" })

A reference to the MapView or SceneView.

Optional viewModel

viewModel: SketchViewModelProperties

The view model for the Sketch widget.

Optional visible

visible: boolean

Indicates whether the widget is visible.

Optional visibleElements

visibleElements: SketchVisibleElements

The visible elements that are displayed within the widget.