Chart Tags¶
| Tag | Data type | Description |
|---|---|---|
| charts | Root object | Creates a charts root object. |
| addItem | Root method | Adds an item to an array. |
| exportCsv | Root method | Exports data in CSV format. |
| setId | Root method | Sets a new id to an element. |
| barChart | Object | Creates a bar chart object. |
| barChart | Object | Creates a bubble chart object. |
| doughnutChart | Object | Creates a doughnut chart object. |
| horizontalBarChart | Object | Creates an horizontal bar chart object. |
| horizontalStackedBarChart | Object | Creates an horizontal stacked bar chart object. |
| lineChart | Object | Creates a line chart object. |
| pieChart | Object | Creates a pie chart object. |
| polarAreaChart | Object | Creates a polar area chart object. |
| radarChart | Object | Creates a radar chart object. |
| stackedBarChart | Object | Creates a stacked bar chart object. |
charts¶
Property
<charts>…</charts>
Data type
Object
Description
Creates a charts object. The tag <charts> is the root xml element.
addItem¶
Property
<addItem reference=”object#id” key=”myKey” value=”myValue” />
Data type
Root method
Description
Method associated with the root tag <charts> which adds an item in an array.
Attributes:
- reference (required): the object reference.
- key (required): the key of the item in the array.
- value(required): the value associated with the item.
exportCsv¶
Property
<exportCvs reference=”object#id” data=”object#id” />
Data type
Root method
Description
Method associated with the root tag <charts> which makes it possible to export data in the CSV format.
Attributes:
- reference (required): the object reference.
- data (required): the reference to data.
- rowHeader: if set, the reference to the row header.
- columnHeader: if set, the reference to the column header.
- encoding: if set, the encoding is used to convert the output. By default, the CSV output is converted to ISO-8859-1.
setId¶
Property
<setId reference=”object#id” newId=”myNewId” />
Data type
Root method
Description
Method associated with the root tag <charts> which makes it possible to change the id of the object given in the reference attribute.
Attributes:
- reference (required): the object reference.
- newId (required): the new id.
barChart¶
Property
<barChart id=”myBarChartId” data=”data#myBarChartData”>…</barChart>
Data type
Object
Description
Creates a bar chart object.
Attributes:
- id (required): the identifier.
- data (required): a reference to the data used for the chart (in general a reference to a data object).
- options: a reference to the options (in general a reference to a data object).
- width: the canvas width. If this attribute is not provided, the default width is 400.
- height: the canvas height. If this attribute is not provided, the default height is 300.
bubbleChart¶
Property
<bubbleChart id=”myBubbleChartId” data=”data#myBubbleChartData”>…</bubbleChart>
Data type
Object
Description
Creates a buble chart object.
Attributes:
- id (required): the identifier.
- data (required): a reference to the data used for the chart (in general a reference to a data object).
- options: a reference to the options (in general a reference to a data object).
- width: the canvas width. If this attribute is not provided, the default width is 400.
- height: the canvas height. If this attribute is not provided, the default height is 300.
doughnutChart¶
Property
<doughnutChart id=”myDoughnutChartId” data=”data#myDoughnutChartData”>…</doughnutChart>
Data type
Object
Description
Creates a doughnut chart object.
Attributes:
- id (required): the identifier.
- data (required): a reference to the data used for the chart (in general a reference to a data object).
- options: a reference to the options (in general a reference to a data object).
- width: the canvas width. If this attribute is not provided, the default width is 400.
- height: the canvas height. If this attribute is not provided, the default height is 300.
horizontalBarChart¶
Property
<horizontalBarChart id=”myhorizontalBarChartId” data=”data#myhorizontalBarChartData”>…</horizontalBarChart>
Data type
Object
Description
Creates an horizontal bar chart object.
Attributes:
- id (required): the identifier.
- data (required): a reference to the data used for the chart (in general a reference to a data object).
- options: a reference to the options (in general a reference to a data object).
- width: the canvas width. If this attribute is not provided, the default width is 400.
- height: the canvas height. If this attribute is not provided, the default height is 300.
horizontalStackedBarChart¶
Property
<horizontalStackedBarChart id=”myhorizontalStackedBarChartId” data=”data#myhorizontalStackedBarChartData”>…</horizontalStackedBarChart>
Data type
Object
Description
Creates an horizontal stacked bar chart object.
Attributes:
- id (required): the identifier.
- data (required): a reference to the data used for the chart (in general a reference to a data object).
- options: a reference to the options (in general a reference to a data object).
- width: the canvas width. If this attribute is not provided, the default width is 400.
- height: the canvas height. If this attribute is not provided, the default height is 300.
lineChart¶
Property
<lineChart id=”myLineChartId” data=”data#myLineChartData”>…</lineChart>
Data type
Object
Description
Creates a doughnut chart object.
Attributes:
- id (required): the identifier.
- data (required): a reference to the data used for the chart (in general a reference to a data object).
- options: a reference to the options (in general a reference to a data object).
- width: the canvas width. If this attribute is not provided, the default width is 400.
- height: the canvas height. If this attribute is not provided, the default height is 300.
pieChart¶
Property
<pieChart id=”myPieChartId” data=”data#myPieChartData”>…</pieChart>
Data type
Object
Description
Creates a pie chart object.
Attributes:
- id (required): the identifier.
- data (required): a reference to the data used for the chart (in general a reference to a data object).
- options: a reference to the options (in general a reference to a data object).
- width: the canvas width. If this attribute is not provided, the default width is 400.
- height: the canvas height. If this attribute is not provided, the default height is 300.
polarAreaChart¶
Property
<polarAreaChart id=”myPolarAreaChartId” data=”data#myPolarAreaChartData”>…</polarAreaChart>
Data type
Object
Description
Creates a polar Area chart object.
Attributes:
- id (required): the identifier.
- data (required): a reference to the data used for the chart (in general a reference to a data object).
- options: a reference to the options (in general a reference to a data object).
- width: the canvas width. If this attribute is not provided, the default width is 400.
- height: the canvas height. If this attribute is not provided, the default height is 300.
radarChart¶
Property
<radarChart id=”myRadarChartId” data=”data#myRadarChartData”>…</radarChart>
Data type
Object
Description
Creates a radar chart object.
Attributes:
- id (required): the identifier.
- data (required): a reference to the data used for the chart (in general a reference to a data object).
- options: a reference to the options (in general a reference to a data object).
- width: the canvas width. If this attribute is not provided, the default width is 400.
- height: the canvas height. If this attribute is not provided, the default height is 300.
stackedBarChart¶
Property
<stackedBarChart id=”myStackedBarChartId” data=”data#myStackedBarChartData”>…</stackedBarChart>
Data type
Object
Description
Creates a stacked bar chart object.
Attributes:
- id (required): the identifier.
- data (required): a reference to the data used for the chart (in general a reference to a data object).
- options: a reference to the options (in general a reference to a data object).
- width: the canvas width. If this attribute is not provided, the default width is 400.
- height: the canvas height. If this attribute is not provided, the default height is 300.