chart-shared
The schema defines the following additional types:
Properties of the YAxis object:
Property | Type | Required | Description |
labels | object | false | Labels of axis. |
isFirstLabelHidden | boolean | false | If true it doesn't display the first label (see isFirstTickHidden to hide also the line) |
isFirstTickHidden | boolean | false | Line and label will be hidden if true |
isHidden | boolean | false | Whole axis will be hidden if true |
isLastLabelHidden | boolean | false | If true it doesn't display the last label (see isLastTickHidden to hide also line) |
isLastTickHidden | boolean | false | Line and label will be hidden if true |
max | number | false | Maximum value displayed on axis |
min | number | false | Minimum value displayed on axis |
minPadding | number | false | When no categories set, it will make 1% space on the left and right of the chart so the id doesn't start on the left or ends on the right edge exactly. |
tickAmount | number | null | false | You can specify how many ticks you want to display on axis. However, the final amount doesn't have to be exactly the same number as you pass into it.It tries to find the best amount of ticks (near to what you passed) that the number will look great for.For example, if the domain is 0-100 and you want 4 ticks (0, 33.33, 66.66, 100) it will round up to 6 to give you "pretty" numbers (0, 20, 40, 60, 80, 100). However, if you set ticks to 3 it will honor that and you'll have 0, 50, and 100. |
Labels of axis.
Properties of the labels object:
Property | Type | Required | Description |
format | Date & Number Format | false | |
Properties of the XAxis object:
Property | Type | Required | Description |
labels | object | false | Labels of axis. |
isFirstLabelHidden | boolean | false | If true it doesn't display the first label (see isFirstTickHidden to hide also the line) |
isFirstTickHidden | boolean | false | Line and label will be hidden if true |
isHidden | boolean | false | Whole axis will be hidden if true |
isLastLabelHidden | boolean | false | If true it doesn't display the last label (see isLastTickHidden to hide also line) |
isLastTickHidden | boolean | false | Line and label will be hidden if true |
max | number | false | Maximum value displayed on axis |
min | number | false | Minimum value displayed on axis |
minPadding | number | false | When no categories set, it will make 1% space on the left and right of the chart so the id doesn't start on the left or ends on the right edge exactly. |
tickAmount | number | null | false | You can specify how many ticks you want to display on axis. However, the final amount doesn't have to be exactly the same number as you pass into it.It tries to find the best amount of ticks (near to what you passed) that the number will look great for.For example, if the domain is 0-100 and you want 4 ticks (0, 33.33, 66.66, 100) it will round up to 6 to give you "pretty" numbers (0, 20, 40, 60, 80, 100). However, if you set ticks to 3 it will honor that and you'll have 0, 50, and 100. |
categories | string[] | string | false | |
Labels of axis.
Properties of the labels object:
Property | Type | Required | Description |
format | Date & Number Format | false | |
The object must be any of the following types:
The object is an array with all elements of the type string.
Properties of the ChartOptions object:
Property | Type | Required | Description |
series | Series[] | true | Data for pies of a chart. |
chart | Chart | false | General options of chart (width, height, etc) |
yAxis | YAxis | false | Options for yAxis |
xAxis | XAxis | false | Options for xAxis |
legend | Legend | false | Legend of chart |
plotOptions | PlotOptions | false | Options of plot |
Data for pies of a chart.
The object is an array with all elements of the type Series.
General options of chart (width, height, etc)
Options for yAxis
Options for xAxis
Legend of chart
Options of plot
Series of line chart
Properties of the Series object:
Property | Type | Required | Description |
data | string | string | true | There are a couple of available formats.data=[23, 89] data=[{"x": 1, "y": 23}, {"x": 2, "y": 89}] data=[{"y": 23, "color": "color2"}, {"y": 89, "color": "color3" }] data=[[1,23], [2,89]] |
name | string | Expression | TextWithFormat | TextLocale | false | Name of series |
description | string | Expression | TextWithFormat | TextLocale | false | Description of series |
dataLabels | DataLabel[] | false | Configuration of labels visible on chart |
color | ChartColor | string | false | Color of series. If expression is used, expression must be evaluated to the predefined color enum. |
There are a couple of available formats.
data=[23, 89] data=[{"x": 1, "y": 23}, {"x": 2, "y": 89}] data=[{"y": 23, "color": "color2"}, {"y": 89, "color": "color3" }] data=[[1,23], [2,89]]
The object must be any of the following types:
Name of series
Description of series
Configuration of labels visible on chart
The object is an array with all elements of the type DataLabel.
Color of series. If expression is used, expression must be evaluated to the predefined color enum.
The object must be any of the following types:
Properties of the DataLabel object:
Property | Type | Required | Description |
isEnabled | boolean | true | |
This element must be one of the following enum values:
- color1
- color2
- color3
- color4
- color5
- color6
- color7
- color8
- color9
- transparent
- positive
- negative
General options of chart (width, height, etc)
Properties of the Chart object:
Property | Type | Required | Description |
isAnimated | boolean | false | If true, chart animates series |
width | number | false | Width of chart |
height | number | false | Height of chart |
title | string | Expression | Text With Format | Text Locale | false | Title of chart |
subtitle | string | Expression | Text With Format | Text Locale | false | Subtitle of chart |
Title of chart
The object must be any of the following types:
see Expression Expects a string of length 2 or more. Value MUST start with = followed by 1 or more characters, with at least 1 being non-whitespace.
Properties of the title object:
Property | Type | Required | Description |
horizontalAlign | enum<string> | false | |
verticalAlign | enum<string> | false | |
This element must be one of the following enum values:
- left
- center
- right
This element must be one of the following enum values:
- top
- center
- bottom
Additional restrictions:
- Regex pattern: ^(((\|)|(>[-+]?))[\s]*)?=[\s]*[\S][\S\s]*$
Text that can be evaluated, translated, formatted
Properties of the title object:
Property | Type | Required | Description |
horizontalAlign | enum<string> | false | |
verticalAlign | enum<string> | false | |
text | string | string | Text Locale | true | |
format | Date & Number Format | false | |
This element must be one of the following enum values:
- left
- center
- right
This element must be one of the following enum values:
- top
- center
- bottom
The object must be any of the following types:
Text that can be translated
Properties of the title object:
Property | Type | Required | Description |
horizontalAlign | enum<string> | false | |
verticalAlign | enum<string> | false | |
id | string | true | |
defaultMessage | string | string | false | |
values | Primitive | Expression | false | |
This element must be one of the following enum values:
- left
- center
- right
This element must be one of the following enum values:
- top
- center
- bottom
The object must be any of the following types:
Subtitle of chart
The object must be any of the following types:
see Expression Expects a string of length 2 or more. Value MUST start with = followed by 1 or more characters, with at least 1 being non-whitespace.
Properties of the subtitle object:
Property | Type | Required | Description |
horizontalAlign | enum<string> | false | |
verticalAlign | enum<string> | false | |
This element must be one of the following enum values:
- left
- center
- right
This element must be one of the following enum values:
- top
- center
- bottom
Additional restrictions:
- Regex pattern: ^(((\|)|(>[-+]?))[\s]*)?=[\s]*[\S][\S\s]*$
Text that can be evaluated, translated, formatted
Properties of the subtitle object:
Property | Type | Required | Description |
horizontalAlign | enum<string> | false | |
verticalAlign | enum<string> | false | |
text | string | string | Text Locale | true | |
format | Date & Number Format | false | |
This element must be one of the following enum values:
- left
- center
- right
This element must be one of the following enum values:
- top
- center
- bottom
The object must be any of the following types:
Text that can be translated
Properties of the subtitle object:
Property | Type | Required | Description |
horizontalAlign | enum<string> | false | |
verticalAlign | enum<string> | false | |
id | string | true | |
defaultMessage | string | string | false | |
values | Primitive | Expression | false | |
This element must be one of the following enum values:
- left
- center
- right
This element must be one of the following enum values:
- top
- center
- bottom
The object must be any of the following types:
Properties of the Legend object:
Property | Type | Required | Description |
isHidden | boolean | false | Whether or not is legend hidden |
Properties of the PlotOptions object:
Property | Type | Required | Description |
series | object | false | |
Properties of the series object:
Property | Type | Required | Description |
pointInterval | number | false | Interval between two points on chart |
pointStart | number | false | It defines on what value to start. Only used if there are no x values for data in series. For example if you want to have Years on x axis you can set this to 2013 and point interval will increase this year by 1 every tick. |
pointWidth | number | false | Width of column regardless on width of chart or number of points. |
marker | MarkerOptions | false | Options for how the markers at each point on a graph are dissplayed. |
Options for how the markers at each point on a graph are dissplayed.
Properties of the MarkerOptions object:
Property | Type | Required | Description |
isHidden | boolean | null | false | Hides the markers on each point if enabled. |
