Free cookie consent management tool by TermsFeed

Chart Reference Line Component

SAIL Design System guidance available for Charts

Every chart should tell a story. What does yours say? Learn how to build rich reporting dashboards that provide users with visualizations of their data.

Function
Copy link to clipboard

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.

Parameters
Copy link to clipboard

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
Copy link to clipboard

Displaying reference lines
Copy link to clipboard

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

Examples
Copy link to clipboard

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
Copy link to clipboard

Use the interactive editor below to test out your code:

Feature compatibility
Copy link to clipboard

The table below lists this 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

Custom record fields that evaluate in real time must be configured using one or more Custom Field functions.
Process Reports Incompatible

Cannot be used to configure a process report.
Process Events Incompatible

Cannot be used to configure a process event node, such as a start event or timer event.
Process Autoscaling Compatible

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

  • KPI Patterns (Formatting): The Key Performance Indicator (KPI) patterns provide a common style and format for displaying important performance measures.

  • Use a Filter to Adjust Chart Reference Lines (Filtering, Charts): Using a dropdown, filter the results of a data set while also adjusting a chart reference line.

Feedback
Copy link to clipboard