You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@echarts.apache.org by sh...@apache.org on 2020/12/22 02:36:37 UTC
[incubator-echarts] branch treeshakable-exports updated: ts: add
dependencies in ComposeOption
This is an automated email from the ASF dual-hosted git repository.
shenyi pushed a commit to branch treeshakable-exports
in repository https://gitbox.apache.org/repos/asf/incubator-echarts.git
The following commit(s) were added to refs/heads/treeshakable-exports by this push:
new 507c0ae ts: add dependencies in ComposeOption
507c0ae is described below
commit 507c0aecbf42df7ff1c7f1c08c51766da37f2b5f
Author: pissang <bm...@gmail.com>
AuthorDate: Tue Dec 22 10:33:38 2020 +0800
ts: add dependencies in ComposeOption
---
src/coord/cartesian/AxisModel.ts | 7 +++++++
src/echarts.ts | 6 +++---
src/export/core.ts | 26 ++++++++++++++++++++++++--
src/export/option.ts | 14 ++++++++------
test/types/importPartial.ts | 9 +++++++++
5 files changed, 51 insertions(+), 11 deletions(-)
diff --git a/src/coord/cartesian/AxisModel.ts b/src/coord/cartesian/AxisModel.ts
index 671202f..6722660 100644
--- a/src/coord/cartesian/AxisModel.ts
+++ b/src/coord/cartesian/AxisModel.ts
@@ -40,6 +40,13 @@ export interface CartesianAxisOption extends AxisBaseOption {
categorySortInfo?: OrdinalSortInfo[];
}
+export interface XAXisOption extends CartesianAxisOption {
+ mainType?: 'xAxis'
+}
+export interface YAXisOption extends CartesianAxisOption {
+ mainType?: 'yAxis'
+}
+
export class CartesianAxisModel extends ComponentModel<CartesianAxisOption>
implements AxisBaseModel<CartesianAxisOption> {
diff --git a/src/echarts.ts b/src/echarts.ts
index 1268139..6c4f25b 100644
--- a/src/echarts.ts
+++ b/src/echarts.ts
@@ -546,10 +546,10 @@ class ECharts extends Eventful {
* @param opts.replaceMerge Default undefined.
*/
// Expose to user full option.
- setOption<Opt extends ECBasicOption = EChartsOption>(option: Opt, notMerge?: boolean, lazyUpdate?: boolean): void;
- setOption<Opt extends ECBasicOption = EChartsOption>(option: Opt, opts?: SetOptionOpts): void;
+ setOption<Opt extends ECBasicOption>(option: Opt, notMerge?: boolean, lazyUpdate?: boolean): void;
+ setOption<Opt extends ECBasicOption>(option: Opt, opts?: SetOptionOpts): void;
/* eslint-disable-next-line */
- setOption<Opt extends ECBasicOption = EChartsOption>(option: Opt, notMerge?: boolean | SetOptionOpts, lazyUpdate?: boolean): void {
+ setOption<Opt extends ECBasicOption>(option: Opt, notMerge?: boolean | SetOptionOpts, lazyUpdate?: boolean): void {
if (__DEV__) {
assert(!this[IN_MAIN_PROCESS_KEY], '`setOption` should not be called during main process.');
}
diff --git a/src/export/core.ts b/src/export/core.ts
index 753bf70..c489161 100644
--- a/src/export/core.ts
+++ b/src/export/core.ts
@@ -19,6 +19,11 @@
import { ComponentOption, ECBasicOption as EChartsCoreOption } from '../util/types';
+import { AxisPointerOption } from '../component/axisPointer/AxisPointerModel';
+import { XAXisOption, YAXisOption } from '../coord/cartesian/AxisModel';
+import { AngleAxisOption, RadiusAxisOption } from '../coord/polar/AxisModel';
+import { ParallelAxisOption } from '../coord/parallel/AxisModel';
+
export * from '../echarts';
export * from './api';
@@ -26,10 +31,27 @@ export {EChartsType as ECharts} from '../echarts';
export {EChartsCoreOption};
+// TODO: Handwritten dependencies
+type Dependencies = {
+ grid: XAXisOption | YAXisOption | AxisPointerOption;
+ polar: AngleAxisOption | RadiusAxisOption
+ parallel: ParallelAxisOption
+};
+
+type GetMainType<OptionUnion extends ComponentOption> = Exclude<OptionUnion['mainType'], undefined>;
+
+type GetDependencies<MainType extends string> = MainType extends keyof Dependencies & string
+ // Add dependencies
+ ? {
+ [key in GetMainType<Dependencies[MainType]>]
+ : Dependencies[MainType] | Dependencies[MainType][]
+ }
+ : any;
+
type ComposeUnitOption<OptionUnion extends ComponentOption = never> =
EChartsCoreOption & {
- [key in Exclude<OptionUnion['mainType'], undefined>]?: OptionUnion | OptionUnion[];
- };
+ [key in GetMainType<OptionUnion>]?: OptionUnion | OptionUnion[];
+ } & GetDependencies<GetMainType<OptionUnion>>;
export type ComposeOption<OptionUnion extends ComponentOption> =
ComposeUnitOption<OptionUnion> & {
diff --git a/src/export/option.ts b/src/export/option.ts
index ac50374..f1c58a5 100644
--- a/src/export/option.ts
+++ b/src/export/option.ts
@@ -24,7 +24,10 @@ import type {
RadiusAxisOption as RadiusAxisComponentOption,
AngleAxisOption as AngleAxisComponentOption
} from '../coord/polar/AxisModel';
-import type {CartesianAxisOption as CartesianAxisComponentOption} from '../coord/cartesian/AxisModel';
+import type {
+ XAXisOption as XAXisComponentOption,
+ YAXisOption as YAXisComponentOption
+} from '../coord/cartesian/AxisModel';
import type {SingleAxisOption as SingleAxisComponentOption} from '../coord/single/AxisModel';
import type {ParallelAxisOption as ParallelAxisComponentOption} from '../coord/parallel/AxisModel';
import type {ParallelCoordinateSystemOption as ParallelComponentOption} from '../coord/parallel/ParallelModel';
@@ -107,13 +110,12 @@ interface ToolboxComponentOption extends ToolboxOption {
export type DataZoomComponentOption = SliderDataZoomOption | InsideDataZoomOption;
export type VisualMapComponentOption = ContinousVisualMapOption | PiecewiseVisualMapOption;
export type LegendComponentOption = LegendOption | ScrollableLegendOption;
-export type XAXisComponentOption = CartesianAxisComponentOption;
-export type YAXisComponentOption = CartesianAxisComponentOption;
export {
GridComponentOption,
PolarComponentOption,
GeoComponentOption,
- CartesianAxisComponentOption,
+ XAXisComponentOption,
+ YAXisComponentOption,
SingleAxisComponentOption,
RadiusAxisComponentOption,
AngleAxisComponentOption,
@@ -197,8 +199,8 @@ export interface EChartsOption extends ECBasicOption {
geo?: GeoComponentOption | GeoComponentOption[];
angleAxis?: AngleAxisComponentOption | AngleAxisComponentOption[];
radiusAxis?: RadiusAxisComponentOption | RadiusAxisComponentOption[];
- xAxis?: CartesianAxisComponentOption | CartesianAxisComponentOption[];
- yAxis?: CartesianAxisComponentOption | CartesianAxisComponentOption[];
+ xAxis?: XAXisComponentOption | XAXisComponentOption[];
+ yAxis?: YAXisComponentOption | YAXisComponentOption[];
singleAxis?: SingleAxisComponentOption | SingleAxisComponentOption[];
parallel?: ParallelComponentOption | ParallelComponentOption[];
parallelAxis?: ParallelAxisComponentOption | ParallelAxisComponentOption[];
diff --git a/test/types/importPartial.ts b/test/types/importPartial.ts
index bb49c07..2f43d0b 100644
--- a/test/types/importPartial.ts
+++ b/test/types/importPartial.ts
@@ -24,6 +24,15 @@ type Option = ComposeOption<
>;
const option: Option= {
+ // xAxis and yAxis should been add as dependencies
+ xAxis: {
+ min: 0,
+ max: 10
+ },
+ yAxis: {
+ min: 0,
+ max: 10
+ },
series: [{
type: 'bar'
}]
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@echarts.apache.org
For additional commands, e-mail: commits-help@echarts.apache.org