Token Reference
Tokens available to create dynamic label content.
Introduction
Text string settings allow tokens prefixed with a percentage sign to be replaced by actual data when the chart is rendered. This is particularly useful for default level settings. For example, the following setting will result in each point's label showing the point's name.
{
defaultPoint_label_text: "%name"
}
Virtually all labels and some other string properties support the use of tokens. For example, point configuration supports tokens in label text, tooltips and url properties.
Different sets of tokens are available based on the type of data the parent objects represent such as a series, point, seriesCollection and so on.
Note: A <br> tag can be used in label text to specify labels with multiple lines.
PercentOf* Token Calculations
Percentages are calculated based on the given value / sum of all series. However, the sum in this calculation is based on the absolute value of the points range from yStart to y or from 0 to y. To sum up y values, the following calculation is used:
Sum += Math.abs(y - (yStart || 0));
Reference
Point Tokens
Used by: Point Labels, Point Tooltips, Point URLs, Point Text Events| Token Name | Description |
|---|---|
| Identification | |
| '%name' | Point's Name |
| '%icon' | (v2.7) Renders an icon that references the point's appearance. |
| '%parentName' | The parent point's name or the series name. Used with tree data where points have parent points. |
| '%parentId' | The parent point's ID. Used with tree data where points have parent points. |
| '%seriesName' | Series name point belongs to. |
| '%color' | Point color |
| '%id' | Point's ID |
| '%yAxisLabel' | Label text of the Y axis this point is plotted on. |
| '%xAxisLabel' | Label text of the X axis this point is plotted on. |
| Values | |
| '%yValue' | Point's Y value. |
| '%yStart' | Point's yStart value. |
| '%xValue' | Point's X value |
| '%zValue' | Point's Z value |
| '%__' | Custom point attribute key values can be used to retrieve additional point data. This data can be defined through point.attributes. Reference: point.attributes JSON Configuration Label Data Attributes Sample Uses data point attributes and displays them in labels with tokens. |
| '%seriesPointCount' | Number of points in series. |
| Calculations (Y Values) | |
| '%percentile' | The y value percentile calculation of this point in relation to other points within the parent series. |
| '%percentOfTotal' | The percentage of all the series on the chart this point represents. |
| '%percentOfSeries' | The percentage of the series this point represents. |
| '%percentOfGroup' | The percentage of all the elements with the same name this point represents. |
| '%percentOfSeriesMax' | The point's y value percentage of the maximum point value on the chart. point represents. |
| '%percentOfSeriesRange' | The point's y value percentage of the range between the parent series minimum and maximum point. |
| Calculations (X Values) | |
| '%xPercentile' | The x value percentile calculation of this point in relation to other points within the parent series. |
| '%xPercentOfTotal' | The percentage of x values of all the series on the chart this point represents. |
| '%xPercentOfSeries' | The percentage of x values of the series this point represents. |
| '%xPercentOfGroup' | The percentage of x values of all the elements with the same name this point represents. |
| '%xPercentOfSeriesMax' | The point's x value percentage of the maximum point value on the chart. point represents. |
| '%xPercentOfSeriesRange' | The point's x value percentage of the range between the parent series minimum and maximum point. |
| Calculations (Z Values) | |
| '%zPercentile' | The z value percentile calculation of this point in relation to other points within the parent series. |
| '%zPercentOfTotal' | The percentage of z values of all the series on the chart this point represents. |
| '%zPercentOfSeries' | The percentage of z values of the series this point represents. |
| '%zPercentOfGroup' | The percentage of z values of all the elements with the same name this point represents. |
| '%zPercentOfSeriesMax' | The point's z value percentage of the maximum point value on the chart. point represents. |
| '%zPercentOfSeriesRange' | The point's z value percentage of the range between the parent series minimum and maximum point. |
| '%yPercentOfAxisRange' | (v1.2) Percentage of Y axis range. |
| '%xPercentOfAxisRange' | (v1.2) Percentage of X axis range. |
| '%PercentOfDataMax' | (v1.2) Percentage of the max y value of all series. |
| '%xPercentOfDataMax' | (v1.2) Percentage of the max x value of all series. |
| '%zPercentOfDataMax' | (v1.2) Percentage of the max z value of all series. |
| '%PercentOfDataRange' | (v1.2) Percentage of the range of y values in all series. |
| '%xPercentOfDataRange' | (v1.2) Percentage of the range of x values in all series. |
| '%zPercentOfDataRange' | (v1.2) Percentage of the range of z values in all series. |
| Finance / Navigator Only | |
| '%open' | Open price value. |
| '%high' | High price value. |
| '%low' | Low price value. |
| '%close' | Close price value. |
Series Tokens
Used by: Legend Entry Text| Token Name | Description |
|---|---|
| Identification | |
| '%name' | Series name. |
| '%id' | Series ID |
| '%color' | Series color. |
| '%yAxisLabel' | Label text of the Y axis this point is plotted on. |
| '%xAxisLabel' | Label text of the X axis this point is plotted on. |
| Point Specific | |
| '%pointCount' | Number of points in series. |
| '%lastY' | Y value of the last point in the series |
| '%lastX' | X value of the last point in the series |
| '%lastZ' | Z value of the last point in the series |
| '%maxPointName' | Name of the point with the largest y value. |
| '%minPointName' | Name of the point with the smallest y value. |
| '%xMaxPointName' | Name of the point with the largest x value. |
| '%xMinPointName' | Name of the point with the smallest x value. |
| '%zMaxPointName' | Name of the point with the largest z value. |
| '%zMinPointName' | Name of the point with the smallest z value. |
| Calculations (Y Values) | |
| '%sum' | Sum of series point y values. |
| '%max' | Largest point y value. |
| '%min' | Smallest point y value |
| '%average' | Average of series point y values. |
| '%median' | Mode of series point y values. |
| '%mode' | Mode of series point y values. |
| '%rangeSum' | Sums of differences between point y and yStart values. |
| '%percentOfTotal' | Percentage of all series on the chart this series represents. |
| Calculations (X Values) | |
| '%xSum' | Sum of series point x values. |
| '%xMax' | Largest point x value. |
| '%xMin' | Smallest point x value |
| '%xAverage' | Average of series point x values. |
| '%xMedian' | Mode of series point x values. |
| '%xMode' | Mode of series point x values. |
| '%xPercentOfTotal' | The x value percentage of all series on the chart this series represents. |
| Calculations (Z Values) | |
| '%zSum' | Sum of series point z values. |
| '%zMax' | Largest point z value. |
| '%zMin' | Smallest point z value |
| '%zAverage' | Average of series point z values. |
| 'zMedian' | Mode of series point z values. |
| '%zMode' | Mode of series point z values. |
| '%xPercentOfTotal' | The z value percentage of all series on the chart this series represents. |
| Added in Version 2.6 | |
| '%xMaxSum' | The x value sum of the series with the highest x value sum. |
| '%yMaxSum' | The y value sum of the series with the highest y value sum. |
| '%zMaxSum' | The z value sum of the series with the highest z value sum. |
| '%xMinSum' | The x value sum of the series with the lowest x value sum. |
| '%yMinSum' | The y value sum of the series with the lowest y value sum. |
| '%zMinSum' | The z value sum of the series with the lowest z value sum. |
| '%xMaxAverage' | The x value average of the series with the highest x value average. |
| '%yMaxAverage' | The y value average of the series with the highest y value average. |
| '%zMaxAverage' | The z value average of the series with the highest z value average. |
| '%xMinAverage' | The x value average of the series with the lowest x value average. |
| '%yMinAverage' | The y value average of the series with the lowest y value average. |
| '%zMinAverage' | The z value average of the series with the lowest z value average. |
| '%zMaxOfSeries' | The maximum z value of points on the chart. |
| '%zMinOfSeries' | The minimum z value of points on the chart. |
| '%zSumOfSeries' | The z value sum of all points on the chart. |
| '%zRangeOfSeries' | The sum of all range z values of all points on the chart. |
| '%zAbsMaxOfSeries' | The absolute max z value of all points on the chart. |
Series Collection Tokens
Used by: Title Label| Token Name | Description |
|---|---|
| Basic Data | |
| '%pointCount' | Number of points in all series.. |
| Identify Points/Series | |
| '%maxSeriesName' | Name of the series with the largest y value point. |
| '%minSeriesName' | Name of the series with the smallest y value point. |
| '%maxPointName' | Name of the point with the largest y value. |
| '%minPointName' | Name of the point with the smallest y value. |
| '%xMaxSeriesName' | Name of the series with the largest x value point. |
| '%xMinSeriesName' | Name of the series with the smallest x value point. |
| '%xMaxPointName' | Name of the point with the largest x value. |
| '%xMinPointName' | Name of the point with the smallest x value. |
| '%zMaxSeriesName' | Name of the series with the largest z value point. |
| '%zMinSeriesName' | Name of the series with the smallest z value point. |
| '%zMaxPointName' | Name of the point with the largest z value. |
| '%zMinPointName' | Name of the point with the smallest z value. |
| Calculations (Y Values) | |
| '%sum' | Sum of all y values on the chart. |
| '%max' | Maximum y value of the chart data. |
| '%min' | Minimum y value of the chart data. |
| '%average' | Average y value of chart data. |
| '%median' | Median y value of chart data. |
| '%mode' | Mode y value of chart data. |
| '%rangeSum' | Sums of differences between point y and yStart values. |
| Calculations (X Values) | |
| '%xSum' | Sum of all x values on the chart. |
| '%xMax' | Maximum x value of the chart data. |
| '%xMin' | Minimum x value of the chart data. |
| '%xAverage' | Average x value of chart data. |
| '%xMedian' | Median x value of chart data. |
| '%xMode' | Mode x value of chart data. |
| Calculations (Z Values) | |
| '%zSum' | Sum of all z values on the chart. |
| '%zMax' | Maximum z value of the chart data. |
| '%zMin' | Minimum z value of the chart data. |
| '%zAverage' | Average z value of chart data. |
| '%zMedian' | Median z value of chart data. |
| '%zMode' | Mode z value of chart data. |
| Added in Version 2.6 | |
| '%xMaxSum' | The x value sum of the series with the highest x value sum. |
| '%yMaxSum' | The y value sum of the series with the highest y value sum. |
| '%zMaxSum' | The z value sum of the series with the highest z value sum. |
| '%xMinSum' | The x value sum of the series with the lowest x value sum. |
| '%yMinSum' | The y value sum of the series with the lowest y value sum. |
| '%zMinSum' | The z value sum of the series with the lowest z value sum. |
| '%xMaxAverage' | The x value average of the series with the highest x value average. |
| '%yMaxAverage' | The y value average of the series with the highest y value average. |
| '%zMaxAverage' | The z value average of the series with the highest z value average. |
| '%xMinAverage' | The x value average of the series with the lowest x value average. |
| '%yMinAverage' | The y value average of the series with the lowest y value average. |
| '%zMinAverage' | The z value average of the series with the lowest z value average. |
Value/Rage Tokens
Used by: Axis Tick labels, Axis Markers| Token Name | Description |
|---|---|
| '%value' | Represents the value. |
| '%min' | Low value. |
| '%max' | High value. |
| '%range' | High minus low value. Or the value if it is not a range. |
| '%minutes' | If using a time range, this token results in the total minutes in the duration. |
| '%hours' | If using a time range, this token results in the total hours in the duration. |
| '%days' | If using a time range, this token results in the total days in the duration. |
Point List Tokens
Used by: Combined Tooltips (defaultTooltip.text)| Token Name | Description |
|---|---|
| '%xValue' | Points shared x value |
| '%yList' | A comma delimited list of y values for each point in this list. Can be used to populate microchart data. |
| '%colors' | A comma delimited list of the colors associated with each point. |
| '%ysum' | Sum of all y values on the chart. |
| '%sum' | Sum of all y values on the chart. |
| '%ymax' | Maximum y value of the related points. |
| '%max' | Maximum y value of the related points. |
| '%ymin' | Minimum y value of the related points. |
| '%min' | Minimum y value of the related points. |
| '%pointCount' | Number of points in this list. |
| '%count' | Number of points in this list. |
| '%points' | In case of defaultTooltip.text property, this will be a new line delimited list the point.tooltip text of each point in this list. To exclude a point from the list the point.tooltip text can be set to an empty string. |