Class: ToolTipTool

• new ToolTipTool(options)

• new ToolTipTool(options?)

ToolTipTool constructor

AbstractTool.constructor

▸ addListener(eventName, listener): ToolTipTool

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)

ToolTipTool

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 ToolTipTool

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

▸ getAlignment(): AnchorType

AnchorType

▸ getAnchorCssClasses(): Partial<Record<AnchorCssKeys, string>>

Return CSS class map for tooltip anchors

Partial<Record<AnchorCssKeys, string>>

CSS classes

▸ getCallback(): Callback

Gets callback

Callback

callback callback to return information about the current position

▸ getClassName(): string

string

AbstractTool.getClassName

▸ getCssClasses(): string

Return CSS classes for tooltip

string

CSS classes

▸ getDivElement(): HTMLElement | CreateHTMLElement

Gets tooltip div element or callback for creates div element

HTMLElement | CreateHTMLElement

divElement HTML div container element or callback which creating div

▸ Protected getEventRadius(eventArgs): number

Returns device radius for the provided event

number

AbstractTool.getEventRadius

▸ 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

▸ getOffsetX(): number

number

▸ getOffsetY(): number

number

▸ getOrientation(): Orientation

Orientation

▸ getParentTool(): AbstractCompositeTool

Gets parent tool

AbstractCompositeTool

parent tool

AbstractTool.getParentTool

▸ getPointerMode(): string

string

▸ getProperties(context?): OptionsOut

Gets all the properties pertaining to this object

OptionsOut

properties object

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

▸ getRadius(): number

Returns radius of selection

number

radius of selection

▸ getRegistry(): ToolTipRegistry

Gets tooltip registry instance

ToolTipRegistry

tooltip registry

▸ getRoot(): AbstractCompositeTool

Gets root tool

AbstractCompositeTool

parent tool

AbstractTool.getRoot

▸ getTooltipPositionHandler(): PositionCallback

Gets tooltip position handler, this handler will be called every time mouse position changed

PositionCallback

PositionCallback

▸ getTooltipSizeHandler(): SizeCallback

Gets tooltip size handler, this handler will be called every time mouse position changed

SizeCallback

SizeCallback

▸ 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

▸ hide(): void

hide tooltips if any

void

▸ 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

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

Notify listeners

ToolTipTool

this

AbstractTool.notify

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

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.

ToolTipTool

this

AbstractTool.off

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

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

ToolTipTool

AbstractTool.on

▸ Protected onActiveStateChanged(): void

Fires

Events.onStateChanged

void

AbstractTool.onActiveStateChanged

▸ Protected onEnabledStateChanged(): void

Fires

Events.onEnabledStateChanged

void

AbstractTool.onEnabledStateChanged

▸ 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

▸ removeListener(eventName, listener?): ToolTipTool

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

Deprecated

since 4.0 use .off() instead.

ToolTipTool

AbstractTool.removeListener

▸ setActive(active): ToolTipTool

set active state

Fires

Events.onStateChanged

ToolTipTool

AbstractTool.setActive

▸ setAlignment(alignment): ToolTipTool

ToolTipTool

▸ setAnchorCssClasses(cssAnchorClasses): ToolTipTool

Sets CSS class map for tooltip anchors (to render arrows). By default this map contains css-classnames for the following anchors: 'topcenter': 'cg-tooltip-arrow-top', 'bottomcenter': 'cg-tooltip-arrow-bottom', 'leftcenter': 'cg-tooltip-arrow-left', 'rightcenter': 'cg-tooltip-arrow-right' You can set it to null is to remove default css classes and use rectangular tooltip instead of callout.

ToolTipTool

this

▸ setCallback(callback): ToolTipTool

Set callback to return information about the current position

ToolTipTool

▸ setCssClasses(cssClasses): ToolTipTool

Sets CSS classes to be applied for tooltip

ToolTipTool

this

▸ setDivElement(divElement): ToolTipTool

Sets tooltip div element or callback for creates div element

ToolTipTool

this

▸ setEnabled(enabled): ToolTipTool

set enable state

Fires

Events.onEnabledStateChanged

Fires

Events.onStateChanged

ToolTipTool

this

AbstractTool.setEnabled

▸ setMouseRadius(radius): ToolTipTool

Sets device radius for mouse events

ToolTipTool

this

AbstractTool.setMouseRadius

▸ setName(name): ToolTipTool

set tool name

ToolTipTool

AbstractTool.setName

▸ setOffsetX(offsetX): ToolTipTool

Sets tooltip offset x

ToolTipTool

this

▸ setOffsetY(offsetY): ToolTipTool

Sets tooltip offset y

ToolTipTool

this

▸ setOptions(options?): ToolTipTool

Sets tooltip options

ToolTipTool

this

▸ setOrientation(orientation): ToolTipTool

ToolTipTool

▸ setPointerMode(mode): ToolTipTool

ToolTipTool

▸ setProperties(properties?, context?): ToolTipTool

Sets all the properties pertaining to this object

ToolTipTool

this

AbstractTool.setProperties

▸ setProperty(name, value): ToolTipTool

Sets dynamic property by name

ToolTipTool

this

AbstractTool.setProperty

▸ setRadius(radius): ToolTipTool

Set radius of selection

ToolTipTool

this

▸ setRegistry(registry): ToolTipTool

Set tooltip registry instance

ToolTipTool

▸ setSilent(bool): ToolTipTool

Set silent mode

ToolTipTool

this

AbstractTool.setSilent

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

Sets slot enabled

ToolTipTool

AbstractTool.setSlotEnabled

▸ setSlots(slots?, merge?): ToolTipTool

Sets new slots.

Example

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

ToolTipTool

this

AbstractTool.setSlots

▸ setTooltipPositionHandler(handler?): ToolTipTool

Set tooltip position handler, this handler will be called every time mouse position changed

ToolTipTool

this

▸ setTooltipSizeHandler(handler?): ToolTipTool

Set tooltip size handler, this handler will be called every time mouse position changed

ToolTipTool

this

▸ setTouchRadius(radius): ToolTipTool

Sets device radius for touch events

ToolTipTool

this

AbstractTool.setTouchRadius

▸ show(point, options?): ToolTipTool

Show tooltip at specified point (in node model coordinates, in case if node is specified)

ToolTipTool

▸ Protected start(eventArgs?): ToolTipTool

start

ToolTipTool

AbstractTool.start

▸ Protected stop(): ToolTipTool

stop

ToolTipTool

AbstractTool.stop

▸ toggle(): ToolTipTool

switch enable state to opposite state

ToolTipTool

AbstractTool.toggle

▸ updateInfo(): ToolTipTool

Updates tooltip information using previous tooltip point

ToolTipTool

this

▸ 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