Interface TerraDrawSketchController<T>`Experimental`

interface TerraDrawSketchController<T = Record<string, unknown>> {
    activeFeatureId: TerraDrawSketchFeatureId | undefined;
    draw: TerraDrawSketchInstance;
    model: EditSketchWorkflowModel<T>;
    selectedFeatureId: TerraDrawSketchFeatureId | undefined;
    cancel(): void;
    redo(): boolean;
    remove(): void;
    select(): void;
    setTool(tool: EditSketchTool): EditSketchToolCapability;
    stop(): void;
    syncFromModel(): boolean;
    undo(): boolean;
}

Type Parameters

T = Record<string, unknown>

Hierarchy (View Summary)

TerraDrawSketchHandle
- TerraDrawSketchController

Index

Properties

activeFeatureId draw model selectedFeatureId

Methods

cancel redo remove select setTool stop syncFromModel undo

Properties

`Readonly` `Experimental`activeFeatureId

activeFeatureId: TerraDrawSketchFeatureId | undefined

The terra-draw feature currently backing the model geometry.

`Readonly` `Experimental`draw

draw: TerraDrawSketchInstance

The constructed terra-draw instance (duck-typed).

`Readonly` `Experimental`model

model: EditSketchWorkflowModel<T>

The bound workflow model.

`Readonly` `Experimental`selectedFeatureId

selectedFeatureId: TerraDrawSketchFeatureId | undefined

The feature currently selected in terra-draw select mode, if any.

Methods

cancel

cancel(): void
Experimental
Leave any drawing/select mode (terra-draw "static").

Returns void
Inherited from TerraDrawSketchHandle.cancel
- Defined in work/honua-sdk-js/honua-sdk-js/src/runtime/terra-draw-sketch.ts:224

redo

redo(): boolean
Experimental
Redo via the workflow model, then sync terra-draw to the model.

Returns boolean
Inherited from TerraDrawSketchHandle.redo
- Defined in work/honua-sdk-js/honua-sdk-js/src/runtime/terra-draw-sketch.ts:228

remove

remove(): void
Experimental
Detach every terra-draw listener.

Returns void
Inherited from TerraDrawSketchHandle.remove
- Defined in work/honua-sdk-js/honua-sdk-js/src/runtime/terra-draw-sketch.ts:236

select

select(): void
Experimental
Switch terra-draw to select mode for update/reshape editing.

Returns void
Inherited from TerraDrawSketchHandle.select
- Defined in work/honua-sdk-js/honua-sdk-js/src/runtime/terra-draw-sketch.ts:222

setTool

setTool(tool: EditSketchTool): EditSketchToolCapability
Experimental
Activate the terra-draw mode for tool and arm the model (model.startSketch). Returns the tool capability; unsupported tools do not change the terra-draw mode.
Parameters
- tool: EditSketchTool
Returns EditSketchToolCapability
Inherited from TerraDrawSketchHandle.setTool
- Defined in work/honua-sdk-js/honua-sdk-js/src/runtime/terra-draw-sketch.ts:220

stop

stop(): void
Experimental
Stop terra-draw and detach the binding.

Returns void
- Defined in work/honua-sdk-js/honua-sdk-js/src/runtime/terra-draw-sketch.ts:508

syncFromModel

syncFromModel(): boolean
Experimental
Replace the tracked terra-draw feature with the model's current geometry (applying restoreGeometry first). Returns false when the instance cannot mutate features (addFeatures/removeFeatures missing).

Returns boolean
Inherited from TerraDrawSketchHandle.syncFromModel
- Defined in work/honua-sdk-js/honua-sdk-js/src/runtime/terra-draw-sketch.ts:234

undo

undo(): boolean
Experimental
Undo via the workflow model, then sync terra-draw to the model.

Returns boolean
Inherited from TerraDrawSketchHandle.undo
- Defined in work/honua-sdk-js/honua-sdk-js/src/runtime/terra-draw-sketch.ts:226