Class TerraDrawSelectMode

Hierarchy

TerraDrawBaseSelectMode<SelectionStyling>
- TerraDrawSelectMode

Constructors

constructor

new TerraDrawSelectMode(options?): TerraDrawSelectMode
Parameters
- Optionaloptions: TerraDrawSelectModeOptions<SelectionStyling>
Returns TerraDrawSelectMode
Overrides TerraDrawBaseSelectMode<SelectionStyling>.constructor
- Defined in terra-draw/src/modes/select/select.mode.ts:130

Properties

`Protected`_state

_state: TerraDrawModeState

`Protected`_styles

_styles: Partial<SelectionStyling>

`Protected`behaviors

behaviors: TerraDrawModeBehavior[] = []

`Protected`coordinatePrecision

coordinatePrecision: number

mode

mode: string = "select"

`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.Select

`Protected`unproject

unproject: Unproject

`Protected`validate

validate: undefined | Validation

Accessors

state

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

styles

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

Methods

cleanUp

cleanUp(): void
Internal
Returns void
Overrides TerraDrawBaseSelectMode.cleanUp
- Defined in terra-draw/src/modes/select/select.mode.ts:587

deselectFeature

deselectFeature(): void
Returns void
Overrides TerraDrawBaseSelectMode.deselectFeature
- Defined in terra-draw/src/modes/select/select.mode.ts:245

`Protected`getHexColorStylingValue

getHexColorStylingValue(value, defaultValue, feature): `#${string}`
Parameters
- value: undefined | `#${string}` | ((feature: GeoJSONStoreFeatures) => `#${string}`)
- defaultValue: `#${string}`
- feature: GeoJSONStoreFeatures
Returns `#${string}`
Inherited from TerraDrawBaseSelectMode.getHexColorStylingValue
- 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
Inherited from TerraDrawBaseSelectMode.getNumericStylingValue
- Defined in terra-draw/src/modes/base.mode.ts:248

onClick

onClick(event): void
Internal
Parameters
- event: TerraDrawMouseEvent
Returns void
Overrides TerraDrawBaseSelectMode.onClick
- Defined in terra-draw/src/modes/select/select.mode.ts:519

onDeselect

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

onDrag

onDrag(event, setMapDraggability): void
Internal
Parameters
- event: TerraDrawMouseEvent
- setMapDraggability: ((enabled: boolean) => void)
  - - (enabled): void
    - Parameters
      enabled: boolean
      Returns void
Returns void
Overrides TerraDrawBaseSelectMode.onDrag
- Defined in terra-draw/src/modes/select/select.mode.ts:670

onDragEnd

onDragEnd(_, setMapDraggability): void
Internal
Parameters
- _: TerraDrawMouseEvent
- setMapDraggability: ((enabled: boolean) => void)
  - - (enabled): void
    - Parameters
      enabled: boolean
      Returns void
Returns void
Overrides TerraDrawBaseSelectMode.onDragEnd
- Defined in terra-draw/src/modes/select/select.mode.ts:760

onDragStart

onDragStart(event, setMapDraggability): void
Internal
Parameters
- event: TerraDrawMouseEvent
- setMapDraggability: ((enabled: boolean) => void)
  - - (enabled): void
    - Parameters
      enabled: boolean
      Returns void
Returns void
Overrides TerraDrawBaseSelectMode.onDragStart
- Defined in terra-draw/src/modes/select/select.mode.ts:594

onFinish

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

onKeyDown

onKeyDown(event): void
Internal
Parameters
- event: TerraDrawKeyboardEvent
Returns void
Overrides TerraDrawBaseSelectMode.onKeyDown
- Defined in terra-draw/src/modes/select/select.mode.ts:553

onKeyUp

onKeyUp(event): void
Internal
Parameters
- event: TerraDrawKeyboardEvent
Returns void
Overrides TerraDrawBaseSelectMode.onKeyUp
- Defined in terra-draw/src/modes/select/select.mode.ts:558

onMouseMove

