MapDefaultSettingsProvider.getArrowDefaultLabelMaskText

Syntax

getArrowDefaultLabelMaskText();

Description

The getArrowDefaultLabelMaskText method returns format for displaying labels of arrows on a map.

Comments

The method is intended for internal use, when the Arrow Labels checkbox is selected, if the express report contains a map with arrows. To display arrows, the express report data source must contain a cube with territory dimensions.

Example

Executing the example requires that the HTML page contains the MapChart component with the map identifier (see. Example of Creating the MapChart Component).

// Get basic map settings
defaultSettings = map.getSettingsProvider();
// Get map arrow label output format
console.log("Map arrow label output format: " + defaultSettings.getArrowDefaultLabelMaskText());

After executing the example the browser console displays settings of map arrow label output:

Map arrow label output format: {%StartShape} > {%EndShape}, {%TimelineStep}
Color, Width: {%ColorValue} - {%ColorTitle}