Class EditFeaturesMouseOverInteraction

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

Hierarchy (view full)

AbstractInteraction
- EditFeaturesMouseOverInteraction

Index

Constructors

Methods

destroy modifierChanged pipe reset setActive setModification setPointer

Properties

active cursorStyle id modificationKey pointerKey

Constructors

constructor

new EditFeaturesMouseOverInteraction(): EditFeaturesMouseOverInteraction
Returns EditFeaturesMouseOverInteraction
Overrides AbstractInteraction.constructor
- Defined in src/util/editor/interactions/editFeaturesMouseOverInteraction.ts:21

Methods

destroy

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

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

modifierChanged

modifierChanged(_modifier): 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): 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/editFeaturesMouseOverInteraction.ts:27

reset

reset(): void
Reset the cursorStyle to auto

Returns void
- Defined in src/util/editor/interactions/editFeaturesMouseOverInteraction.ts:48

setActive

setActive(active?): 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/editFeaturesMouseOverInteraction.ts:40

setModification

setModification(mod?): 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?): 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: number

The current active bitmask for EventType

cursorStyle

cursorStyle: undefined | CSSStyleDeclaration

id

id: string

A unique identifier for this interaction

modificationKey

modificationKey: ModificationKeyType

The current active ModificationKeyType

pointerKey

pointerKey: PointerKeyType

The currently active PointerKeyType