Class TerraDraw

Hierarchy

TerraDraw

Index

Constructors

constructor

new TerraDraw(options): TerraDraw
Parameters
- options: {
  adapter: TerraDrawAdapter;
  modes: TerraDrawBaseDrawMode<any>[];
  }
  - adapter: TerraDrawAdapter
  - modes: TerraDrawBaseDrawMode<any>[]
Returns TerraDraw
- Defined in terra-draw.ts:76

Properties

`Private` _adapter

_adapter: TerraDrawAdapter

`Private` _enabled

_enabled: boolean = false

`Private` _eventListeners

_eventListeners: {
    change: ChangeListener[];
    deselect: DeselectListener[];
    finish: FinishListener[];
    select: SelectListener[];
}

Type declaration

change: ChangeListener[]
deselect: DeselectListener[]
finish: FinishListener[]
select: SelectListener[]

`Private` _instanceSelectMode

_instanceSelectMode: undefined | string

`Private` _mode

_mode: TerraDrawBaseDrawMode<any>

`Private` _modes

_modes: {
[mode: string]: TerraDrawBaseDrawMode<any>;
}

Type declaration

[mode: string]: TerraDrawBaseDrawMode<any>

`Private` _store

_store: GeoJSONStore

Accessors

enabled

get enabled(): boolean
Alpha
A property used to determine whether the instance is active or not. You can use the start method to set this to true, and stop method to set this to false. This is a read only property.

Returns boolean
true or false depending on if the instance is stopped or started
- Defined in terra-draw.ts:424

Methods

addFeatures

addFeatures(features): void
Alpha
A method for adding features to the store. This method will validate the features. Features must match one of the modes enabled in the instance.
Parameters
- features: GeoJSONStoreFeatures[]
Returns void
- Defined in terra-draw.ts:498

`Private` checkEnabled

checkEnabled(): void
Returns void
- Defined in terra-draw.ts:262

clear

clear(): void
Alpha
Removes all data from the current store and removes any rendered layers via the registering the adapter.

Returns void
- Defined in terra-draw.ts:410

`Private` featuresAtLocation

featuresAtLocation(__namedParameters, options?): GeoJSONStoreFeatures[]
Parameters
- __namedParameters: {
  lat: number;
  lng: number;
  }
  - lat: number
  - lng: number
- Optional options: {
  ignoreSelectFeatures: boolean;
  pointerDistance: number;
  }
  - ignoreSelectFeatures: boolean
  - pointerDistance: number
Returns GeoJSONStoreFeatures[]
- Defined in terra-draw.ts:292

getFeaturesAtLngLat

getFeaturesAtLngLat(lngLat, options?): GeoJSONStoreFeatures[]
Alpha
Gets the features at a given longitude and latitude. Will return point and linestrings that are a given pixel distance away from the lng/lat and any polygons which contain it.
Parameters
- lngLat: {
  lat: number;
  lng: number;
  }
  - lat: number
  - lng: number
- Optional options: {
  ignoreSelectFeatures: boolean;
  pointerDistance: number;
  }
  - ignoreSelectFeatures: boolean
  - pointerDistance: number
Returns GeoJSONStoreFeatures[]
- Defined in terra-draw.ts:587

getFeaturesAtPointerEvent

getFeaturesAtPointerEvent(event, options?): GeoJSONStoreFeatures[]
Alpha
Takes a given pointer event and Will return point and linestrings that are a given pixel distance away from the lng/lat and any polygons which contain it.
Parameters
- event: PointerEvent | MouseEvent
- Optional options: {
  ignoreSelectFeatures: boolean;
  pointerDistance: number;
  }
  - ignoreSelectFeatures: boolean
  - pointerDistance: number
Returns GeoJSONStoreFeatures[]
- Defined in terra-draw.ts:609

getMode

getMode(): string
Alpha
A method for getting the current mode name

Returns string
the current mode name
- Defined in terra-draw.ts:444

`Private` getModeStyles

getModeStyles(): {
[key: string]: ((feature) => TerraDrawAdapterStyling);
}
Returns {
[key: string]: ((feature) => TerraDrawAdapterStyling);
}
- [key: string]: ((feature) => TerraDrawAdapterStyling)
  - - (feature): TerraDrawAdapterStyling
    - Parameters
      
      feature: GeoJSONStoreFeatures
      Returns TerraDrawAdapterStyling
- Defined in terra-draw.ts:268

getSnapshot

getSnapshot(): GeoJSONStoreFeatures[]
Alpha
Allows the user to get a snapshot (copy) of all given features

Returns GeoJSONStoreFeatures[]
An array of all given Feature Geometries in the instances store
- Defined in terra-draw.ts:399

off

off<T>(event, callback): void
Alpha
Unregisters a Terra Draw event
Type Parameters
- T extends keyof TerraDrawEventListeners
Parameters
- event: keyof TerraDrawEventListeners
  
  The name of the event you wish to unregister
