Class: Paint

• new Paint(options)

• new Paint(options?)

Creates paint tool

AbstractEditingTool.constructor

▸ addListener(eventName, listener): Paint

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)

Paint

AbstractEditingTool.addListener

▸ canRedo(): boolean

Checks if there is command in history to redo

boolean

AbstractEditingTool.canRedo

▸ canUndo(): boolean

Checks if there is command in history to undo

boolean

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

AbstractEditingTool.captureMouseUp

▸ clear(): Paint

Clears scene from all the painting elements

Paint

this

▸ 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[]>

AbstractEditingTool.createEditor

▸ dispose(): void

Dispose tool.

void

AbstractEditingTool.dispose

▸ editNode(node): Paint

Starts editing the node provided

Paint

this

AbstractEditingTool.editNode

▸ execute(command): Paint

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

Paint

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

AbstractEditingTool.fireEvent

▸ getActiveShape(): Node

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

Node

AbstractEditingTool.getActiveShape

▸ getClassName(): string

string

AbstractEditingTool.getClassName

▸ getEditMode(): EditMode

Returns tool current edit mode

EditMode

AbstractEditingTool.getEditMode

▸ getEditor(): AbstractEditorBase<Node | Node[]>

Returns current editor tool (if exists)

AbstractEditorBase<Node | Node[]>

AbstractEditingTool.getEditor

▸ Protected getEventRadius(eventArgs): number

Returns device radius for the provided event

number

AbstractEditingTool.getEventRadius

▸ getHistory(): History

Returns current history

History

AbstractEditingTool.getHistory

▸ getManipulatorLayer(): CompositeNode<Node>

return manipulator layer

CompositeNode<Node>

layer

AbstractEditingTool.getManipulatorLayer

▸ getMode(): PaintMode

Returns current painting mode

PaintMode

▸ getMouseRadius(): number

Returns current device radius for mouse events

number

AbstractEditingTool.getMouseRadius

▸ getName(): string

return tool name if any

string

name of the tool

AbstractEditingTool.getName

▸ getParentTool(): AbstractCompositeTool

Gets parent tool

AbstractCompositeTool

parent tool

AbstractEditingTool.getParentTool

▸ getProperties(): OptionsOut

Returns all properties

OptionsOut

tool options

AbstractEditingTool.getProperties

▸ getProperty(name): any

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

any

AbstractEditingTool.getProperty

▸ getPropertyKeys(): string[]

Returns known properties keys

string[]

AbstractEditingTool.getPropertyKeys

▸ Protected getRegistry(): Registry

Registry

AbstractEditingTool.getRegistry

▸ getRoot(): AbstractCompositeTool

Gets root tool

AbstractCompositeTool

parent tool

AbstractEditingTool.getRoot

▸ getShape(): Node | Node[]

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

Node | Node[]

AbstractEditingTool.getShape

▸ getTouchRadius(): number

Returns current device radius for touch events

number

AbstractEditingTool.getTouchRadius

▸ hasEventListener(type, callback?): boolean

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

boolean

AbstractEditingTool.hasEventListener

▸ isActive(): boolean

return active state

boolean

AbstractEditingTool.isActive

▸ isDisposed(): boolean

Returns whether this object has been disposed

boolean

AbstractEditingTool.isDisposed

▸ Protected isDoubleClick(point, eventArgs?): boolean

returns true if double clicked

boolean

AbstractEditingTool.isDoubleClick

▸ isEnabled(): boolean

returns enable state

boolean

state

AbstractEditingTool.isEnabled

▸ isSilent(): boolean

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

boolean

AbstractEditingTool.isSilent

▸ isTouchEvent(eventArgs): boolean

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

boolean

AbstractEditingTool.isTouchEvent

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

Notify listeners

Paint

this

AbstractEditingTool.notify

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

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.

Paint

this

AbstractEditingTool.off

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

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

Paint

AbstractEditingTool.on

▸ Protected onActiveStateChanged(): void

Fires

Events.onStateChanged

void

AbstractEditingTool.onActiveStateChanged

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

Fires the EditEvents.BeforeCommandApplied event

void

AbstractEditingTool.onBeforeCommandApplying

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

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

void

AbstractEditingTool.onCommandApplied

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

Fires the EditEvents.CommandApplying event

void

AbstractEditingTool.onCommandApplying

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

Fires the EditEvents.Redo event

void

AbstractEditingTool.onCommandRedo

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

Fires the EditEvents.Undo event

void

AbstractEditingTool.onCommandUndo

▸ Protected onEnabledStateChanged(): void

Fires

Events.onEnabledStateChanged

void

AbstractEditingTool.onEnabledStateChanged

▸ Protected onKeyDown(eventArgs): void

