API / geotoolkit / welllog / tooltip / LogBarVisualTooltip / LogBarVisualTooltip
tooltip.LogBarVisualTooltip.LogBarVisualTooltip
The base abstract class for tooltips to use in ToolTipRegistry. See example of simple tooltip usage in @int/geotoolkit/controls/tools/SimpleToolTip
LogVisualTooltip<LogBarVisual>↳
LogBarVisualTooltip
Constructors
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) |
format | ToolTipFormat | Tooltip formaters |
format | ToolTipFormat | Tooltip formaters |
format-headerformat | string | Format of tooltip over header visual.name - visual name visual.min - visual min visual.max - visual max |
Constructors
• new LogBarVisualTooltip(format?)
| Name | Type |
|---|---|
Optional format | ToolTipFormat |
LogVisualTooltip<LogBarVisual&gt;.constructor
Methods
▸ clone(): NodeTooltip<Node>
Create clone
clone
▸ 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
▸ getClassName(): string
string
▸ getFormat(): string | ToolTipFormatter
return tooltip format options
string | ToolTipFormatter
▸ getHeaderFormat(): string | ToolTipFormatter
return tooltip header format options
string | ToolTipFormatter
LogVisualTooltip.getHeaderFormat
▸ Protected getIndexType(visual): "string" | "depth" | IndexType
| Name | Type |
|---|---|
visual | LogBarVisual |
"string" | "depth" | IndexType
▸ Protected getIndexUnit(visual): AbstractUnit
| Name | Type |
|---|---|
visual | LogBarVisual |
▸ getProperties(): PropertiesOut
Returns all the properties pertaining to this object
An object containing the properties
LogVisualTooltip.getProperties
▸ Protected getRadius(): number
Returns radius of selection
number
radius of selection
▸ getToolTipFormat(visual, pt, registry?, options?): string | ToolTipFormatter
Return formatted string from information which can be collected at specific screen coordinates
| Name | Type | Description |
|---|---|---|
visual | LogBarVisual | LogVisualHeader<LogBarVisual> | or visual header |
pt | Point | point in canvas model limits |
Optional registry | LogToolTipRegistry | tool tip registry |
Optional options | Record<string, any> | additional options |
string | ToolTipFormatter
LogVisualTooltip.getToolTipFormat
▸ getTooltip(visual, pt, registry?, options?): string
Return formatted string from information which can be collected at specific screen coordinates
| Name | Type | Description |
|---|---|---|
visual | LogBarVisual | LogVisualHeader<LogBarVisual> | or visual header |
pt | Point | point in canvas model limits |
Optional registry | ToolTipRegistry | tool tip registry |
Optional options | Record<string, any> | additional options |
string
▸ hitTest(visual, pt, registry?, options?): ToolTipInfo
Return information from visual that can be collected at specific screen coordinates
| Name | Type | Description |
|---|---|---|
visual | LogBarVisual | LogVisualHeader<LogBarVisual> | or visual header |
pt | Point | point in canvas model limits |
Optional registry | LogToolTipRegistry | tool tip registry |
Optional options | Record<string, any> | additional options |
▸ Protected inverseTransformPoint(node, point): Point
Inverse transform device point to model point for specified node
model point
LogVisualTooltip.inverseTransformPoint
▸ isEnabled(): boolean
returns enable state
boolean
state
▸ setEnabled(enabled): LogBarVisualTooltip
set enable state
| Name | Type | Description |
|---|---|---|
enabled | boolean | sets the enabled state |
this
▸ setFormat(format?): LogBarVisualTooltip
Set tool tip format options
| Name | Type | Description |
|---|---|---|
Optional format | string | ToolTipFormatter | tooltip format options |
▸ setHeaderFormat(format): LogBarVisualTooltip
set tooltip header format options
| Name | Type |
|---|---|
format | string | ToolTipFormatter |
LogVisualTooltip.setHeaderFormat
▸ setProperties(properties?): LogBarVisualTooltip
Sets all the properties pertaining to this object
| Name | Type | Description |
|---|---|---|
Optional properties | Properties | An object containing the properties to set |
this
LogVisualTooltip.setProperties
▸ Static getClassName(): string
string