Class: Callout

• [new Callout(options)](/solutions/geotoolkit/GeoToolkit_JS/apis/classes/geotoolkit.controls.tools.editors.callout.callout.md#new callout(options))

• new Callout(options?)

AbstractTextEditor<CalloutShape>.constructor

▸ addListener(eventName, listener): Callout

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)

Callout

AbstractTextEditor.addListener

▸ apply(command): Callout

Applies command to the current node

Callout

this

AbstractTextEditor.apply

▸ Protected canInsert(eventArgs): boolean

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

boolean

AbstractTextEditor.canInsert

▸ canRedo(): boolean

Checks if there is command in history to redo

boolean

AbstractTextEditor.canRedo

▸ canUndo(): boolean

Checks if there is command in history to undo

boolean

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

AbstractTextEditor.captureMouseUp

▸ changeNodeOrder(order, anchor?): Callout

changes the z-order of the nodes being rendered.

Callout

this

AbstractTextEditor.changeNodeOrder

▸ Protected createGhost(): Node

Creates a clone of the current node

Node

AbstractTextEditor.createGhost

▸ Protected createTextOnClick(eventArgs): void

Creates shape basing on user click event and default text sizes

void

AbstractTextEditor.createTextOnClick

▸ deleteNode(trash?, shape?): Callout

Delete node or array of nodes to specified trash container

Callout

this

AbstractTextEditor.deleteNode

▸ dispose(): void

Dispose tool.

void

AbstractTextEditor.dispose

▸ Protected end(eventArgs): void | Callout

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

void | Callout

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

AbstractTextEditor.fireEvent

▸ flipNodeOrientation(flipX, flipY): Callout

Flip node vertically and/or horizontally

Callout

this

AbstractTextEditor.flipNodeOrientation

▸ getActiveNode(): Node

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

Node

AbstractTextEditor.getActiveNode

▸ Protected getActivePlot(): Plot

Gets an active plot

Plot

AbstractTextEditor.getActivePlot

▸ 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

AbstractTextEditor.getBboxHandle

▸ getBounds(): Rect

Returns bounds for the bounding box elements

Rect

AbstractTextEditor.getBounds

▸ getClassName(): string

string

AbstractTextEditor.getClassName

▸ Protected getDataLayer(): Node

Gets the edited nodes' parent layer

Node

AbstractTextEditor.getDataLayer

▸ getDeviceTransform(): Transformation

Returns current node-to-device transformation

Transformation

AbstractTextEditor.getDeviceTransform

▸ getEditMode(): EditMode

Returns current edit mode

EditMode

AbstractTextEditor.getEditMode

▸ Protected getEventRadius(eventArgs): number

Returns device radius for the provided event

number

AbstractTextEditor.getEventRadius

▸ Protected getGhost(): Node

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

Node

AbstractTextEditor.getGhost

▸ getHandlesGroup(): Group<Node&gt;

Returns handles group

Group<Node&gt;

AbstractTextEditor.getHandlesGroup

▸ getHistory(): History

Returns current history

History

AbstractTextEditor.getHistory

▸ Protected getLocalTransform(): Transformation

Returns current node local transformation

Transformation

AbstractTextEditor.getLocalTransform

▸ getManipulatorLayer(): CompositeNode<Node&gt;

return manipulator layer

CompositeNode<Node&gt;

layer

AbstractTextEditor.getManipulatorLayer

▸ getMouseRadius(): number

Returns current device radius for mouse events

number

AbstractTextEditor.getMouseRadius

▸ getName(): string

return tool name if any

string

name of the tool

AbstractTextEditor.getName

▸ getNode(): Callout

Returns current node

Callout

AbstractTextEditor.getNode

▸ getParentTool(): AbstractCompositeTool

Gets parent tool

AbstractCompositeTool

parent tool

AbstractTextEditor.getParentTool

▸ getProperties(): OptionsOut

Returns properties

OptionsOut

editor properties

AbstractTextEditor.getProperties

▸ getProperty(name): any

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

any

AbstractTextEditor.getProperty

▸ getPropertyKeys(): string[]

Returns known properties keys

string[]

AbstractTextEditor.getPropertyKeys

▸ getRoot(): AbstractCompositeTool

Gets root tool

AbstractCompositeTool

parent tool

AbstractTextEditor.getRoot

▸ getTextBounds(): Rect

Rect

AbstractTextEditor.getTextBounds

▸ getTouchRadius(): number

Returns current device radius for touch events

number

