API / geotoolkit3d / tool / ToolTip / ToolTip
A tool providing cursor tooltip in 3D.<br> This tooltip will listen to cursor events and notify user-defined tooltip div.<br> <br> The tooltip provides an alternative way to highlight objects. By default it is disabled.<br> When highlight option is enabled, a highlighter object will be created along with the tooltip. (See Highlighter for more info)<br> Please note that the highlighter only works with 2D objects like PointCloud and ScatterPlot.<br> It is not compatible with 3D objects. <br> To disable the cursor, set options.cursor to null.<br> <br> The content of tooltip is left to users. By default, it shows the type of selected object.<br> If the user needs to change it, then modifying options.innerHTML.<br> <br> Users can provide their own divElement for styling purpose. If a divElement is not provided, ToolTip will create one.<br>
↳
ToolTip
Constructors
- [new ToolTip(options)](/solutions/geotoolkit/GeoToolkit_JS/apis/classes/geotoolkit3d.tool.tooltip.tooltip.md#new tooltip(options))
Methods
Constructors
• new ToolTip(options)
constructor
| Name | Type | Description |
|---|---|---|
options | Options | See geotoolkit3d.tool.AbstractGestureTool for inherited options |
AbstractGestureTool.constructor
Methods
▸ addMoveListener(callback): void
Adds a listener that will be triggered each time this tool 'move' occurs.
| Name | Type | Description |
|---|---|---|
callback | ListenerFunction | The function that will be called |
void
▸ dispose(): void
Dispose tooltip
void
▸ getClassName(): string
string
AbstractGestureTool.getClassName
▸ getDivElement(): HTMLElement
Get tooltip's div element
HTMLElement
divElement
▸ getName(): string
Returns the tool name.
string
The tool's name
▸ getOptions(): Required<Options>
Get abstract gesture tool options
Required<Options>
options
AbstractGestureTool.getOptions
▸ getPlot(): Plot
Get the plot of this Tool.
▸ hasEventListener(type, callback?): boolean
Check if a list of event listeners for this type contains this listener
| Name | Type | Description |
|---|---|---|
type | string | type of event or property |
Optional callback | Function | to be called, if null, check if any callback is registered |
boolean
AbstractGestureTool.hasEventListener
▸ isArmed(): boolean
Return if this tool is 'armed'.<br> The tool actions are disabled when not armed.<br> A tool can either be armed at all time, or only when a specific key is pressed. To set/unset the arming key, please see this tool option 'armingkey', via .setOptions().
boolean
▸ isDisposed(): boolean
Returns whether this object has been disposed
boolean
AbstractGestureTool.isDisposed
▸ isSilent(): boolean
Return true if the event dispatcher doesn't notify any events
boolean
▸ isTouchEvent(eventArgs): boolean
return true if the event is a touch event and false otherwise.
| Name | Type | Description |
|---|---|---|
eventArgs | Event | EventArgs | contains info of the event |
boolean
AbstractGestureTool.isTouchEvent
▸ notify<E>(type, source, args?): ToolTip
Notify listeners
| Name | Type |
|---|---|
E | extends string |
| Name | Type | Description |
|---|---|---|
type | E | event types |
source | AbstractTool | of the event |
Optional args | EventMap[E] | arguments of the event |
this
▸ off<E>(type?, callback?): ToolTip
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.
| Name | Type |
|---|---|
E | extends string |
| Name | Type | Description |
|---|---|---|
Optional type | E | type of the event |
Optional callback | (eventType: E, sender: ToolTip, args: EventMap[E]) => void | function to be called |
this
▸ on<E>(type, callback): ToolTip
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>
| Name | Type |
|---|---|
E | extends string |
| Name | Type | Description |
|---|---|---|
type | E | type of event or property |
callback | (eventType: E, sender: ToolTip, args: EventMap[E]) => void | to be called |
this
▸ onContext(event): void
Called when a 'context' event has occurred
| Name | Type | Description |
|---|---|---|
event | PointerEvent | the native event with plot coordinates added |
void
▸ onCursorMove(event): void
Called when a 'onCursorMove' event has occurred
| Name | Type | Description |
|---|---|---|
event | CustomPointerEvent | the native event with plot coordinates added |
void
AbstractGestureTool.onCursorMove
▸ onDoubleClick(event): void
Called when a 'doubleclick' event has occurred
| Name | Type | Description |
|---|---|---|
event | CustomPointerEvent | the native event with plot coordinates added |
void
AbstractGestureTool.onDoubleClick
▸ onDoubleTap(event): void
Called when a 'onDoubleTap' event has occurred
| Name | Type | Description |
|---|---|---|
event | CustomPointerEvent | the native event with plot coordinates added |
void
AbstractGestureTool.onDoubleTap
▸ onDrag(event): void
Called when a 'onDrag' event has occurred
| Name | Type | Description |
|---|---|---|
event | CustomPointerEvent | the native event with plot coordinates added |
void
▸ onDragEnd(event): void
Called when a 'onDragEnd' event has occurred
| Name | Type | Description |
|---|---|---|
event | CustomPointerEvent | the native event with plot coordinates added |
void
▸ onDragStart(event): void
Called when a 'onDragStart' event has occurred
| Name | Type | Description |
|---|---|---|
event | CustomPointerEvent | the native event with plot coordinates added |
void
AbstractGestureTool.onDragStart
▸ onKey(event): void
Called when a 'onKey' event has occurred
| Name | Type | Description |
|---|---|---|
event | KeyboardEvent | the native event with plot coordinates added |
void
▸ onKeyDown(event): void
Called when a 'keydown' event has occurred
| Name | Type | Description |
|---|---|---|
event | KeyboardEvent | the native event with plot coordinates added |
void
▸ onKeyEnd(event): void
Called when a 'onKeyEnd' event has occurred
| Name | Type | Description |
|---|---|---|
event | KeyboardEvent | the native event with plot coordinates added |
void
▸ onKeyStart(event): void
Called when a 'onKeyStart' event has occurred
| Name | Type | Description |
|---|---|---|
event | KeyboardEvent | the native event with plot coordinates added |
void
AbstractGestureTool.onKeyStart
▸ onKeyUp(event): void
Called when a 'keyup' event has occurred
| Name | Type | Description |
|---|---|---|
event | KeyboardEvent | the native event with plot coordinates added |
void
▸ onMouseDown(event): void
Called when a 'mousedown' event has occurred
| Name | Type | Description |
|---|---|---|
event | CustomPointerEvent | the native event with plot coordinates added |
void
AbstractGestureTool.onMouseDown
▸ onMouseMove(event): void
Called when a 'mousemove' event has occurred
| Name | Type | Description |
|---|---|---|
event | CustomPointerEvent | the native event with plot coordinates added |
void
AbstractGestureTool.onMouseMove
▸ onMouseOut(event): void
Called when a 'mouseout' event has occurred
| Name | Type | Description |
|---|---|---|
event | CustomPointerEvent | the native event with plot coordinates added |
void
AbstractGestureTool.onMouseOut
▸ onMouseUp(event): void
Called when a 'mouseup' event has occurred
| Name | Type | Description |
|---|---|---|
event | CustomPointerEvent | the native event with plot coordinates added |
void
▸ onMouseWheel(event): void
Called when a 'mousewheel' event has occurred
| Name | Type | Description |
|---|---|---|
event | WheelEvent | the native event with plot coordinates added |
void
AbstractGestureTool.onMouseWheel
▸ onPinch(event): void
Called when a 'onPinch' event has occurred
| Name | Type | Description |
|---|---|---|
event | MovePointerEvent | the native event with plot coordinates added |
void
▸ onPinchEnd(event): void
Called when a 'onPinchEnd' event has occurred
| Name | Type | Description |
|---|---|---|
event | CustomPointerEvent | the native event with plot coordinates added |
void
AbstractGestureTool.onPinchEnd
▸ onPinchStart(event): void
Called when a 'onPinchStart' event has occurred
| Name | Type | Description |
|---|---|---|
event | MovePointerEvent | the native event with plot coordinates added |
void
AbstractGestureTool.onPinchStart
▸ onSlide(event): void
Called when a 'onSlide' event has occurred
| Name | Type | Description |
|---|---|---|
event | CustomPointerEvent | the native event with plot coordinates added |
void
▸ onSlideEnd(event): void
Called when a 'onSlideEnd' event has occurred
| Name | Type | Description |
|---|---|---|
event | CustomPointerEvent | the native event with plot coordinates added |
void
AbstractGestureTool.onSlideEnd
▸ onSlideStart(event): void
Called when a 'onSlideStart' event has occurred
| Name | Type | Description |
|---|---|---|
event | CustomPointerEvent | the native event with plot coordinates added |
void
AbstractGestureTool.onSlideStart
▸ onTap(event): void
Called when a 'onTap' event has occurred
| Name | Type | Description |
|---|---|---|
event | CustomPointerEvent | the native event with plot coordinates added |
void
▸ onTouchEnd(event): void
Called when a 'touchend' event has occurred
| Name | Type | Description |
|---|---|---|
event | CustomPointerEvent | the native event with plot coordinates added |
void
AbstractGestureTool.onTouchEnd
▸ onTouchMove(event): void
Called when a 'touchmove' event has occurred
| Name | Type | Description |
|---|---|---|
event | CustomPointerEvent | the native event with plot coordinates added |
void
AbstractGestureTool.onTouchMove
▸ onTouchStart(event): void
Called when a 'touchstart' event has occurred
| Name | Type | Description |
|---|---|---|
event | CustomPointerEvent | the native event with plot coordinates added |
void
AbstractGestureTool.onTouchStart
▸ onVisibilityChanged(event): void
Called when a 'onVisibilityChanged' event has occurred
| Name | Type | Description |
|---|---|---|
event | CustomPointerEvent | the native event with plot coordinates added |
void
AbstractGestureTool.onVisibilityChanged
▸ onVisibilityGained(event): void
Called when a 'onVisibilityGained' event has occurred
| Name | Type | Description |
|---|---|---|
event | CustomPointerEvent | the native event with plot coordinates added |
void
AbstractGestureTool.onVisibilityGained
▸ onVisibilityLost(event): void
Called when a 'onVisibilityLost' event has occurred
| Name | Type | Description |
|---|---|---|
event | CustomPointerEvent | the native event with plot coordinates added |
void
AbstractGestureTool.onVisibilityLost
▸ setOptions(options): ToolTip
Set options, the given json will be merged with the object's state so that only the given options will be changed.<br>
| Name | Type | Description |
|---|---|---|
options | Options | The options |
this
AbstractGestureTool.setOptions
▸ setSilent(bool): ToolTip
Set silent mode
| Name | Type | Description |
|---|---|---|
bool | boolean | flag to enable silent mode |
this
▸ setup(deviceSupport): ToolTip
This function allows tools to bind their events to the device support
| Name | Type | Description |
|---|---|---|
deviceSupport | AbstractDeviceSupport | the type of device we are attaching to |
▸ Static getClassName(): string
string