Predefined Structure Types for Power Dashboard
Here is a list of predefined structures that are used for making the reporting easier through SIL.
Name | Field | Type | Description |
|---|---|---|---|
SILReportingOption | name | string | The name of the option. |
value | string | The value of the option. | |
label | string | The value of the option. |
Chart Structures
Name | Field | Type | Description |
|---|---|---|---|
SILReportingChart | type | string | The type of the chart. E.g. line, bar, pie, doughnut. |
data | SILReportingChartData | The chart data. | |
options | SILReportingChartOptions | The chart options. | |
SILReportingChartData | labels | string [] | The labels of the chart data. |
datasets | SILReportingChartDataset [] | The datasets of a chart. You can pass more than one dataset to a chart. (E.g. If you want to create a grouped bar chart you will need to pass more datasets and the type will be still set to bar.) | |
SILReportingChartDataset | label | string | The label of the dataset. |
data | number[] / string[] | The data property of a dataset can be passed in two formats. As an array of numbers or as an array of points where the first value is a property for x coordinate and the second value is a property for y coordinate. For the time scales the x coordinate can be passed as a string value representing the date (e.g "01/04/2018"). | |
backgroundColor | string[] | Represents the background color of a dataset which can be passed as a string in hexadecimal, RGB, or HSL notations. | |
borderColor | string[] | Represents the border color of a dataset which can be passed as a string in hexadecimal, RGB, or HSL notations. | |
fill | boolean | It is used when you want to fill the area under a line. Default value is false. | |
xAxisID | string | The ID of the x axis to plot this dataset on. You have to specify an ID if you are using multiple axes. | |
yAxisID | string | The ID of the y axis to plot this dataset on. You have to specify an ID if you are using multiple axes. | |
SILReportingChartOptions | title | SILReportingChartTitle | The chart title. |
legend | SILReportingChartLegend | The chart legend displays data about the datasets that are appearing on the chart. | |
scales | SILReportingChartScales | The chart scales. | |
aspectRatio | number | Canvas aspect ratio (i.e. width / height, a value of 1 representing a square canvas) | |
SILReportingChartTitle | display | boolean | It is used when you want to show the title on the chart. Default value is false. |
position | string | Position of title. The default value is "top". Possible values are: 'top', 'left', 'bottom', 'right' | |
text | string | The title text to be displayed. | |
SILReportingChartLegend | display | boolean | It is used when you want to show the legend on the chart. Default value is false. |
position | string | Position of the legend. The default value is "top". Possible values are: 'top', 'left', 'bottom', 'right' | |
SILReportingChartScales | xAxes | SILReportingChartXAxes [] | The X axes of a chart. This is especially needed if multi-axes charts are used |
yAxes | SILReportingChartYAxes [] | The Y axes of a chart. This is especially needed if multi-axes charts are used | |
SILReportingChartXAxes
| id | string | The ID is used to link datasets and scale axes together. The xAxes id should match the dataset xAxisID. |
type | string | The type of scale. | |
position | string | Position of the axis in the chart. Possible values are: 'top', 'left', 'bottom', 'right' | |
offset | boolean | Default value is false. If true, extra space is added to the both edges and the axis is scaled to fit into the chart area. This is set to true for a category scale in a bar chart by default. | |
ticks | SILReportingChartTicks | The ticks configuration. | |
SILReportingChartYAxes | id | string | The ID is used to link datasets and scale axes together. The yAxes id should match the dataset yAxisID. |
type | string | The type of scale. | |
position | string | Position of the axis in the chart. Possible values are: 'top', 'left', 'bottom', 'right' | |
offset | boolean | Default value is false. If true, extra space is added to the both edges and the axis is scaled to fit into the chart area. This is set to true for a category scale in a bar chart by default. | |
ticks | SILReportingChartTicks | The ticks configuration. | |
SILReportingChartTicks | beginAtZero | boolean | Default value is false. If true, scale will include 0 if it is not already included. |
min | number | User defined minimum number for the scale, overrides minimum value from data. | |
max | number | User defined maximum number for the scale, overrides maximum value from data. | |
suggestedMin | number | Adjustment used when calculating the minimum data value. | |
suggestedMax | number | Adjustment used when calculating the maximum data value. |
Table Structures
Name | Field | Type | Description |
|---|---|---|---|
SILReportingTable | headers | SILReportingHeader[] | The headers of the table. |
rows | string[][] | The rows of the table. | |
footers | SILReportingFooter[] | The footer of the table. | |
SILReportingHeader
| name | string | The name of the header. |
sortable | string | If set to "sortable" it will make the header sortable. In order to sort JIRA issue keys set it to "issue-key". | |
bgColor | string | The background color of the header. | |
color | string | The color of the text inside the header. | |
SILReportingFooter | name | string | The footer name. |
sortable | string | If set to "sortable" it will make the header sortable. In order to sort JIRA issue keys set it to "issue-key". | |
bgColor | string | The background color of the footer. | |
color | string | The color of the text inside the footer. |
Contents