Class: PolylineSelection

• [new PolylineSelection(options)](/solutions/geotoolkit/GeoToolkit_JS/apis/classes/geotoolkit.controls.tools.polylineselection.polylineselection.md#new polylineselection(options))

• new PolylineSelection(options?)

AbstractShapeSelection.constructor

▸ addListener(eventName, listener): PolylineSelection

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)

PolylineSelection

AbstractShapeSelection.addListener

▸ canRedo(): boolean

Checks if there is command in history to redo

boolean

AbstractShapeSelection.canRedo

▸ canUndo(): boolean

Checks if there is command in history to undo

boolean

AbstractShapeSelection.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

AbstractShapeSelection.captureMouseUp

▸ clear(): PolylineSelection

Clears scene from all the painting elements

PolylineSelection

this

AbstractShapeSelection.clear

▸ Protected createEditor(options): AbstractEditorBase<Node | Node[]&gt;

Returns editor to edit node with provided options

Throws

if supported editor was not found and default editor was not set

AbstractEditorBase<Node | Node[]&gt;

AbstractShapeSelection.createEditor

▸ Protected createShapeSelectionEventArgs(eventArgs, selection, coordinates): PolylineSelectionEventArgs

PolylineSelectionEventArgs

AbstractShapeSelection.createShapeSelectionEventArgs

▸ dispose(): void

Dispose tool.

void

AbstractShapeSelection.dispose

▸ editNode(node): PolylineSelection

Starts editing the node provided

PolylineSelection

this

AbstractShapeSelection.editNode

▸ execute(command): PolylineSelection

Applies the specified command to the associated node and appends it to history

PolylineSelection

AbstractShapeSelection.execute

▸ 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

AbstractShapeSelection.fireEvent

▸ getActiveShape(): Node

Returns currently edited shape. Relevant for EditMode.Ghost mode.

Node

AbstractShapeSelection.getActiveShape

▸ getAllowIntersection(): boolean

Get allow intersection

boolean

will this select items that intersect

AbstractShapeSelection.getAllowIntersection

▸ getClassName(): string

string

AbstractShapeSelection.getClassName

▸ getEditMode(): EditMode

Returns tool current edit mode

EditMode

AbstractShapeSelection.getEditMode

▸ getEditor(): Polyline

Returns current editor tool (if exists)

Polyline

AbstractShapeSelection.getEditor

▸ getEvenOddMode(): boolean

Get even odd mode

boolean

will this use even odd mode or not

AbstractShapeSelection.getEvenOddMode

▸ Protected getEventRadius(eventArgs): number

Returns device radius for the provided event

number

AbstractShapeSelection.getEventRadius

▸ getFillStyle(): FillStyle

Return fill style

FillStyle

fill style

AbstractShapeSelection.getFillStyle

▸ getHistory(): History

Returns current history

History

AbstractShapeSelection.getHistory

▸ getLineStyle(): LineStyle

Return line style

LineStyle

line style

AbstractShapeSelection.getLineStyle

▸ getManipulatorLayer(): CompositeNode<Node&gt;

return manipulator layer

CompositeNode<Node&gt;

layer

AbstractShapeSelection.getManipulatorLayer

▸ getMode(): PaintMode

Returns current painting mode

PaintMode

AbstractShapeSelection.getMode

▸ getMouseRadius(): number

Returns current device radius for mouse events

number

AbstractShapeSelection.getMouseRadius

▸ getName(): string

return tool name if any

string

name of the tool

AbstractShapeSelection.getName

▸ getParentTool(): AbstractCompositeTool

Gets parent tool

AbstractCompositeTool

parent tool

AbstractShapeSelection.getParentTool

▸ getProperties(): OptionsOut

Returns all properties

OptionsOut

tool options

AbstractShapeSelection.getProperties

▸ getProperty(name): any

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

any

AbstractShapeSelection.getProperty

▸ getPropertyKeys(): string[]

Returns known properties keys

string[]

AbstractShapeSelection.getPropertyKeys

▸ Protected getRegistry(): Registry

Registry

AbstractShapeSelection.getRegistry

▸ getRoot(): AbstractCompositeTool

Gets root tool

AbstractCompositeTool

parent tool

AbstractShapeSelection.getRoot

▸ getSelection(): (Node | SelectedItem<any&gt;)[]

gets the currently selected items

(Node | SelectedItem<any&gt;)[]

AbstractShapeSelection.getSelection

▸ getShape(): Polyline

Returns the origin of currently edited shape (if exists, null otherwise).

