Class: AbstractCombinedEditor<T>

• new AbstractCombinedEditor&lt;T&amp;gt;(options)

• Protected new AbstractCombinedEditor<T>(options?)

AbstractEditor&lt;T&amp;gt;.constructor

▸ addListener(eventName, listener): AbstractCombinedEditor<T>

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)

AbstractCombinedEditor<T>

AbstractEditor.addListener

▸ apply(command): AbstractCombinedEditor<T>

Applies command to the current node

AbstractCombinedEditor<T>

this

AbstractEditor.apply

▸ Protected canInsert(eventArgs): boolean

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

boolean

AbstractEditor.canInsert

▸ canRedo(): boolean

Checks if there is command in history to redo

boolean

AbstractEditor.canRedo

▸ canUndo(): boolean

Checks if there is command in history to undo

boolean

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

AbstractEditor.captureMouseUp

▸ changeNodeOrder(order, anchor?): AbstractCombinedEditor<T>

changes the z-order of the nodes being rendered.

AbstractCombinedEditor<T>

this

AbstractEditor.changeNodeOrder

▸ Protected createGhost(): Node

Creates a clone of the current node

Node

AbstractEditor.createGhost

▸ deleteNode(trash?, shape?): AbstractCombinedEditor<T>

Delete node or array of nodes to specified trash container

AbstractCombinedEditor<T>

this

AbstractEditor.deleteNode

▸ dispose(): void

Dispose tool.

void

AbstractEditor.dispose

▸ Protected end(eventArgs?): void

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

void

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

AbstractEditor.fireEvent

▸ flipNodeOrientation(flipX, flipY): AbstractCombinedEditor<T>

Flip node vertically and/or horizontally

AbstractCombinedEditor<T>

this

AbstractEditor.flipNodeOrientation

▸ getActiveNode(): Node

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

Node

AbstractEditor.getActiveNode

▸ Protected getActivePlot(): Plot

Gets an active plot

Plot

AbstractEditor.getActivePlot

▸ getAspectRatio(): number

number

▸ 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

AbstractEditor.getBboxHandle

▸ getBounds(): Rect

Returns bounds for the bounding box elements

Rect

AbstractEditor.getBounds

▸ getClassName(): string

string

AbstractEditor.getClassName

▸ Protected getDataLayer(): Node

Gets the edited nodes' parent layer

Node

AbstractEditor.getDataLayer

▸ getDeviceTransform(): Transformation

Returns current node-to-device transformation

Transformation

AbstractEditor.getDeviceTransform

▸ getEditMode(): EditMode

Returns current edit mode

EditMode

AbstractEditor.getEditMode

▸ Protected getEventRadius(eventArgs): number

Returns device radius for the provided event

number

AbstractEditor.getEventRadius

▸ Protected getGhost(): Node

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

Node

AbstractEditor.getGhost

▸ getHandlesGroup(): Group<Node>

Returns handles group

Group<Node>

AbstractEditor.getHandlesGroup

▸ getHistory(): History

Returns current history

History

AbstractEditor.getHistory

▸ Protected getLocalTransform(): Transformation

Returns current node local transformation

Transformation

AbstractEditor.getLocalTransform

▸ getManipulatorLayer(): CompositeNode<Node>

return manipulator layer

CompositeNode<Node>

layer

AbstractEditor.getManipulatorLayer

▸ getMouseRadius(): number

Returns current device radius for mouse events

number

AbstractEditor.getMouseRadius

▸ getName(): string

return tool name if any

string

name of the tool

AbstractEditor.getName

▸ getNode(): T

Returns current node

T

AbstractEditor.getNode

▸ getParentTool(): AbstractCompositeTool

Gets parent tool

AbstractCompositeTool

parent tool

AbstractEditor.getParentTool

▸ getProperties(): OptionsOut

Returns properties

OptionsOut

editor properties

AbstractEditor.getProperties

▸ getProperty(name): any

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

any

AbstractEditor.getProperty

▸ getPropertyKeys(): string[]

Returns known properties keys

string[]

AbstractEditor.getPropertyKeys

▸ getRoot(): AbstractCompositeTool

Gets root tool

AbstractCompositeTool

parent tool

AbstractEditor.getRoot

▸ getTouchRadius(): number

Returns current device radius for touch events

number

AbstractEditor.getTouchRadius

▸ Protected getVisible(): boolean

Gets the edited node visibility state

boolean

AbstractEditor.getVisible

▸ hasEventListener(type, callback?): boolean

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

boolean

AbstractEditor.hasEventListener

▸ Protected initialize(options): void

void

