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, line, or area 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

This example demonstrate how to configure a chart using categories and series. For examples on using record data, see Chart Configuration Using Record Data.

Single series column chart with reference lines

Use the interactive editor below to test out your code:

Feature compatibility

The table below lists this SAIL component's compatibility with various features in Appian.
Feature Compatibility Note
Portals Compatible
Offline Mobile Compatible
Sync-Time Custom Record Fields Compatible

Can be used to create a custom record field that only evaluates at sync time.

Real-Time Custom Record Fields Incompatible
Process Reports Incompatible

You cannot use this function to configure a process report.

Process Events Incompatible

You cannot use this function to configure a process event node, such as a start event or timer event.

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

Open in Github Built: Mon, Dec 05, 2022 (08:15:39 PM)

On This Page

FEEDBACK