Polyline

AbstractShapeSelection.getShape

▸ getTouchRadius(): number

Returns current device radius for touch events

number

AbstractShapeSelection.getTouchRadius

▸ hasEventListener(type, callback?): boolean

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

boolean

AbstractShapeSelection.hasEventListener

▸ isActive(): boolean

return active state

boolean

AbstractShapeSelection.isActive

▸ isAutoDisabled(): boolean

Get auto-disabled mode

boolean

does the selection automatically disable itself on selection changed

AbstractShapeSelection.isAutoDisabled

▸ isDisposed(): boolean

Returns whether this object has been disposed

boolean

AbstractShapeSelection.isDisposed

▸ Protected isDoubleClick(point, eventArgs?): boolean

returns true if double clicked

boolean

AbstractShapeSelection.isDoubleClick

▸ isEnabled(): boolean

returns enable state

boolean

state

AbstractShapeSelection.isEnabled

▸ isSilent(): boolean

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

boolean

AbstractShapeSelection.isSilent

▸ isTouchEvent(eventArgs): boolean

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

boolean

AbstractShapeSelection.isTouchEvent

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

Notify listeners

PolylineSelection

this

AbstractShapeSelection.notify

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

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.

PolylineSelection

this

AbstractShapeSelection.off

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

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;
// ...
}

PolylineSelection

AbstractShapeSelection.on

▸ Protected onActiveStateChanged(): void

Fires

Events.onStateChanged

void

AbstractShapeSelection.onActiveStateChanged

▸ Protected onBeforeCommandApplying(eventName, history, command): void

Fires the EditEvents.BeforeCommandApplied event

void

AbstractShapeSelection.onBeforeCommandApplying

▸ Protected onCommandApplied(eventName, history, command): void

Fires the EditEvents.CommandApplied event and the event according to the command event name

void

AbstractShapeSelection.onCommandApplied

▸ Protected onCommandApplying(eventName, history, command): void

Fires the EditEvents.CommandApplying event

void

AbstractShapeSelection.onCommandApplying

▸ Protected onCommandRedo(eventName, history, command): void

Fires the EditEvents.Redo event

void

AbstractShapeSelection.onCommandRedo

▸ Protected onCommandUndo(eventName, history, command): void

Fires the EditEvents.Undo event

void

AbstractShapeSelection.onCommandUndo

▸ Protected onEnabledStateChanged(): void

Fires

Events.onEnabledStateChanged

void

AbstractShapeSelection.onEnabledStateChanged

▸ Protected onKeyDown(eventArgs): void

Handles key down event

void

AbstractShapeSelection.onKeyDown

▸ Protected onKeyUp(eventArgs): void

Handles key up event

void

AbstractShapeSelection.onKeyUp

▸ Protected onMouseDown(eventArgs): void

void

AbstractShapeSelection.onMouseDown

▸ Protected onMouseMove(eventArgs): void

void

AbstractShapeSelection.onMouseMove

▸ Protected onMouseUp(eventArgs): void

void

AbstractShapeSelection.onMouseUp

▸ Protected onNodeCreated(editor, eventArgs): void

Node created handler

void

AbstractShapeSelection.onNodeCreated

▸ pageToCanvas(eventArgs, externalPlot?): Object

return position relative to the canvas

Object

AbstractShapeSelection.pageToCanvas

▸ pointToModel(model, eventArgs): Point

converts device coordinates to inner coordinates of node

Point

AbstractShapeSelection.pointToModel

▸ redo(): PolylineSelection

Reapplies last canceled command in history (if possible)

PolylineSelection

AbstractShapeSelection.redo

▸ removeListener(eventName, listener?): PolylineSelection

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

Deprecated

since 4.0 use .off() instead.

PolylineSelection

AbstractShapeSelection.removeListener

▸ Protected selection(root, x, y, eventArgs): PolylineSelection

starts the selection process

PolylineSelection

this

AbstractShapeSelection.selection

▸ setActive(active): PolylineSelection

set active state

Fires

Events.onStateChanged

PolylineSelection

AbstractShapeSelection.setActive

▸ setAllowIntersection(mode): PolylineSelection

Set allow intersection

PolylineSelection

this

AbstractShapeSelection.setAllowIntersection

▸ setAutoDisabled(mode): PolylineSelection

Set auto-disabled mode

PolylineSelection

this

AbstractShapeSelection.setAutoDisabled

▸ setEditMode(mode): PolylineSelection

Sets tool edit mode (for nodes with node manipulators)

