Skip to content

feat(type): provide ability to extend series option #15735

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
pissang merged 1 commit into from
Sep 16, 2021
Merged

feat(type): provide ability to extend series option #15735

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
63 changes: 41 additions & 22 deletions src/export/option.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -201,28 +201,47 @@ export type ThemeRiverSeriesOption = ThemeRiverSeriesOptionInner & SeriesInjecte
export type SunburstSeriesOption = SunburstSeriesOptionInner & SeriesInjectedOption;
export type CustomSeriesOption = CustomSeriesOptionInner & SeriesInjectedOption;

export type SeriesOption = LineSeriesOption
| BarSeriesOption
| ScatterSeriesOption
| PieSeriesOption
| RadarSeriesOption
| MapSeriesOption
| TreeSeriesOption
| TreemapSeriesOption
| GraphSeriesOption
| GaugeSeriesOption
| FunnelSeriesOption
| ParallelSeriesOption
| SankeySeriesOption
| BoxplotSeriesOption
| CandlestickSeriesOption
| EffectScatterSeriesOption
| LinesSeriesOption
| HeatmapSeriesOption
| PictorialBarSeriesOption
| ThemeRiverSeriesOption
| SunburstSeriesOption
| CustomSeriesOption;

/**
* A map from series 'type' to series option
* It's used for declaration merging in echarts extensions.
* For example:
* ```ts
* import echarts from 'echarts';
* declare module 'echarts/types/dist/echarts' {
* interface RegisteredSeriesOption {
* wordCloud: WordCloudSeriesOption
* }
* }
* ```
*/
export interface RegisteredSeriesOption {
line: LineSeriesOption
bar: BarSeriesOption
scatter: ScatterSeriesOption
pie: PieSeriesOption
radar: RadarSeriesOption
map: MapSeriesOption
tree: TreeSeriesOption
treemap: TreemapSeriesOption
graph: GraphSeriesOption
gauge: GaugeSeriesOption
funnel: FunnelSeriesOption
parallel: ParallelSeriesOption
sankey: SankeySeriesOption
boxplot: BoxplotSeriesOption
candlestick: CandlestickSeriesOption
effectScatter: EffectScatterSeriesOption
lines: LinesSeriesOption
heatmap: HeatmapSeriesOption
pictorialBar: PictorialBarSeriesOption
themeRiver: ThemeRiverSeriesOption
sunburst: SunburstSeriesOption
custom: CustomSeriesOption
}
type Values<T> = T[keyof T];

export type SeriesOption = Values<RegisteredSeriesOption>;

export interface EChartsOption extends ECBasicOption {
dataset?: DatasetComponentOption | DatasetComponentOption[];
Expand Down