AbstractTextEditor.getTouchRadius

▸ Protected getVisible(): boolean

Gets the edited node visibility state

boolean

AbstractTextEditor.getVisible

▸ hasEventListener(type, callback?): boolean

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

boolean

AbstractTextEditor.hasEventListener

▸ Protected initialize(options): void

void

AbstractTextEditor.initialize

▸ isActive(): boolean

return active state

boolean

AbstractTextEditor.isActive

▸ isDisposed(): boolean

Returns whether this object has been disposed

boolean

AbstractTextEditor.isDisposed

▸ Protected isDoubleClick(point, eventArgs?): boolean

returns true if double clicked

boolean

AbstractTextEditor.isDoubleClick

▸ isEnabled(): boolean

returns enable state

boolean

state

AbstractTextEditor.isEnabled

▸ isSilent(): boolean

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

boolean

AbstractTextEditor.isSilent

▸ isStarted(): boolean

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

boolean

AbstractTextEditor.isStarted

▸ Protected isSupported(options): boolean

Checks if editor supports the options provided

boolean

AbstractTextEditor.isSupported

▸ isTouchEvent(eventArgs): boolean

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

boolean

AbstractTextEditor.isTouchEvent

▸ Protected move(node, x, y): Callout

Callout

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

Notify listeners

Callout

this

AbstractTextEditor.notify

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

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.

Callout

this

AbstractTextEditor.off

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

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

Callout

AbstractTextEditor.on

▸ Protected onActiveStateChanged(): void

Fires

Events.onStateChanged

void

AbstractTextEditor.onActiveStateChanged

▸ Protected onBeforeCommandApplied(command): void

Fires the EditEvents.BeforeCommandApplied event

void

AbstractTextEditor.onBeforeCommandApplied

▸ Protected onCommandApplied(command): void

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

void

AbstractTextEditor.onCommandApplied

▸ Protected onCommandApplying(command): void

Fires the EditEvents.CommandApplying event

void

AbstractTextEditor.onCommandApplying

▸ Protected onCommandRedo(command): void

Fires the EditEvents.Redo event

void

AbstractTextEditor.onCommandRedo

▸ Protected onCommandUndo(command): void

Fires the EditEvents.Undo event

void

AbstractTextEditor.onCommandUndo

▸ Protected onDoubleClick(eventArgs): void

Handles mouse double click event

void

AbstractTextEditor.onDoubleClick

▸ Protected onEnabledStateChanged(): void

Fires

Events.onEnabledStateChanged

void

AbstractTextEditor.onEnabledStateChanged

▸ Protected onKeyDown(eventArgs): void

Handles key down event

void

AbstractTextEditor.onKeyDown

▸ Protected onKeyUp(eventArgs): void

Handles key up event

void

AbstractTextEditor.onKeyUp

▸ Protected onLeave(eventArgs): void

Handles mouse leave event

void

AbstractTextEditor.onLeave

▸ Protected onMouseDown(eventArgs): void

Handles mouse down event

void

AbstractTextEditor.onMouseDown

▸ Protected onMouseMove(eventArgs): void

Handles mouse move event

void

AbstractTextEditor.onMouseMove

▸ Protected onMouseUp(eventArgs): void

Handles mouse up event

void

AbstractTextEditor.onMouseUp

▸ Protected onNodeCreated(node, eventArgs?): void

Fires the EditEvents.End event

void

AbstractTextEditor.onNodeCreated

▸ pageToCanvas(eventArgs, externalPlot?): Object

return position relative to the canvas

Object

AbstractTextEditor.pageToCanvas

▸ pointToModel(model, eventArgs): Point

converts device coordinates to inner coordinates of node

Point

AbstractTextEditor.pointToModel

▸ Protected push(command): Callout

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

Callout

this

AbstractTextEditor.push

▸ redo(): Callout

Reapplies last canceled command in history (if possible)

Callout

this

AbstractTextEditor.redo

▸ removeListener(eventName, listener?): Callout

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

Deprecated

since 4.0 use .off() instead.

Callout

AbstractTextEditor.removeListener

▸ Protected resetNode(unlink?): Callout

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

Callout

this

AbstractTextEditor.resetNode

▸ Protected resetNodeToGhost(): Callout

Resets the current node to its ghost state

Callout

AbstractTextEditor.resetNodeToGhost

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

boolean

AbstractTextEditor.rotateNode

▸ setActive(active): Callout

set active state

Fires

Events.onStateChanged

Callout

AbstractTextEditor.setActive

