EaxMapDefaultSettingsProvider.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 Arrows Labels checkbox is selected, if an express report contains a map with arrows. To display arrows, the express report data source must contain a cube with dimensions by territories.

Example

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

// Get basic map settings
dataView = expressBox.getDataView(); 
mapView = dataView.getMapView(); 
map = mapView.getInstance();
defaultSettings = map.getSettingsProvider();
// Get arrow label output format on map
console.log("Arrow label output format on map: " + defaultSettings.getArrowDefaultLabelMaskText());

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

Arrow label output format on map: {%StartShape} > {%EndShape}, {%TimelineStep}