React VectorMap - tooltip

Configures tooltips.

Selector: Tooltip

Type:

A tooltip is a miniature rectangle displaying data of an area or a marker. A tooltip appears when the end-user hovers the cursor over an area or a marker. To show tooltips, do the following.

Enable tooltips.
Set the enabled property to true.
Specify text to be displayed in tooltips. Specify the customizeTooltip property.

You can also change the appearance of tooltips using fields of the tooltip configuration object.

View Demo

arrowLength

Specifies the length of a tooltip's arrow in pixels.

Type:

Number

Default Value: 10

border

Configures a tooltip's border.

Selector: Border

Type:

Object

color

Colors all tooltips.

Type:

String

Default Value: '#ffffff'

This property supports the following colors:

Hexadecimal colors
RGB colors
RGBA colors
Predefined/cross-browser color names
Predefined SVG colors
Paint server address

This property sets one color for all tooltips. You can specify a particular tooltip's color in the tooltip.customizeTooltip function.

container

Specifies the container in which to draw tooltips. The default container is the HTML DOM <body> element.

Type:

String

|

HTMLElement | jQuery

| undefined

Default Value: undefined

contentComponent

An alias for the contentTemplate property specified in React. Accepts a custom component. Refer to Using a Custom Component for more information.

contentRender

An alias for the contentTemplate property specified in React. Accepts a rendering function. Refer to Using a Rendering Function for more information.

contentTemplate

Specifies a custom template for a tooltip.

Type:

template

Template Data:

Layer Element

Information on the area or marker being pressed or hovered over. To distinguish between areas and markers, use the info.layer.type field.

Default Name: undefined

View Demo

cornerRadius

Makes all the tooltip's corners rounded.

Type:

Number

Default Value: 0, 4 (Fluent, Material)

The following table demonstrates how the corner's curvature depends on the cornerRadius value:

cornerRadius	Result
`cornerRadius: 0`
`cornerRadius: 15`
`cornerRadius: 35`

customizeTooltip

Specifies text and appearance of a set of tooltips.

Type:

Function

Function parameters:

info:

Layer Element

Information on the area or marker being pressed or hovered over with the mouse pointer.

Return Value:

Object

The tooltip's text or markup and color.

Default Value: undefined

Cannot be used in themes.

This property should be assigned a function that returns an object with the following fields:

Field name	Description
`text`	The tooltip's text.
`html`	The HTML markup displayed in a tooltip. The VectorMap evaluates the markup. Make sure that it does not contain malicious code. Refer to the following help topic for more information: Potentially Vulnerable API - customizeTooltip. To use external resources (for example, images) in the markup, specify the size of the area they occupy beforehand.
`color`	The tooltip's color.
`fontColor`	The color of the tooltip's text.
`borderColor`	The color of the tooltip's border.

NOTE

The tooltip is displayed only if text or html is specified.

NOTE

As an alternative to the function’s parameter you can use the this keyword.

Colors Customization Demo Tooltip HTML Support Demo

enabled

Enables tooltips.

Type:

Boolean

Default Value: false

font

Specifies tooltips' font properties.

Selector: Font

Type:

Object

opacity

Specifies tooltips' transparency.

Type:

Number

| undefined

Default Value: undefined

This property accepts a value from 0 to 1, where 0 makes tooltips completely transparent, and 1 makes them opaque.

paddingLeftRight

Generates an empty space, measured in pixels, between a tooltip's left/right border and its text.

Type:

Number

Default Value: 18

DevExtreme HTML5 JavaScript Funnel Tooltips Left-Right Padding

paddingTopBottom

Generates an empty space, measured in pixels, between a tooltip's top/bottom border and its text.

Type:

Number

Default Value: 15

DevExtreme HTML5 JavaScript Funnel Tooltips Top-Bottom Padding

shadow

Configures a tooltip's shadow.

Selector: Shadow

Type:

Object

zIndex

Specifies a tooltip's z-index.

Type:

Number

| undefined

Default Value: undefined

If the UI component's container has the CSS z-index property specified, and tooltips are displayed incorrectly, configure their z-index using this property.