▸ Protected setAnchor(node, ax, ay?): Callout

Sets anchor to provided node

Callout

AbstractTextEditor.setAnchor

▸ setEditMode(mode): Callout

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

Callout

this

AbstractTextEditor.setEditMode

▸ setEnabled(enabled): Callout

set enable state

Fires

Events.onEnabledStateChanged

Fires

Events.onStateChanged

Callout

this

AbstractTextEditor.setEnabled

▸ setMouseRadius(radius): Callout

Sets device radius for mouse events

Callout

this

AbstractTextEditor.setMouseRadius

▸ setName(name): Callout

set tool name

Callout

AbstractTextEditor.setName

▸ Protected setNode(node): Callout

Sets node to edit

Callout

this

AbstractTextEditor.setNode

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

boolean

AbstractTextEditor.setNodeBounds

▸ setProperties(properties?): Callout

Sets properties to the editing elements

Callout

this

AbstractTextEditor.setProperties

▸ setProperty(name, value): Callout

Sets dynamic property by name

Callout

this

AbstractTextEditor.setProperty

▸ setSilent(bool): Callout

Set silent mode

Callout

this

AbstractTextEditor.setSilent

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

Sets slot enabled

Callout

AbstractTextEditor.setSlotEnabled

▸ setSlots(slots?, merge?): Callout

Sets new slots.

Example

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

Callout

this

AbstractTextEditor.setSlots

▸ Protected setTextAreaVisible(visible): Callout

Shows/hides textarea dom element (and hides/shows scene text shape respectively

Callout

this

AbstractTextEditor.setTextAreaVisible

▸ setTouchRadius(radius): Callout

Sets device radius for touch events

Callout

this

AbstractTextEditor.setTouchRadius

▸ Protected start(eventArgs?): Callout

start

Callout

AbstractTextEditor.start

▸ Protected stop(): Callout

stop

Callout

AbstractTextEditor.stop

▸ Protected swapActiveHandles(handleId, vertical): EditHandleId

Swaps active handles vertically/horizontally

EditHandleId

swapped handle id

AbstractTextEditor.swapActiveHandles

▸ toggle(): Callout

switch enable state to opposite state

Callout

AbstractTextEditor.toggle

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

boolean

AbstractTextEditor.transformNode

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

boolean

AbstractTextEditor.translateNode

▸ undo(): Callout

Cancels last command in history (if possible)

Callout

this

AbstractTextEditor.undo

▸ update(): Callout

Forces editing shapes and handles to be updated

Callout

this

AbstractTextEditor.update

▸ Protected updateBounds(bounds, node): Rect

Updates bounds for provided node

Rect

AbstractTextEditor.updateBounds

▸ Protected updateBrowserCursor(eventArgs, cursor?): void

void

AbstractTextEditor.updateBrowserCursor

▸ updateHandles(): Callout

Forces editing handles to be updated

Callout

this

AbstractTextEditor.updateHandles

▸ Protected updateNodePosition(): void

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

void

AbstractTextEditor.updateNodePosition

▸ Protected updateTextShape(): void

Updates text shape bounds (anchor + size)

void

AbstractTextEditor.updateTextShape

▸ Static canvasToClient(plotPoint, plot): Point

Convert plot coordinates to global coordinates

Point

AbstractTextEditor.canvasToClient

▸ Static clientToCanvas(nativeEvent, plot): Point

Convert global coordinates to plot coordinates

Point

AbstractTextEditor.clientToCanvas

▸ Static getClassName(): string

string

AbstractTextEditor.getClassName

▸ Static getExclusiveTool(plot): AbstractTool

return exclusive tool associated with plot

AbstractTool

tool

AbstractTextEditor.getExclusiveTool

▸ Static getNativeEventName(eventName): string[]

Returns native event name

string[]

AbstractTextEditor.getNativeEventName

▸ Static isTouchEvent(eventArgs): eventArgs is TouchEvent

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

eventArgs is TouchEvent

AbstractTextEditor.isTouchEvent

▸ Static lock(plot, tool): void

Set exclusive tool for plot

void

AbstractTextEditor.lock

▸ Static setDefaultMouseRadius(radius): void

Sets default device radius for mouse events

void

AbstractTextEditor.setDefaultMouseRadius

▸ Static setDefaultTouchRadius(radius): void

Sets default device radius for touch events

void

AbstractTextEditor.setDefaultTouchRadius

▸ Static unlock(value): void

Remove exclusive tool from plot

void

AbstractTextEditor.unlock