Chart Component
Properties
backgroundColor Specifies the chart's background color as an alpha-red-green-blue integer.
| Data type: color |
||
| Designer Writable | true |
No designer sample code available at this time. |
| Code Writeable | true |
No code writing sample available at this time. |
| Code Readable | true |
No code reading sample available at this time. |
description Specifies the text displayed by the description label inside the Chart. Specifying an empty string ("") will not display any label.
| Data type: string |
||
| Designer Writable | true |
No designer sample code available at this time. |
| Code Writeable | true |
No code writing sample available at this time. |
| Code Readable | true |
No code reading sample available at this time. |
gridEnabled Changes the visibility of the Chart's grid, if the Chart Type is set to a Chart with an Axis (applies for Area, Bar, Line, Scatter Chart types).
| Data type: boolean |
||
| Designer Writable | true |
No designer sample code available at this time. |
| Code Writeable | true |
No code writing sample available at this time. |
| Code Readable | true |
No code reading sample available at this time. |
height Specifies the Chart's vertical height, measured in pixels.
| Data type: number |
||
| Designer Writable | false | |
| Code Writeable | true |
No code writing sample available at this time. |
| Code Readable | true |
No code reading sample available at this time. |
heightPercent Specifies the Chart's vertical height as a percentage of the Screen's Height.
| Data type: number |
||
| Designer Writable | false | |
| Code Writeable | true |
No code writing sample available at this time. |
| Code Readable | false | |
labels Changes the Chart's X axis labels to the specified List, if the Chart's Type is set to a Chart with an Axis. The first entry of the List corresponds to the minimum x value of the data, the second to the min x value + 1, and so on. If a label is not specified for an x value, a default value is used (the x value of the axis tick at that location).
| Data type: array |
||
| Designer Writable | false | |
| Code Writeable | true |
No code writing sample available at this time. |
| Code Readable | true |
No code reading sample available at this time. |
labelsFromString Specifies the labels to set to the Chart's X Axis, provided the current view is a Chart with an X Axis. The labels are specified as a single comma-separated values String (meaning each value is separated by a comma). See Chart.Labels for more details on how the Labels are applied to the Chart.
| Data type: string |
||
| Designer Writable | true |
No designer sample code available at this time. |
| Code Writeable | false | |
| Code Readable | false | |
legendEnabled Changes the visibility of the Chart's Legend.
| Data type: boolean |
||
| Designer Writable | true |
No designer sample code available at this time. |
| Code Writeable | true |
No code writing sample available at this time. |
| Code Readable | true |
No code reading sample available at this time. |
pieRadius Sets the Pie Radius of the Chart. If the current type is not the Pie Chart, the value has no effect.
| Data type: number |
||
| Designer Writable | true |
No designer sample code available at this time. |
| Code Writeable | false | |
| Code Readable | false | |
type Specifies the type of the Chart, which determines how to visualize the data. Default is 'line', but you can set it to 'scatter', 'area', 'pie' or 'bar'.
| Data type: string |
||
| Designer Writable | true |
No designer sample code available at this time. |
| Code Writeable | false | |
| Code Readable | false | |
visible Specifies whether the Chart should be visible on the screen. Value is true if the Chart is showing and false if hidden.
| Data type: boolean |
||
| Designer Writable | true |
No designer sample code available at this time. |
| Code Writeable | true |
No code writing sample available at this time. |
| Code Readable | true |
No code reading sample available at this time. |
width Specifies the horizontal width of the Chart, measured in pixels.
| Data type: number |
||
| Designer Writable | false | |
| Code Writeable | true |
No code writing sample available at this time. |
| Code Readable | true |
No code reading sample available at this time. |
widthPercent Specifies the horizontal width of the Chart as a percentage of the Screen's Width.
| Data type: number |
||
| Designer Writable | false | |
| Code Writeable | true |
No code writing sample available at this time. |
| Code Readable | false | |
XFromZero Determines whether the X axis origin is set at 0 or the minimum X value across all data series.
| Data type: boolean |
||
| Designer Writable | true |
No designer sample code available at this time. |
| Code Writeable | true |
No code writing sample available at this time. |
| Code Readable | true |
No code reading sample available at this time. |
YFromZero Determines whether the Y axis origin is set at 0 or the minimum y value across all data series.
| Data type: boolean |
||
| Designer Writable | true |
No designer sample code available at this time. |
| Code Writeable | true |
No code writing sample available at this time. |
| Code Readable | true |
No code reading sample available at this time. |
class The styling class of the the component
| Data type: string |
||
| Designer Writable | true |
No designer sample code available at this time. |
| Code Writeable | false | |
| Code Readable | false | |
id The styling id of the the component
| Data type: string |
||
| Designer Writable | true |
No designer sample code available at this time. |
| Code Writeable | false | |
| Code Readable | false | |
name The name of the component that will be used to refer to it in code.
| Data type: string |
||
| Designer Writable | true |
No designer sample code available at this time. |
| Code Writeable | false | |
| Code Readable | false | |
Methods
| Method name | Description | Parameters | ||||
|---|---|---|---|---|---|---|
| setDomain |
Sets the minimum and maximum for the domain of the X axis. chartName.setDomain(minimum, maximum) |
|
||||
| setRange |
Sets the minimum and maximum for the range of the Y axis. chartName.setRange(minimum, maximum) |
|
||||
| addEventListener |
Method used to create event listeners. See Events below for samples. |
|
Events
| Event name | Description | Parameters | ||||||
|---|---|---|---|---|---|---|---|---|
| entryClick | Indicates that the user clicked on a data entry in the Chart. The specific series, along with its x and y values, are reported.
chartName.addEventListener(
"entryClick",
function (series, x, y) {
//Your code here
}
)
|
|