Class TerraDrawBaseAdapter`Abstract`

Implements

TerraDrawAdapter

Constructors

constructor

new TerraDrawBaseAdapter(config): TerraDrawBaseAdapter
Parameters
- config: BaseAdapterConfig
Returns TerraDrawBaseAdapter
- Defined in terra-draw/src/common/base.adapter.ts:28

Properties

`Protected`_coordinatePrecision

_coordinatePrecision: number

`Protected`_currentModeCallbacks

_currentModeCallbacks: undefined | TerraDrawCallbacks

`Protected`_dragState

_dragState: "not-dragging" | "pre-dragging" | "dragging" = "not-dragging"

`Protected`_heldKeys

_heldKeys: Set<string> = ...

`Protected`_lastDrawEvent

_lastDrawEvent: undefined | TerraDrawMouseEvent

`Protected`_listeners

_listeners: AdapterListener<BasePointerListener | BaseKeyboardListener | BaseMouseListener>[] = []

`Protected`_minPixelDragDistance

_minPixelDragDistance: number

`Protected`_minPixelDragDistanceDrawing

_minPixelDragDistanceDrawing: number

`Protected`_minPixelDragDistanceSelecting

_minPixelDragDistanceSelecting: number

Methods

`Abstract`clear

clear(): void
Returns void
Implementation of TerraDrawAdapter.clear
- Defined in terra-draw/src/common/base.adapter.ts:397

`Protected`getAdapterListeners

getAdapterListeners(): AdapterListener<BasePointerListener>[]
Returns AdapterListener<BasePointerListener>[]
- Defined in terra-draw/src/common/base.adapter.ts:139

`Protected`getButton

getButton(event):
    | "neither"
    | "left"
    | "middle"
    | "right"
Parameters
- event: PointerEvent | MouseEvent
Returns
    | "neither"
    | "left"
    | "middle"
    | "right"
- Defined in terra-draw/src/common/base.adapter.ts:65

getCoordinatePrecision

getCoordinatePrecision(): number
Gets the coordinate precision. The coordinate precision is the number of decimal places in geometry coordinates stored in the store.

Returns number
The coordinate precision.
Implementation of TerraDrawAdapter.getCoordinatePrecision
- Defined in terra-draw/src/common/base.adapter.ts:135

`Protected`getDrawEventFromEvent

getDrawEventFromEvent(event): null | TerraDrawMouseEvent
Parameters
- event: PointerEvent | MouseEvent
Returns null | TerraDrawMouseEvent
- Defined in terra-draw/src/common/base.adapter.ts:90

`Abstract`getLngLatFromEvent

getLngLatFromEvent(...event): null | {
lat: number;
lng: number;
}
Parameters
- Rest...event: [event: PointerEvent | MouseEvent]
Returns null | {
lat: number;
lng: number;
}
Implementation of TerraDrawAdapter.getLngLatFromEvent
- Defined in terra-draw/src/common/base.adapter.ts:409

`Protected`getMapElementXYPosition

getMapElementXYPosition(event): {
containerX: number;
containerY: number;
}
Parameters
- event: PointerEvent | MouseEvent
Returns {
containerX: number;
containerY: number;
}
- containerX: number
- containerY: number
- Defined in terra-draw/src/common/base.adapter.ts:80

`Abstract`getMapEventElement

getMapEventElement(): HTMLElement
Returns HTMLElement
Implementation of TerraDrawAdapter.getMapEventElement
- Defined in terra-draw/src/common/base.adapter.ts:63

`Abstract`project

project(...args): CartesianPoint
Parameters
- Rest...args: [lng: number, lat: number]
Returns CartesianPoint
Implementation of TerraDrawAdapter.project
- Defined in terra-draw/src/common/base.adapter.ts:399

register

register(callbacks): void
Registers the provided callbacks for the current drawing mode and attaches the necessary event listeners.
Parameters
- callbacks: TerraDrawCallbacks
  An object containing callback functions for handling various drawing events in the current mode.
Returns void
Implementation of TerraDrawAdapter.register
- Defined in terra-draw/src/common/base.adapter.ts:120

`Abstract`render