Handles key down event

void

AbstractEditingTool.onKeyDown

▸ Protected onKeyUp(eventArgs): void

Handles key up event

void

AbstractEditingTool.onKeyUp

▸ Protected onMouseDown(eventArgs): void

void

AbstractEditingTool.onMouseDown

▸ Protected onMouseMove(eventArgs): void

void

AbstractEditingTool.onMouseMove

▸ Protected onMouseUp(eventArgs): void

void

AbstractEditingTool.onMouseUp

▸ Protected onNodeCreated(editor, eventArgs): void

Node created handler

void

AbstractEditingTool.onNodeCreated

▸ pageToCanvas(eventArgs, externalPlot?): Object

return position relative to the canvas

Object

AbstractEditingTool.pageToCanvas

▸ pointToModel(model, eventArgs): Point

converts device coordinates to inner coordinates of node

Point

AbstractEditingTool.pointToModel

▸ redo(): Paint

Reapplies last canceled command in history (if possible)

Paint

AbstractEditingTool.redo

▸ removeListener(eventName, listener?): Paint

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

Deprecated

since 4.0 use .off() instead.

Paint

AbstractEditingTool.removeListener

▸ setActive(active): Paint

set active state

Fires

Events.onStateChanged

Paint

AbstractEditingTool.setActive

▸ setEditMode(mode): Paint

Sets tool edit mode (for nodes with node manipulators)

Paint

this

AbstractEditingTool.setEditMode

▸ Protected setEditor(editor): Paint

For internal use

Paint

this

AbstractEditingTool.setEditor

▸ setEnabled(enabled): Paint

set enable state

Fires

Events.onEnabledStateChanged

Fires

Events.onStateChanged

Paint

this

AbstractEditingTool.setEnabled

▸ setMode(mode): Paint

Sets painting mode

Paint

▸ setMouseRadius(radius): Paint

Sets device radius for mouse events

Paint

this

AbstractEditingTool.setMouseRadius

▸ setName(name): Paint

set tool name

Paint

AbstractEditingTool.setName

▸ setProperties(props?): Paint

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

Paint

this

AbstractEditingTool.setProperties

▸ setProperty(name, value): Paint

Sets dynamic property by name

Paint

this

AbstractEditingTool.setProperty

▸ setSilent(bool): Paint

Set silent mode

Paint

this

AbstractEditingTool.setSilent

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

Sets slot enabled

Paint

AbstractEditingTool.setSlotEnabled

▸ setSlots(slots?, merge?): Paint

Sets new slots.

Example

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

Paint

this

AbstractEditingTool.setSlots

▸ setTouchRadius(radius): Paint

Sets device radius for touch events

Paint

this

AbstractEditingTool.setTouchRadius

▸ Protected start(eventArgs?): Paint

start

Paint

AbstractEditingTool.start

▸ Protected stop(): Paint

stop

Paint

AbstractEditingTool.stop

▸ toggle(): Paint

switch enable state to opposite state

Paint

AbstractEditingTool.toggle

▸ undo(): Paint

Cancels last command in history (if possible)

Paint

AbstractEditingTool.undo

▸ update(): Paint

Forces editing shapes and handles to be updated

Paint

this

AbstractEditingTool.update

▸ updateHandles(): Paint

Forces editing handles to be synchronized with shape

Paint

this

AbstractEditingTool.updateHandles

▸ Static canvasToClient(plotPoint, plot): Point

Convert plot coordinates to global coordinates

Point

AbstractEditingTool.canvasToClient

▸ Static clientToCanvas(nativeEvent, plot): Point

Convert global coordinates to plot coordinates

Point

AbstractEditingTool.clientToCanvas

▸ Static getClassName(): string

string

AbstractEditingTool.getClassName

▸ Static getExclusiveTool(plot): AbstractTool

return exclusive tool associated with plot

AbstractTool

tool

AbstractEditingTool.getExclusiveTool

▸ Static getNativeEventName(eventName): string[]

Returns native event name

string[]

AbstractEditingTool.getNativeEventName

▸ Static isTouchEvent(eventArgs): eventArgs is TouchEvent

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

eventArgs is TouchEvent

AbstractEditingTool.isTouchEvent

▸ Static lock(plot, tool): void

Set exclusive tool for plot

void

AbstractEditingTool.lock

▸ Static setDefaultMouseRadius(radius): void

Sets default device radius for mouse events

void

AbstractEditingTool.setDefaultMouseRadius

▸ Static setDefaultTouchRadius(radius): void

Sets default device radius for touch events

void

AbstractEditingTool.setDefaultTouchRadius

▸ Static unlock(value): void

Remove exclusive tool from plot

void

AbstractEditingTool.unlock