mirror of
https://github.com/hustcc/echarts-for-react.git
synced 2025-12-08 20:16:09 +00:00
fix: use @types/echarts as option type (#325)
This commit is contained in:
parent
9a26214bd0
commit
b1df3b339b
65
lib/index.d.ts
vendored
65
lib/index.d.ts
vendored
@ -1,6 +1,7 @@
|
||||
/// <reference types="react" />
|
||||
|
||||
import * as React from 'react';
|
||||
import { EChartOption, EChartsLoadingOption } from 'echarts';
|
||||
|
||||
type Func = (...args: any[]) => any;
|
||||
|
||||
@ -21,16 +22,74 @@ interface optsMap {
|
||||
|
||||
// Index
|
||||
export interface ReactEchartsPropsTypes {
|
||||
option: ObjectMap;
|
||||
/**
|
||||
* the echarts option config
|
||||
* @see http://echarts.baidu.com/option.html#title
|
||||
*/
|
||||
option: EChartOption;
|
||||
/**
|
||||
* when `setOption`, not merge the data.
|
||||
* @default false
|
||||
* @see http://echarts.baidu.com/api.html#echartsInstance.setOption
|
||||
*/
|
||||
notMerge?: boolean;
|
||||
/**
|
||||
* when `setOption`, lazy update the data.
|
||||
* @default false
|
||||
* @see http://echarts.baidu.com/api.html#echartsInstance.setOption
|
||||
*/
|
||||
lazyUpdate?: boolean;
|
||||
style?: ObjectMap;
|
||||
/**
|
||||
* the `style` of echarts div.
|
||||
* @default {height: '300px'}
|
||||
*/
|
||||
style?: React.CSSProperties;
|
||||
/**
|
||||
* the `class` of echarts div. you can setting the css style of charts by class name.
|
||||
*/
|
||||
className?: string;
|
||||
/**
|
||||
* the `theme` of echarts. should `registerTheme` before use it.
|
||||
* @see https://github.com/ecomfe/echarts/blob/master/theme/dark.js)
|
||||
* @example
|
||||
* ```
|
||||
// register theme object
|
||||
echarts.registerTheme('my_theme', { backgroundColor: '#f4cccc' });
|
||||
// render the echarts use option `theme`
|
||||
<ReactEcharts option={this.getOption()} theme='my_theme' />
|
||||
* ```
|
||||
*/
|
||||
theme?: string | null | ObjectMap;
|
||||
/**
|
||||
* when the chart is ready, will callback the function with the `echarts object` as it's paramter.
|
||||
*/
|
||||
onChartReady?: Func;
|
||||
/**
|
||||
* when the chart is rendering, show the loading mask.
|
||||
*/
|
||||
showLoading?: boolean;
|
||||
loadingOption?: ObjectMap;
|
||||
/**
|
||||
* the echarts loading option config.
|
||||
* @see http://echarts.baidu.com/api.html#echartsInstance.showLoading
|
||||
*/
|
||||
loadingOption?: EChartsLoadingOption;
|
||||
/**
|
||||
* binding the echarts event, will callback with the `echarts event object`, and the `echart object` as it's paramters.
|
||||
* @example
|
||||
* ```
|
||||
let onEvents = {
|
||||
'click': this.onChartClick,
|
||||
'legendselectchanged': this.onChartLegendselectchanged
|
||||
}
|
||||
<ReactEcharts onEvents={onEvents} />
|
||||
* ```
|
||||
* @see: http://echarts.baidu.com/api.html#events
|
||||
*/
|
||||
onEvents?: EventMap;
|
||||
/**
|
||||
* the `opts` of echarts. will be used when initial echarts instance by `echarts.init`.
|
||||
* @see http://echarts.baidu.com/api.html#echarts.init
|
||||
*/
|
||||
opts?: optsMap;
|
||||
shouldSetOption?: Func;
|
||||
}
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user