Class CreateLineStringInteraction

Implements

Hierarchy

AbstractInteraction
- CreateLineStringInteraction

Implements

CreateInteraction<LineString>

Index

Constructors

Methods

_setCoordinates destroy finish modifierChanged pipe setActive setModification setPointer

Properties

_coordinates _geometry _lastCoordinate active created finished id modificationKey pointerKey

Constructors

constructor

new CreateLineStringInteraction(): CreateLineStringInteraction
Returns CreateLineStringInteraction
Overrides AbstractInteraction.constructor
- Defined in src/util/editor/interactions/createLineStringInteraction.ts:33

Methods

`Private` _setCoordinates

_setCoordinates(): void
Private
Sets the coordiantes on the geometry

Returns void
- Defined in src/util/editor/interactions/createLineStringInteraction.ts:42

destroy

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

Returns void
Implementation of CreateInteraction.destroy

Overrides AbstractInteraction.destroy
- Defined in src/util/editor/interactions/createLineStringInteraction.ts:94

finish

finish(): void
Finish the current creation. Calls finish and sets the interaction to be inactive

Returns void
Implementation of CreateInteraction.finish
- Defined in src/util/editor/interactions/createLineStringInteraction.ts:85

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/createLineStringInteraction.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
- 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` _coordinates

_coordinates: Coordinate[] = []

`Private` _geometry

_geometry: null | LineString = null

`Private` _lastCoordinate

_lastCoordinate: null | Coordinate = null

active

active: number

The current active bitmask for EventType

created

created: VcsEvent<LineString> = ...

finished

finished: VcsEvent<null | LineString> = ...

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