Charts Function
setOption(options)
is the primary function in the Apache ECharts library. It is depicted as a square on the right in the schema below. This function gets called by the Business Charts panel (the Charts Function) with only one required parameter options
.
The parameter options
describes the charts in the JSON format.
To configure the Business Charts panel mainly means writing the Charts Function. Generally, this function contains two parts:
- JavaScript to read data points from the data source.
- JSON to specify a graph as
options
.
Both parts can use parameters passed into the Charts function. You can find the complete list of parameters in the table below.
See the schema and the print screen below for illustration.
Options
The return
clause is where you need to specify the options
parameter to be passed into the setOption(options)
Apache ECharts library function.
Parameters
Parameter | Description |
---|---|
data | Object containing a time range, series, and request information. |
echarts | Apache ECharts library. |
echartsInstance | Instance of the Apache ECharts library. See the example in the screenshot above. |
ecStat | A statistical and data mining tool for Apache ECharts. |
eventBus | Publish and subscribe to application events. |
locationService | Works with browser location and history. |
notifyError(['Header', 'Error Message']) | Display error notifications. |
notifySuccess(['Header', 'Message']) | Display success notifications. |
replaceVariables | Function to interpolate variables. |
theme | Theme object. |
To inspect those parameters, use the browser's developer console.
console.error(
data,
theme,
echartsInstance,
echarts,
replaceVariables,
locationService
);
Notifications
You can display success and error notifications when handling specific events.
notifySuccess(["Update", "Values updated successfully."]);
notifyError(["Update", `An error occurred while updating values.`]);