[echarts] branch improve-types updated: fix(type): optimize custom renderItem return type. expose renderItem type

[sh...@apache.org]

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

shenyi pushed a commit to branch improve-types
in repository https://gitbox.apache.org/repos/asf/echarts.git


The following commit(s) were added to refs/heads/improve-types by this push:
     new a7e1e7f  fix(type): optimize custom renderItem return type. expose renderItem type
a7e1e7f is described below

commit a7e1e7fcb12e803d61ede99127fd3d8ebda9d2d4
Author: pissang <bm...@gmail.com>
AuthorDate: Thu Sep 9 13:21:07 2021 +0800

    fix(type): optimize custom renderItem return type. expose renderItem type
---
 src/chart/custom/CustomSeries.ts | 8 ++++----
 src/export/option.ts             | 6 ++++--
 2 files changed, 8 insertions(+), 6 deletions(-)

diff --git a/src/chart/custom/CustomSeries.ts b/src/chart/custom/CustomSeries.ts
index 7167274..8fa8285 100644
--- a/src/chart/custom/CustomSeries.ts
+++ b/src/chart/custom/CustomSeries.ts
@@ -204,7 +204,7 @@ interface BuiltinShapes {
     circle: Partial<Circle['shape']>
     rect: Partial<Rect['shape']>
     sector: Partial<Sector['shape']>
-    poygon: Partial<Polygon['shape']>
+    polygon: Partial<Polygon['shape']>
     polyline: Partial<Polyline['shape']>
     line: Partial<Line['shape']>
     arc: Partial<Arc['shape']>
@@ -337,12 +337,12 @@ export interface CustomSeriesRenderItemParams {
     actionType?: string;
 }
 
-export type CustomSeriesRenderItemReturn = CustomRootElementOption;
+export type CustomSeriesRenderItemReturn = CustomRootElementOption | undefined | null;
 
-type CustomSeriesRenderItem = (
+export type CustomSeriesRenderItem = (
     params: CustomSeriesRenderItemParams,
     api: CustomSeriesRenderItemAPI
-) => CustomElementOption;
+) => CustomSeriesRenderItemReturn;
 
 export interface CustomSeriesOption extends
     SeriesOption<unknown>,    // don't support StateOption in custom series.
diff --git a/src/export/option.ts b/src/export/option.ts
index c3256c3..4980e43 100644
--- a/src/export/option.ts
+++ b/src/export/option.ts
@@ -90,7 +90,8 @@ import type {
     CustomSeriesOption as CustomSeriesOptionInner,
     CustomSeriesRenderItemAPI,
     CustomSeriesRenderItemParams,
-    CustomSeriesRenderItemReturn
+    CustomSeriesRenderItemReturn,
+    CustomSeriesRenderItem
 } from '../chart/custom/CustomSeries';
 
 import type { GraphicComponentLooseOption as GraphicComponentOption } from '../component/graphic/install';
@@ -273,5 +274,6 @@ export {
 
     CustomSeriesRenderItemParams,
     CustomSeriesRenderItemAPI,
-    CustomSeriesRenderItemReturn
+    CustomSeriesRenderItemReturn,
+    CustomSeriesRenderItem
 };

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