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. |
a!columnChartConfig( primaryGrouping, secondaryGrouping, measures, sort, dataLimit, link, showIntervalsWithNoData )
Contains configuration for how to display data in a column chart. See the Column Chart Component page for examples on using this configuration supporting function.
See also:
Name | Keyword | Types | Description |
---|---|---|---|
Primary Grouping |
|
Grouping |
Defines the field labels to display on the axis in the chart, configured using a!grouping(). |
Secondary Grouping |
|
Grouping |
Defines the field labels to display in the stacking or grouped bars in the chart, configured using a!grouping(). |
Measures |
|
Measure |
Defines the numerical calculations for data in the chart, configured using a!measure(). If no measure is provided, a count of records shows as the measurement in the chart. |
Sort |
|
SortInfo |
Use a!sortInfo() to define a sort in ascending or descending order. Use the alias of any groupings or measures to sort by the values in the chart. Use a record field or related record field reference to sort by data that is not referenced in the chart. |
Data Limit |
|
Integer |
Maximum number of data points to display on the chart. Default: 100. Valid values: 1-5000. |
Link |
|
Any Type |
Link to execute when a user selects a data point on the chart. Use |
Show time intervals with no data |
|
Boolean |
Determines whether the axis in the chart displays date or time values that do not have a value associated with them. For example, show January, February, and March, even if February has no data. This parameter is only available when a Date, Time, or Date and Time field is used as the primary grouping. Default: false. |
a!columnChartConfig()
is always used within a column chart component.Count of <primary key field name>
.fv!selection
. This variable returns a map that contains each of the field aliases as the key and the unformatted value as the value. Since the alias is used for the key, aliases are required for each grouping and measure when using a link. See Chart Configuration Using Records for an example of how to configure a link.To use the showIntervalsWithNoData parameter, the primaryGrouping must be a Date, Time, or Date and Time field, and have a time interval set to a value other than "AUTO"
. For example:
true
when you select a time interval for your primary grouping.true
, the sort must be on the primaryGrouping field.Feature | Compatibility | Note |
---|---|---|
Portals | Compatible | |
Offline Mobile | Compatible | |
Sync-Time Custom Record Fields | Incompatible | |
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. |
The following patterns include usage of the Column Chart Configuration.
Aggregate Data by Multiple Fields and Display in a Chart (Reports, Charts, Query Data, Records): Aggregate data by multiple fields and display it in a stacked column chart. In this pattern, we will calculate the total number of employees for each title in each department and display it in a stacked column chart.
Configure a Chart Drilldown to a Grid (Charts, Grids, Query Data, Records): Displays a column chart with aggregate data from a record type and conditionally shows a grid with filtered records when a user selects a column on the chart.
Sales by Country and Currency (Records, Reports): This pattern illustrates how to create two different charts. One chart shows sales (calculated in US dollars) by country and the currency paid. The other shows sales by currency type, comparing the number of sales paid in US dollars versus the local currency.
Total Orders Compared to Orders Purchased with Promo Codes (Records, Reports, Charts): This pattern illustrates how to create a column chart that compares the number of total orders and the number of orders that had at least one item purchased with a promo code.
Column Chart Configuration