Class: AbstractLogVisualEditingTool

• new AbstractLogVisualEditingTool(options, name)

• Protected new AbstractLogVisualEditingTool(options?, name?)

Creates a new instance of AbstractLogVisualEditingTool class

AbstractTool.constructor

▸ Protected addHandle(handle): AbstractLogVisualEditingTool

Add editor handle

AbstractLogVisualEditingTool

this

▸ addListener(eventName, listener): AbstractLogVisualEditingTool

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)

AbstractLogVisualEditingTool

AbstractTool.addListener

▸ 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

AbstractTool.captureMouseUp

▸ dispose(): void

Dispose tool.

void

AbstractTool.dispose

▸ 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

AbstractTool.fireEvent

▸ getActiveHandle(): GhostBearingHandle

Returns currently active handle,if exists, otherwise null

GhostBearingHandle

▸ getCachedManipulatorLayer(): CompositeNode<Node>

Gets the manipulator layer with contains handles

Deprecated

since 4.0. Use AbstractLogVisualEditingTool#getManipulatorLayer instead

CompositeNode<Node>

▸ getClassName(): string

string

AbstractTool.getClassName

▸ Protected getDeviceXY(args): Point

Returns a point in model coordinates, edits one of the util points

Point

▸ Protected getEventRadius(eventArgs): number

Returns device radius for the provided event

number

AbstractTool.getEventRadius

▸ Protected getHandle(index): GhostBearingHandle

GhostBearingHandle

▸ getHandlePainter(): Painter

Gets the shape painter with which is used to render handles. Format is the same as in SymbolShape Redraws all handles

Painter

painter

▸ getHandleSize(): number

Get the size of the handles

number

▸ getHandleStyles(): HandleStylesOut

Returns registered styles for active, inactive, and ghost states of all handles

HandleStylesOut

object containing stylings for different types of handle states

▸ Protected getHandlesCount(): number

Return number of handles

number

number of handles

▸ getHideGhostOnDrop(): boolean

Gets a flag defining if the ghost should be reset after it has been dropped

boolean

▸ getManipulatorLayer(): CompositeNode<Node>

return manipulator layer

CompositeNode<Node>

layer

AbstractTool.getManipulatorLayer

▸ getMouseRadius(): number

Returns current device radius for mouse events

number

AbstractTool.getMouseRadius

▸ getName(): string

return tool name if any

string

name of the tool

AbstractTool.getName

▸ getParentTool(): AbstractCompositeTool

Gets parent tool

AbstractCompositeTool

parent tool

AbstractTool.getParentTool

▸ getPosition(): Point

Returns the last registered position of the mouse in device space

Point

▸ getProperties(): OptionsOut

Returns all the properties pertaining to this object

OptionsOut

An object containing the properties

AbstractTool.getProperties

▸ getProperty(name): any

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

any

AbstractTool.getProperty

▸ getPropertyKeys(): string[]

Returns known properties keys

string[]

AbstractTool.getPropertyKeys

▸ getRoot(): AbstractCompositeTool

Gets root tool

AbstractCompositeTool

parent tool

AbstractTool.getRoot

▸ getShape(): Node

Returns the shape which this tool is manipulating

Node

▸ getShowGhost(): boolean

Returns the flag defining if a ghost should be moved instead of the actual object

boolean

showGhost Show ghost flag

▸ getTouchRadius(): number

Returns current device radius for touch events

number

AbstractTool.getTouchRadius

▸ hasEventListener(type, callback?): boolean

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

boolean

AbstractTool.hasEventListener

▸ isActive(): boolean

return active state

boolean

AbstractTool.isActive

▸ isDisposed(): boolean

Returns whether this object has been disposed

boolean

AbstractTool.isDisposed

▸ Protected isDoubleClick(point, eventArgs?): boolean

returns true if double clicked

boolean

AbstractTool.isDoubleClick

▸ isEnabled(): boolean

returns enable state

boolean

state

AbstractTool.isEnabled

▸ isSilent(): boolean

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

boolean

AbstractTool.isSilent

▸ isTouchEvent(eventArgs): boolean

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

boolean

AbstractTool.isTouchEvent

▸ Protected makeSelection(x, y): Node[]

Makes a selection according to current position of the pointer

Node[]

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

Notify listeners

AbstractLogVisualEditingTool

this

AbstractTool.notify

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

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.

AbstractLogVisualEditingTool

this

AbstractTool.off

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

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

AbstractLogVisualEditingTool

AbstractTool.on

▸ Protected onActiveStateChanged(): void

Fires

Events.onStateChanged

void

AbstractTool.onActiveStateChanged

▸ Protected onEnabledStateChanged(): void

Called when the tool is enabled or disabled

void

AbstractTool.onEnabledStateChanged

▸ Abstract onMouseDown(eventArgs): void

Handles the event caused by user pressing the mouse button

void

▸ Abstract onMouseMove(eventArgs): void

Handles the event caused by user moving the mouse

void

▸ Abstract onMouseUp(eventArgs): void

Handles the event caused by user releasing the mouse button

void

▸ pageToCanvas(eventArgs, externalPlot?): Object

return position relative to the canvas

Object

AbstractTool.pageToCanvas

▸ pointToModel(model, eventArgs): Point

converts device coordinates to inner coordinates of node

Point

AbstractTool.pointToModel

▸ Protected removeHandle(handle, disposeHandles?): AbstractLogVisualEditingTool