onMouseMove(event): void
Internal
Parameters
- event: TerraDrawMouseEvent
Returns void
Overrides TerraDrawBaseSelectMode.onMouseMove
- Defined in terra-draw/src/modes/select/select.mode.ts:794

onSelect

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

register

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

registerBehaviors

registerBehaviors(config): void
Parameters
- config: BehaviorConfig
Returns void
Overrides TerraDrawBaseSelectMode.registerBehaviors
- Defined in terra-draw/src/modes/select/select.mode.ts:201

selectFeature

selectFeature(featureId): void
Parameters
- featureId: FeatureId
Returns void
Overrides TerraDrawBaseSelectMode.selectFeature
- Defined in terra-draw/src/modes/select/select.mode.ts:189

`Protected`setDrawing

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

setSelecting

setSelecting(): void
Returns void
- Defined in terra-draw/src/modes/select/select.mode.ts:193

`Protected`setStarted

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

`Protected`setStopped

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

start

start(): void
Internal
Returns void
Overrides TerraDrawBaseSelectMode.start
- Defined in terra-draw/src/modes/select/select.mode.ts:506

stop

stop(): void
Internal
Returns void
Overrides TerraDrawBaseSelectMode.stop
- Defined in terra-draw/src/modes/select/select.mode.ts:512

styleFeature

styleFeature(feature): TerraDrawAdapterStyling
Internal
Parameters
- feature: GeoJSONStoreFeatures
Returns TerraDrawAdapterStyling
Overrides TerraDrawBaseSelectMode.styleFeature
- Defined in terra-draw/src/modes/select/select.mode.ts:851

validateFeature

validateFeature(feature): {
reason?: string;
valid: boolean;
}
Parameters
- feature: unknown
Returns {
reason?: string;
valid: boolean;
}
- Optionalreason?: string
- valid: boolean
Inherited from TerraDrawBaseSelectMode.validateFeature
- 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
Inherited from TerraDrawBaseSelectMode.validateModeFeature
- Defined in terra-draw/src/modes/base.mode.ts:191

Class TerraDrawSelectMode

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns TerraDrawSelectMode

Properties

Protected_state

Protected_styles

Protectedbehaviors

ProtectedcoordinatePrecision

mode

ProtectedonStyleChange

ProtectedpointerDistance

Protectedproject

Protectedprojection

ProtectedsetCursor

ProtectedsetDoubleClickToZoom

Protectedstore

type

Protectedunproject

Protectedvalidate

Accessors

state

Returns TerraDrawModeState

Parameters

Returns void

styles

Returns Partial<T>

Parameters

Returns void

Methods

cleanUp

Returns void

deselectFeature

Returns void

ProtectedgetHexColorStylingValue

Parameters

Returns `#${string}`

ProtectedgetNumericStylingValue

Parameters

Returns number

onClick

Parameters

Returns void

onDeselect

Parameters

Returns void

onDrag

Parameters

Parameters

Returns void

Returns void

onDragEnd

Parameters

Parameters

Returns void

Returns void

onDragStart

Parameters

Parameters

Returns void

Returns void

onFinish

Parameters

Returns void

onKeyDown

Parameters

Returns void

onKeyUp

Parameters

Returns void

onMouseMove

Parameters

Returns void

`Protected`_state

`Protected`_styles

`Protected`behaviors

`Protected`coordinatePrecision

`Protected`onStyleChange

`Protected`pointerDistance

`Protected`project

`Protected`projection

`Protected`setCursor

`Protected`setDoubleClickToZoom

`Protected`store

`Protected`unproject

`Protected`validate

`Protected`getHexColorStylingValue

`Protected`getNumericStylingValue

`Protected`setDrawing

`Protected`setStarted

`Protected`setStopped

Returns {
reason?: string;
valid: boolean;
}

`Optional`reason?: string

`Protected`validateModeFeature

Returns {
reason?: string;
valid: boolean;
}

`Optional`reason?: string

Returns {
reason?: string;
valid: boolean;
}

`Optional`reason?: string