Class SelectFeatureMouseOverInteraction

A class to handle mouse over effects on features for select sessions.

Hierarchy (View Summary)

AbstractInteraction
- SelectFeatureMouseOverInteraction

Index

Constructors

Methods

destroy modifierChanged pipe reset setActive setModification setPointer

Properties

active id layerName modificationKey pointerKey selectionMode

Constructors

constructor

new SelectFeatureMouseOverInteraction(
    layerName: string,
    selectFeatureInteraction:
        | SelectSingleFeatureInteraction
        | SelectMultiFeatureInteraction,
): SelectFeatureMouseOverInteraction
Parameters
- layerName: string
- selectFeatureInteraction: SelectSingleFeatureInteraction | SelectMultiFeatureInteraction
Returns SelectFeatureMouseOverInteraction
Overrides AbstractInteraction.constructor
- Defined in src/util/editor/interactions/selectFeatureMouseOverInteraction.ts:46

Methods

destroy

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

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

modifierChanged

modifierChanged(modifier: ModificationKeyType): void
Called when the modifier keys have changed.
Parameters
- modifier: ModificationKeyType
Returns void
Overrides AbstractInteraction.modifierChanged
- Defined in src/util/editor/interactions/selectFeatureMouseOverInteraction.ts:85

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/selectFeatureMouseOverInteraction.ts:72

reset

reset(): void
Returns void
- Defined in src/util/editor/interactions/selectFeatureMouseOverInteraction.ts:94

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
Overrides AbstractInteraction.setActive
- Defined in src/util/editor/interactions/selectFeatureMouseOverInteraction.ts:89

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

Properties

active

active: EventType

The current active bitmask for EventType

id

id: string

A unique identifier for this interaction

layerName

layerName: string

The layer name to react to

modificationKey

modificationKey: ModificationKeyType

The current active ModificationKeyType

pointerKey

pointerKey: PointerKeyType

The currently active PointerKeyType

selectionMode

selectionMode: SelectionMode