Class SketchCompat

constructor

• new SketchCompat(options?: SketchCompatOptions): SketchCompat

  Parameters

  • options: SketchCompatOptions = {}

  Returns SketchCompat

activeCreateOptions

activeTool

activeUpdateGraphics

activeUpdateOptions

Readonlycontainer

ReadonlycreationMode

ReadonlydefaultCreateOptions

ReadonlydefaultUpdateOptions

ReadonlyeventBus

Readonlylayer

loaded

loadStatus

snappingOptions

state

ReadonlyupdateOnGraphicClick

Readonlyview

cancel

• cancel(): SketchCreateResultCompat | undefined

  Returns SketchCreateResultCompat | undefined

complete

• complete(
      graphic?: Record<string, unknown>,
  ): SketchCreateResultCompat | undefined

  Parameters

  • Optionalgraphic: Record<string, unknown>

  Returns SketchCreateResultCompat | undefined

create

• create(
      tool: SketchToolCompat,
      options?: Partial<SketchCreateOptionsCompat>,
  ): 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?: unknown): 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: SnappingOptionsCompat): 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: Record<string, unknown> | readonly Record<string, unknown>[],
      options?: Partial<SketchUpdateOptionsCompat>,
  ): readonly Record<string, unknown>[]

  Parameters

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

  Returns readonly Record<string, unknown>[]

watch

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

  Parameters

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

  Returns SketchHandleCompat

when

• when(callback?: (widget: SketchCompat) => void): Promise<SketchCompat>

  Parameters

  • Optionalcallback: (widget: SketchCompat) => void

  Returns Promise<SketchCompat>