Chart Reference Line Component

Function

a!chartReferenceLine( label, value, showWhen, color, style )

Contains the reference line value for each threshold that is defined on a column, bar, or line chart.

See also:

Parameters

Name Keyword Types Description

Label

label

Text

Text to display on top of the reference line.

Value

value

Decimal

The numeric value at which the reference line will be drawn.

Visibility

showWhen

Boolean

Determines whether the reference line is displayed on the interface. When set to false, the reference line is hidden and is not evaluated. Default: true.

Color

color

Text

Color for the reference line. Valid values: Any valid hex color or "ACCENT", "BLUEGRAY", "GREEN", "GOLD", "ORANGE", "PURPLE", "RED","SKYBLUE", "LIMEGREEN", "YELLOW", "AMBER", "PINK", and "VIOLETRED".

Style

style

Text

Style of the reference line. Valid values are: "SOLID", "DOT", "DASH" (default), "DASHDOT", "SHORTDASH".

Usage considerations

Displaying reference lines

  • Reference lines will not display if used in a chart when the yAxisStyle is set to "NONE".

Examples

Use the interactive editor below to test out your code:

Single series column chart with reference lines

The following patterns include usage of the Chart Reference Line Component.

Open in Github Built: Tue, Sep 14, 2021 (11:54:22 AM)

On This Page

FEEDBACK