API / geotoolkit / controls / tooltip / ToolTipRegistry / ToolTipRegistry
tooltip.ToolTipRegistry.ToolTipRegistry
The implementation of the default tool tip registry
ToolTipRegistry
Constructors
Methods
▸ clone(deepCopy?): ToolTipRegistry
return tool tip registry clone
| Name | Type | Description |
|---|---|---|
Optional deepCopy | boolean | clone tooltips prototypes if deep is true overwise copy only references |
▸ getFormatter(): ToolTipFormatter
Return active tooltip formatter
▸ getToolTipFormatter(node): NodeTooltip<Node>
Returns formatter instance for given node or class name. If formatter is not registered for node's class name this method travels up inheritance chain and returns formatter of base class.
| Name | Type | Description |
|---|---|---|
node | string | Node | Node or class name |
Formatter instance
▸ getTooltip(node, point, options?): string
Returns formatted tooltip string for specific node and specified canvas point
string
▸ register(className, formatter): ToolTipRegistry
Registers formatter functions for given class name
| Name | Type | Description |
|---|---|---|
className | string | Class name |
formatter | NodeTooltip<Node> | Formatter function |
this
▸ setFormatter(formatter): ToolTipRegistry
Set active tooltip formatter
| Name | Type |
|---|---|
formatter | ToolTipFormatter |