import type {
AxisPointerComponentOption,
ECharts,
LineSeriesOption,
PatternObject,
} from 'echarts';
import type ReactEchartsCore from 'echarts-for-react/lib/core';
export type SeriesDataUnit = {
// number because we sometimes use timestamps
name: string | number;
value: number;
itemStyle?: {
color?: string;
};
onClick?: (series: Series, instance: ECharts) => void;
};
export type Series = {
data: SeriesDataUnit[];
seriesName: string;
areaStyle?: {
color: string | PatternObject;
opacity: number;
};
color?: string;
id?: string;
lineStyle?: AxisPointerComponentOption['lineStyle'];
// https://echarts.apache.org/en/option.html#series-line.z
markLine?: LineSeriesOption['markLine'];
stack?: string;
// https://echarts.apache.org/en/option.html#series-line.stack
symbol?: LineSeriesOption['symbol'];
symbolSize?: LineSeriesOption['symbolSize'];
z?: number;
};
export type ReactEchartsRef = ReactEchartsCore;
export type EChartEventHandler
= (params: P, instance: ECharts) => void;
export type EChartChartReadyHandler = (instance: ECharts) => void;
export type EChartHighlightHandler = EChartEventHandler;
/**
* XXX: These are incomplete types and can also vary depending on the component type
*
* Taken from https://echarts.apache.org/en/api.html#events.Mouse%20events
*/
interface EChartMouseEventParam {
// color of component (make sense when componentType is 'series')
color: string;
// subtype of the component to which the clicked glyph belongs
// i.e. 'scatter', 'line', etc
componentSubType: string;
// type of the component to which the clicked glyph belongs
// i.e., 'series', 'markLine', 'markPoint', 'timeLine'
componentType: string;
// incoming raw data item
data: Record;
// data index in incoming data array
dataIndex: number;
// Some series, such as sankey or graph, maintains more than
// one types of data (nodeData and edgeData), which can be
// distinguished from each other by dataType with its value
// 'node' and 'edge'.
// On the other hand, most series has only one type of data,
// where dataType is not needed.
dataType: string;
// data name, category name
name: string;
seriesId: string;
// series index in incoming option.series (make sense when componentType is 'series')
seriesIndex: number;
// series name (make sense when componentType is 'series')
seriesName: string;
// series type (make sense when componentType is 'series')
// i.e., 'line', 'bar', 'pie'
seriesType: string;
// incoming data value
value: number | number[];
}
export type EChartMouseOutHandler = EChartEventHandler;
export type EChartMouseOverHandler = EChartEventHandler;
export type EChartClickHandler = EChartEventHandler;
export type EChartDataZoomHandler = EChartEventHandler<{
/**
* percentage of zoom finish position, 0 - 100
*/
end: number;
/**
* percentage of zoom start position, 0 - 100
*/
start: number;
type: 'datazoom';
/**
* data value of zoom finish position; only exists in zoom event of
* triggered by toolbar
*/
endValue?: number;
/**
* data value of zoom start position; only exists in zoom event of
* triggered by toolbar
*/
startValue?: number;
}>;
export type DataPoint = Pick;
export type EChartRestoreHandler = EChartEventHandler<{type: 'restore'}>;
export type EChartFinishedHandler = EChartEventHandler<{}>;
export type EChartRenderedHandler = EChartEventHandler<{}>;
type EchartBrushAreas = {
coordRange: number[][];
range: number[][];
}[];
export type EChartBrushStartHandler = EChartEventHandler<{
areas: EchartBrushAreas;
brushId: string;
type: 'brush';
}>;
export type EChartBrushEndHandler = EChartEventHandler<{
areas: EchartBrushAreas;
brushId: string;
type: 'brushend';
}>;
export type EChartBrushSelectedHandler = EChartEventHandler<{
brushId: string;
type: 'brushselected';
}>;