API / geotoolkit / schematics / tooltip / ComponentNodeToolTipRegistry / ComponentNodeToolTipRegistry
tooltip.ComponentNodeToolTipRegistry.ComponentNodeToolTipRegistry
The implementation of the default tool tip registry for Schematics To register formatter function use: ComponentNodeToolTipRegistry.getDefaultInstance().register(ComponentNodeClass.getClassName(), yourFormatterFunction); To unregister formatter function use: ComponentNodeToolTipRegistry.getDefaultInstance().register(ComponentNodeClass.getClassName(), null);
↳
ComponentNodeToolTipRegistry
Constructors
- [new ComponentNodeToolTipRegistry(options)](/solutions/geotoolkit/GeoToolkit_JS/apis/classes/geotoolkit.schematics.tooltip-1.componentnodetooltipregistry.componentnodetooltipregistry.md#new componentnodetooltipregistry(options))
Methods
Constructors
• new ComponentNodeToolTipRegistry(options?)
| Name | Type |
|---|---|
Optional options | Options |
ToolTipRegistry.constructor
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
▸ getToolTipBuilder(): ToolTipBuilderCallback
Set tooltip builder
tooltip builder
ToolTipRegistry.getToolTipBuilder
▸ 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 |
NodeTooltip<Node>
Formatter instance
ToolTipRegistry.getToolTipFormatter
▸ getTooltip(node, point, options?): string
Returns formatted tooltip string for specific node and specified canvas point
string
▸ hitTest(node, point, options?): Record<string, any>
Record<string, any>
▸ register(className, formatter): ComponentNodeToolTipRegistry
Registers formatter functions for given class name
| Name | Type | Description |
|---|---|---|
className | string | Class name |
formatter | NodeTooltip<Node> | Formatter function |
this
▸ setFormatter(formatter): ComponentNodeToolTipRegistry
Set active tooltip formatter
| Name | Type |
|---|---|
formatter | ToolTipFormatter |
▸ setToolTipBuilder(builder): ComponentNodeToolTipRegistry
Set tooltip builder
| Name | Type | Description |
|---|---|---|
builder | ToolTipBuilderCallback | tooltip builder |
this
ToolTipRegistry.setToolTipBuilder
▸ Static getDefaultInstance(): ComponentNodeToolTipRegistry
Returns instance of the tool tip registry
Tool tip registry