MapDefaultSettingsProvider.getBarDefaultTooltipMaskText

Syntax

getBarDefaultTooltipMaskText();

Description

The getBarDefaultTooltipMaskText method returns output format of map bar factor tooltip.

Comments

The method returns default output format.

Example

To execute the example the HTML page must contain the MapChart component with the "map" identifier (see Example of Creating the MapChart Component). Get tooltip display settings:

// Get basic settings of map
defaultSettings = map.getSettingsProvider();
// Get output format for bar factor tooltip
console.log("Output format of bat factor tooltip: " + defaultSettings.getBarDefaultTooltipMaskText());
// -> "{%Name}, {%TimelineStep}"
// {%HeightValue:#,##0.00} - {%HeightTitle}"
// Get output format of pie factor tooltip
console.log("Output format of pie factor tooltip: " + defaultSettings.getPieDefaultTooltipMaskText());
// -> "{%Name}, {%TimelineStep}
// {%Value:#,##0.00} - {%Title}"
// Get output format of bubble factor tooltip
console.log("Output format of bubble factor tooltip: " + defaultSettings.getBubbleDefaultTooltipMaskText());
// -> "{%Name}, {%TimelineStep}
// {%SizeValue:#,##0.00} - {%SizeTitle}"
// Get output format of label tooltip
console.log("Output format of label tooltip: " + defaultSettings.getMarkerDefaultTooltipMaskText());
// -> "{%Name}, {%TimelineStep}
// {%ColorValue:#,##0.00} - {%ColorTitle}"

After executing the example the browser console displays basic settings of tooltip output for various map visual components.