API / geotoolkit3d / shapes / GridIntersection2DTooltip / GridIntersection2DTooltip
shapes.GridIntersection2DTooltip.GridIntersection2DTooltip
A tooltip utility class for 2D grid intersection results.
↳
GridIntersection2DTooltip
Constructors
- [new GridIntersection2DTooltip(format)](/solutions/geotoolkit/GeoToolkit_JS/apis/classes/geotoolkit3d.shapes-6.gridintersection2dtooltip.gridintersection2dtooltip.md#new gridintersection2dtooltip(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 GridIntersection2DTooltip(format?)
| Name | Type |
|---|---|
Optional format | string | ToolTipFormatter |
NodeTooltip.constructor
Methods
▸ clone(): NodeTooltip<Node>
Create clone
NodeTooltip<Node>
clone
▸ Protected copyConstructor(src, deepCopy?): GridIntersection2DTooltip
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
▸ 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
▸ getProperties(): PropertiesOut
Returns all the properties pertaining to this object
An object containing the properties
▸ getRadius(): number
Returns radius of selection
number
radius of selection
▸ getSymbolClass(): string
return symbol class
string
▸ getTooltip(visual, pt, registry, options?): string
Return formatted string from information which can be collected at specific screen coordinates
| Name | Type | Description |
|---|---|---|
visual | PanelsIntersection2D | or visual header |
pt | Point | point in canvas model limits |
registry | ToolTipRegistry | tool tip registry |
Optional options | Record<string, any> | additional options |
string
▸ hitTest(visual, pt, registry?, options?): ToolTipInfo
Return hit test for specified visual at specific screen coordinates
| Name | Type | Description |
|---|---|---|
visual | PanelsIntersection2D | or visual header |
pt | Point | point in canvas model limits |
Optional registry | ToolTipRegistry | tool tip registry |
Optional options | Record<string, any> | additional options |
▸ isEnabled(): boolean
returns enable state
boolean
state
▸ setEnabled(enabled): GridIntersection2DTooltip
set enable state
| Name | Type | Description |
|---|---|---|
enabled | boolean | sets the enabled state |
this
▸ setFormat(format): GridIntersection2DTooltip
Set tool tip format options
| Name | Type | Description |
|---|---|---|
format | string | ToolTipFormatter | tooltip format options |
▸ setProperties(properties?): GridIntersection2DTooltip
Sets all the properties pertaining to this object
| Name | Type | Description |
|---|---|---|
Optional properties | Properties | An object containing the properties to set |
this
▸ setSymbolClass(symbolClass): GridIntersection2DTooltip
Set symbol class
| Name | Type | Description |
|---|---|---|
symbolClass | string | tooltip symbol class |
▸ Static getClassName(): string
string