- callback: TerraDrawEventListeners[T]
  
  The callback you originally provided to the 'on' method
Returns void
- Defined in terra-draw.ts:667

on

on<T>(event, callback): void
Alpha
Registers a Terra Draw event
Type Parameters
- T extends keyof TerraDrawEventListeners
Parameters
- event: T
  
  The name of the event you wish to listen for
- callback: TerraDrawEventListeners[T]
  
  The callback with you wish to be called when this event occurs
Returns void
- Defined in terra-draw.ts:647

removeFeatures

removeFeatures(ids): void
Alpha
A method for removing features to the store
Parameters
- ids: string[]
Returns void
- Defined in terra-draw.ts:484

setMode

setMode(mode): void
Alpha
A method for setting the current mode by name. Under the hood this will stop the previous mode and start the new one.
Parameters
- mode: string
  
  The mode name you wish to start
Returns void
- Defined in terra-draw.ts:456

setModeStyles

setModeStyles<Styling>(mode, styles): void
Alpha
Allows the setting of a style for a given mode
Type Parameters
- Styling extends Record<string, number | `#${string}`>
Parameters
- mode: string
  
  The mode you wish to set a style for
- styles: Styling
  
  The styles you wish to set for the mode - this is the same as the initialisation style schema
Returns void
- Defined in terra-draw.ts:380

start

start(): void
Alpha
A method starting Terra Draw. It put the instance into a started state, and in registers the passed adapter giving it all the callbacks required to operate.

Returns void
- Defined in terra-draw.ts:542

stop

stop(): void
Alpha
A method for stopping Terra Draw. Will clear the store, deregister the adapter and remove any rendered layers in the process.

Returns void
- Defined in terra-draw.ts:634

Class TerraDraw

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

options: { adapter: TerraDrawAdapter; modes: TerraDrawBaseDrawMode<any>[]; }

adapter: TerraDrawAdapter

modes: TerraDrawBaseDrawMode<any>[]

Returns TerraDraw

Properties

Private _adapter

Private _enabled

Private _eventListeners

Type declaration

change: ChangeListener[]

deselect: DeselectListener[]

finish: FinishListener[]

select: SelectListener[]

Private _instanceSelectMode

Private _mode

Private _modes

Type declaration

[mode: string]: TerraDrawBaseDrawMode<any>

Private _store

Accessors

enabled

Returns boolean

Methods

addFeatures

Parameters

features: GeoJSONStoreFeatures[]

Returns void

Private checkEnabled

Returns void

clear

Returns void

Private featuresAtLocation

Parameters

__namedParameters: { lat: number; lng: number; }

lat: number

lng: number

Optional options: { ignoreSelectFeatures: boolean; pointerDistance: number; }

ignoreSelectFeatures: boolean

pointerDistance: number

Returns GeoJSONStoreFeatures[]

getFeaturesAtLngLat

Parameters

lngLat: { lat: number; lng: number; }

lat: number

lng: number

Optional options: { ignoreSelectFeatures: boolean; pointerDistance: number; }

ignoreSelectFeatures: boolean

pointerDistance: number

Returns GeoJSONStoreFeatures[]

getFeaturesAtPointerEvent

Parameters

event: PointerEvent | MouseEvent

Optional options: { ignoreSelectFeatures: boolean; pointerDistance: number; }

ignoreSelectFeatures: boolean

pointerDistance: number

Returns GeoJSONStoreFeatures[]

getMode

Returns string

Private getModeStyles

Returns { [key: string]: ((feature) => TerraDrawAdapterStyling); }

[key: string]: ((feature) => TerraDrawAdapterStyling)

Parameters

feature: GeoJSONStoreFeatures

Returns TerraDrawAdapterStyling

getSnapshot

Returns GeoJSONStoreFeatures[]

off

Type Parameters

T extends keyof TerraDrawEventListeners

Parameters

options: {
adapter: TerraDrawAdapter;
modes: TerraDrawBaseDrawMode<any>[];
}

`Private` _adapter

`Private` _enabled

`Private` _eventListeners

`Private` _instanceSelectMode

`Private` _mode

`Private` _modes

`Private` _store

`Private` checkEnabled

`Private` featuresAtLocation

__namedParameters: {
lat: number;
lng: number;
}

`Optional` options: {
ignoreSelectFeatures: boolean;
pointerDistance: number;
}

lngLat: {
lat: number;
lng: number;
}

`Optional` options: {
ignoreSelectFeatures: boolean;
pointerDistance: number;
}

`Optional` options: {
ignoreSelectFeatures: boolean;
pointerDistance: number;
}

`Private` getModeStyles

Returns {
[key: string]: ((feature) => TerraDrawAdapterStyling);
}