ColorLegendBase.BetweenFormat

Syntax

BetweenFormat: String;

Description

The BetweenFormat property determines format for intervals with both borders.

Comments

Use JSON or the setBetweenFormat method to set the property value, and the getBetweenFormat method to get the property value.

Example

To execute the example, the HTML page must contain the BubbleChart component named bubbleChart (see Example of Creating the BubbleChart Component). Set new values for the following properties of value intervals legend: format of intervals with left, right and both borders, position and text of the element that corresponds to missing data in visualizer, color and transparency of legend elements highlighting brush, color of highlighted elements. Enable legend elements highlighting, set highlighting on click:

// Get value interval legend
var legend = bubbleChart.getLegend();
// Set record format for intervals with both borders
legend.setBetweenFormat("from {0:0} to {1:0}")
// Set record format for interval with left border
legend.setGreaterFormat("greater than {0:0}");
// Set record format for interval with right border
legend.setLessFormat("less than {0:0}");
/*
 Set position of the element corresponding to absent data 
 in visualizer before other elements 
*/
legend.setNoDataPosition(PP.Ui.NoDataPosition.Before);
// Set signature for the element corresponding to absent data in visualizer 
legend.setNoDataText("no data");
// Set color and transparency for legend element highlight brush
var brush = legend.getHighlightBrush();
brush.setColor("#FFE500");
brush.setOpacity(0.2);
legend.setHighlightBrush(brush);
// Set color of highlighted legend elements
legend.setHighlightItemColor("LightSeaGreen");
// Enable highlighting of legend elements
legend.setDoHighlight(true);
// Set highlighting display mode on click
legend.setHoverMode(PP.HoverMode.Click);
// Refresh bubble chart
bubbleChart.refresh();

Click on any element of value intervals legend.

After executing the example the following legend properties are changed: record format of intervals with left, right and both borders, position and text of the element corresponding to absent data in visualizer, color and transparency of legend elements highlight brush, color of highlighted elements, highlighting display mode is set on click, and legend elements highlighting is enabled:

See also:

ColorLegendBase