AbstractEditor.initialize

▸ isActive(): boolean

return active state

boolean

AbstractEditor.isActive

▸ isDisposed(): boolean

Returns whether this object has been disposed

boolean

AbstractEditor.isDisposed

▸ Protected isDoubleClick(point, eventArgs?): boolean

returns true if double clicked

boolean

AbstractEditor.isDoubleClick

▸ isEnabled(): boolean

returns enable state

boolean

state

AbstractEditor.isEnabled

▸ isSilent(): boolean

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

boolean

AbstractEditor.isSilent

▸ isStarted(): boolean

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

boolean

AbstractEditor.isStarted

▸ Protected isSupported(options): boolean

Checks if editor supports the options provided

boolean

AbstractEditor.isSupported

▸ isTouchEvent(eventArgs): boolean

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

boolean

AbstractEditor.isTouchEvent

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

Notify listeners

AbstractCombinedEditor<T>

this

AbstractEditor.notify

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

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.

AbstractCombinedEditor<T>

this

AbstractEditor.off

▸ on<E>(type, callback): AbstractCombinedEditor<T>

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

AbstractCombinedEditor<T>

AbstractEditor.on

▸ Protected onActiveStateChanged(): void

Fires

Events.onStateChanged

void

AbstractEditor.onActiveStateChanged

▸ Protected onBeforeCommandApplied(command): void

Fires the EditEvents.BeforeCommandApplied event

void

AbstractEditor.onBeforeCommandApplied

▸ Protected onCommandApplied(command): void

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

void

AbstractEditor.onCommandApplied

▸ Protected onCommandApplying(command): void

Fires the EditEvents.CommandApplying event

void

AbstractEditor.onCommandApplying

▸ Protected onCommandRedo(command): void

Fires the EditEvents.Redo event

void

AbstractEditor.onCommandRedo

▸ Protected onCommandUndo(command): void

Fires the EditEvents.Undo event

void

AbstractEditor.onCommandUndo

▸ Protected onDoubleClick(eventArgs): void

Handles mouse double click event

void

AbstractEditor.onDoubleClick

▸ Protected onEnabledStateChanged(): void

Fires

Events.onEnabledStateChanged

void

AbstractEditor.onEnabledStateChanged

▸ Protected onKeyDown(eventArgs): void

Handles key down event

void

AbstractEditor.onKeyDown

▸ Protected onKeyUp(eventArgs): void

Handles key up event

void

AbstractEditor.onKeyUp

▸ Protected onLeave(eventArgs): void

Handles mouse leave event

void

AbstractEditor.onLeave

▸ Protected onMouseDown(eventArgs): void

Handles mouse down event

void

AbstractEditor.onMouseDown

▸ Protected onMouseMove(eventArgs): void

Handles mouse move event

void

AbstractEditor.onMouseMove

▸ Protected onMouseUp(eventArgs): void

Handles mouse up event

void

AbstractEditor.onMouseUp

▸ Protected onNodeCreated(node, eventArgs?): void

Fires the EditEvents.End event

void

AbstractEditor.onNodeCreated

▸ pageToCanvas(eventArgs, externalPlot?): Object

return position relative to the canvas

Object

AbstractEditor.pageToCanvas

▸ pointToModel(model, eventArgs): Point

converts device coordinates to inner coordinates of node

Point

AbstractEditor.pointToModel

▸ Protected push(command): AbstractCombinedEditor<T>

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

AbstractCombinedEditor<T>

this

AbstractEditor.push

▸ redo(): AbstractCombinedEditor<T>

Reapplies last canceled command in history (if possible)

AbstractCombinedEditor<T>

this

AbstractEditor.redo

▸ removeListener(eventName, listener?): AbstractCombinedEditor<T>

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

Deprecated

since 4.0 use .off() instead.

AbstractCombinedEditor<T>

AbstractEditor.removeListener

▸ Protected resetNode(unlink?): AbstractCombinedEditor<T>

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

AbstractCombinedEditor<T>

this

AbstractEditor.resetNode

▸ Protected resetNodeToGhost(): AbstractCombinedEditor<T>

Resets the current node to its ghost state

AbstractCombinedEditor<T>

AbstractEditor.resetNodeToGhost

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

boolean

AbstractEditor.rotateNode

▸ setActive(active): AbstractCombinedEditor<T>

set active state

Fires

Events.onStateChanged

AbstractCombinedEditor<T>

AbstractEditor.setActive

▸ setEditMode(mode): AbstractCombinedEditor<T>

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

AbstractCombinedEditor<T>

this

AbstractEditor.setEditMode

