Class TerraDrawArcGISMapsSDKAdapter

Hierarchy

  • TerraDrawBaseAdapter
    • TerraDrawArcGISMapsSDKAdapter

Constructors

constructor

Properties

_coordinatePrecision _currentModeCallbacks _dragState _heldKeys _lastDrawEvent _listeners _minPixelDragDistance _minPixelDragDistanceDrawing _minPixelDragDistanceSelecting

Methods

clear getAdapterListeners getButton getCoordinatePrecision getDrawEventFromEvent getLngLatFromEvent getMapElementXYPosition getMapEventElement project register render setCursor setDoubleClickToZoom setDraggability unproject unregister

Constructors

constructor

Properties

Protected_coordinatePrecision

_coordinatePrecision: number

Protected_currentModeCallbacks

_currentModeCallbacks: undefined | TerraDrawCallbacks

Protected_dragState

_dragState: "not-dragging" | "pre-dragging" | "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

clear

ProtectedgetAdapterListeners

  • getAdapterListeners(): AdapterListener<BasePointerListener>[]

  • Returns AdapterListener<BasePointerListener>[]

ProtectedgetButton

  • getButton(event):
        | "neither"
        | "left"
        | "middle"
        | "right"

  • Parameters

    • event: PointerEvent | MouseEvent

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

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.

ProtectedgetDrawEventFromEvent

  • getDrawEventFromEvent(event): null | TerraDrawMouseEvent

  • Parameters

    • event: PointerEvent | MouseEvent

    Returns null | TerraDrawMouseEvent

getLngLatFromEvent

  • getLngLatFromEvent(event): {
        lat: number;
        lng: number;
    }

  • Returns the longitude and latitude coordinates from a given PointerEvent on the map.

    Parameters

    • event: PointerEvent | MouseEvent

      The PointerEvent or MouseEvent containing the screen coordinates of the pointer.

    Returns {
        lat: number;
        lng: number;
    }

    An object with 'lng' and 'lat' properties representing the longitude and latitude, or null if the conversion is not possible.

    • lat: number
    • lng: number

ProtectedgetMapElementXYPosition

  • getMapElementXYPosition(event): {
        containerX: number;
        containerY: number;
    }

  • Parameters

    • event: PointerEvent | MouseEvent

    Returns {
        containerX: number;
        containerY: number;
    }

    • containerX: number
    • containerY: number

getMapEventElement

  • getMapEventElement(): HTMLElement

  • Retrieves the HTML element of the ArcGIS element that handles interaction events

    Returns HTMLElement

    The HTMLElement representing the map container.

project

  • project(lng, lat): {
        x: number;
        y: number;
    }

  • Converts longitude and latitude coordinates to pixel coordinates in the map container.

    Parameters

    • lng: number

      The longitude coordinate to project.

    • lat: number

      The latitude coordinate to project.

    Returns {
        x: number;
        y: number;
    }

    An object with 'x' and 'y' properties representing the pixel coordinates within the map container.

    • x: number
    • y: number

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

render

  • render(changes, styling): void

  • Renders GeoJSON features on the map using the provided styling configuration.

    Parameters

    • changes: TerraDrawChanges

      An object containing arrays of created, updated, and unchanged features to render.

    • styling: TerraDrawStylingFunction

      An object mapping draw modes to feature styling functions

    Returns void

setCursor

  • setCursor(cursor): void

  • Sets the cursor style for the map container.

    Parameters

    • cursor:
          | "unset"
          | "grab"
          | "grabbing"
          | "crosshair"
          | "pointer"
          | "wait"
          | "move"

      The CSS cursor style to apply, or 'unset' to remove any previously applied cursor style.

    Returns void

setDoubleClickToZoom

  • setDoubleClickToZoom(enabled): void

  • Enables or disables the double-click to zoom functionality on the map.

    Parameters

    • enabled: boolean

      Set to true to enable double-click to zoom, or false to disable it.

    Returns void

setDraggability

  • setDraggability(enabled): void

  • Enables or disables the draggable functionality of the map.

    Parameters

    • enabled: boolean

      Set to true to enable map dragging, or false to disable it.

    Returns void

unproject

  • unproject(x, y): {
        lat: number;
        lng: number;
    }

  • Converts pixel coordinates in the map container to longitude and latitude coordinates.

    Parameters

    • x: number

      The x-coordinate in the map container to unproject.

    • y: number

      The y-coordinate in the map container to unproject.

    Returns {
        lat: number;
        lng: number;
    }

    An object with 'lng' and 'lat' properties representing the longitude and latitude coordinates.

    • lat: number
    • lng: number

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

Settings

Member Visibility

On This Page

Constructors
Properties
Methods