Class: PolygonSelection

• new PolygonSelection(options)

• new PolygonSelection(options?)

Paint.constructor

▸ addListener(eventName, listener): PolygonSelection

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)

PolygonSelection

Paint.addListener

▸ canRedo(): boolean

Checks if there is command in history to redo

boolean

Paint.canRedo

▸ canUndo(): boolean

Checks if there is command in history to undo

boolean

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

Paint.captureMouseUp

▸ clear(): PolygonSelection

Clears scene from all the painting elements

PolygonSelection

this

Paint.clear

▸ Protected createEditor(options): AbstractEditorBase<Node | Node[]>

Returns editor to edit node with provided options

Throws

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

AbstractEditorBase<Node | Node[]>

Paint.createEditor

▸ dispose(): void

Dispose tool.

void

Paint.dispose

▸ editNode(node): PolygonSelection

Starts editing the node provided

PolygonSelection

this

Paint.editNode

▸ execute(command): PolygonSelection

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

PolygonSelection

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

Paint.fireEvent

▸ getActiveShape(): Node

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

Node

Paint.getActiveShape

▸ getAllowIntersection(): boolean

Get allow intersection

boolean

will this select items that intersect

▸ getClassName(): string

string

Paint.getClassName

▸ getEditMode(): EditMode

Returns tool current edit mode

EditMode

Paint.getEditMode

▸ getEditor(): Polygon

Returns current editor tool (if exists)

Polygon

Paint.getEditor

▸ getEvenOddMode(): boolean

Get even odd mode

boolean

will this use even odd mode or not

▸ Protected getEventRadius(eventArgs): number

Returns device radius for the provided event

number

Paint.getEventRadius

▸ getHistory(): History

Returns current history

History

Paint.getHistory

▸ getLineStyle(): LineStyle

Return line style

LineStyle

line style

▸ getManipulatorLayer(): CompositeNode<Node>

return manipulator layer

CompositeNode<Node>

layer

Paint.getManipulatorLayer

▸ getMode(): PaintMode

Returns current painting mode

PaintMode

Paint.getMode

▸ getMouseRadius(): number

Returns current device radius for mouse events

number

Paint.getMouseRadius

▸ getName(): string

return tool name if any

string

name of the tool

Paint.getName

▸ getParentTool(): AbstractCompositeTool

Gets parent tool

AbstractCompositeTool

parent tool

Paint.getParentTool

▸ getProperties(): OptionsOut

Returns all properties

OptionsOut

tool options

Paint.getProperties

▸ getProperty(name): any

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

any

Paint.getProperty

▸ getPropertyKeys(): string[]

Returns known properties keys

string[]

Paint.getPropertyKeys

▸ Protected getRegistry(): Registry

Registry

Paint.getRegistry

▸ getRoot(): AbstractCompositeTool

Gets root tool

AbstractCompositeTool

parent tool

Paint.getRoot

▸ getSelection(): (Node | SelectedItem<any>)[]

gets the currently selected items

(Node | SelectedItem<any>)[]

▸ getShape(): Polygon

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

Polygon

Paint.getShape

▸ getTouchRadius(): number

Returns current device radius for touch events

number

Paint.getTouchRadius

▸ hasEventListener(type, callback?): boolean

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

boolean

Paint.hasEventListener

▸ isActive(): boolean

return active state

boolean

Paint.isActive

▸ isAutoDisabled(): boolean

Get auto-disabled mode

boolean

does the selection automatically disable itself on selection changed

▸ isDisposed(): boolean

Returns whether this object has been disposed

boolean

Paint.isDisposed

▸ Protected isDoubleClick(point, eventArgs?): boolean

returns true if double clicked

boolean

Paint.isDoubleClick

▸ isEnabled(): boolean

returns enable state

boolean

state

Paint.isEnabled

▸ isSilent(): boolean

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

boolean

Paint.isSilent

▸ isTouchEvent(eventArgs): boolean

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

boolean

Paint.isTouchEvent

▸ notify<E>(type, source, args?): PolygonSelection

Notify listeners

PolygonSelection

this

Paint.notify

▸ off<E>(type?, callback?): PolygonSelection

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.

PolygonSelection

this

Paint.off

▸ on<E>(type, callback): PolygonSelection

Attach listener on event that will be called whenever the specified event is delivered to the target

If the callback function is already in the list of event listeners for this target, the function is not added a second time.

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.

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

PolygonSelection

Paint.on

▸ Protected onActiveStateChanged(): void

Fires

Events.onStateChanged

void

Paint.onActiveStateChanged

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

Fires the EditEvents.BeforeCommandApplied event

void

Paint.onBeforeCommandApplying

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

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

void

Paint.onCommandApplied

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

Fires the EditEvents.CommandApplying event

void

Paint.onCommandApplying

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

Fires the EditEvents.Redo event

void

Paint.onCommandRedo

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

Fires the EditEvents.Undo event

void

Paint.onCommandUndo

▸ Protected onEnabledStateChanged(): void

Fires

Events.onEnabledStateChanged

void

Paint.onEnabledStateChanged

▸ Protected onKeyDown(eventArgs): void

Handles key down event

void

Paint.onKeyDown

