Class SelectSingleFeatureInteraction

Class to select features for editing. Static FeatureStore features will be converted into their dynamic form

Hierarchy (View Summary)

AbstractInteraction
- SelectSingleFeatureInteraction

Implements

SelectFeatureInteraction

Index

Accessors

Constructors

Methods

clear destroy hasFeatureId modifierChanged pipe setActive setModification setPointer setSelected

Properties

active featureChanged id modificationKey pointerKey

Accessors

selected

get selected(): Feature<Geometry, { [x: string]: any }>[]
Returns Feature<Geometry, { [x: string]: any }>[]
Implementation of SelectFeatureInteraction.selected
- Defined in src/util/editor/interactions/selectSingleFeatureInteraction.ts:43

Constructors

constructor

new SelectSingleFeatureInteraction(
layer: VectorLayer,
): SelectSingleFeatureInteraction
Parameters
- layer: VectorLayer
Returns SelectSingleFeatureInteraction
Overrides AbstractInteraction.constructor
- Defined in src/util/editor/interactions/selectSingleFeatureInteraction.ts:36

Methods

clear

clear(): void
Clears the current selection, if there is one.

Returns void
- Defined in src/util/editor/interactions/selectSingleFeatureInteraction.ts:92

destroy

destroy(): void
destroys the implementation, removing any created resources

Returns void
Overrides AbstractInteraction.destroy
- Defined in src/util/editor/interactions/selectSingleFeatureInteraction.ts:99

hasFeatureId

hasFeatureId(id: string | number): boolean
Checks if a feature with a spicific id is selected.
Parameters
- id: string | number
Returns boolean
Implementation of SelectFeatureInteraction.hasFeatureId
- Defined in src/util/editor/interactions/selectSingleFeatureInteraction.ts:85

modifierChanged

modifierChanged(_modifier: ModificationKeyType): void
Called when the modifier keys have changed.
Parameters
- _modifier: ModificationKeyType
Returns void
Inherited from AbstractInteraction.modifierChanged
- Defined in src/interaction/abstractInteraction.ts:147

pipe

pipe(event: EventAfterEventHandler): Promise<EventAfterEventHandler>
Main function, called when an event is raised for this interaction
Parameters
- event: EventAfterEventHandler
Returns Promise<EventAfterEventHandler>
Overrides AbstractInteraction.pipe
- Defined in src/util/editor/interactions/selectSingleFeatureInteraction.ts:47

setActive

setActive(active?: number | boolean): void
Sets the interaction active. Use boolean (true|false) to toggle default behavior. Pass it a bitmask of EventType to change the active state. Call without arguments to reset the default active, modification key and pointer Key behavior
Parameters
- Optionalactive: number | boolean
Returns void
Inherited from AbstractInteraction.setActive
- Defined in src/interaction/abstractInteraction.ts:156

setModification

setModification(mod?: ModificationKeyType): void
Sets the modification key to listen to or the default modification key if none is provided.
Parameters
- Optionalmod: ModificationKeyType
Returns void
Inherited from AbstractInteraction.setModification
- Defined in src/interaction/abstractInteraction.ts:171

setPointer

setPointer(pointer?: PointerKeyType): void
Sets the pointer key for this interaction or the default pointer if none is provided.
Parameters
- Optionalpointer: PointerKeyType
Returns void
Inherited from AbstractInteraction.setPointer
- Defined in src/interaction/abstractInteraction.ts:182

setSelected

setSelected(
feature: SelectableFeatureType | SelectableFeatureType[],
): Promise<void>
Selects the given feature. if passed in a tiled feature store feature, it will be converted. Do not pass in uneditable features (feature which do not belong to the layer for which this interaction was created)
Parameters
- feature: SelectableFeatureType | SelectableFeatureType[]
Returns Promise<void>
Implementation of SelectFeatureInteraction.setSelected
- Defined in src/util/editor/interactions/selectSingleFeatureInteraction.ts:68

Properties

active

active: EventType

The current active bitmask for EventType

`Readonly`featureChanged

featureChanged: VcsEvent<Feature<Geometry, { [x: string]: any }> | null> = ...

Event called when the feature changes. Called with null if the selection is cleared.

id

id: string

A unique identifier for this interaction

modificationKey

modificationKey: ModificationKeyType

The current active ModificationKeyType

pointerKey

pointerKey: PointerKeyType

The currently active PointerKeyType