Interface CreateTerraDrawSketchOptions<T>Experimental

Experimentalmodel

OptionalfeatureFilter

• featureFilter(id, feature): boolean
• Experimental

  Scope which terra-draw features drive the model. Features rejected by the filter still surface through BindTerraDrawSketchOptions.onFinish with applied: false.

  Parameters

  • id: TerraDrawSketchFeatureId
  • feature: TerraDrawSketchFeature

  Returns boolean

OptionalonDelete

• onDelete(featureId): void
• Experimental

  Fired when the tracked sketch feature is deleted in terra-draw.

  Parameters

  • featureId: TerraDrawSketchFeatureId

  Returns void

OptionalonDeselect

• onDeselect(featureId): void
• Experimental

  Parameters

  • featureId: TerraDrawSketchFeatureId

  Returns void

OptionalonFinish

• onFinish(event): void
• Experimental

  Fired after every terra-draw finish event, applied or not.

  Parameters

  • event: TerraDrawSketchFinishEvent

  Returns void

OptionalonSelect

• onSelect(featureId): void
• Experimental

  Parameters

  • featureId: TerraDrawSketchFeatureId

  Returns void

OptionalrestoreGeometry

• restoreGeometry(geometry): Record<string, unknown>
• Experimental

  Inverse of BindTerraDrawSketchOptions.transformGeometry, used when pushing model geometry back into terra-draw after undo/redo.

  Parameters

  • geometry: Record<string, unknown>

  Returns Record<string, unknown>

OptionaltoolForMode

• toolForMode(mode): undefined | EditSketchTool
• Experimental

  Override the terra-draw mode → sketch tool mapping.

  Parameters

  • mode: string

  Returns undefined | EditSketchTool

OptionaltransformGeometry

• transformGeometry(geometry): Record<string, unknown>
• Experimental

  Transform a completed terra-draw geometry (always EPSG:4326 GeoJSON) before it reaches the model — e.g. (g) => toWebMercator(g, 4326) from @honua/sdk-js/geometry when the edit source stores Web Mercator.

  Parameters

  • geometry: Record<string, unknown>

  Returns Record<string, unknown>