API / geotoolkit / schematics / tooltip / RegularComponentTooltip / RegularComponentTooltip
tooltip.RegularComponentTooltip.RegularComponentTooltip
The base abstract class for tooltips to use in ToolTipRegistry. See example of simple tooltip usage in @int/geotoolkit/controls/tools/SimpleToolTip
ComponentNodeTooltip<RegularComponentNode>↳
RegularComponentTooltip
Constructors
- [new RegularComponentTooltip(format)](/solutions/geotoolkit/GeoToolkit_JS/apis/classes/geotoolkit.schematics.tooltip-1.regularcomponenttooltip.regularcomponenttooltip.md#new regularcomponenttooltip(format))
Methods
Css Properties
| Name | Type | Description |
|---|---|---|
enabled | boolean | Enabled state |
format | ToolTipFormat | Tooltip formaters |
format-visualformat | string | Format 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) |
radius | number | Radius of selection |
symbolclass | string | Tooltip symbol class |
Constructors
• new RegularComponentTooltip(format?)
| Name | Type |
|---|---|
Optional format | ToolTipFormat |
ComponentNodeTooltip<RegularComponentNode&gt;.constructor
Methods
▸ clone(): NodeTooltip<Node>
Create clone
NodeTooltip<Node>
clone
▸ Protected copyConstructor(src, deepCopy?): RegularComponentTooltip
Copy constructor function.<br> Function used as part of the cloning mechanism.<br> Implementations should copy the given instance state to this instance.<br>
| Name | Type | Description |
|---|---|---|
src | NodeTooltip<Node> | Source to copy from |
Optional deepCopy | boolean | deep copy |
this
ComponentNodeTooltip.copyConstructor
▸ Protected formatSymbol(fillStyle, lineStyle?, symbolClass?): string
format symbol string
| Name | Type | Description |
|---|---|---|
fillStyle | string | ColoredStyle | symbol fill style |
Optional lineStyle | string | ColoredStyle | symbol line style |
Optional symbolClass | string | symbol css class |
string
ComponentNodeTooltip.formatSymbol
▸ getClassName(): string
string
ComponentNodeTooltip.getClassName
▸ getFormat(): string | ToolTipFormatter
return tooltip format options
string | ToolTipFormatter
ComponentNodeTooltip.getFormat
▸ getProperties(): PropertiesOut
Returns all the properties pertaining to this object
An object containing the properties
ComponentNodeTooltip.getProperties
▸ getRadius(): number
Returns radius of selection
number
radius of selection
ComponentNodeTooltip.getRadius
▸ getSymbolClass(): string
return symbol class
string
ComponentNodeTooltip.getSymbolClass
▸ getTooltip(component, pt, registry?, options?): string
Return formatted string from information which can be collected at specific screen coordinates
| Name | Type | Description |
|---|---|---|
component | RegularComponentNode | component node |
pt | Point | point in canvas model limits |
Optional registry | ToolTipRegistry | tool tip registry |
Optional options | Record<string, any> | additional options |
string
ComponentNodeTooltip.getTooltip
▸ hitTest(component, pt, registry?, options?): ToolTipInfo
Return information from visual that can be collected at specific screen coordinates
| Name | Type | Description |
|---|---|---|
component | RegularComponentNode | regular schematics component |
pt | Point | point in canvas model limits |
Optional registry | ComponentNodeToolTipRegistry | tool tip registry |
Optional options | Record<string, any> | additional options |
▸ isEnabled(): boolean
returns enable state
boolean
state
ComponentNodeTooltip.isEnabled
▸ setEnabled(enabled): RegularComponentTooltip
set enable state
| Name | Type | Description |
|---|---|---|
enabled | boolean | sets the enabled state |
this
ComponentNodeTooltip.setEnabled
▸ setFormat(format): RegularComponentTooltip
Set tool tip format options
| Name | Type | Description |
|---|---|---|
format | string | ToolTipFormatter | tooltip format options |
ComponentNodeTooltip.setFormat
▸ setProperties(properties?): RegularComponentTooltip
Sets all the properties pertaining to this object
| Name | Type | Description |
|---|---|---|
Optional properties | Properties | An object containing the properties to set |
this
ComponentNodeTooltip.setProperties
▸ setSymbolClass(symbolClass): RegularComponentTooltip
Set symbol class
| Name | Type | Description |
|---|---|---|
symbolClass | string | tooltip symbol class |
ComponentNodeTooltip.setSymbolClass
▸ Static getClassName(): string
string