Column Chart Component


a!columnChartField( label, instructions, categories, series, xAxisTitle, yAxisTitle, yAxisMin, yAxisMax, stacking, referenceLines, showLegend, showDataLabels, showTooltips, allowDecimalAxisLabels, labelPosition, helpTooltip, accessibilityText, showWhen, colorScheme, height, xAxisStyle, yAxisStyle, data, config )

Displays numerical data as vertical bars. Use a column chart to graphically display data that changes over time. If trend is more important than specific values, consider using a line chart.

See also:


Name Keyword Types Description




Text to display as the field label.




Supplemental text about this field.



List of Text String

Text to display on the x-axis next to each column.



List of ColumnChartSeries

Array of data series created with a!chartSeries().

X-Axis Title



Title for the independent (horizontal) axis.

Y-Axis Title



Title for the dependent (vertical) axis.

Min Y-Axis


Number (Decimal)

Determines the minimum displayed point on the vertical axis.

Max Y-Axis


Number (Decimal)

Determines the maximum displayed point on the vertical axis.




Determines if series values display as separate bars, stacked within one bar to show the sum of series values, or stacked to a height of 100% to show the contribution to the whole within each category. Valid values: "NONE" (default), "NORMAL", "PERCENT_TO_TOTAL".

Reference Lines


List of Variant

Array of reference line values for each threshold to be defined on the chart. Configured using a!chartReferenceLine().

Show legend



Determines if a color legend displays below the chart. Default: true.

Show data labels



Determines if data values are displayed on each column. Default: false.

Show tooltips



Determines if a tooltip displays the data value for a column. Default: true.

Allow decimal axis labels



Allows dependent (vertical) values to display as decimal numbers instead of integers. Default: false.

Label Position



Determines where the label appears. Valid values:

  • "ABOVE" (default) Displays the label above the component.
  • "ADJACENT" Displays the label to the left of the component.
  • "COLLAPSED" Hides the label. The label will still be read by screen readers; see accessibility considerations for more information.
  • "JUSTIFIED" Aligns the label alongside the component starting at the edge of the page.

Help Tooltip



Displays a help icon with the specified text as a tooltip. The tooltip displays a maximum of 500 characters. The help icon does not show when the label position is "COLLAPSED".

Accessibility Text



Additional text to be announced by screen readers. Used only for accessibility; produces no visible change.




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

Color scheme


Any type

Determines which color scheme to use in the chart. Use one of the following valid values: "CLASSIC" (default), "MIDNIGHT", "OCEAN", "MOSS", "BERRY", "PARACHUTE", "RAINFOREST", "SUNSET" or define a custom color scheme using a!colorSchemeCustom. See Chart Color Scheme for color scheme examples.




Determines the chart height. Valid values: "MICRO", "SHORT", "MEDIUM" (default), "TALL". See Chart Heights for guidance on using the MICRO size.

X-Axis Style



Determines how to display the labels and axis separators for the X-Axis. Valid values: "STANDARD" (default), "NONE".

Y-Axis Style



Determines how to display the labels, axis separators, and grid lines for the Y-Axis. Valid values: "STANDARD" (default), "MINIMAL", "NONE".



Any type

Reference to the record type used for the source of this chart. Can accept a!recordData or a Record Type Reference.

Chart Configuration



Configures how to display data on the chart, including fields used for calculations and grouping, using a!columnChartConfig().


There are two ways to configure a column chart:

  1. Set a record type as the data source and define fields to display on the chart.
  2. Perform your own query and define lists of data within the categories and series.

The chart allows using an entity-backed or synced record type as the source. If you have one of these record types available as a source, we recommend using the record type as the source. This configuration is easier because Appian will perform the query for you and display the results in the bar chart directly. If you have complex requirements or your data source is not a entity-backed or synced record type, use the categories and series to construct the chart manually.

Using record data

Configuring a column chart using a record type as the source requires using two parameters: data and config. Once you provide a source record type in the data parameter and provide the fields in the config parameter, the chart displays the results.

See Chart Configuration Using Record Data for details on using a record type as the source.

Using categories and series

When using categories and series, you must provide the list of data labels and values directly to these parameters. See the notes below for guidance.


  • The order of items in the Categories array determines the display order of categories on the chart with the left-most item in the array appearing on the far left of the x-axis.
  • For each null or empty item in the array passed to Categories, [Category #] displays on the x-axis with # as the index number in the Categories array of the null or empty item. For example, [Category 1].
  • The index of each item in the Categories array must match with the index of its Series data value. You can retrieve a dictionary from the data field of a query result, and then use a!chartSeries() to create the chart series array.


  • A single series item produces a bar for each categories item with all bars the same color. The data parameter should contain a list of values that match the size of the list for categories.
  • When you have multiple series items, Appian recommends setting showLegend to true, so user's know what each color represents. When you only have one series item, you can use the label or instructions fields to tell users what the data represents.
  • If the series argument has a non-null label value paired with a 0, null, or empty data value, the data value still displays in the legend.
  • If the series argument has a null or empty label value paired with a non-null data value, the label value displays as [Series #] with # as the index number of the data value. For example, [Series 1].
  • If values are small and less than a whole number, Appian recommends settings allowDecimalAxisLabels to true.
  • Multiple series items when stacking is PERCENT_TO_TOTAL also shows a single bar for each category, but bars have a total height of 100%. Each value shows the percent contribution to the total within each category.

Series and stacking

  • Multiple series items when stacking is NONE or null produces a set of bars for each Categories item - one bar for each series item with each bar in that set a different color. The order of the label items determine the display order of the columns in each set with the first label item appearing at the top of the set.
  • Multiple series items when stacking is NORMAL produces a single bar for each categories item with each series item displayed as a different segment of the bar in a different color, so they appear stacked on top of each other. The order of the series.label items determine the display order of the bar segments with the first series.label item appearing furthest from the axis.

Usage considerations

Chart height and background color

  • Column charts with a height of "TALL", "MEDIUM" or "SHORT" will show a scroll bar if too many categories are provided. "MICRO" charts will only show scroll bars on mobile devices; on a web browser, these charts will adjust to fit the size of the column.
  • When the chart is placed in a colored card, the chart background will match the color of the card. Text labels and lines in the chart will also adjust if a dark background color is used. See the UX Design Guide for best practices on using charts with background colors.

Chart data and stacking

  • If data contains a!recordData or a record type reference, the categories and series parameters are ignored.
  • The Percent to Total stacking will also update the axes and tooltips to show with a percentage. Also, the minimum and maximum y-axes values refer to percentages. For example, yAxisMax: 50 would set the maximum y-axis at 50%.


Use the interactive editor below to test out your code:

The examples below demonstrate how to configure your charts using categories and series. For examples on using record data, please see Chart Configuration Using Record Data.

Single series column chart with label, y-axis title, and tooltips

Multiple series column chart with label, x-axis title, y-axis title, and legend

Use the interactive editor below to test out your code:

Column charts with more than 10 points of data in a series can cause performance issues on the Appian Android application.

The following patterns include usage of the Column Chart Component.

Open in Github Built: Tue, May 23, 2023 (06:12:33 PM)

On This Page