[incubator-echarts] 02/02: refact: adjust exports.

[sh...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

shenyi pushed a commit to branch no-register-when-extend
in repository https://gitbox.apache.org/repos/asf/incubator-echarts.git

commit 0b14e0652ff2d9f91584978b758fc0d42df443a0
Author: pissang <bm...@gmail.com>
AuthorDate: Thu Jan 7 11:19:55 2021 +0800

    refact: adjust exports.
---
 src/core/echarts.ts | 46 ------------------------------------
 src/export/api.ts   | 68 ++++++++++++++++++++++++++++++++++++++++++++++-------
 2 files changed, 59 insertions(+), 55 deletions(-)

diff --git a/src/core/echarts.ts b/src/core/echarts.ts
index 7093603..f94282b 100644
--- a/src/core/echarts.ts
+++ b/src/core/echarts.ts
@@ -2805,52 +2805,6 @@ export function registerLoading(
     loadingEffects[name] = loadingFx;
 }
 
-export function extendComponentModel(proto: object): ComponentModel {
-    // let Clazz = ComponentModel;
-    // if (superClass) {
-    //     let classType = parseClassType(superClass);
-    //     Clazz = ComponentModel.getClass(classType.main, classType.sub, true);
-    // }
-    const Model = (ComponentModel as ComponentModelConstructor).extend(proto) as any;
-    ComponentModel.registerClass(Model);
-    return Model;
-}
-
-export function extendComponentView(proto: object): ChartView {
-    // let Clazz = ComponentView;
-    // if (superClass) {
-    //     let classType = parseClassType(superClass);
-    //     Clazz = ComponentView.getClass(classType.main, classType.sub, true);
-    // }
-    const View = (ComponentView as ComponentViewConstructor).extend(proto) as any;
-    ComponentView.registerClass(View);
-    return View;
-}
-
-export function extendSeriesModel(proto: object): SeriesModel {
-    // let Clazz = SeriesModel;
-    // if (superClass) {
-    //     superClass = 'series.' + superClass.replace('series.', '');
-    //     let classType = parseClassType(superClass);
-    //     Clazz = ComponentModel.getClass(classType.main, classType.sub, true);
-    // }
-    const Model = (SeriesModel as SeriesModelConstructor).extend(proto) as any;
-    SeriesModel.registerClass(Model);
-    return Model;
-}
-
-export function extendChartView(proto: object): ChartView {
-    // let Clazz = ChartView;
-    // if (superClass) {
-    //     superClass = superClass.replace('series.', '');
-    //     let classType = parseClassType(superClass);
-    //     Clazz = ChartView.getClass(classType.main, true);
-    // }
-    const View = (ChartView as ChartViewConstructor).extend(proto) as any;
-    ChartView.registerClass(View);
-    return View;
-}
-
 /**
  * ZRender need a canvas context to do measureText.
  * But in node environment canvas may be created by node-canvas.
diff --git a/src/export/api.ts b/src/export/api.ts
index 2906d21..1d84814 100644
--- a/src/export/api.ts
+++ b/src/export/api.ts
@@ -17,6 +17,14 @@
 * under the License.
 */
 
+// These APIs are for more advanced usages
+// For example extend charts and components, creating graphic elements, formatting.
+import ComponentModel, { ComponentModelConstructor } from '../model/Component';
+import ComponentView, { ComponentViewConstructor } from '../view/Component';
+import SeriesModel, { SeriesModelConstructor } from '../model/Series';
+import ChartView, { ChartViewConstructor } from '../view/Chart';
+
+
 // Provide utilities API in echarts. It will be in echarts namespace.
 // Like echarts.util, echarts.graphic
 export * as zrender from 'zrender/src/zrender';
@@ -30,14 +38,7 @@ export * as helper from './api/helper';
 
 export {use} from '../extension';
 
-// Only for GL
-export {brushSingle as innerDrawElementOnCanvas} from 'zrender/src/canvas/graphic';
-
-export {default as List} from '../data/List';
-export {default as Model} from '../model/Model';
-export {default as Axis} from '../coord/Axis';
-export {default as env} from 'zrender/src/core/env';
-
+//////////////// Helper Methods /////////////////////
 export {default as parseGeoJSON} from '../coord/geo/parseGeoJson';
 export {default as parseGeoJson} from '../coord/geo/parseGeoJson';
 
@@ -47,4 +48,53 @@ export * as graphic from './api/graphic';
 
 export * as format from './api/format';
 
-export * as util from './api/util';
\ No newline at end of file
+export * as util from './api/util';
+
+export {default as env} from 'zrender/src/core/env';
+
+//////////////// Export for Exension Usage ////////////////
+export {default as List} from '../data/List';
+export {default as Model} from '../model/Model';
+export {default as Axis} from '../coord/Axis';
+
+export {
+    ComponentModel,
+    ComponentView,
+    SeriesModel,
+    ChartView
+};
+
+// Only for GL
+export {brushSingle as innerDrawElementOnCanvas} from 'zrender/src/canvas/graphic';
+
+
+//////////////// Deprecated Extension Methods ////////////////
+
+// Should use `ComponentModel.extend` or `class XXXX extend ComponentModel` to create class.
+// Then use `registerComponentModel` in `install` parameter when `use` this extension. For example:
+// class Bar3DModel extends ComponentModel {}
+// export function install(registers) { regsiters.registerComponentModel(Bar3DModel); }
+// echarts.use(install);
+export function extendComponentModel(proto: object): ComponentModel {
+    const Model = (ComponentModel as ComponentModelConstructor).extend(proto) as any;
+    ComponentModel.registerClass(Model);
+    return Model;
+}
+
+export function extendComponentView(proto: object): ChartView {
+    const View = (ComponentView as ComponentViewConstructor).extend(proto) as any;
+    ComponentView.registerClass(View);
+    return View;
+}
+
+export function extendSeriesModel(proto: object): SeriesModel {
+    const Model = (SeriesModel as SeriesModelConstructor).extend(proto) as any;
+    SeriesModel.registerClass(Model);
+    return Model;
+}
+
+export function extendChartView(proto: object): ChartView {
+    const View = (ChartView as ChartViewConstructor).extend(proto) as any;
+    ChartView.registerClass(View);
+    return View;
+}


---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@echarts.apache.org
For additional commands, e-mail: commits-help@echarts.apache.org