▸ setEnabled(enabled): AbstractCombinedEditor<T>

set enable state

Fires

Events.onEnabledStateChanged

Fires

Events.onStateChanged

AbstractCombinedEditor<T>

this

AbstractEditor.setEnabled

▸ setMouseRadius(radius): AbstractCombinedEditor<T>

Sets device radius for mouse events

AbstractCombinedEditor<T>

this

AbstractEditor.setMouseRadius

▸ setName(name): AbstractCombinedEditor<T>

set tool name

AbstractCombinedEditor<T>

AbstractEditor.setName

▸ Protected setNode(node): AbstractCombinedEditor<T>

Sets node to edit

AbstractCombinedEditor<T>

this

AbstractEditor.setNode

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

boolean

AbstractEditor.setNodeBounds

▸ setProperties(properties?): AbstractCombinedEditor<T>

Sets properties to the editing elements

AbstractCombinedEditor<T>

this

AbstractEditor.setProperties

▸ setProperty(name, value): AbstractCombinedEditor<T>

Sets dynamic property by name

AbstractCombinedEditor<T>

this

AbstractEditor.setProperty

▸ setSilent(bool): AbstractCombinedEditor<T>

Set silent mode

AbstractCombinedEditor<T>

this

AbstractEditor.setSilent

▸ setSlotEnabled(eventName, value, target?): AbstractCombinedEditor<T>

Sets slot enabled

AbstractCombinedEditor<T>

AbstractEditor.setSlotEnabled

▸ setSlots(slots?, merge?): AbstractCombinedEditor<T>

Sets new slots.

Example

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

AbstractCombinedEditor<T>

this

AbstractEditor.setSlots

▸ setTouchRadius(radius): AbstractCombinedEditor<T>

Sets device radius for touch events

AbstractCombinedEditor<T>

this

AbstractEditor.setTouchRadius

▸ Protected start(eventArgs?): AbstractCombinedEditor<T>

start

AbstractCombinedEditor<T>

AbstractEditor.start

▸ Protected stop(): AbstractCombinedEditor<T>

stop

AbstractCombinedEditor<T>

AbstractEditor.stop

▸ Protected swapActiveHandles(handleId, vertical): EditHandleId

Swaps active handles vertically/horizontally

EditHandleId

swapped handle id

AbstractEditor.swapActiveHandles

▸ toggle(): AbstractCombinedEditor<T>

switch enable state to opposite state

AbstractCombinedEditor<T>

AbstractEditor.toggle

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

boolean

AbstractEditor.transformNode

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

boolean

AbstractEditor.translateNode

▸ undo(): AbstractCombinedEditor<T>

Cancels last command in history (if possible)

AbstractCombinedEditor<T>

this

AbstractEditor.undo

▸ update(): AbstractCombinedEditor<T>

Forces editing shapes and handles to be updated

AbstractCombinedEditor<T>

this

AbstractEditor.update

▸ Protected updateBrowserCursor(eventArgs, cursor?): void

void

AbstractEditor.updateBrowserCursor

▸ updateHandles(): AbstractCombinedEditor<T>

Forces editing handles to be updated

AbstractCombinedEditor<T>

this

AbstractEditor.updateHandles

▸ Protected updateNodePosition(): void

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

void

AbstractEditor.updateNodePosition

▸ Static canvasToClient(plotPoint, plot): Point

Convert plot coordinates to global coordinates

Point

AbstractEditor.canvasToClient

▸ Static clientToCanvas(nativeEvent, plot): Point

Convert global coordinates to plot coordinates

Point

AbstractEditor.clientToCanvas

▸ Static getClassName(): string

string

AbstractEditor.getClassName

▸ Static getExclusiveTool(plot): AbstractTool

return exclusive tool associated with plot

AbstractTool

tool

AbstractEditor.getExclusiveTool

▸ Static getNativeEventName(eventName): string[]

Returns native event name

string[]

AbstractEditor.getNativeEventName

▸ Static isTouchEvent(eventArgs): eventArgs is TouchEvent

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

eventArgs is TouchEvent

AbstractEditor.isTouchEvent

▸ Static lock(plot, tool): void

Set exclusive tool for plot

void

AbstractEditor.lock

▸ Static setDefaultMouseRadius(radius): void

Sets default device radius for mouse events

void

AbstractEditor.setDefaultMouseRadius

▸ Static setDefaultTouchRadius(radius): void

Sets default device radius for touch events

void

AbstractEditor.setDefaultTouchRadius

▸ Static unlock(value): void

Remove exclusive tool from plot

void

AbstractEditor.unlock