EaxMapDefaultSettingsProvider.getBarDefaultTooltipMaskText

Syntax

getBarDefaultTooltipMaskText();

Description

The getBarDefaultTooltipMaskText method returns display format for bar factor tooltip on express report map.

Comments

The method returns default output format.

Example

Executing the example requires that the HTML page contains the ExpressBox component with the expressBox identifier (see Example of Creating the ExpressBox Component) and have a loaded map in the working area. Get tooltip display settings:

// Get basic settings of express report map
dataView = expressBox.getDataView();
mapView = dataView.getMapView()
map = mapView.getInstance()
defaultSettings = map.getSettingsProvider();
// Get display format for bar factor tooltip
console.log("Display format for bar factor tooltip: " + defaultSettings.getBarDefaultTooltipMaskText());
// -> "{%Name}, {%TimelineStep}"
// Get display format for pie factor tooltip
console.log("Display format for pie factor tooltip: " + defaultSettings.getPieDefaultTooltipMaskText());
// -> "{%Name}, {%TimelineStep}
// Get display format for bubble factor tooltip
console.log("Display format for bubble factor tooltip: " + defaultSettings.getBubbleDefaultTooltipMaskText());
// -> "{%Name}, {%TimelineStep}
// Get display format for marker tooltip
console.log("Display format for marker tooltip: " + defaultSettings.getMarkerDefaultTooltipMaskText());
// -> "{%Name}, {%TimelineStep}

After executing the example the browser console displays basic settings of displaying tooltips for various visual elements of express report map.