render(changes, styling): void
Parameters
- changes: TerraDrawChanges
- styling: TerraDrawStylingFunction
Returns void
Implementation of TerraDrawAdapter.render
- Defined in terra-draw/src/common/base.adapter.ts:417

`Abstract`setCursor

setCursor(...args): void
Parameters
- Rest...args: [cursor:
      | "unset"
      | "grab"
      | "grabbing"
      | "crosshair"
      | "pointer"
      | "wait"
      | "move"]
Returns void
Implementation of TerraDrawAdapter.setCursor
- Defined in terra-draw/src/common/base.adapter.ts:405

`Abstract`setDoubleClickToZoom

setDoubleClickToZoom(enabled): void
Parameters
- enabled: boolean
Returns void
Implementation of TerraDrawAdapter.setDoubleClickToZoom
- Defined in terra-draw/src/common/base.adapter.ts:415

`Abstract`setDraggability

setDraggability(enabled): void
Parameters
- enabled: boolean
Returns void
- Defined in terra-draw/src/common/base.adapter.ts:413

`Abstract`unproject

unproject(...args): {
lat: number;
lng: number;
}
Parameters
- Rest...args: [x: number, y: number]
Returns {
lat: number;
lng: number;
}
- lat: number
- lng: number
Implementation of TerraDrawAdapter.unproject
- Defined in terra-draw/src/common/base.adapter.ts:401

unregister

unregister(): void
Unregisters the event listeners for the current drawing mode. This is typically called when switching between drawing modes or stopping the drawing process.

Returns void
Implementation of TerraDrawAdapter.unregister
- Defined in terra-draw/src/common/base.adapter.ts:390

Class TerraDrawBaseAdapterAbstract

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns TerraDrawBaseAdapter

Properties

Protected_coordinatePrecision

Protected_currentModeCallbacks

Protected_dragState

Protected_heldKeys

Protected_lastDrawEvent

Protected_listeners

Protected_minPixelDragDistance

Protected_minPixelDragDistanceDrawing

Protected_minPixelDragDistanceSelecting

Methods

Abstractclear

Returns void

ProtectedgetAdapterListeners

Returns AdapterListener<BasePointerListener>[]

ProtectedgetButton

Parameters

Returns | "neither" | "left" | "middle" | "right"

getCoordinatePrecision

Returns number

ProtectedgetDrawEventFromEvent

Parameters

Returns null | TerraDrawMouseEvent

AbstractgetLngLatFromEvent

Parameters

Returns null | { lat: number; lng: number; }

ProtectedgetMapElementXYPosition

Parameters

Returns { containerX: number; containerY: number; }

containerX: number

containerY: number

AbstractgetMapEventElement

Returns HTMLElement

Abstractproject

Parameters

Returns CartesianPoint

register

Parameters

Returns void

Abstractrender

Parameters

Returns void

AbstractsetCursor

Parameters

Returns void

AbstractsetDoubleClickToZoom

Parameters

Returns void

AbstractsetDraggability

Parameters

Returns void

Abstractunproject

Parameters

Returns { lat: number; lng: number; }

lat: number

lng: number

unregister

Returns void

Settings

On This Page

Class TerraDrawBaseAdapter`Abstract`

`Protected`_coordinatePrecision

`Protected`_currentModeCallbacks

`Protected`_dragState

`Protected`_heldKeys

`Protected`_lastDrawEvent

`Protected`_listeners

`Protected`_minPixelDragDistance

`Protected`_minPixelDragDistanceDrawing

`Protected`_minPixelDragDistanceSelecting

`Abstract`clear

`Protected`getAdapterListeners

`Protected`getButton

Returns
| "neither"
| "left"
| "middle"
| "right"

`Protected`getDrawEventFromEvent

`Abstract`getLngLatFromEvent

Returns null | {
lat: number;
lng: number;
}

`Protected`getMapElementXYPosition

Returns {
containerX: number;
containerY: number;
}

`Abstract`getMapEventElement

`Abstract`project

`Abstract`render

`Abstract`setCursor

`Abstract`setDoubleClickToZoom

`Abstract`setDraggability

`Abstract`unproject

Returns {
lat: number;
lng: number;
}