spatial-monorepo

---

spatial-monorepo / editor/src / ImageSnapMode

Class: ImageSnapMode

Defined in: packages/editor/src/modes/ImageSnapMode.ts:37

Extends

• TerraDrawBaseDrawMode

Indexable

[key: string]: any

Constructors

Constructor

new ImageSnapMode(options?): ImageSnapMode

Defined in: packages/editor/src/modes/ImageSnapMode.ts:49

Parameters

options?

ImageSnapModeOptions

Returns

ImageSnapMode

Overrides

TerraDrawBaseDrawMode.constructor

Properties

mode

mode: string = 'image-snap'

Defined in: packages/editor/src/modes/ImageSnapMode.ts:44

---

setCursor

protected setCursor: (cursor) => void

Defined in: packages/editor/src/modes/ImageSnapMode.ts:42

Parameters

cursor

any

Returns

void

---

setStarted

protected setStarted: () => void

Defined in: packages/editor/src/modes/ImageSnapMode.ts:39

Returns

void

---

setStopped

protected setStopped: () => void

Defined in: packages/editor/src/modes/ImageSnapMode.ts:40

Returns

void

---

type

type: string = 'drawing'

Defined in: packages/editor/src/modes/ImageSnapMode.ts:45

Accessors

snapPixelDistance

Get Signature

get snapPixelDistance(): number

Defined in: packages/editor/src/modes/ImageSnapMode.ts:118

Returns

number

Methods

onDrag()

onDrag(_event, _setMapDraggability): void

Defined in: packages/editor/src/modes/ImageSnapMode.ts:92

Parameters

_event

TerraDrawMouseEvent

_setMapDraggability

(enabled) => void

Returns

void

---

onDragEnd()

onDragEnd(_event, setMapDraggability): void

Defined in: packages/editor/src/modes/ImageSnapMode.ts:94

Parameters

_event

TerraDrawMouseEvent

setMapDraggability

(enabled) => void

Returns

void

---

onDragStart()

onDragStart(_event, setMapDraggability): void

Defined in: packages/editor/src/modes/ImageSnapMode.ts:85

Parameters

_event

TerraDrawMouseEvent

setMapDraggability

(enabled) => void

Returns

void