tooltip

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 option to true.

• Specify text to be displayed in tooltips. Specify the customizeTooltip option.

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

View Demo

This option supports the following colors.

• Hexadecimal colors
• RGB colors
• RGBA colors
• Predefined/cross-browser color names
• Predefined SVG colors

This option sets one color for all tooltips in the widget. To specify a color for a particular tooltip, use the customizeTooltip option.

By default, tooltips are shown within the body DOM element. Use this option if you need to specify another container for tooltips.

This option should be assigned a function that returns a specific object. The following fields can be specified in this object.

• text
  Specifies the text displayed by a tooltip. This is an obligatory option. If this option is not specified, the tooltip will not be shown.

• html
  Specifies the HTML markup displayed by a tooltip. [note]If you are going to use external resources (for example, images) in the markup, specify the size of the area they will occupy beforehand.

• color
  Specifies the color of a tooltip.

• fontColor
  Specifies the color of the text displayed by a tooltip.

• borderColor
  Specifies the color of the tooltip border.

When implementing a callback function for this option, you can access the hovered area or marker. For this purpose, use the object passed as the function's parameter or the this object. To discover the members of the obtained object that can be used, see the Area or Marker class description of the Map Elements reference section.

View Demo

If the widget container has the CSS z-index property specified and tooltips are displayed incorrectly, configure the z-index of the tooltips using this option.