▸ Protected onKeyUp(eventArgs): void

Handles key up event

void

Paint.onKeyUp

▸ Protected onMouseDown(eventArgs): void

void

Paint.onMouseDown

▸ Protected onMouseMove(eventArgs): void

void

Paint.onMouseMove

▸ Protected onMouseUp(eventArgs): void

void

Paint.onMouseUp

▸ Protected onNodeCreated(editor, eventArgs): void

Node created handler

void

Paint.onNodeCreated

▸ pageToCanvas(eventArgs, externalPlot?): Object

return position relative to the canvas

Object

Paint.pageToCanvas

▸ pointToModel(model, eventArgs): Point

converts device coordinates to inner coordinates of node

Point

Paint.pointToModel

▸ redo(): PolygonSelection

Reapplies last canceled command in history (if possible)

PolygonSelection

Paint.redo

▸ removeListener(eventName, listener?): PolygonSelection

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

Deprecated

since 4.0 use .off() instead.

PolygonSelection

Paint.removeListener

▸ setActive(active): PolygonSelection

set active state

Fires

Events.onStateChanged

PolygonSelection

Paint.setActive

▸ setAllowIntersection(mode): PolygonSelection

Set allow intersection

PolygonSelection

this

▸ setAutoDisabled(mode): PolygonSelection

Set auto-disabled mode

PolygonSelection

this

▸ setEditMode(mode): PolygonSelection

Sets tool edit mode (for nodes with node manipulators)

PolygonSelection

this

Paint.setEditMode

▸ Protected setEditor(editor): PolygonSelection

Sets a new editor

Throws

Error if editor is not instance of Polygon

PolygonSelection

Paint.setEditor

▸ setEnabled(enabled): PolygonSelection

set enable state

Fires

Events.onEnabledStateChanged

Fires

Events.onStateChanged

PolygonSelection

this

Paint.setEnabled

▸ setEvenOddMode(mode): PolygonSelection

Set even odd mode

PolygonSelection

this

▸ setFillStyle(fillStyle, merge?): PolygonSelection

Sets fill style

PolygonSelection

this

▸ setLineStyle(lineStyle, merge?): PolygonSelection

Sets line style

PolygonSelection

this

▸ setMode(mode): PolygonSelection

Sets painting mode

PolygonSelection

Paint.setMode

▸ setMouseRadius(radius): PolygonSelection

Sets device radius for mouse events

PolygonSelection

this

Paint.setMouseRadius

▸ setName(name): PolygonSelection

set tool name

PolygonSelection

Paint.setName

▸ setNodeFilter(filter): PolygonSelection

set filter handler

PolygonSelection

this

▸ setProperties(props?): PolygonSelection

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

PolygonSelection

this

Paint.setProperties

▸ setProperty(name, value): PolygonSelection

Sets dynamic property by name

PolygonSelection

this

Paint.setProperty

▸ setSilent(bool): PolygonSelection

Set silent mode

PolygonSelection

this

Paint.setSilent

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

Sets slot enabled

PolygonSelection

Paint.setSlotEnabled

▸ setSlots(slots?, merge?): PolygonSelection

Sets new slots.

Example

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

PolygonSelection

this

Paint.setSlots

▸ setTouchRadius(radius): PolygonSelection

Sets device radius for touch events

PolygonSelection

this

Paint.setTouchRadius

▸ Protected start(eventArgs?): PolygonSelection

start

PolygonSelection

Paint.start

▸ Protected stop(): PolygonSelection

stop

PolygonSelection

Paint.stop

▸ toggle(): PolygonSelection

switch enable state to opposite state

PolygonSelection

Paint.toggle

▸ undo(): PolygonSelection

Cancels last command in history (if possible)

PolygonSelection

Paint.undo

▸ update(): PolygonSelection

Forces editing shapes and handles to be updated

PolygonSelection

this

Paint.update

▸ updateHandles(): PolygonSelection

Forces editing handles to be synchronized with shape

PolygonSelection

this

Paint.updateHandles

▸ Static canvasToClient(plotPoint, plot): Point

Convert plot coordinates to global coordinates

Point

Paint.canvasToClient

▸ Static clientToCanvas(nativeEvent, plot): Point

Convert global coordinates to plot coordinates

Point

Paint.clientToCanvas

▸ Static getClassName(): string

string

Paint.getClassName

▸ Static getExclusiveTool(plot): AbstractTool

return exclusive tool associated with plot

AbstractTool

tool

Paint.getExclusiveTool

▸ Static getNativeEventName(eventName): string[]

Returns native event name

string[]

Paint.getNativeEventName

▸ Static isTouchEvent(eventArgs): eventArgs is TouchEvent

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

eventArgs is TouchEvent

Paint.isTouchEvent

▸ Static lock(plot, tool): void

Set exclusive tool for plot

void

Paint.lock

▸ Static setDefaultMouseRadius(radius): void

Sets default device radius for mouse events

void

Paint.setDefaultMouseRadius

▸ Static setDefaultTouchRadius(radius): void

Sets default device radius for touch events

void

Paint.setDefaultTouchRadius

▸ Static unlock(value): void

Remove exclusive tool from plot

void

Paint.unlock