Class TerraDrawBaseAdapter`Abstract`

Implements

TerraDrawAdapter

Constructors

constructor

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

Properties

`Protected`_coordinatePrecision

_coordinatePrecision: number

`Protected`_currentModeCallbacks

_currentModeCallbacks: TerraDrawCallbacks | undefined

`Protected`_dragState

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

`Protected`_heldKeys

_heldKeys: Set<string> = ...

`Protected`_ignoreMismatchedPointerEvents

_ignoreMismatchedPointerEvents: boolean = false

`Protected`_lastDrawEvent

_lastDrawEvent: TerraDrawMouseEvent | undefined

`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:443

`Protected`getAdapterListeners

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

`Protected`getButton

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

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:147

`Protected`getDrawEventFromEvent

getDrawEventFromEvent(
event: PointerEvent | MouseEvent,
isContextMenu?: boolean,
): TerraDrawMouseEvent | null
Parameters
- event: PointerEvent | MouseEvent
- isContextMenu: boolean = false
Returns TerraDrawMouseEvent | null
- Defined in terra-draw/src/common/base.adapter.ts:100

`Abstract`getLngLatFromEvent

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

`Protected`getMapElementXYPosition

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

`Abstract`getMapEventElement

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

`Abstract`project

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

register

register(callbacks: TerraDrawCallbacks): 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:132

`Abstract`render

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

`Abstract`setCursor

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

`Abstract`setDoubleClickToZoom

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

`Abstract`setDraggability

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

`Abstract`unproject

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

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:429

Class TerraDrawBaseAdapterAbstract

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns TerraDrawBaseAdapter

Properties

Protected_coordinatePrecision

Protected_currentModeCallbacks

Protected_dragState

Protected_heldKeys

Protected_ignoreMismatchedPointerEvents

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 TerraDrawMouseEvent | null

AbstractgetLngLatFromEvent

Parameters

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

ProtectedgetMapElementXYPosition

Parameters

Returns { 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 }

unregister

Returns void

Settings

On This Page

Class TerraDrawBaseAdapter`Abstract`

`Protected`_coordinatePrecision

`Protected`_currentModeCallbacks

`Protected`_dragState

`Protected`_heldKeys

`Protected`_ignoreMismatchedPointerEvents

`Protected`_lastDrawEvent

`Protected`_listeners

`Protected`_minPixelDragDistance

`Protected`_minPixelDragDistanceDrawing

`Protected`_minPixelDragDistanceSelecting

`Abstract`clear

`Protected`getAdapterListeners

`Protected`getButton

`Protected`getDrawEventFromEvent

`Abstract`getLngLatFromEvent

`Protected`getMapElementXYPosition

`Abstract`getMapEventElement

`Abstract`project

`Abstract`render

`Abstract`setCursor

`Abstract`setDoubleClickToZoom

`Abstract`setDraggability

`Abstract`unproject