Class SketchCompat

constructor

• new SketchCompat(options?): SketchCompat

• Parameters

  • options: SketchCompatOptions = {}

  Returns SketchCompat

activeCreateOptions

activeTool

activeUpdateGraphics

activeUpdateOptions

Readonlycontainer

ReadonlycreationMode

ReadonlydefaultCreateOptions

ReadonlydefaultUpdateOptions

ReadonlyeventBus

Readonlylayer

loaded

loadStatus

snappingOptions

state

ReadonlyupdateOnGraphicClick

Readonlyview

cancel

• cancel(): undefined | SketchCreateResultCompat

• Returns undefined | SketchCreateResultCompat

complete

• complete(graphic?): undefined | SketchCreateResultCompat

• Parameters

  • Optionalgraphic: Record<string, unknown>

  Returns undefined | SketchCreateResultCompat

create

• create(tool, options?): void

• Parameters

  • tool: SketchToolCompat
  • Optionaloptions: Partial<SketchCreateOptionsCompat>

  Returns void

delegatesToSketchBinding

• delegatesToSketchBinding(): boolean
• Experimental

  Whether tool modes delegate to a terra-draw sketch binding.

  Returns boolean

delete

• delete(graphics?): number

• Parameters

  • Optionalgraphics: unknown

  Returns number

destroy

• destroy(): void

• Returns void

load

• load(): Promise<SketchCompat>

• Returns Promise<SketchCompat>

reset

• reset(): void

• Returns void

setSnappingOptions

• setSnappingOptions(options): void

• Replace the ArcGIS-shaped snapping options and notify watchers.

  Parameters

  • options: SnappingOptionsCompat

  Returns void

snappingConfig

• snappingConfig(): SnappingConfig

• The snapping options mapped onto the contract SnappingConfig.

  Returns SnappingConfig

update

• update(graphics, options?): readonly Record<string, unknown>[]

• Parameters

  • graphics: Record<string, unknown> | readonly Record<string, unknown>[]
  • Optionaloptions: Partial<SketchUpdateOptionsCompat>

  Returns readonly Record<string, unknown>[]

watch

• watch(propertyName, listener): SketchHandleCompat

• Parameters

  • propertyName: string
  • listener: ((value: unknown) => void)
    • • (value): void

      • Parameters

        • value: unknown

        Returns void

  Returns SketchHandleCompat

when

• when(callback?): Promise<SketchCompat>

• Parameters

  • Optionalcallback: ((widget: SketchCompat) => void)
    • • (widget): void

      • Parameters

        • widget: SketchCompat

        Returns void

  Returns Promise<SketchCompat>