Application configuration
Informations about an application.
Properties
| Name | Label | Documentation | Type |
|---|---|---|---|
| Title | The application title appears on the welcome page and in the navigation drawer. |
|
| Documentation (Markdown) | Status: TODO Rich text describing the application. The <a href="https://commonmark.org/help/" target="_blank">Markdown</a> syntax is supported. | |
| Default Palette | Color palette used by default in the charts. A different palette may also be defined for each chart. | |
| Required role | Role required to access this application. Roles must be declared first in the platform Configuration to appear in this list. | |
| Avatar | Icon used in the navigation drawer title and the welcome page. For better results, use an SVG image or icon. | |
| Favicon | Icon displayed in the browser tab. Use a PNG, GIF or ICO image format. | |
| Cover image | Background image of the navigation drawer title. An optimal image size is 250 x 128px. | |
| Title color | Color for the application title text. It should contrast with the cover image. | |
| Navigation drawer | Navigation drawer configuration | |
| Visible | Displays/Hides the application on Welcome Page. |
|
Navigation dashboard argument
Argument used to parameterize a dashboard opened from the navigation drawer.
Properties
| Name | Label | Documentation | Type |
|---|---|---|---|
| Parameter | Name of the dashboard parameter |
|
| Value | Value passed to the dashboard parameter |
Navigation dashboard arguments
List of arguments used to parameterize a dashboard opened from the navigation drawer.
Type: Array<Navigation dashboard argument>
Item
Navigation item appearing in the navigation drawer.
Properties
| Name | Label | Documentation | Type |
|---|---|---|---|
| Dashboard | Existing application dashboard opened by the navigation item. |
|
| Label | The item label appears in the navigation drawer. The label of the selected dashboard is used by default. | |
| Label color | Color of the label | |
| Icon | Icon displayed in the navigation drawer | |
| Icon color | Color of the icon. Note that coloring works for SVG icons with no embedded color information. | |
| Arguments | Arguments passed to the opened dashboard |
Group
Group of navigation items in the navigation drawer.
Properties
| Name | Label | Documentation | Type |
|---|---|---|---|
| Label | The group label appears in the navigation drawer. | |
| Show divider | Show a thin line above the group. |
|
| Items | Items in the navigation group |
Navigation drawer
UI panel that shows the application’s main navigation menu.
Properties
| Name | Label | Documentation | Type |
|---|---|---|---|
| Groups | Groups in the navigation drawer |
Axis
An axis displays data points in a range of values.
Sub-types: Value axis, Categories axis
Properties
| Name | Label | Documentation | Type |
|---|---|---|---|
| Title | Titre (label) of this axis. |
|
| Hide title | Check to hide the axis title. |
|
| Hide labels | Check to hide labels along this axis. |
|
| Show grid | Check to show the grid lines for this axis. |
|
| Truncation length (characters) | Truncate large labels to this number of characters. |
|
Scale
Scale used for a value axis.
Type: enum
Enum Values
| Value | Label | Description |
|---|---|---|
| Linear | Linear scale |
| Logarithmic | Logarithmic scale |
Series stacking
Stacking or grouping mode for the series.
Type: enum
Enum Values
| Value | Label | Description |
|---|---|---|
| Clustered | Show data from multiple data series in clusters of shapes (for example, clusters of horizontal or vertical bars). |
| Stacked | Show data from multiple data series in stacked shapes (for example, horizontally or vertically stacked bars). |
| Stacked 100% | Show the relative percentage of multiple data series in stacked bars or areas, where the total (cumulative) of the stacked bar or area always equals 100%. |
Value axis
Axis of ordinates (or y axis) where the measures appear.
Extends: Axis
Properties
| Name | Label | Documentation | Type |
|---|---|---|---|
| Title | Inherited from Axis Titre (label) of this axis. |
|
| Hide title | Inherited from Axis Check to hide the axis title. |
|
| Hide labels | Inherited from Axis Check to hide labels along this axis. |
|
| Show grid | Inherited from Axis Check to show the grid lines for this axis. |
|
| Truncation length (characters) | Inherited from Axis Truncate large labels to this number of characters. |
|
| Min value | Minimum value for this axis. |
|
| Max value | Maximum value for this axis. |
|
| Interval | Interval between grid lines on this axis. |
|
| Minimum interval | If the Interval is not specified, it is automatically computed. The minimum interval defines the minimum space between two grid lines. |
|
| Axis scale | Type of scale used for this axis. The logarithmic scale is more suitable when the values are distributed on a large range. | |
| Logarithmic base | Numeric base used for the logarithmic scale. |
|
| Target goal | Goal value, materialized on the chart as a line. |
|
| Target goal color | Color of the target goal line. | |
| Stacking | Stacking method used for the series on this axis:
|
Categories axis
X axis, showing category labels.
Extends: Axis
Properties
| Name | Label | Documentation | Type |
|---|---|---|---|
| Title | Inherited from Axis Titre (label) of this axis. |
|
| Hide title | Inherited from Axis Check to hide the axis title. |
|
| Hide labels | Inherited from Axis Check to hide labels along this axis. |
|
| Show grid | Inherited from Axis Check to show the grid lines for this axis. |
|
| Truncation length (characters) | Inherited from Axis Truncate large labels to this number of characters. |
|
| Group labels | Group (merge) adjacent labels with the same value. |
|
Chart
Graphical representation of pivot query.
Sub-types: Number chart, Pivot table chart, Category chart, Hierarchical chart, Sunburst chart, Treemap chart, Series chart, Donut/pie chart, Gauge chart, Axis chart, Column chart, Bar chart, Line chart, Area chart, Combined chart
Properties
| Name | Label | Documentation | Type |
|---|---|---|---|
| Chart type | Visualization used for this chart. | Value per sub-types:
|
| Label | Label appearing as the chart title. | |
| Documentation (Markdown) | Rich text describing the chart. It appears near the chart title. The <a href="https://commonmark.org/help/" target="_blank">Markdown</a> syntax is supported. | |
| Label placement | Default position of the chart title, relative to the visualization. Select Hidden to hide the title. | |
| Show divider | Show a thin line between the title and the visualization. |
|
| Required role | Role required to access this chart. Roles must be declared first in the platform Configuration to appear in this list. | |
| Pivot query | A table that summarize the data using dimensions and measures. | |
| Enable drilldown | Enable drilldown into the data aggregated into a measure value. |
|
| Filters | Filters applies to render a subset of the query data. These filters are combined with an AND operator. |
Target goal display type
Defines how the target goal is represented in a number chart.
Type: enum
Enum Values
| Value | Label | Description |
|---|---|---|
| None | The target goal is not displayed on the chart |
| Number | Display the target value |
| Percentage | Display the percentage of target goal achieved |
| Difference | Display the difference between the target and the value |
| Difference Percentage | Display the percentage of difference between the target and the value |
Number chart
Chart displaying a single numerical value.
Extends: Chart
Properties
| Name | Label | Documentation | Type |
|---|---|---|---|
| Chart type | Inherited from Chart Visualization used for this chart. |
|
| Label | Inherited from Chart Label appearing as the chart title. | |
| Documentation (Markdown) | Inherited from Chart Rich text describing the chart. It appears near the chart title. The <a href="https://commonmark.org/help/" target="_blank">Markdown</a> syntax is supported. | |
| Label placement | Inherited from Chart Default position of the chart title, relative to the visualization. Select Hidden to hide the title. | |
| Show divider | Inherited from Chart Show a thin line between the title and the visualization. |
|
| Required role | Inherited from Chart Role required to access this chart. Roles must be declared first in the platform Configuration to appear in this list. | |
| Pivot query | Inherited from Chart A table that summarize the data using dimensions and measures. | |
| Enable drilldown | Inherited from Chart Enable drilldown into the data aggregated into a measure value. |
|
| Filters | Inherited from Chart Filters applies to render a subset of the query data. These filters are combined with an AND operator. | |
| Positive variation color | Color indicating a positive variation. | |
| Negative variation color | Color indicating a negative variation. | |
| Target goal | Target value to which the chart value is compared. |
|
| Target goal format | Comment: When not defined: fallback to measure number format or reasonable default (e.g. two decimals if PCT) Format used to display the target goal value. | |
| Show target as | Defines how the target value appears in the chart:
|
Pivot table chart
Chart displaying the pivot query as a table with a hierarchy of rows and columns.
Extends: Chart
Properties
| Name | Label | Documentation | Type |
|---|---|---|---|
| Chart type | Inherited from Chart Visualization used for this chart. |
|
| Label | Inherited from Chart Label appearing as the chart title. | |
| Documentation (Markdown) | Inherited from Chart Rich text describing the chart. It appears near the chart title. The <a href="https://commonmark.org/help/" target="_blank">Markdown</a> syntax is supported. | |
| Label placement | Inherited from Chart Default position of the chart title, relative to the visualization. Select Hidden to hide the title. | |
| Show divider | Inherited from Chart Show a thin line between the title and the visualization. |
|
| Required role | Inherited from Chart Role required to access this chart. Roles must be declared first in the platform Configuration to appear in this list. | |
| Pivot query | Inherited from Chart A table that summarize the data using dimensions and measures. | |
| Enable drilldown | Inherited from Chart Enable drilldown into the data aggregated into a measure value. |
|
| Filters | Inherited from Chart Filters applies to render a subset of the query data. These filters are combined with an AND operator. | |
| Rows title | Title of the set of rows. This title replaces the title automatically generated from the categories labels. |
|
| Columns title | Title of the set of columns. |
|
| Columns header background color | Background color for the column headers. | |
| Rows header background color | Background color for the row headers. | |
| Table background color | Background color for all the table cells. | |
| Total background color | Background color for the grand total cells. | |
| Subtotals background color | Background color for the subtotals cells. | |
| Allow expand/collapse | Allow expanding and collapsing rows and columns. |
|
Legend placement
Position of the legend, relative to the chart.
Type: enum
Enum Values
| Value | Label | Description |
|---|---|---|
| Hidden | The legend is not displayed |
| Left | The legend appears left of the chart |
| Right | The legend appears right of the chart |
| Top | The legend appears above the chart |
| Bottom | The legend appears below the chart |
Category chart
Chart supporting multiple categories.
Extends: Chart
Sub-types: Hierarchical chart, Sunburst chart, Treemap chart, Series chart, Donut/pie chart, Gauge chart, Axis chart, Column chart, Bar chart, Line chart, Area chart, Combined chart
Properties
| Name | Label | Documentation | Type |
|---|---|---|---|
| Chart type | Inherited from Chart Visualization used for this chart. |
|
| Label | Inherited from Chart Label appearing as the chart title. | |
| Documentation (Markdown) | Inherited from Chart Rich text describing the chart. It appears near the chart title. The <a href="https://commonmark.org/help/" target="_blank">Markdown</a> syntax is supported. | |
| Label placement | Inherited from Chart Default position of the chart title, relative to the visualization. Select Hidden to hide the title. | |
| Show divider | Inherited from Chart Show a thin line between the title and the visualization. |
|
| Required role | Inherited from Chart Role required to access this chart. Roles must be declared first in the platform Configuration to appear in this list. | |
| Pivot query | Inherited from Chart A table that summarize the data using dimensions and measures. | |
| Enable drilldown | Inherited from Chart Enable drilldown into the data aggregated into a measure value. |
|
| Filters | Inherited from Chart Filters applies to render a subset of the query data. These filters are combined with an AND operator. | |
| Legend placement | Status: WIP Position of the legend, relative to the chart. Select Hidden to hide the legend. | |
| Palette | Color palette used by this chart. |
Chart category configurations
Array of category configurations of a hierarchical chart.
Type: Array<Chart category configuration>
Hierarchical chart
Chart displaying values for a hierarchy of categories.
Extends: Category chart
Sub-types: Sunburst chart, Treemap chart
Properties
| Name | Label | Documentation | Type |
|---|---|---|---|
| Chart type | Inherited from Chart Visualization used for this chart. |
|
| Label | Inherited from Chart Label appearing as the chart title. | |
| Documentation (Markdown) | Inherited from Chart Rich text describing the chart. It appears near the chart title. The <a href="https://commonmark.org/help/" target="_blank">Markdown</a> syntax is supported. | |
| Label placement | Inherited from Chart Default position of the chart title, relative to the visualization. Select Hidden to hide the title. | |
| Show divider | Inherited from Chart Show a thin line between the title and the visualization. |
|
| Required role | Inherited from Chart Role required to access this chart. Roles must be declared first in the platform Configuration to appear in this list. | |
| Pivot query | Inherited from Chart A table that summarize the data using dimensions and measures. | |
| Enable drilldown | Inherited from Chart Enable drilldown into the data aggregated into a measure value. |
|
| Filters | Inherited from Chart Filters applies to render a subset of the query data. These filters are combined with an AND operator. | |
| Legend placement | Status: WIP Inherited from Category chart Position of the legend, relative to the chart. Select Hidden to hide the legend. | |
| Palette | Inherited from Category chart Color palette used by this chart. | |
| Categories | Configuration of the categories |
Sunburst chart
Chart displaying a multi-level donut/pie chart.
Extends: Hierarchical chart
Properties
| Name | Label | Documentation | Type |
|---|---|---|---|
| Chart type | Inherited from Chart Visualization used for this chart. |
|
| Label | Inherited from Chart Label appearing as the chart title. | |
| Documentation (Markdown) | Inherited from Chart Rich text describing the chart. It appears near the chart title. The <a href="https://commonmark.org/help/" target="_blank">Markdown</a> syntax is supported. | |
| Label placement | Inherited from Chart Default position of the chart title, relative to the visualization. Select Hidden to hide the title. | |
| Show divider | Inherited from Chart Show a thin line between the title and the visualization. |
|
| Required role | Inherited from Chart Role required to access this chart. Roles must be declared first in the platform Configuration to appear in this list. | |
| Pivot query | Inherited from Chart A table that summarize the data using dimensions and measures. | |
| Enable drilldown | Inherited from Chart Enable drilldown into the data aggregated into a measure value. |
|
| Filters | Inherited from Chart Filters applies to render a subset of the query data. These filters are combined with an AND operator. | |
| Legend placement | Status: WIP Inherited from Category chart Position of the legend, relative to the chart. Select Hidden to hide the legend. | |
| Palette | Inherited from Category chart Color palette used by this chart. | |
| Categories | Inherited from Hierarchical chart Configuration of the categories | |
| Size (%) | Size of the visualization in percentage of the chart size. | |
| Hole size (%) | Size of the central hole in percentage of the chart size. |
Treemap chart
Chart displaying values as a hierarchy of nested rectangles.
Extends: Hierarchical chart
Properties
| Name | Label | Documentation | Type |
|---|---|---|---|
| Chart type | Inherited from Chart Visualization used for this chart. |
|
| Label | Inherited from Chart Label appearing as the chart title. | |
| Documentation (Markdown) | Inherited from Chart Rich text describing the chart. It appears near the chart title. The <a href="https://commonmark.org/help/" target="_blank">Markdown</a> syntax is supported. | |
| Label placement | Inherited from Chart Default position of the chart title, relative to the visualization. Select Hidden to hide the title. | |
| Show divider | Inherited from Chart Show a thin line between the title and the visualization. |
|
| Required role | Inherited from Chart Role required to access this chart. Roles must be declared first in the platform Configuration to appear in this list. | |
| Pivot query | Inherited from Chart A table that summarize the data using dimensions and measures. | |
| Enable drilldown | Inherited from Chart Enable drilldown into the data aggregated into a measure value. |
|
| Filters | Inherited from Chart Filters applies to render a subset of the query data. These filters are combined with an AND operator. | |
| Legend placement | Status: WIP Inherited from Category chart Position of the legend, relative to the chart. Select Hidden to hide the legend. | |
| Palette | Inherited from Category chart Color palette used by this chart. | |
| Categories | Inherited from Hierarchical chart Configuration of the categories |
Chart series configuration array
Array listing the series configuration for a given chart.
Type: Array<Chart series configuration>
Series chart
Charts supporting multiple data series.
Extends: Category chart
Sub-types: Donut/pie chart, Gauge chart, Axis chart, Column chart, Bar chart, Line chart, Area chart, Combined chart
Properties
| Name | Label | Documentation | Type |
|---|---|---|---|
| Chart type | Inherited from Chart Visualization used for this chart. |
|
| Label | Inherited from Chart Label appearing as the chart title. | |
| Documentation (Markdown) | Inherited from Chart Rich text describing the chart. It appears near the chart title. The <a href="https://commonmark.org/help/" target="_blank">Markdown</a> syntax is supported. | |
| Label placement | Inherited from Chart Default position of the chart title, relative to the visualization. Select Hidden to hide the title. | |
| Show divider | Inherited from Chart Show a thin line between the title and the visualization. |
|
| Required role | Inherited from Chart Role required to access this chart. Roles must be declared first in the platform Configuration to appear in this list. | |
| Pivot query | Inherited from Chart A table that summarize the data using dimensions and measures. | |
| Enable drilldown | Inherited from Chart Enable drilldown into the data aggregated into a measure value. |
|
| Filters | Inherited from Chart Filters applies to render a subset of the query data. These filters are combined with an AND operator. | |
| Legend placement | Status: WIP Inherited from Category chart Position of the legend, relative to the chart. Select Hidden to hide the legend. | |
| Palette | Inherited from Category chart Color palette used by this chart. | |
| Data labels display | Defines how labels appear on the data points by default. | |
| Series | Configuration of the series. |
Angle
Measure of a rotation.
Type: number
Max Value: 360
Donut/pie chart
Chart showing proportions between categories as sectors.
Extends: Series chart
Properties
| Name | Label | Documentation | Type |
|---|---|---|---|
| Chart type | Inherited from Chart Visualization used for this chart. |
|
| Label | Inherited from Chart Label appearing as the chart title. | |
| Documentation (Markdown) | Inherited from Chart Rich text describing the chart. It appears near the chart title. The <a href="https://commonmark.org/help/" target="_blank">Markdown</a> syntax is supported. | |
| Label placement | Inherited from Chart Default position of the chart title, relative to the visualization. Select Hidden to hide the title. | |
| Show divider | Inherited from Chart Show a thin line between the title and the visualization. |
|
| Required role | Inherited from Chart Role required to access this chart. Roles must be declared first in the platform Configuration to appear in this list. | |
| Pivot query | Inherited from Chart A table that summarize the data using dimensions and measures. | |
| Enable drilldown | Inherited from Chart Enable drilldown into the data aggregated into a measure value. |
|
| Filters | Inherited from Chart Filters applies to render a subset of the query data. These filters are combined with an AND operator. | |
| Legend placement | Status: WIP Inherited from Category chart Position of the legend, relative to the chart. Select Hidden to hide the legend. | |
| Palette | Inherited from Category chart Color palette used by this chart. | |
| Data labels display | Inherited from Series chart Defines how labels appear on the data points by default. | |
| Series | Inherited from Series chart Configuration of the series. | |
| Startup angle | Startup angle for the chart. | |
| Size (%) | Size of the visualization in percentage of the chart size. | |
| Hole size (%) | Size of the central hole in percentage of the chart size. | |
| Spacing (%) | Spacing between segments in percentage of the segments. |
Range value type
Type of the range max values in a gauge chart range (value, percentage, etc).
Type: enum
Enum Values
| Value | Label | Description |
|---|---|---|
| Absolute values | Range maximum values are expressed as absolute values. |
| Percentages of the maximum value | Range maximum values are expressed as percentages of the maximum value. |
| Percentages of target | Range maximum values are expressed as percentages of the target goal. |
Gauge chart
Chart displaying graphically numerical data.
Extends: Series chart
Properties
| Name | Label | Documentation | Type |
|---|---|---|---|
| Chart type | Inherited from Chart Visualization used for this chart. |
|
| Label | Inherited from Chart Label appearing as the chart title. | |
| Documentation (Markdown) | Inherited from Chart Rich text describing the chart. It appears near the chart title. The <a href="https://commonmark.org/help/" target="_blank">Markdown</a> syntax is supported. | |
| Label placement | Inherited from Chart Default position of the chart title, relative to the visualization. Select Hidden to hide the title. | |
| Show divider | Inherited from Chart Show a thin line between the title and the visualization. |
|
| Required role | Inherited from Chart Role required to access this chart. Roles must be declared first in the platform Configuration to appear in this list. | |
| Pivot query | Inherited from Chart A table that summarize the data using dimensions and measures. | |
| Enable drilldown | Inherited from Chart Enable drilldown into the data aggregated into a measure value. |
|
| Filters | Inherited from Chart Filters applies to render a subset of the query data. These filters are combined with an AND operator. | |
| Legend placement | Status: WIP Inherited from Category chart Position of the legend, relative to the chart. Select Hidden to hide the legend. | |
| Palette | Inherited from Category chart Color palette used by this chart. | |
| Data labels display | Inherited from Series chart Defines how labels appear on the data points by default. | |
| Series | Inherited from Series chart Configuration of the series. | |
| Minimum value | Minimum value of the range. |
|
| Maximum value | Maximum value of the range. |
|
| Range 1 color | Color of the gauge lower tier. | |
| Range 1 maximum value | High value of the gauge lower tier. |
|
| Range 2 color | Color of the gauge middle tier. | |
| Range 2 maximum value | High value of the gauge middle tier. |
|
| Range 3 color | Color of the gauge upper tier. | |
| Target goal | Target value to which the chart value is compared. |
|
| Goal color | Display color of the target goal. | |
| Range maximum values type | Defines how the range max values are expressed:
|
Axis chart
Chart displaying dimensions on axes.
Extends: Series chart
Sub-types: Column chart, Bar chart, Line chart, Area chart, Combined chart
Properties
| Name | Label | Documentation | Type |
|---|---|---|---|
| Chart type | Inherited from Chart Visualization used for this chart. |
|
| Label | Inherited from Chart Label appearing as the chart title. | |
| Documentation (Markdown) | Inherited from Chart Rich text describing the chart. It appears near the chart title. The <a href="https://commonmark.org/help/" target="_blank">Markdown</a> syntax is supported. | |
| Label placement | Inherited from Chart Default position of the chart title, relative to the visualization. Select Hidden to hide the title. | |
| Show divider | Inherited from Chart Show a thin line between the title and the visualization. |
|
| Required role | Inherited from Chart Role required to access this chart. Roles must be declared first in the platform Configuration to appear in this list. | |
| Pivot query | Inherited from Chart A table that summarize the data using dimensions and measures. | |
| Enable drilldown | Inherited from Chart Enable drilldown into the data aggregated into a measure value. |
|
| Filters | Inherited from Chart Filters applies to render a subset of the query data. These filters are combined with an AND operator. | |
| Legend placement | Status: WIP Inherited from Category chart Position of the legend, relative to the chart. Select Hidden to hide the legend. | |
| Palette | Inherited from Category chart Color palette used by this chart. | |
| Data labels display | Inherited from Series chart Defines how labels appear on the data points by default. | |
| Series | Inherited from Series chart Configuration of the series. | |
| Point configuration | Configuration of a data point in this chart. | |
| Line configuration | Lines configuration in this chart | |
| Primary value axis | Configuration of the (primary) value axis for an axis chart. | |
| Categories axis | Configuration of the categories axis for this chart. |
Column chart
Chart displaying values side by side as vertical bars, to compare across categories.
Extends: Axis chart
Properties
| Name | Label | Documentation | Type |
|---|---|---|---|
| Chart type | Inherited from Chart Visualization used for this chart. |
|
| Label | Inherited from Chart Label appearing as the chart title. | |
| Documentation (Markdown) | Inherited from Chart Rich text describing the chart. It appears near the chart title. The <a href="https://commonmark.org/help/" target="_blank">Markdown</a> syntax is supported. | |
| Label placement | Inherited from Chart Default position of the chart title, relative to the visualization. Select Hidden to hide the title. | |
| Show divider | Inherited from Chart Show a thin line between the title and the visualization. |
|
| Required role | Inherited from Chart Role required to access this chart. Roles must be declared first in the platform Configuration to appear in this list. | |
| Pivot query | Inherited from Chart A table that summarize the data using dimensions and measures. | |
| Enable drilldown | Inherited from Chart Enable drilldown into the data aggregated into a measure value. |
|
| Filters | Inherited from Chart Filters applies to render a subset of the query data. These filters are combined with an AND operator. | |
| Legend placement | Status: WIP Inherited from Category chart Position of the legend, relative to the chart. Select Hidden to hide the legend. | |
| Palette | Inherited from Category chart Color palette used by this chart. | |
| Data labels display | Inherited from Series chart Defines how labels appear on the data points by default. | |
| Series | Inherited from Series chart Configuration of the series. | |
| Point configuration | Inherited from Axis chart Configuration of a data point in this chart. | |
| Line configuration | Inherited from Axis chart Lines configuration in this chart | |
| Primary value axis | Inherited from Axis chart Configuration of the (primary) value axis for an axis chart. | |
| Categories axis | Inherited from Axis chart Configuration of the categories axis for this chart. |
Bar chart
Chart displaying values side by side as horizontal bars, to compare across categories.
Extends: Axis chart
Properties
| Name | Label | Documentation | Type |
|---|---|---|---|
| Chart type | Inherited from Chart Visualization used for this chart. |
|
| Label | Inherited from Chart Label appearing as the chart title. | |
| Documentation (Markdown) | Inherited from Chart Rich text describing the chart. It appears near the chart title. The <a href="https://commonmark.org/help/" target="_blank">Markdown</a> syntax is supported. | |
| Label placement | Inherited from Chart Default position of the chart title, relative to the visualization. Select Hidden to hide the title. | |
| Show divider | Inherited from Chart Show a thin line between the title and the visualization. |
|
| Required role | Inherited from Chart Role required to access this chart. Roles must be declared first in the platform Configuration to appear in this list. | |
| Pivot query | Inherited from Chart A table that summarize the data using dimensions and measures. | |
| Enable drilldown | Inherited from Chart Enable drilldown into the data aggregated into a measure value. |
|
| Filters | Inherited from Chart Filters applies to render a subset of the query data. These filters are combined with an AND operator. | |
| Legend placement | Status: WIP Inherited from Category chart Position of the legend, relative to the chart. Select Hidden to hide the legend. | |
| Palette | Inherited from Category chart Color palette used by this chart. | |
| Data labels display | Inherited from Series chart Defines how labels appear on the data points by default. | |
| Series | Inherited from Series chart Configuration of the series. | |
| Point configuration | Inherited from Axis chart Configuration of a data point in this chart. | |
| Line configuration | Inherited from Axis chart Lines configuration in this chart | |
| Primary value axis | Inherited from Axis chart Configuration of the (primary) value axis for an axis chart. | |
| Categories axis | Inherited from Axis chart Configuration of the categories axis for this chart. |
Line chart
Chart displaying series of data points connected by lines.
Extends: Axis chart
Properties
| Name | Label | Documentation | Type |
|---|---|---|---|
| Chart type | Inherited from Chart Visualization used for this chart. |
|
| Label | Inherited from Chart Label appearing as the chart title. | |
| Documentation (Markdown) | Inherited from Chart Rich text describing the chart. It appears near the chart title. The <a href="https://commonmark.org/help/" target="_blank">Markdown</a> syntax is supported. | |
| Label placement | Inherited from Chart Default position of the chart title, relative to the visualization. Select Hidden to hide the title. | |
| Show divider | Inherited from Chart Show a thin line between the title and the visualization. |
|
| Required role | Inherited from Chart Role required to access this chart. Roles must be declared first in the platform Configuration to appear in this list. | |
| Pivot query | Inherited from Chart A table that summarize the data using dimensions and measures. | |
| Enable drilldown | Inherited from Chart Enable drilldown into the data aggregated into a measure value. |
|
| Filters | Inherited from Chart Filters applies to render a subset of the query data. These filters are combined with an AND operator. | |
| Legend placement | Status: WIP Inherited from Category chart Position of the legend, relative to the chart. Select Hidden to hide the legend. | |
| Palette | Inherited from Category chart Color palette used by this chart. | |
| Data labels display | Inherited from Series chart Defines how labels appear on the data points by default. | |
| Series | Inherited from Series chart Configuration of the series. | |
| Point configuration | Inherited from Axis chart Configuration of a data point in this chart. | |
| Line configuration | Inherited from Axis chart Lines configuration in this chart | |
| Primary value axis | Inherited from Axis chart Configuration of the (primary) value axis for an axis chart. | |
| Categories axis | Inherited from Axis chart Configuration of the categories axis for this chart. |
Area chart
Chart based on the line chart, with the area between axis and line is filled with a color.
Extends: Axis chart
Properties
| Name | Label | Documentation | Type |
|---|---|---|---|
| Chart type | Inherited from Chart Visualization used for this chart. |
|
| Label | Inherited from Chart Label appearing as the chart title. | |
| Documentation (Markdown) | Inherited from Chart Rich text describing the chart. It appears near the chart title. The <a href="https://commonmark.org/help/" target="_blank">Markdown</a> syntax is supported. | |
| Label placement | Inherited from Chart Default position of the chart title, relative to the visualization. Select Hidden to hide the title. | |
| Show divider | Inherited from Chart Show a thin line between the title and the visualization. |
|
| Required role | Inherited from Chart Role required to access this chart. Roles must be declared first in the platform Configuration to appear in this list. | |
| Pivot query | Inherited from Chart A table that summarize the data using dimensions and measures. | |
| Enable drilldown | Inherited from Chart Enable drilldown into the data aggregated into a measure value. |
|
| Filters | Inherited from Chart Filters applies to render a subset of the query data. These filters are combined with an AND operator. | |
| Legend placement | Status: WIP Inherited from Category chart Position of the legend, relative to the chart. Select Hidden to hide the legend. | |
| Palette | Inherited from Category chart Color palette used by this chart. | |
| Data labels display | Inherited from Series chart Defines how labels appear on the data points by default. | |
| Series | Inherited from Series chart Configuration of the series. | |
| Point configuration | Inherited from Axis chart Configuration of a data point in this chart. | |
| Line configuration | Inherited from Axis chart Lines configuration in this chart | |
| Primary value axis | Inherited from Axis chart Configuration of the (primary) value axis for an axis chart. | |
| Categories axis | Inherited from Axis chart Configuration of the categories axis for this chart. |
Combined chart
Chart combining multiple views within the same visualization. For example bars and lines.
Extends: Axis chart
Properties
| Name | Label | Documentation | Type |
|---|---|---|---|
| Chart type | Inherited from Chart Visualization used for this chart. |
|
| Label | Inherited from Chart Label appearing as the chart title. | |
| Documentation (Markdown) | Inherited from Chart Rich text describing the chart. It appears near the chart title. The <a href="https://commonmark.org/help/" target="_blank">Markdown</a> syntax is supported. | |
| Label placement | Inherited from Chart Default position of the chart title, relative to the visualization. Select Hidden to hide the title. | |
| Show divider | Inherited from Chart Show a thin line between the title and the visualization. |
|
| Required role | Inherited from Chart Role required to access this chart. Roles must be declared first in the platform Configuration to appear in this list. | |
| Pivot query | Inherited from Chart A table that summarize the data using dimensions and measures. | |
| Enable drilldown | Inherited from Chart Enable drilldown into the data aggregated into a measure value. |
|
| Filters | Inherited from Chart Filters applies to render a subset of the query data. These filters are combined with an AND operator. | |
| Legend placement | Status: WIP Inherited from Category chart Position of the legend, relative to the chart. Select Hidden to hide the legend. | |
| Palette | Inherited from Category chart Color palette used by this chart. | |
| Data labels display | Inherited from Series chart Defines how labels appear on the data points by default. | |
| Series | Inherited from Series chart Configuration of the series. | |
| Point configuration | Inherited from Axis chart Configuration of a data point in this chart. | |
| Line configuration | Inherited from Axis chart Lines configuration in this chart | |
| Primary value axis | Inherited from Axis chart Configuration of the (primary) value axis for an axis chart. | |
| Categories axis | Inherited from Axis chart Configuration of the categories axis for this chart. | |
| Secondary value axis | Configuration of the secondary value axis for a combined chart. |
Data label placement
Position of the label, relative to the data point.
Type: enum
Enum Values
| Value | Label | Description |
|---|---|---|
| Auto | The label is automatically positioned near the data point |
| Top | The label appears above the data point |
| Middle | The label appears anchored to the data point |
| Bottom | The label appears below the data point |
Data label configuration
Configuration of a data label or tooltip in a chart.
Properties
| Name | Label | Documentation | Type |
|---|---|---|---|
| Placement | Position of the label, relative to the data point. Auto automatically puts the label at an optimal position near the data point. | |
| Show series as | Defines how the string representing the series appears in the label. | |
| Display categories as | Defines how the string representing the category appears in the label. | |
| Show value | Show the value of the data point in the label. |
|
| Show percentage | Show the percentage represented by the value in the series in the label. |
|
| Show measure label | Show the measure’s label before the value and percentage in the label. |
|
Data labels display
A label appears to provide more information about a given data point, for example as a tooltip.
Type: union of [Data label configuration | `NO_LABELS `]
Series chart type
Type of chart used for a given series.
Type: enum
Enum Values
| Value | Label | Description |
|---|---|---|
| Column chart | Chart displaying values side by side as vertical bars, to compare across categories. |
| Bar chart | Chart displaying values side by side as horizontal bars, to compare across categories. |
| Line chart | Chart displaying series of data points connected by lines |
| Area chart | Chart based on the line chart, with the area between axis and line is filled with a color. |
Value axis name
Name of a value axis
Type: enum
Enum Values
| Value | Label | Description |
|---|---|---|
| Primary | Primary axis |
| Secondary | Secondary axis |
Chart series configuration
Configuration of a series in a series chart.
Properties
| Name | Label | Documentation | Type |
|---|---|---|---|
| Path | Pivot path identifying the series. | |
| Data labels display | Defines how labels appear on the data points. | |
| Fill color | Color used to fill the shapes. | |
| Line or border color | Color used for lines and borders. | |
| Line configuration | Lines configuration in this series. | |
| Point configuration | Configuration of a data point in this series. | |
| Chart type | Visualization used for this series in a combined chart. | |
| Value axis | Value axis (primary or secondary) onto which the series appears. |
Label item display mode
Defines how an element appears in the label of a data point.
Type: enum
Enum Values
| Value | Label | Description |
|---|---|---|
| Hide | Hide this element |
| Label and value | Display the label and value |
| Value | Display the value |
Point configuration
Configuration of a data point in a chart.
Properties
| Name | Label | Documentation | Type |
|---|---|---|---|
| Point shape | Shape used for the data points. | |
| Point filled | The point shape appears filled in. |
|
| Point size (px) | Point size in pixels. |
|
Line configuration
Configuration of a line in a chart.
Properties
| Name | Label | Documentation | Type |
|---|---|---|---|
| Line style | Style used to draw the lines. | |
| Line interpolation | Interpolation function to smooth lines between data points. |
Point shape
Shape used to display data points in charts.
Type: enum
Enum Values
| Value | Label | Description |
|---|---|---|
| None | The data points do not appear |
| Circle | Data points appear as circles |
| Square | Data points appear as square shapes |
| Triangle | Data points appear as triangle shapes |
| Diamond | Data points appear as diamond shapes |
Line style
Style used to draw lines on a chart.
Type: enum
Enum Values
| Value | Label | Description |
|---|---|---|
| None | The line does not appear |
| Line | Draw the line continuously |
| Dashed | Draw the line as a succession of strokes |
| Dotted | Draw the line as a succession of points |
Line interpolation function
Function used to interpolate/smooth the lines between data points.
Type: enum
Enum Values
| Value | Label | Description |
|---|---|---|
| Linear | Linear interpolation |
| Cubic | Cubic interpolation |
| Monotone | Monotone cubic interpolation |
Chart category configuration
Configuration of a category in a hierarchical chart.
Properties
| Name | Label | Documentation | Type |
|---|---|---|---|
| Root category | Root category this configuration applies to. The configuration may affect all sub-categories. | |
| Fill color | Color used to fill the shapes for this category and its sub-categories. |
Dimension values
Map of name / value pairs for dimensions to define a path in a pivot query.
Type: Map<Dimension name, Dashboard value>
Pivot path
Path used to identify a series with a specific configuration in a series chart.
Properties
| Name | Label | Documentation | Type |
|---|---|---|---|
| Dimension values | Pivot query path defined with dimensions' name/value pairs. | |
| Measure name | Reference to one measure for a chart with multiple measures. |
Percentage
Number representing a percentage. Must be in a 0-100 range.
Type: number
Max Value: 100
Name
The name is the unique identifier of an object. References to that object are typically made using this name.
Type: string
Max length: 128
Datatype
Type of data managed in a dashboard application.
Type: enum
Enum Values
| Value | Label | Description |
|---|---|---|
| Text | Stores a text value |
| Number | Stores a numeric value |
| Date | Stores an instant in time expressed as a calendar date. |
| Datetime | Stores an instant in time expressed as a calendar date and time of day. |
Dashboard value
A literal value in a dashboard application.
Type: union of [string | number]
Number format
Defines the format used to display a numeric value.
Properties
| Name | Label | Documentation | Type |
|---|---|---|---|
| Decimal places | Number of digits after the decimal point. |
|
| Prefix | Character string added before the formatted number. |
|
| Suffix | Character string added after the formatted number. |
|
| Multiply by | Multiply the number by this value before formatting. |
|
| Use user separators | Use each user’s decimal and thousands separators as defined in the profile. De-select this option to define specific separators. |
|
| Decimal separator | Character used as the decimal point. |
|
| Thousands separator | Character used as the thousands separator. |
|
| Show thousands separator | Display the thousands separator character. |
|
Text alignment
Defines the horizontal alignment of a text.
Type: enum
Enum Values
| Value | Label | Description |
|---|---|---|
| Left | Text is aligned at the left |
| Center | Text is aligned at the center |
| Right | Text is aligned at the right |
Title placement
Position of the title, relative to the chart.
Type: enum
Enum Values
| Value | Label | Description |
|---|---|---|
| Hidden | The text is not displayed |
| Top | The label appears above the content |
| Bottom | The label appears below the content |
Sort order
Direction of a sort operation.
Type: enum
Enum Values
| Value | Label | Description |
|---|---|---|
| Auto | Automated sort order |
| Ascending | Arranged from smallest to largest |
| Descending | Arranged from largest to smallest |
Dashboard parameter array
Array of parameters for a given dashboard.
Type: Array<Dashboard parameter>
Dashboard slicers array
Array of dashboard slicers for a given dashboard
Type: Array<Dashboard slicer>
Dashboard
A dashboard groups several charts on a multi-tab page.
Properties
| Name | Label | Documentation | Type |
|---|---|---|---|
| Label | Label displayed in the header as the dashboard title. | |
| Documentation (Markdown) | Rich text describing the dashboard. It appears near the dashboard title. The <a href="https://commonmark.org/help/" target="_blank">Markdown</a> syntax is supported. | |
| Icon | Icon displayed in the dashboard header. | |
| Required role | Role required to access this dashboard. Roles must be declared first in the platform Configuration to appear in this list. | |
| Tabs | Tabs composing the dashboard. | |
| Parameters | Parameters exposed to filter the dashboard data. | |
| Dashboard slicers | Dashboard slicers appear in a sidesheet to filter the whole dashboard. |
Tab display type
Defines how a tab is displayed in a dashboard.
Type: enum
Enum Values
| Value | Label | Description |
|---|---|---|
| Icon | Only the icon is displayed |
| Label | Only the label is displayed |
| Icon and label | Both icon and label are displayed |
Dashboard elements array
Array of the elements appearing on a dashboard tab.
Type: Array<Dashboard element>
Tab
A dashboard tab visually groups dashboard elements.
Properties
| Name | Label | Documentation | Type |
|---|---|---|---|
| Name | Internal name of the tab, used to refer to it. | |
| Label | Label appearing on the tab. |
|
| Icon | Optional icon displayed on the tab. | |
| Display as | Defines whether the tab appears with its label and/or icon. | |
| Content | Dashboard elements contained in this tab |
Dashboard element
An element (chart, text, or slicer) displayed in a dashboard tab.
Sub-types: Text, Dashboard chart, Slicer
Properties
| Name | Label | Documentation | Type |
|---|---|---|---|
| Name | Internal identifier of the element in the dashboard | |
| Height (px) | Element height in pixels. When the dashboard renders, elements take the height of the bigger element on their line. |
|
| Width (cells) | Element width expressed as a number of cells. Note that the dashboard total width depends on the device:
If an element is larger than the dashboard, it occupies 100% of the dashboard width. |
|
| Type | Dashboard element type | Value per sub-types:
|
Text
The text element displays markdown content in a dashboard.
Extends: Dashboard element
Properties
| Name | Label | Documentation | Type |
|---|---|---|---|
| Name | Inherited from Dashboard element Internal identifier of the element in the dashboard | |
| Height (px) | Inherited from Dashboard element Element height in pixels. When the dashboard renders, elements take the height of the bigger element on their line. |
|
| Width (cells) | Inherited from Dashboard element Element width expressed as a number of cells. Note that the dashboard total width depends on the device:
If an element is larger than the dashboard, it occupies 100% of the dashboard width. |
|
| Type | Inherited from Dashboard element Dashboard element type |
|
| Content | Text element content. The <a href="https://commonmark.org/help/" target="_blank">Markdown</a> syntax is supported. | |
| Color | Base color of the text content. |
Dashboard chart
The chart element displays an existing chart in a dashboard tab.
Extends: Dashboard element
Properties
| Name | Label | Documentation | Type |
|---|---|---|---|
| Name | Inherited from Dashboard element Internal identifier of the element in the dashboard | |
| Height (px) | Inherited from Dashboard element Element height in pixels. When the dashboard renders, elements take the height of the bigger element on their line. |
|
| Width (cells) | Inherited from Dashboard element Element width expressed as a number of cells. Note that the dashboard total width depends on the device:
If an element is larger than the dashboard, it occupies 100% of the dashboard width. |
|
| Type | Inherited from Dashboard element Dashboard element type |
|
| Chart | Existing chart embedded in the dashboard. You can configure how this chart appears in the dashboard. You can optionally parameterize data filtering for this chart using Slicers and Dashboard Parameters. Values selected by users in the slicers or passed in the dashboard parameters filter the content of an embedded chart. |
|
| Label | Label appearing as the chart title in the dashboard. When not specified, the label defined in the chart is used instead. | |
| Documentation (Markdown) | Rich text describing the chart in this dashboard. It appears near the chart title. The <a href="https://commonmark.org/help/" target="_blank">Markdown</a> syntax is supported. | |
| Label placement | Position of the chart title in the dashboard, relative to the visualization. Select Hidden to hide the title. | |
| Show divider | Show a thin line between the title and the visualization. |
|
| Enable drilldown | Enable drilldown into the data aggregated into a measure value. |
|
| Filters | Filters applies to render a subset of the query data, in addition to those defined for the chart. These filters are combined with an AND operator. |
Slicer
A slicer shows a list of values that you can use to quickly filter data in a dashboard.
Extends: Dashboard element
Properties
| Name | Label | Documentation | Type |
|---|---|---|---|
| Name | Inherited from Dashboard element Internal identifier of the element in the dashboard | |
| Height (px) | Inherited from Dashboard element Element height in pixels. When the dashboard renders, elements take the height of the bigger element on their line. |
|
| Width (cells) | Inherited from Dashboard element Element width expressed as a number of cells. Note that the dashboard total width depends on the device:
If an element is larger than the dashboard, it occupies 100% of the dashboard width. |
|
| Type | Inherited from Dashboard element Dashboard element type |
|
| Label | Label appearing as the slicer title. | |
| Documentation (Markdown) | Rich text describing the slicer. It appears near the slicer title. The <a href="https://commonmark.org/help/" target="_blank">Markdown</a> syntax is supported. | |
| Label placement | Position of the title of the slicer. Select Hidden to hide the title. | |
| Show divider | Show a thin line between the title and the slicer. |
|
| Sort order | Sort order of the slicer values. | |
| Format | Format used to display the slicer values | |
| Allow multiple selection | Allow selecting multiple values in this slicer. When this option is active, the slicer appears as a list of checkboxes. Otherwise, it appears as a list of radio buttons. |
|
| Display search field | Display a search field above the slicer values to search into these values. |
|
| Allow select all | Allow selecting/unselecting all the values in this slicer. |
|
| Show items with no data | Display slicer items with no related metrics values. |
|
| Grey out item with no data | When they are displayed, grey out slicer items that do not related to metrics values. |
|
| Show items with no data last | When they are displayed, slicer items with no related metrics values are displayed last in the list of items. |
|
| Filtered charts | Charts filtered with the values selected in this slicer. Each chart is indicated with the parameter the slicer value applies to. |
Slicer chart link array
Array of links relating a slicer to a given chart’s query attribute.
Type: Array<Slicer chart link>
Slicer chart link
Link relating a slicer to a given chart’s query attribute.
Properties
| Name | Label | Documentation | Type |
|---|---|---|---|
| Query attribute | Name of the query attribute affected by this slicer. |
|
| Dashboard chart name | Name of the dashboard chart affected by this slicer |
|
Parameter chart link array
Array of links relating a parameter to a given chart’s query attribute.
Type: Array<Parameter chart link>
Dashboard parameter
Value passed to a dashboard to parameterize its content.
Properties
| Name | Label | Documentation | Type |
|---|---|---|---|
| Parameter name | Unique identifier of the parameter for this dashboard. Values passed to the dashboard using this parameter are passed to the Filtered Charts as parameters, in order to filter the content of these charts. | |
| Filtered charts | Charts filtered using the value passed to the dashboard parameter. Each chart are indicated with the chart parameter filtered with the value. |
Parameter chart link
Link relating a parameter to a given chart’s query attribute.
Properties
| Name | Label | Documentation | Type |
|---|---|---|---|
| Query attribute | Name of the query attribute affected by this parameter |
|
| Dashboard chart name | Name of the dashboard chart affected by this parameter |
|
Dashboard slicer
Dashboard slicers appear in a sidesheet to filter the whole dashboard.
Properties
| Name | Label | Documentation | Type |
|---|---|---|---|
| Name | Unique identifier of the slicer for this dashboard. |
|
| Label | Label appearing as the slicer title. |
|
| Documentation (Markdown) | Rich text describing the slicer. It appears near the slicer title. The <a href="https://commonmark.org/help/" target="_blank">Markdown</a> syntax is supported. |
|
| Sort order | Sort order of the slicer values. | |
| Format | Format used to display the slicer values | |
| Allow multiple selection | Allow selecting multiple values in this slicer. When this option is active, the slicer appears as a list of checkboxes. Otherwise, it appears as a list of radio buttons. |
|
| Display search field | Display a search field above the slicer values to search into these values. |
|
| Allow select all | Allow selecting/unselecting all the values in this slicer. |
|
| Show item with no data | Display slicer items with no related metrics values. |
|
| Grey out item with no data | When they are displayed, grey out slicer items with no related metrics values. |
|
| Show items with no data last | When they are displayed, slicer items with no related metrics values are displayed last in the list of items. |
|
| Filtered charts | Charts filtered with the values selected in this slicer. Each chart is indicated with the parameter the slicer value applies to. |
Datasource
Defines how to connect to the data, using a datasource defined in the application server.
Properties
| Name | Label | Documentation | Type |
|---|---|---|---|
| JNDI Resource | JNDI resource defined in the application server. Only datasources defined in the application server appear in the list. Contact your administrator or refer to the installation guide to configure datasources in the application server. |
|
| Database Type | The database technology of this datasource. Databases not listed should use the SQL 92 Compliant Database type. |
Database type
Type of database technology supported for datasources.
Type: enum
Enum Values
| Value | Label | Description |
|---|---|---|
| Oracle | Oracle database |
| PostgreSQL | PostgreSQL database |
| MySQL | MySQL database |
| Microsoft SQL Server | Microsoft SQL Server database |
| SQL-92 compliant database | SQL-92 compliant database |
Shade
Material Design color shade.
Type: enum
Enum Values
| Value | Label | Description |
|---|---|---|
| 100 | 100 |
| 200 | 200 |
| 300 | 300 |
| 400 | 400 |
| 500 | 500 |
| 600 | 600 |
| 700 | 700 |
| 800 | 800 |
| 900 | 900 |
| A100 | A100 |
| A200 | A200 |
| A400 | A400 |
| A700 | A600 |
Color
Material Design color name.
Type: enum
Enum Values
| Value | Label | Description |
|---|---|---|
| Red | Red |
| Pink | Pink |
| Purple | Purple |
| Deep purple | Deep purple |
| Indigo | Indigo |
| Blue | Blue |
| Light blue | Light blue |
| Cyan | Cyan |
| Teal | Teal |
| Green | Green |
| Light green | Light green |
| Lime | Lime |
| Yellow | Yellow |
| Amber | Amber |
| Orange | Orange |
| Deep orange | Deep orange |
Color palette
Set of colors. This set is either monochrome or colorful.
Sub-types: Colorful palette, Monochrome palette
Properties
| Name | Label | Documentation | Type |
|---|---|---|---|
| Palette | Type of the palette. A palette is either:
| Value per sub-types:
|
Colorful palette
This palette uses multiple colors of a single shade.
Extends: Color palette
Properties
| Name | Label | Documentation | Type |
|---|---|---|---|
| Palette | Inherited from Color palette Type of the palette. A palette is either:
|
|
| Shade | Shade used in the colorful palette. |
Monochrome palette
This palette used multiple shades of a single color.
Extends: Color palette
Properties
| Name | Label | Documentation | Type |
|---|---|---|---|
| Palette | Inherited from Color palette Type of the palette. A palette is either:
|
|
| Color | Color used in the monochrome palette. |
Additional parameter
Query attributes not used as dimensions of a chart but that must be available to filter the chart.
Type: Array<`string`>
Pivot query
A table that summarize the data using dimensions and measures. Used as a the foundation for a chart.
Properties
| Name | Label | Documentation | Type |
|---|---|---|---|
| Query | Existing query providing the data for this chart. | |
| Show row totals | Show the total values for each row. |
|
| Show column totals | Show the total values for each column. |
|
| Measures location | Location of the measures in the pivot query. | |
| Rows | Rows (categories) of the chart. | |
| Columns | Columns (series) of the chart. | |
| Measures | Measures of the chart. | |
| Additional parameters | Attributes not used as dimensions that should be available to filter. |
Subtotals type
Defines how subtotals are calculated.
Type: enum
Enum Values
| Value | Label | Description |
|---|---|---|
| Auto | Subtotals are calculated using the aggregation type of the associated metric. |
| None | Subtotals are neither calculated nor displayed. |
| Custom | Subtotals are calculated using the defined subtotal aggregation type. |
Subtotals position
Location of subtotals in relation to the records they aggregate.
Type: enum
Enum Values
| Value | Label | Description |
|---|---|---|
| Top | Subtotals are located before the records they aggregate |
| Bottom | Subtotals are located after the records they aggregate |
Dimension
Query attribute used as a dimension (row or column) in a pivot query.
Properties
| Name | Label | Documentation | Type |
|---|---|---|---|
| Name | Internal identifier of the dimension. | |
| Label | Label for this dimension. | |
| Attribute | Query attribute used for this dimension. | |
| Label alignment | Comment: Should only be supported in pivot table Label alignment for this dimension. | |
| Format | Format used to display values for a datetime or numeric dimension. | |
| Subtotals aggregation type | Aggregation method for the subtotals for this dimension. For Pivot Tables, the subtotal values displayed use this method when Custom is selected for Subtotals computation. For Column, Bar, Line, Area or Combined, Gauge and Donut charts, subtotal are not displayed. However, this aggregation method defines how the metrics subtotal is computed for this dimension. This metrics subtotal may be used to sort a dimension on the opposite axis. | |
| Subtotals computation | Defines whether and how to compute subtotals for this dimension:
| |
| Subtotals position | Location of subtotals in relation to the records they aggregate. | |
| Values sort configuration | Defines how values are sorted for this dimension. |
Sort strategy
Defines the configuration to sort the values of a dimension in a chart.
Properties
| Name | Label | Documentation | Type |
|---|---|---|---|
| Sort order | Order in which the values are sorted. | |
| Sort by | Sort method for this dimension:
|
Dimension
Sort the dimension using its own values.
Extends: Sort strategy
Properties
| Name | Label | Documentation | Type |
|---|---|---|---|
| Sort order | Inherited from Sort strategy Order in which the values are sorted. | |
| Sort by | Inherited from Sort strategy Sort method for this dimension:
|
|
Measure path
Map of name / value pairs for dimensions to define a path to a measure in a pivot query.
Type: Map<Dimension name, Dashboard value>
Measure
Sort the dimension using values from a related measure
Extends: Sort strategy
Properties
| Name | Label | Documentation | Type |
|---|---|---|---|
| Sort order | Inherited from Sort strategy Order in which the values are sorted. | |
| Sort by | Inherited from Sort strategy Sort method for this dimension:
|
|
| Measure path | Path to the measure used to sort. | |
| Measure name | When the measure path points to multiple measures, this name indicates the measure used to sort. |
Measure
Measure in a pivot query, aggregating values from a query attribute.
Properties
| Name | Label | Documentation | Type |
|---|---|---|---|
| Name | Internal identifier of the measure. | |
| Label | Label appearing in the chart for this measure. | |
| Query attribute | Query attribute aggregated in this measure. | |
| Format | Format used to display values for the measure. | |
| Aggregation type | Aggregation method used for this measure. | |
| Label alignment | Comment: Should only be supported in pivot table Alignment of the measure label. | |
| Value alignment | Comment: Should only be supported in pivot table Alignment of the measure values. |
Aggregation type
Process used to show data in a summary form.
Type: enum
Enum Values
| Value | Label | Description |
|---|---|---|
| Sum | Returns the sum of values, for a numeric attribute only. Null values are ignored. |
| Average | Returns the average of all values, for a numeric attribute only. Null values are ignored. |
| Min | Returns the minimum value in all records. Null values are ignored. |
| Max | Returns the maximum value in all records. Null values are ignored. |
| Count | Returns the number of elements. Null values are ignored. |
Measures location presets
Preset locations for the measures.
Type: enum
Enum Values
| Value | Label | Description |
|---|---|---|
| First column | Measures are located before the first column |
| Last column | Measures are located after the last column |
| Last row | Measures are located after the last row |
| First row | Measures are located before the first row |
Measures location type
Defines whether the measures are located in the rows or columns.
Type: enum
Enum Values
| Value | Label | Description |
|---|---|---|
| Rows | Measures are located at a given insertion position in the rows |
| Columns | Measures are located at a given insertion position in the columns |
Measures location object
Object describing the location of the measures.
Properties
| Name | Label | Documentation | Type |
|---|---|---|---|
| Insertion location | Location (rows or columns) where the measures are inserted. | |
| Insertion point | Position at which the measures are located in the rows or columns. |
|
Measures location
Measures location in the rows or columns, defined via a preset or a location object.
Type: union of [Measures location presets | Measures location object]
Operator
Operator used in a query filter
Type: enum
Enum Values
| Value | Label | Description |
|---|---|---|
| in | Filtered attribute value is in the given list of values. This operator is case-sensitive. |
| not in | Filtered attribute value is not in the given list of values. This operator is case-sensitive. |
| > | Filtered attribute value is greater than the given value. |
| >= | Filtered attribute value is greater than or equal to the given value. |
| < | Filtered attribute value is less than the given value. |
| ⇐ | Filtered attribute value is less than or equal to the given value. |
| = | Filtered attribute value is equal to the given value. This operator is case-sensitive. |
| <> | Filtered attribute value is not equal to the given value. This operator is case-sensitive. |
| is null | Filtered attribute value is null. |
| is not null | Filtered attribute value is not null. |
| contains | Filtered attribute value contains the given value. This operator is case insensitive. |
| does not contain | Filtered attribute value does not contain the given value. This operator is case insensitive. |
| begins with | Filtered attribute value begins with the given value. This operator is case insensitive. |
| ends with | Filtered attribute value ends with the given value. This operator is case insensitive. |
Value
Value used in a query filter
Type: union of [string | number]
Query filter
A query filter is defined on a chart or a dashboard chart to filter the query in its usage context.
Sub-types: Query filter - in, Query filter - not in, Query filter - greater than, Query filter - greater than or equal to, Query filter - less than, Query filter - less than or equal to, Query filter - equal, Query filter - not equal, Query filter - is null, Query filter - is not null, Query filter - contains, Query filter - does not contain, Query filter - begins with, Query filter - ends with
Properties
| Name | Label | Documentation | Type |
|---|---|---|---|
| Attribute | Attribute to filter. |
|
| Operator | Operator used to compare the attribute value with the given value or list of values. | Value per sub-types:
|
Query filter - in
Query filter using the "in" operator
Extends: Query filter
Properties
| Name | Label | Documentation | Type |
|---|---|---|---|
| Attribute | Inherited from Query filter Attribute to filter. |
|
| Operator | Inherited from Query filter Operator used to compare the attribute value with the given value or list of values. |
|
| Values | List of values into which the attribute value is searched. |
Query filter - not in
Query filter using the "not in" operator
Extends: Query filter
Properties
| Name | Label | Documentation | Type |
|---|---|---|---|
| Attribute | Inherited from Query filter Attribute to filter. |
|
| Operator | Inherited from Query filter Operator used to compare the attribute value with the given value or list of values. |
|
| Values | List of values into which the attribute value is searched. |
Query filter - greater than
Query filter using the "greater than" operator
Extends: Query filter
Properties
| Name | Label | Documentation | Type |
|---|---|---|---|
| Attribute | Inherited from Query filter Attribute to filter. |
|
| Operator | Inherited from Query filter Operator used to compare the attribute value with the given value or list of values. |
|
| Value | Value compared to the attribute value. |
Query filter - greater than or equal to
Query filter using the "greater than or equal to" operator
Extends: Query filter
Properties
| Name | Label | Documentation | Type |
|---|---|---|---|
| Attribute | Inherited from Query filter Attribute to filter. |
|
| Operator | Inherited from Query filter Operator used to compare the attribute value with the given value or list of values. |
|
| Value | Value compared to the attribute value. |
Query filter - less than
Query filter using the "less than" operator
Extends: Query filter
Properties
| Name | Label | Documentation | Type |
|---|---|---|---|
| Attribute | Inherited from Query filter Attribute to filter. |
|
| Operator | Inherited from Query filter Operator used to compare the attribute value with the given value or list of values. |
|
| Value | Value compared to the attribute value. |
Query filter - less than or equal to
Query filter using the "less than or equal to" operator
Extends: Query filter
Properties
| Name | Label | Documentation | Type |
|---|---|---|---|
| Attribute | Inherited from Query filter Attribute to filter. |
|
| Operator | Inherited from Query filter Operator used to compare the attribute value with the given value or list of values. |
|
| Value | Value compared to the attribute value. |
Query filter - equal
Query filter using the "equal" operator
Extends: Query filter
Properties
| Name | Label | Documentation | Type |
|---|---|---|---|
| Attribute | Inherited from Query filter Attribute to filter. |
|
| Operator | Inherited from Query filter Operator used to compare the attribute value with the given value or list of values. |
|
| Value | Value compared to the attribute value. |
Query filter - not equal
Query filter using the "not equal" operator
Extends: Query filter
Properties
| Name | Label | Documentation | Type |
|---|---|---|---|
| Attribute | Inherited from Query filter Attribute to filter. |
|
| Operator | Inherited from Query filter Operator used to compare the attribute value with the given value or list of values. |
|
| Value | Value compared to the attribute value. |
Query filter - is null
Query filter using the "is null" operator
Extends: Query filter
Properties
| Name | Label | Documentation | Type |
|---|---|---|---|
| Attribute | Inherited from Query filter Attribute to filter. |
|
| Operator | Inherited from Query filter Operator used to compare the attribute value with the given value or list of values. |
|
Query filter - is not null
Query filter using the "is not null" operator
Extends: Query filter
Properties
| Name | Label | Documentation | Type |
|---|---|---|---|
| Attribute | Inherited from Query filter Attribute to filter. |
|
| Operator | Inherited from Query filter Operator used to compare the attribute value with the given value or list of values. |
|
Query filter - contains
Query filter using the "contains" operator
Extends: Query filter
Properties
| Name | Label | Documentation | Type |
|---|---|---|---|
| Attribute | Inherited from Query filter Attribute to filter. |
|
| Operator | Inherited from Query filter Operator used to compare the attribute value with the given value or list of values. |
|
| Value | Value to find in the attribute value. |
Query filter - does not contain
Query filter using the "does not contain" operator
Extends: Query filter
Properties
| Name | Label | Documentation | Type |
|---|---|---|---|
| Attribute | Inherited from Query filter Attribute to filter. |
|
| Operator | Inherited from Query filter Operator used to compare the attribute value with the given value or list of values. |
|
| Value | Value not to find in the attribute value. |
Query filter - begins with
Query filter using the "begins with" operator
Extends: Query filter
Properties
| Name | Label | Documentation | Type |
|---|---|---|---|
| Attribute | Inherited from Query filter Attribute to filter. |
|
| Operator | Inherited from Query filter Operator used to compare the attribute value with the given value or list of values. |
|
| Value | Value to find at the beginning of the attribute value. |
Query filter - ends with
Query filter using the "ends with" operator
Extends: Query filter
Properties
| Name | Label | Documentation | Type |
|---|---|---|---|
| Attribute | Inherited from Query filter Attribute to filter. |
|
| Operator | Inherited from Query filter Operator used to compare the attribute value with the given value or list of values. |
|
| Value | Value to find at the end of the attribute value. |
Query attributes map
Map of the attributes of a query. The key of this map is the name of the column returned by the SQL query.
Type: Map<Name, Query attribute>
Query
A query connects to a data source and run a SQL statement returning a data set with identified query attributes.
Properties
| Name | Label | Documentation | Type |
|---|---|---|---|
| SQL Query | SQL Query returning a set of records used in dashboards. |
|
| Datasource | Existing datasource containing the data to query. You must declare datasources prior to creating queries. |
|
| Attributes | List of attributes of the query. | |
| Query actions | Query actions open parameterized URLs when drilling down into the query results. |
Query attribute
Value (column) in the data set returned by the query. This attribute may be used as a dimension or a measure in the charts.
Properties
| Name | Label | Documentation | Type |
|---|---|---|---|
| Label | Label of the attribute. | |
| Datatype | Datatype of the attribute. | |
| Format | Format used to display values for a datetime or numeric attribute. | |
| Measure | This attribute is usable as a measure in charts. |
|
| Dimension | This attribute is usable as a row or column in charts. |
|
| Time dimension | This attribute is usable as a time dimension in charts. |
|
| Sortable | This attribute is available to sort in drilldown data tables. |
|
Query action target type
Target where the action URL should open
Type: enum
Enum Values
| Value | Label | Description |
|---|---|---|
| Chart container | Opens the URL within the chart container |
| Current tab | Opens the URL in the same tab |
| New tab | Opens the URL in a new tab |
Query action
A query action opens a parameterized URL when drilling down into the query results.
Properties
| Name | Label | Documentation | Type |
|---|---|---|---|
| Name | Query action name |
|
| Label | Label displayed for the action in the action menu | |
| URL | URL to open when the action is triggered. This URL is parameterized with query attributes using the following syntax: Query attribute values are processed as described below:
URL can be relative or absolute. Relative URLs only have a path and do not start with | |
| Icon | Icon displayed in the action menu | |
| Required role | Role required to see this action | |
| Target | Target where the URL should open |