Remove handles

AbstractLogVisualEditingTool

this

▸ removeListener(eventName, listener?): AbstractLogVisualEditingTool

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

Deprecated

since 4.0 use .off() instead.

AbstractLogVisualEditingTool

AbstractTool.removeListener

▸ setActive(active): AbstractLogVisualEditingTool

set active state

Fires

Events.onStateChanged

AbstractLogVisualEditingTool

AbstractTool.setActive

▸ setActiveHandle(handle): AbstractLogVisualEditingTool

Sets the handle currently active

AbstractLogVisualEditingTool

▸ setEnabled(enabled): AbstractLogVisualEditingTool

set enable state

Fires

Events.onEnabledStateChanged

Fires

Events.onStateChanged

AbstractLogVisualEditingTool

this

AbstractTool.setEnabled

▸ setHandlePainter(painter): AbstractLogVisualEditingTool

Sets the shape painter with which the handles will be drawn. Format is the same as in geotoolkit.scene.shapes.SymbolShape Redraws all handles

AbstractLogVisualEditingTool

▸ setHandleSize(size): AbstractLogVisualEditingTool

Sets the pixel side of the handles to which a size is applicable (anchored handles)

AbstractLogVisualEditingTool

▸ setHandleStyles(styles): AbstractLogVisualEditingTool

Sets styles for active, inactive, and ghost states of all handles, and redraws each handle (this will lose edited handles position)

AbstractLogVisualEditingTool

▸ Protected setHandlesVisible(visible): AbstractLogVisualEditingTool

Iterates through handles and sets the provided visibility. If the visibility is to hide, hides the ghosts as well

AbstractLogVisualEditingTool

▸ setHideGhostOnDrop(hide): AbstractLogVisualEditingTool

Gets a flag defining if the ghost should be reset after it has been dropped

AbstractLogVisualEditingTool

▸ setMouseRadius(radius): AbstractLogVisualEditingTool

Sets device radius for mouse events

AbstractLogVisualEditingTool

this

AbstractTool.setMouseRadius

▸ setName(name): AbstractLogVisualEditingTool

set tool name

AbstractLogVisualEditingTool

AbstractTool.setName

▸ setPosition(x, y): AbstractLogVisualEditingTool

Sets the last registered position of the mouse in device space

AbstractLogVisualEditingTool

▸ setProperties(properties?): AbstractLogVisualEditingTool

Sets all the properties pertaining to this object

AbstractLogVisualEditingTool

this

AbstractTool.setProperties

▸ setProperty(name, value): AbstractLogVisualEditingTool

Sets dynamic property by name

AbstractLogVisualEditingTool

this

AbstractTool.setProperty

▸ setShape(shape): AbstractLogVisualEditingTool

Sets the shape which this tool has to manipulate and calculate its handles from.

AbstractLogVisualEditingTool

▸ setShowGhost(showGhost): AbstractLogVisualEditingTool

Sets the flag defining if a ghost should be moved instead of the actual handle

AbstractLogVisualEditingTool

▸ setSilent(bool): AbstractLogVisualEditingTool

Set silent mode

AbstractLogVisualEditingTool

this

AbstractTool.setSilent

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

Sets slot enabled

AbstractLogVisualEditingTool

AbstractTool.setSlotEnabled

▸ setSlots(slots?, merge?): AbstractLogVisualEditingTool

Sets new slots.

Example

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

AbstractLogVisualEditingTool

this

AbstractTool.setSlots

▸ setTouchRadius(radius): AbstractLogVisualEditingTool

Sets device radius for touch events

AbstractLogVisualEditingTool

this

AbstractTool.setTouchRadius

▸ Protected start(eventArgs?): AbstractLogVisualEditingTool

start

AbstractLogVisualEditingTool

AbstractTool.start

▸ Protected stop(): AbstractLogVisualEditingTool

stop

AbstractLogVisualEditingTool

AbstractTool.stop

▸ toggle(): AbstractLogVisualEditingTool

switch enable state to opposite state

AbstractLogVisualEditingTool

AbstractTool.toggle

▸ Abstract update(forceUpdateShape?): void

Updates tool

void

▸ Static canvasToClient(plotPoint, plot): Point

Convert plot coordinates to global coordinates

Point

AbstractTool.canvasToClient

▸ Static clientToCanvas(nativeEvent, plot): Point

Convert global coordinates to plot coordinates

Point

AbstractTool.clientToCanvas

▸ Static getClassName(): string

string

AbstractTool.getClassName

▸ Static getExclusiveTool(plot): AbstractTool

return exclusive tool associated with plot

AbstractTool

tool

AbstractTool.getExclusiveTool

▸ Static getNativeEventName(eventName): string[]

Returns native event name

string[]

AbstractTool.getNativeEventName

▸ Static isTouchEvent(eventArgs): eventArgs is TouchEvent

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

eventArgs is TouchEvent

AbstractTool.isTouchEvent

▸ Static lock(plot, tool): void

Set exclusive tool for plot

void

AbstractTool.lock

▸ Static setDefaultMouseRadius(radius): void

Sets default device radius for mouse events

void

AbstractTool.setDefaultMouseRadius

▸ Static setDefaultTouchRadius(radius): void

Sets default device radius for touch events

void

AbstractTool.setDefaultTouchRadius

▸ Static unlock(value): void

Remove exclusive tool from plot

void

AbstractTool.unlock