Class TerraDrawBaseDrawMode<T>`Abstract`

Type Parameters

T extends CustomStyling

Hierarchy (view full)

TerraDrawBaseDrawMode

Constructors

constructor

new TerraDrawBaseDrawMode<T>(options?): TerraDrawBaseDrawMode<T>
Type Parameters
- T extends CustomStyling
Parameters
- Optionaloptions: BaseModeOptions<T>
Returns TerraDrawBaseDrawMode<T>
- Defined in terra-draw/src/modes/base.mode.ts:80

Properties

`Protected`_state

_state: TerraDrawModeState

`Protected`_styles

_styles: Partial<T>

`Protected`behaviors

behaviors: TerraDrawModeBehavior[] = []

`Protected`coordinatePrecision

coordinatePrecision: number

mode

mode: string = "base"

`Protected`onStyleChange

onStyleChange: StoreChangeHandler

`Protected`pointerDistance

pointerDistance: number

`Protected`project

project: Project

`Protected`projection

projection: Projection

`Protected`setCursor

setCursor: SetCursor

`Protected`setDoubleClickToZoom

setDoubleClickToZoom: ((enabled: boolean) => void)

`Protected`store

store: GeoJSONStore<FeatureId>

type

type: ModeTypes = ModeTypes.Drawing

`Protected`unproject

unproject: Unproject

`Protected`validate

validate: undefined | Validation

Accessors

state

get state(): TerraDrawModeState
Returns TerraDrawModeState
- Defined in terra-draw/src/modes/base.mode.ts:47
set state(_): void
Parameters
- _: TerraDrawModeState
Returns void
- Defined in terra-draw/src/modes/base.mode.ts:50

styles

get styles(): Partial<T>
Returns Partial<T>
- Defined in terra-draw/src/modes/base.mode.ts:56
set styles(styling): void
Parameters
- styling: Partial<T>
Returns void
- Defined in terra-draw/src/modes/base.mode.ts:59

Methods

`Abstract`cleanUp

cleanUp(): void
Returns void
- Defined in terra-draw/src/modes/base.mode.ts:217

`Protected`getHexColorStylingValue

getHexColorStylingValue(value, defaultValue, feature): `#${string}`
Parameters
- value: undefined | `#${string}` | ((feature: GeoJSONStoreFeatures) => `#${string}`)
- defaultValue: `#${string}`
- feature: GeoJSONStoreFeatures
Returns `#${string}`
- Defined in terra-draw/src/modes/base.mode.ts:240

`Protected`getNumericStylingValue

getNumericStylingValue(value, defaultValue, feature): number
Parameters
- value: undefined | number | ((feature: GeoJSONStoreFeatures) => number)
- defaultValue: number
- feature: GeoJSONStoreFeatures
Returns number
- Defined in terra-draw/src/modes/base.mode.ts:248

onClick

onClick(event): void
Parameters
- event: TerraDrawMouseEvent
Returns void
- Defined in terra-draw/src/modes/base.mode.ts:226

onDeselect

onDeselect(deselectedId): void
Parameters
- deselectedId: FeatureId
Returns void
- Defined in terra-draw/src/modes/base.mode.ts:221

onDrag

onDrag(event, setMapDraggability): void
Parameters
- event: TerraDrawMouseEvent
- setMapDraggability: ((enabled: boolean) => void)
  - - (enabled): void
    - Parameters
      enabled: boolean
      Returns void
Returns void
- Defined in terra-draw/src/modes/base.mode.ts:231

onDragEnd

onDragEnd(event, setMapDraggability): void
Parameters
- event: TerraDrawMouseEvent
- setMapDraggability: ((enabled: boolean) => void)
  - - (enabled): void
    - Parameters
      enabled: boolean
      Returns void
Returns void
- Defined in terra-draw/src/modes/base.mode.ts:235

onDragStart

onDragStart(event, setMapDraggability): void
Parameters
- event: TerraDrawMouseEvent
- setMapDraggability: ((enabled: boolean) => void)
  - - (enabled): void
    - Parameters
      enabled: boolean
      Returns void
Returns void
- Defined in terra-draw/src/modes/base.mode.ts:227

onFinish

onFinish(finishedId, context): void
Parameters
- finishedId: FeatureId
- context: OnFinishContext
Returns void
- Defined in terra-draw/src/modes/base.mode.ts:220

onKeyDown

onKeyDown(event): void
Parameters
- event: TerraDrawKeyboardEvent
Returns void
- Defined in terra-draw/src/modes/base.mode.ts:223

onKeyUp

onKeyUp(event): void
Parameters
- event: TerraDrawKeyboardEvent
Returns void
- Defined in terra-draw/src/modes/base.mode.ts:224

onMouseMove

onMouseMove(event): void
Parameters
- event: TerraDrawMouseEvent
Returns void
- Defined in terra-draw/src/modes/base.mode.ts:225

onSelect

onSelect(selectedId): void
Parameters
- selectedId: FeatureId
Returns void
- Defined in terra-draw/src/modes/base.mode.ts:222

register

register(config): void
Parameters
- config: TerraDrawModeRegisterConfig
Returns void
- Defined in terra-draw/src/modes/base.mode.ts:125

`Protected`registerBehaviors

registerBehaviors(behaviorConfig): void
Parameters
- behaviorConfig: BehaviorConfig
Returns void
- Defined in terra-draw/src/modes/base.mode.ts:77

`Protected`setDrawing

setDrawing(): void
Returns void
- Defined in terra-draw/src/modes/base.mode.ts:94

`Protected`setStarted

setStarted(): void
Returns void
- Defined in terra-draw/src/modes/base.mode.ts:102

`Protected`setStopped

setStopped(): void
Returns void
- Defined in terra-draw/src/modes/base.mode.ts:116

`Abstract`start

start(): void
Returns void
- Defined in terra-draw/src/modes/base.mode.ts:215

`Abstract`stop

stop(): void
Returns void
- Defined in terra-draw/src/modes/base.mode.ts:216

`Abstract`styleFeature

styleFeature(feature): TerraDrawAdapterStyling
Parameters
- feature: GeoJSONStoreFeatures
Returns TerraDrawAdapterStyling
- Defined in terra-draw/src/modes/base.mode.ts:218

validateFeature

validateFeature(feature): {
reason?: string;
valid: boolean;
}
Parameters
- feature: unknown
Returns {
reason?: string;
valid: boolean;
}
- Optionalreason?: string
- valid: boolean
- Defined in terra-draw/src/modes/base.mode.ts:154

`Protected`validateModeFeature

validateModeFeature(feature, modeValidationFn): {
reason?: string;
valid: boolean;
}
Parameters
- feature: unknown
- modeValidationFn: ((feature: GeoJSONStoreFeatures) => {
  reason?: string;
  valid: boolean;
  })
  - - (feature): {
      reason?: string;
      valid: boolean;
      }
    - Parameters
      feature: GeoJSONStoreFeatures
      Returns {
      reason?: string;
      valid: boolean;
      }
      Optionalreason?: string
      valid: boolean
Returns {
reason?: string;
valid: boolean;
}
- Optionalreason?: string
- valid: boolean
- Defined in terra-draw/src/modes/base.mode.ts:191