Skip to content

Documentation v1.0.0


Documentation / @openassistant/plots / EChartsToolContext

Type Alias: EChartsToolContext

EChartsToolContext = object

Defined in: types.ts:35

The context you should provided to run the ECharts tool.

Properties

config?

optional config: object

Defined in: types.ts:51

The config for the ECharts.

isDraggable?

optional isDraggable: boolean

Whether the ECharts is draggable.

isExpanded?

optional isExpanded: boolean

Whether the ECharts is expanded.

showLoess?

optional showLoess: boolean

Whether to show the loess line. Only for scatter plot.

showRegressionLine?

optional showRegressionLine: boolean

Whether to show the regression line. Only for scatter plot.

theme?

optional theme: string

The theme of the ECharts.


filteredIndex?

optional filteredIndex: number[]

Defined in: types.ts:47

The filtered indices of the ECharts. This can be used to initialize what has been filtered in the ECharts.


getValues

getValues: GetValues

Defined in: types.ts:39

The function to get the values of the variable from dataset.


onSelected?

optional onSelected: OnSelected

Defined in: types.ts:43

The function to handle the selected indices of the ECharts. This can be used to get what's highlighted in the ECharts and you can use it to sync the highlight in your own app.

Released under the MIT License.