Class MapInteractionController

An interaction to suppress map interactions when handling editor features (e.g. dragPan)

Hierarchy

AbstractInteraction
- MapInteractionController

Index

Constructors

Methods

destroy modifierChanged pipe reset setActive setModification setPointer

Properties

_clear active id modificationKey pointerKey

Constructors

constructor

new MapInteractionController(): MapInteractionController
Returns MapInteractionController
Overrides AbstractInteraction.constructor
- Defined in src/util/editor/interactions/mapInteractionController.ts:87

Methods

destroy

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

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

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:142

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/mapInteractionController.ts:93

reset

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

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
- Optional active: number | boolean
Returns void
Inherited from AbstractInteraction.setActive
- Defined in src/interaction/abstractInteraction.ts:151

setModification

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

setPointer

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

Properties

`Private` _clear

_clear: (() => void) = ...

Type declaration

- (): void
- Returns void

active

active: number

The current active bitmask for EventType

id

id: string

A unique identifier for this interaction

modificationKey

modificationKey: ModificationKeyType

The current active ModificationKeyType

pointerKey

pointerKey: PointerKeyType

The currently active PointerKeyType

Generated using TypeDoc