[API](/solutions/geotoolkit/geotoolkit_js/apis/readme) / [geotoolkit](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit) / [schematics](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit.schematics) / [tooltip](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit.schematics#tooltip) / [MarkerComponentTooltip](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit.schematics#markercomponenttooltip) / MarkerComponentTooltip

# Class: MarkerComponentTooltip

[tooltip](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit.schematics#tooltip).[MarkerComponentTooltip](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit.schematics#markercomponenttooltip).MarkerComponentTooltip

The base abstract class for tooltips to use in [ToolTipRegistry](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tooltip.tooltipregistry.tooltipregistry).
See example of simple tooltip usage in @int/geotoolkit/controls/tools/SimpleToolTip

## Hierarchy

- [`ComponentNodeTooltip`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.schematics.tooltip-1.componentnodetooltip.componentnodetooltip)<[`NodeMarker`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.schematics.scene-2.impl.nodemarker.nodemarker)&gt;
↳ **`MarkerComponentTooltip`**


## Table of contents

Constructors
- [new MarkerComponentTooltip(format)](/solutions/geotoolkit/GeoToolkit_JS/apis/classes/geotoolkit.schematics.tooltip-1.markercomponenttooltip.markercomponenttooltip.md#new markercomponenttooltip(format))


Methods
| [clone](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.schematics.tooltip-1.markercomponenttooltip.markercomponenttooltip#clone) | [copyConstructor](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.schematics.tooltip-1.markercomponenttooltip.markercomponenttooltip#copyconstructor) | [formatSymbol](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.schematics.tooltip-1.markercomponenttooltip.markercomponenttooltip#formatsymbol) |
|  --- | --- | --- |
| [getClassName](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.schematics.tooltip-1.markercomponenttooltip.markercomponenttooltip#getclassname) | [getFormat](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.schematics.tooltip-1.markercomponenttooltip.markercomponenttooltip#getformat) | [getProperties](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.schematics.tooltip-1.markercomponenttooltip.markercomponenttooltip#getproperties) |
| [getRadius](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.schematics.tooltip-1.markercomponenttooltip.markercomponenttooltip#getradius) | [getSymbolClass](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.schematics.tooltip-1.markercomponenttooltip.markercomponenttooltip#getsymbolclass) | [getTooltip](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.schematics.tooltip-1.markercomponenttooltip.markercomponenttooltip#gettooltip) |
| [hitTest](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.schematics.tooltip-1.markercomponenttooltip.markercomponenttooltip#hittest) | [isEnabled](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.schematics.tooltip-1.markercomponenttooltip.markercomponenttooltip#isenabled) | [setEnabled](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.schematics.tooltip-1.markercomponenttooltip.markercomponenttooltip#setenabled) |
| [setFormat](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.schematics.tooltip-1.markercomponenttooltip.markercomponenttooltip#setformat) | [setProperties](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.schematics.tooltip-1.markercomponenttooltip.markercomponenttooltip#setproperties) | [setSymbolClass](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.schematics.tooltip-1.markercomponenttooltip.markercomponenttooltip#setsymbolclass) |
| [getClassName](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.schematics.tooltip-1.markercomponenttooltip.markercomponenttooltip#getclassname-1) |


Css Properties
| Name  | Type  | Description |
|  --- | --- | --- |
| `enabled` | `boolean` | Enabled state |
| `format` | [`ToolTipFormat`](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit.controls#tooltip#nodetooltip#nodetooltip#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 |


## Contents

Constructors
#### new MarkerComponentTooltip(format)

• **new MarkerComponentTooltip**(`format?`)

#### Parameters

| Name  | Type  |
|  --- | --- |
| `Optional` `format` | [`ToolTipFormat`](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit.schematics#componentnodetooltip#tooltipformat) |


#### Overrides

ComponentNodeTooltip&lt;NodeMarker&amp;gt;.constructor

Methods
#### clone

▸ **clone**(): [`NodeTooltip`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tooltip.nodetooltip.nodetooltip)<[`Node`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.scene.node.node)&gt;

Create clone

#### Returns

[`NodeTooltip`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tooltip.nodetooltip.nodetooltip)<[`Node`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.scene.node.node)&gt;

clone

#### Inherited from

[ComponentNodeTooltip](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.schematics.tooltip-1.componentnodetooltip.componentnodetooltip).[clone](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.schematics.tooltip-1.componentnodetooltip.componentnodetooltip#clone)

#### copyConstructor

▸ `Protected` **copyConstructor**(`src`, `deepCopy?`): [`MarkerComponentTooltip`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.schematics.tooltip-1.markercomponenttooltip.markercomponenttooltip)

Copy constructor function.<br>
Function used as part of the cloning mechanism.<br>
Implementations should copy the given instance state to this instance.<br>

#### Parameters

| Name  | Type  | Description  |
|  --- | --- | --- |
| `src` | [`NodeTooltip`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tooltip.nodetooltip.nodetooltip)<[`Node`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.scene.node.node)&gt; | Source to copy from |
| `Optional` `deepCopy` | `boolean` | deep copy |


#### Returns

[`MarkerComponentTooltip`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.schematics.tooltip-1.markercomponenttooltip.markercomponenttooltip)

this

#### Inherited from

[ComponentNodeTooltip](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.schematics.tooltip-1.componentnodetooltip.componentnodetooltip).[copyConstructor](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.schematics.tooltip-1.componentnodetooltip.componentnodetooltip#copyconstructor)

#### formatSymbol

▸ `Protected` **formatSymbol**(`fillStyle`, `lineStyle?`, `symbolClass?`): `string`

format symbol string

#### Parameters

| Name  | Type  | Description  |
|  --- | --- | --- |
| `fillStyle` | `string` | [`ColoredStyle`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.attributes.coloredstyle.coloredstyle) | symbol fill style |
| `Optional` `lineStyle` | `string` | [`ColoredStyle`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.attributes.coloredstyle.coloredstyle) | symbol line style |
| `Optional` `symbolClass` | `string` | symbol css class |


#### Returns

`string`

#### Inherited from

[ComponentNodeTooltip](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.schematics.tooltip-1.componentnodetooltip.componentnodetooltip).[formatSymbol](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.schematics.tooltip-1.componentnodetooltip.componentnodetooltip#formatsymbol)

#### getClassName

▸ **getClassName**(): `string`

#### Returns

`string`

#### Inherited from

[ComponentNodeTooltip](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.schematics.tooltip-1.componentnodetooltip.componentnodetooltip).[getClassName](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.schematics.tooltip-1.componentnodetooltip.componentnodetooltip#getclassname)

#### getFormat

▸ **getFormat**(): `string` | [`ToolTipFormatter`](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit.controls#nodetooltip#tooltipformatter)

return tooltip format options

#### Returns

`string` | [`ToolTipFormatter`](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit.controls#nodetooltip#tooltipformatter)

#### Inherited from

[ComponentNodeTooltip](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.schematics.tooltip-1.componentnodetooltip.componentnodetooltip).[getFormat](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.schematics.tooltip-1.componentnodetooltip.componentnodetooltip#getformat)

#### getProperties

▸ **getProperties**(): [`PropertiesOut`](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit.controls#nodetooltip#propertiesout)

Returns all the properties pertaining to this object

#### Returns

[`PropertiesOut`](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit.controls#nodetooltip#propertiesout)

An object containing the properties

#### Inherited from

[ComponentNodeTooltip](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.schematics.tooltip-1.componentnodetooltip.componentnodetooltip).[getProperties](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.schematics.tooltip-1.componentnodetooltip.componentnodetooltip#getproperties)

#### getRadius

▸ **getRadius**(): `number`

Returns radius of selection

#### Returns

`number`

radius of selection

#### Inherited from

[ComponentNodeTooltip](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.schematics.tooltip-1.componentnodetooltip.componentnodetooltip).[getRadius](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.schematics.tooltip-1.componentnodetooltip.componentnodetooltip#getradius)

#### getSymbolClass

▸ **getSymbolClass**(): `string`

return symbol class

#### Returns

`string`

#### Inherited from

[ComponentNodeTooltip](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.schematics.tooltip-1.componentnodetooltip.componentnodetooltip).[getSymbolClass](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.schematics.tooltip-1.componentnodetooltip.componentnodetooltip#getsymbolclass)

#### getTooltip

▸ **getTooltip**(`component`, `pt`, `registry?`, `options?`): `string`

Return formatted string from information which can be collected at specific screen coordinates

#### Parameters

| Name  | Type  | Description  |
|  --- | --- | --- |
| `component` | [`NodeMarker`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.schematics.scene-2.impl.nodemarker.nodemarker) | component node |
| `pt` | [`Point`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.util.point.point) | point in canvas model limits |
| `Optional` `registry` | [`ToolTipRegistry`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tooltip.tooltipregistry.tooltipregistry) | tool tip registry |
| `Optional` `options` | `Record`<`string`, `any`&gt; | additional options |


#### Returns

`string`

#### Inherited from

[ComponentNodeTooltip](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.schematics.tooltip-1.componentnodetooltip.componentnodetooltip).[getTooltip](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.schematics.tooltip-1.componentnodetooltip.componentnodetooltip#gettooltip)

#### hitTest

▸ **hitTest**(`component`, `pt`, `registry?`, `options?`): [`ToolTipInfo`](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit.schematics#componentnodetooltip#tooltipinfo)

Return information from visual that can be collected at specific screen coordinates

#### Parameters

| Name  | Type  | Description  |
|  --- | --- | --- |
| `component` | [`NodeMarker`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.schematics.scene-2.impl.nodemarker.nodemarker) | marker schematics component |
| `pt` | [`Point`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.util.point.point) | point in canvas model limits |
| `Optional` `registry` | [`ComponentNodeToolTipRegistry`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.schematics.tooltip-1.componentnodetooltipregistry.componentnodetooltipregistry) | tool tip registry |
| `Optional` `options` | `Record`<`string`, `any`&gt; | additional options |


#### Returns

[`ToolTipInfo`](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit.schematics#componentnodetooltip#tooltipinfo)

#### Overrides

[ComponentNodeTooltip](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.schematics.tooltip-1.componentnodetooltip.componentnodetooltip).[hitTest](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.schematics.tooltip-1.componentnodetooltip.componentnodetooltip#hittest)

#### isEnabled

▸ **isEnabled**(): `boolean`

returns enable state

#### Returns

`boolean`

state

#### Inherited from

[ComponentNodeTooltip](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.schematics.tooltip-1.componentnodetooltip.componentnodetooltip).[isEnabled](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.schematics.tooltip-1.componentnodetooltip.componentnodetooltip#isenabled)

#### setEnabled

▸ **setEnabled**(`enabled`): [`MarkerComponentTooltip`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.schematics.tooltip-1.markercomponenttooltip.markercomponenttooltip)

set enable state

#### Parameters

| Name  | Type  | Description  |
|  --- | --- | --- |
| `enabled` | `boolean` | sets the enabled state |


#### Returns

[`MarkerComponentTooltip`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.schematics.tooltip-1.markercomponenttooltip.markercomponenttooltip)

this

#### Inherited from

[ComponentNodeTooltip](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.schematics.tooltip-1.componentnodetooltip.componentnodetooltip).[setEnabled](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.schematics.tooltip-1.componentnodetooltip.componentnodetooltip#setenabled)

#### setFormat

▸ **setFormat**(`format`): [`MarkerComponentTooltip`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.schematics.tooltip-1.markercomponenttooltip.markercomponenttooltip)

Set tool tip format options

#### Parameters

| Name  | Type  | Description  |
|  --- | --- | --- |
| `format` | `string` | [`ToolTipFormatter`](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit.controls#nodetooltip#tooltipformatter) | tooltip format options |


#### Returns

[`MarkerComponentTooltip`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.schematics.tooltip-1.markercomponenttooltip.markercomponenttooltip)

#### Inherited from

[ComponentNodeTooltip](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.schematics.tooltip-1.componentnodetooltip.componentnodetooltip).[setFormat](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.schematics.tooltip-1.componentnodetooltip.componentnodetooltip#setformat)

#### setProperties

▸ **setProperties**(`properties?`): [`MarkerComponentTooltip`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.schematics.tooltip-1.markercomponenttooltip.markercomponenttooltip)

Sets all the properties pertaining to this object

#### Parameters

| Name  | Type  | Description  |
|  --- | --- | --- |
| `Optional` `properties` | [`Properties`](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit.controls#nodetooltip#properties) | An object containing the properties to set |


#### Returns

[`MarkerComponentTooltip`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.schematics.tooltip-1.markercomponenttooltip.markercomponenttooltip)

this

#### Inherited from

[ComponentNodeTooltip](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.schematics.tooltip-1.componentnodetooltip.componentnodetooltip).[setProperties](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.schematics.tooltip-1.componentnodetooltip.componentnodetooltip#setproperties)

#### setSymbolClass

▸ **setSymbolClass**(`symbolClass`): [`MarkerComponentTooltip`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.schematics.tooltip-1.markercomponenttooltip.markercomponenttooltip)

Set symbol class

#### Parameters

| Name  | Type  | Description  |
|  --- | --- | --- |
| `symbolClass` | `string` | tooltip symbol class |


#### Returns

[`MarkerComponentTooltip`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.schematics.tooltip-1.markercomponenttooltip.markercomponenttooltip)

#### Inherited from

[ComponentNodeTooltip](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.schematics.tooltip-1.componentnodetooltip.componentnodetooltip).[setSymbolClass](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.schematics.tooltip-1.componentnodetooltip.componentnodetooltip#setsymbolclass)

#### getClassName

▸ `Static` **getClassName**(): `string`

#### Returns

`string`

#### Inherited from

[ComponentNodeTooltip](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.schematics.tooltip-1.componentnodetooltip.componentnodetooltip).[getClassName](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.schematics.tooltip-1.componentnodetooltip.componentnodetooltip#getclassname-1)