Class: Line

• [new Line(options)](/solutions/geotoolkit/GeoToolkit_JS/apis/classes/geotoolkit.controls.tools.editors.line.line.md#new line(options))

• new Line(options?)

AbstractLineEditor<LineShape>.constructor

▸ addListener(eventName, listener): Line

add event listener. The listener receives the message when the system event happens.

Deprecated

since 4.0 use .on() instead. Note that 3 args callback should be used in subscription via .on(): (eventType, source, args)

Line

AbstractLineEditor.addListener

▸ apply(command): Line

Applies command to the current node

Line

this

AbstractLineEditor.apply

▸ Protected canInsert(eventArgs): boolean

Determines if the editor can insert a new node at the point

boolean

AbstractLineEditor.canInsert

▸ canRedo(): boolean

Checks if there is command in history to redo

boolean

AbstractLineEditor.canRedo

▸ canUndo(): boolean

Checks if there is command in history to undo

boolean

AbstractLineEditor.canUndo

▸ captureMouseUp(): void

listen to window mouse events in order to catch a mouse up action outside of the tool container DOM element. useful for example when you pan and release click outside of DOM element.

void

AbstractLineEditor.captureMouseUp

▸ changeNodeOrder(order, anchor?): Line

changes the z-order of the nodes being rendered.

Line

this

AbstractLineEditor.changeNodeOrder

▸ Protected createGhost(): Node

Creates a clone of the current node

Node

AbstractLineEditor.createGhost

▸ deleteNode(trash?, shape?): Line

Delete node or array of nodes to specified trash container

Line

this

AbstractLineEditor.deleteNode

▸ dispose(): void

Dispose tool.

void

AbstractLineEditor.dispose

▸ Protected end(eventArgs?): void

Ends current node creation, fires the corresponding event and clones new empty node for the new creation

void

AbstractLineEditor.end

▸ fireEvent(eventName, eventArgs?): void

This method is Protected. Fire an Event.

Deprecated

since 4.0 use .notify() instead. Note that 3 args callback should be used in subscription via .on()

void

AbstractLineEditor.fireEvent

▸ flipNodeOrientation(flipX, flipY): Line

Flip node vertically and/or horizontally

Line

this

AbstractLineEditor.flipNodeOrientation

▸ getActiveNode(): Node

Returns the ghost if ghost mode is enabled and initialized and the original node otherwise

Node

AbstractLineEditor.getActiveNode

▸ Protected getActivePlot(): Plot

Gets an active plot

Plot

AbstractLineEditor.getActivePlot

▸ Protected getBboxHandle(eventArgs?): EditHandleId

Returns current bounding box handle if no arguments provided, or bounding box element index that is currently under mouse event, null if nothing is

EditHandleId

AbstractLineEditor.getBboxHandle

▸ getBounds(): Rect

Returns bounds for the bounding box elements

Rect

AbstractLineEditor.getBounds

▸ getClassName(): string

string

AbstractLineEditor.getClassName

▸ Protected getDataLayer(): Node

Gets the edited nodes' parent layer

Node

AbstractLineEditor.getDataLayer

▸ getDeviceTransform(): Transformation

Returns current node-to-device transformation

Transformation

AbstractLineEditor.getDeviceTransform

▸ getEditMode(): EditMode

Returns current edit mode

EditMode

AbstractLineEditor.getEditMode

▸ Protected getEventRadius(eventArgs): number

Returns device radius for the provided event

number

AbstractLineEditor.getEventRadius

▸ Protected getGhost(): Node

Returns the ghost registered with this editor. If ghost does not exist, returns null

Node

AbstractLineEditor.getGhost

▸ getHandlesGroup(): Group<Node&gt;

Returns handles group

Group<Node&gt;

AbstractLineEditor.getHandlesGroup

▸ getHistory(): History

Returns current history

History

AbstractLineEditor.getHistory

▸ Protected getLocalTransform(): Transformation

Returns current node local transformation

Transformation

AbstractLineEditor.getLocalTransform

▸ getManipulatorLayer(): CompositeNode<Node&gt;

return manipulator layer

CompositeNode<Node&gt;

layer

AbstractLineEditor.getManipulatorLayer

▸ getMouseRadius(): number

Returns current device radius for mouse events

number

AbstractLineEditor.getMouseRadius

▸ getName(): string

return tool name if any

string

name of the tool

AbstractLineEditor.getName

▸ getNode(): Line

Returns current node

Line

AbstractLineEditor.getNode

▸ getParentTool(): AbstractCompositeTool

Gets parent tool

AbstractCompositeTool

parent tool

AbstractLineEditor.getParentTool

▸ getProperties(): OptionsOut

Gets properties

OptionsOut

editor properties

AbstractLineEditor.getProperties

▸ getProperty(name): any

Gets dynamic property by name. These properties can be used as a property bags

any

AbstractLineEditor.getProperty

▸ getPropertyKeys(): string[]

Returns known properties keys

string[]

AbstractLineEditor.getPropertyKeys

▸ getRoot(): AbstractCompositeTool

Gets root tool

AbstractCompositeTool

parent tool

AbstractLineEditor.getRoot

▸ getTouchRadius(): number

Returns current device radius for touch events

number

AbstractLineEditor.getTouchRadius

▸ Protected getVisible(): boolean

Gets the edited node visibility state

boolean

AbstractLineEditor.getVisible

▸ hasEventListener(type, callback?): boolean

Check if a list of event listeners for this type contains this listener

boolean

AbstractLineEditor.hasEventListener

▸ Protected initialize(options): void

void

AbstractLineEditor.initialize

▸ isActive(): boolean

return active state

boolean

AbstractLineEditor.isActive

▸ isDisposed(): boolean

Returns whether this object has been disposed

boolean

AbstractLineEditor.isDisposed

▸ Protected isDoubleClick(point, eventArgs?): boolean

returns true if double clicked

boolean

AbstractLineEditor.isDoubleClick

▸ isEnabled(): boolean

returns enable state

boolean

state

AbstractLineEditor.isEnabled

▸ isSilent(): boolean

Return true if the event dispatcher doesn't notify any events

boolean

AbstractLineEditor.isSilent

▸ isStarted(): boolean

Tests if editing was started (editor is active and at least one command was applied)

boolean

AbstractLineEditor.isStarted

▸ Protected isSupported(options): boolean

Checks if editor supports the options provided

boolean

AbstractLineEditor.isSupported

▸ isTouchEvent(eventArgs): boolean

return true if the event is a touch event and false otherwise.

boolean

AbstractLineEditor.isTouchEvent

▸ notify<E&gt;(type, source, args?): Line

Notify listeners

Line

this

AbstractLineEditor.notify

▸ off<E&gt;(type?, callback?): Line

Detach listener on event. Calling .off() with no arguments removes all attached listeners. Calling .off(type) with no callback removes all attached listeners for specific type.

Line

this

AbstractLineEditor.off

▸ on<E&gt;(type, callback): Line

Attach listener on event that will be called whenever the specified event is delivered to the target <p> If the callback function is already in the list of event listeners for this target, the function is not added a second time. </p> <p> If a particular anonymous function is in the list of event listeners registered for a certain target, and then later in the code, an identical anonymous function is given in an "on" call, the second function will also be added to the list of event listeners for that target. </p> TypeScript hint: in case of creating derived tool with own events, EventMap should be extended and .on() and .notify() methods redeclared, see sample.

Example

// Using in derived tool
import type {EventMap as EventMapBase} from '@int/geotoolkit/controls/tools/AbstractTool';
export type EventMap = EventMapBase & {
[MyToolEvents.onValueChanged]: MyToolEventArgs
}
export enum MyToolEvents {
onValueChanged = 'onValueChanged'
}
export class MyTool extends AbstractTool {
public declare on: <E extends keyof EventMap>(type: E, callback: (eventType: E, sender: this, args: EventMap[E]) => void) => this;
protected declare notify: <E extends keyof EventMap>(type: E, source: AbstractTool, args?: EventMap[E]) => this;
public declare off: <E extends keyof EventMap>(type: E, callback?: (eventType: E, sender: this, args: EventMap[E]) => void) => this;
// ...
}

Line

AbstractLineEditor.on

▸ Protected onActiveStateChanged(): void

Fires

Events.onStateChanged

void

AbstractLineEditor.onActiveStateChanged

▸ Protected onBeforeCommandApplied(command): void

Fires the EditEvents.BeforeCommandApplied event

void

AbstractLineEditor.onBeforeCommandApplied

▸ Protected onCommandApplied(command): void

Fires the EditEvents.CommandApplied and the command.getEventName() events

void

AbstractLineEditor.onCommandApplied

▸ Protected onCommandApplying(command): void

Fires the EditEvents.CommandApplying event

void

AbstractLineEditor.onCommandApplying

▸ Protected onCommandRedo(command): void

Fires the EditEvents.Redo event

void

AbstractLineEditor.onCommandRedo

▸ Protected onCommandUndo(command): void

Fires the EditEvents.Undo event

void

AbstractLineEditor.onCommandUndo

▸ Protected onDoubleClick(eventArgs): void

Handles mouse double click event

void

AbstractLineEditor.onDoubleClick

▸ Protected onEnabledStateChanged(): void

Fires

Events.onEnabledStateChanged

void

AbstractLineEditor.onEnabledStateChanged

▸ Protected onKeyDown(eventArgs): void

Handles key down event

void

AbstractLineEditor.onKeyDown

▸ Protected onKeyUp(eventArgs): void

Handles key up event

void

AbstractLineEditor.onKeyUp

▸ Protected onLeave(eventArgs): void

Handles mouse leave event

void

AbstractLineEditor.onLeave

▸ Protected onMouseDown(eventArgs): void

Handles mouse down event

void

AbstractLineEditor.onMouseDown

▸ Protected onMouseMove(eventArgs): void

Handles mouse move event

void

AbstractLineEditor.onMouseMove

▸ Protected onMouseUp(eventArgs): void

Handles mouse up event

void

AbstractLineEditor.onMouseUp

▸ Protected onNodeCreated(node, eventArgs?): void

Fires the EditEvents.End event

void

AbstractLineEditor.onNodeCreated

▸ pageToCanvas(eventArgs, externalPlot?): Object

return position relative to the canvas

Object

AbstractLineEditor.pageToCanvas

▸ pointToModel(model, eventArgs): Point

converts device coordinates to inner coordinates of node

Point

AbstractLineEditor.pointToModel

▸ Protected push(command): Line

Pushes command to the history after applying it and firing the corresponding event

Line

this

AbstractLineEditor.push

▸ redo(): Line

Reapplies last canceled command in history (if possible)

Line

this

AbstractLineEditor.redo

▸ removeListener(eventName, listener?): Line

remove event listener. The listener reveives the message when the system event happens.

Deprecated

since 4.0 use .off() instead.

Line

AbstractLineEditor.removeListener

▸ Protected resetNode(unlink?): Line

Resets current node to the initial state before all the changes were made

Line

this

AbstractLineEditor.resetNode

▸ Protected resetNodeToGhost(): Line

Resets the current node to its ghost state

Line

AbstractLineEditor.resetNodeToGhost

▸ Protected rotateNode(node, angle, hint?): boolean

boolean

AbstractLineEditor.rotateNode

▸ setActive(active): Line

set active state

Fires

Events.onStateChanged

Line

AbstractLineEditor.setActive

▸ setEditMode(mode): Line

Sets edit mode to determine operations that can be applied to the current node. Use bitwise operations for the full customization.

Line

this

AbstractLineEditor.setEditMode

▸ setEnabled(enabled): Line

set enable state

Fires

Events.onEnabledStateChanged

Fires

Events.onStateChanged

Line

this

AbstractLineEditor.setEnabled

▸ Protected setLine(node, from, to): Line

Line

AbstractLineEditor.setLine

▸ setMouseRadius(radius): Line

Sets device radius for mouse events

Line

this

AbstractLineEditor.setMouseRadius

▸ setName(name): Line

set tool name

Line

AbstractLineEditor.setName

▸ Protected setNode(node): Line

Sets node to edit

Line

this

AbstractLineEditor.setNode

▸ Protected setNodeBounds(node, p1, p2, hint?): boolean

boolean

AbstractLineEditor.setNodeBounds

▸ setProperties(properties?): Line

Sets properties to the editing elements

Line

this

AbstractLineEditor.setProperties

▸ setProperty(name, value): Line

Sets dynamic property by name

Line

this

AbstractLineEditor.setProperty

▸ setSilent(bool): Line

Set silent mode

Line

this

AbstractLineEditor.setSilent

▸ setSlotEnabled(eventName, value, target?): Line

Sets slot enabled

Line

AbstractLineEditor.setSlotEnabled

▸ setSlots(slots?, merge?): Line

Sets new slots.

Example

const slots = {
'pointerdown': (event: EventArgs) => {
// event is an instance of @int/geotoolkit/controls/tools/EventArgs
...
}
};
tool.setSlots(slots);

Line

this

AbstractLineEditor.setSlots

▸ setTouchRadius(radius): Line

Sets device radius for touch events

Line

this

AbstractLineEditor.setTouchRadius

▸ Protected start(eventArgs?): Line

start

Line

AbstractLineEditor.start

▸ Protected stop(): Line

stop

Line

AbstractLineEditor.stop

▸ Protected swapActiveHandles(handleId, vertical): EditHandleId

Swaps active handles vertically/horizontally

EditHandleId

swapped handle id

AbstractLineEditor.swapActiveHandles

▸ toggle(): Line

switch enable state to opposite state

Line

AbstractLineEditor.toggle

▸ Protected transformNode(node, tr, hint?): boolean

boolean

AbstractLineEditor.transformNode

▸ Protected translateNode(node, x, y, hint?): boolean

boolean

AbstractLineEditor.translateNode

▸ undo(): Line

Cancels last command in history (if possible)

Line

this

AbstractLineEditor.undo

▸ update(): Line

Forces editing shapes and handles to be updated

Line

this

AbstractLineEditor.update

▸ Protected updateBrowserCursor(eventArgs, cursor?): void

void

AbstractLineEditor.updateBrowserCursor

▸ updateHandles(): Line

Forces editing handles to be updated

Line

this

AbstractLineEditor.updateHandles

▸ Protected updateNodePosition(): void

Updates active node's position if scene transformation was changed but pointer position wasn't

void

AbstractLineEditor.updateNodePosition

▸ Static canvasToClient(plotPoint, plot): Point

Convert plot coordinates to global coordinates

Point

AbstractLineEditor.canvasToClient

▸ Static clientToCanvas(nativeEvent, plot): Point

Convert global coordinates to plot coordinates

Point

AbstractLineEditor.clientToCanvas

▸ Static getClassName(): string

string

AbstractLineEditor.getClassName

▸ Static getExclusiveTool(plot): AbstractTool

return exclusive tool associated with plot

AbstractTool

tool

AbstractLineEditor.getExclusiveTool

▸ Static getNativeEventName(eventName): string[]

Returns native event name

string[]

AbstractLineEditor.getNativeEventName

▸ Static isTouchEvent(eventArgs): eventArgs is TouchEvent

return true if the event is a touch event and false otherwise.

eventArgs is TouchEvent

AbstractLineEditor.isTouchEvent

▸ Static lock(plot, tool): void

Set exclusive tool for plot

void

AbstractLineEditor.lock

▸ Static setDefaultMouseRadius(radius): void

Sets default device radius for mouse events

void

AbstractLineEditor.setDefaultMouseRadius

▸ Static setDefaultTouchRadius(radius): void

Sets default device radius for touch events

void

AbstractLineEditor.setDefaultTouchRadius

▸ Static unlock(value): void

Remove exclusive tool from plot

void

AbstractLineEditor.unlock