PolylineSelection

this

AbstractShapeSelection.setEditMode

▸ Protected setEditor(editor): PolylineSelection

Sets a new editor

Throws

Error if editor is not instance of Polyline

PolylineSelection

AbstractShapeSelection.setEditor

▸ setEnabled(enabled): PolylineSelection

set enable state

Fires

Events.onEnabledStateChanged

Fires

Events.onStateChanged

PolylineSelection

this

AbstractShapeSelection.setEnabled

▸ setEvenOddMode(mode): PolylineSelection

Set even odd mode

PolylineSelection

this

AbstractShapeSelection.setEvenOddMode

▸ setFillStyle(fillStyle, merge?): PolylineSelection

Sets fill style

PolylineSelection

this

AbstractShapeSelection.setFillStyle

▸ setLineStyle(fillStyle, merge?): PolylineSelection

Sets line style

PolylineSelection

this

AbstractShapeSelection.setLineStyle

▸ setMode(mode): PolylineSelection

Sets painting mode

PolylineSelection

AbstractShapeSelection.setMode

▸ setMouseRadius(radius): PolylineSelection

Sets device radius for mouse events

PolylineSelection

this

AbstractShapeSelection.setMouseRadius

▸ setName(name): PolylineSelection

set tool name

PolylineSelection

AbstractShapeSelection.setName

▸ setNodeFilter(filter): PolylineSelection

set filter handler

PolylineSelection

this

AbstractShapeSelection.setNodeFilter

▸ setProperties(props?): PolylineSelection

Sets paint tool properties (mode, styles, etc.)

PolylineSelection

this

AbstractShapeSelection.setProperties

▸ setProperty(name, value): PolylineSelection

Sets dynamic property by name

PolylineSelection

this

AbstractShapeSelection.setProperty

▸ setSilent(bool): PolylineSelection

Set silent mode

PolylineSelection

this

AbstractShapeSelection.setSilent

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

Sets slot enabled

PolylineSelection

AbstractShapeSelection.setSlotEnabled

▸ setSlots(slots?, merge?): PolylineSelection

Sets new slots.

Example

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

PolylineSelection

this

AbstractShapeSelection.setSlots

▸ setTouchRadius(radius): PolylineSelection

Sets device radius for touch events

PolylineSelection

this

AbstractShapeSelection.setTouchRadius

▸ Protected start(eventArgs?): PolylineSelection

start

PolylineSelection

AbstractShapeSelection.start

▸ Protected stop(): PolylineSelection

stop

PolylineSelection

AbstractShapeSelection.stop

▸ toggle(): PolylineSelection

switch enable state to opposite state

PolylineSelection

AbstractShapeSelection.toggle

▸ undo(): PolylineSelection

Cancels last command in history (if possible)

PolylineSelection

AbstractShapeSelection.undo

▸ update(): PolylineSelection

Forces editing shapes and handles to be updated

PolylineSelection

this

AbstractShapeSelection.update

▸ updateHandles(): PolylineSelection

Forces editing handles to be synchronized with shape

PolylineSelection

this

AbstractShapeSelection.updateHandles

▸ Static canvasToClient(plotPoint, plot): Point

Convert plot coordinates to global coordinates

Point

AbstractShapeSelection.canvasToClient

▸ Static clientToCanvas(nativeEvent, plot): Point

Convert global coordinates to plot coordinates

Point

AbstractShapeSelection.clientToCanvas

▸ Static getClassName(): string

string

AbstractShapeSelection.getClassName

▸ Static getExclusiveTool(plot): AbstractTool

return exclusive tool associated with plot

AbstractTool

tool

AbstractShapeSelection.getExclusiveTool

▸ Static getNativeEventName(eventName): string[]

Returns native event name

string[]

AbstractShapeSelection.getNativeEventName

▸ Static isTouchEvent(eventArgs): eventArgs is TouchEvent

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

eventArgs is TouchEvent

AbstractShapeSelection.isTouchEvent

▸ Static lock(plot, tool): void

Set exclusive tool for plot

void

AbstractShapeSelection.lock

▸ Static setDefaultMouseRadius(radius): void

Sets default device radius for mouse events

void

AbstractShapeSelection.setDefaultMouseRadius

▸ Static setDefaultTouchRadius(radius): void

Sets default device radius for touch events

void

AbstractShapeSelection.setDefaultTouchRadius

▸ Static unlock(value): void

Remove exclusive tool from plot

void

AbstractShapeSelection.unlock