Skip to content
Last updated

API / geotoolkit / controls / tooltip / NodeTooltip / NodeTooltip

Class: NodeTooltip<T&gt;

tooltip.NodeTooltip.NodeTooltip

The base abstract class for tooltips to use in ToolTipRegistry. See example of simple tooltip usage in @int/geotoolkit/controls/tools/SimpleToolTip

Type parameters

NameType
Textends Node = Node

Hierarchy

Table of contents

Constructors
  • [new NodeTooltip<T&gt;(properties)](/solutions/geotoolkit/GeoToolkit_JS/apis/classes/geotoolkit.controls.tooltip.nodetooltip.nodetooltip.md#new nodetooltip<t>(properties))
Methods
Css Properties
Name Type Description
enabledbooleanEnabled state
formatToolTipFormatTooltip formaters
format-visualformatstringFormat of tooltip over visual visual.symbol - visual symbol visual.name - visual name visual.value - visual value visual.unit - visual unit (for curve) visual.columnnumber - column number (for log2d visual)
radiusnumberRadius of selection
symbolclassstringTooltip symbol class

Contents

Constructors

new NodeTooltip&lt;T&amp;gt;(properties)

• Protected new NodeTooltip<T&gt;(properties?)

Type parameters

NameType
Textends Node<T&gt; = Node

Parameters

Name Type
Optional propertiesstring | ToolTipFormatter | Properties
Methods

clone

▸ clone(): NodeTooltip<Node&gt;

Create clone

Returns

NodeTooltip<Node&gt;

clone


copyConstructor

▸ Protected copyConstructor(src, deepCopy?): NodeTooltip<T&gt;

Copy constructor function.<br> Function used as part of the cloning mechanism.<br> Implementations should copy the given instance state to this instance.<br>

Parameters

Name Type Description
srcNodeTooltip<Node&gt;Source to copy from
Optional deepCopybooleandeep copy

Returns

NodeTooltip<T&gt;

this


formatSymbol

▸ Protected formatSymbol(fillStyle, lineStyle?, symbolClass?): string

format symbol string

Parameters

Name Type Description
fillStylestring | ColoredStylesymbol fill style
Optional lineStylestring | ColoredStylesymbol line style
Optional symbolClassstringsymbol css class

Returns

string


getClassName

▸ getClassName(): string

Returns

string


getFormat

▸ getFormat(): string | ToolTipFormatter

return tooltip format options

Returns

string | ToolTipFormatter


getProperties

▸ getProperties(): PropertiesOut

Returns all the properties pertaining to this object

Returns

PropertiesOut

An object containing the properties


getRadius

▸ getRadius(): number

Returns radius of selection

Returns

number

radius of selection


getSymbolClass

▸ getSymbolClass(): string

return symbol class

Returns

string


getTooltip

▸ Abstract getTooltip(visual, pt, registry?, options?): string

Return formatted string from information which can be collected at specific screen coordinates

Parameters

Name Type Description
visualTor visual header
ptPointpoint in canvas model limits
Optional registryToolTipRegistrytool tip registry
Optional optionsRecord<string, any&gt;additional options

Returns

string


hitTest

▸ hitTest(visual, pt, registry?, options?): ToolTipInfo

Return hit test for specified visual at specific screen coordinates

Parameters

Name Type Description
visualTor visual header
ptPointpoint in canvas model limits
Optional registryToolTipRegistrytool tip registry
Optional optionsRecord<string, any&gt;additional options

Returns

ToolTipInfo


isEnabled

▸ isEnabled(): boolean

returns enable state

Returns

boolean

state


setEnabled

▸ setEnabled(enabled): NodeTooltip<T&gt;

set enable state

Parameters

Name Type Description
enabledbooleansets the enabled state

Returns

NodeTooltip<T&gt;

this


setFormat

▸ setFormat(format): NodeTooltip<T&gt;

Set tool tip format options

Parameters

Name Type Description
formatstring | ToolTipFormattertooltip format options

Returns

NodeTooltip<T&gt;


setProperties

▸ setProperties(properties?): NodeTooltip<T&gt;

Sets all the properties pertaining to this object

Parameters

Name Type Description
Optional propertiesPropertiesAn object containing the properties to set

Returns

NodeTooltip<T&gt;

this


setSymbolClass

▸ setSymbolClass(symbolClass): NodeTooltip<T&gt;

Set symbol class

Parameters

Name Type Description
symbolClassstringtooltip symbol class

Returns

NodeTooltip<T&gt;


getClassName

▸ Static getClassName(): string

Returns

string