Merge pull request apache#14871 from dougalg/fix-14277

fix(types) Export cbs and their parameter types
ruanwenkai · May 18, 2021 · 7c4c93c · 7c4c93c
2 parents e112417 + 531c77f
commit 7c4c93c
Show file tree

Hide file tree

Showing 4 changed files with 43 additions and 9 deletions.
diff --git a/src/component/tooltip/TooltipModel.ts b/src/component/tooltip/TooltipModel.ts
@@ -30,7 +30,7 @@ import {
 import {AxisPointerOption} from '../axisPointer/AxisPointerModel';
 
 
-type TopLevelFormatterParams = CallbackDataParams | CallbackDataParams[];
+export type TopLevelFormatterParams = CallbackDataParams | CallbackDataParams[];
 
 export interface TooltipOption extends CommonTooltipOption<TopLevelFormatterParams>, ComponentOption {
     mainType?: 'tooltip'

diff --git a/src/export/all.ts b/src/export/all.ts
@@ -20,4 +20,4 @@
 // This file is for providing types when import whole module.
 
 export * from './core';
-export * from './option';
+export * from './option';
diff --git a/src/export/option.ts b/src/export/option.ts
@@ -34,7 +34,10 @@ import type {ParallelAxisOption as ParallelAxisComponentOption} from '../coord/p
 import type {ParallelCoordinateSystemOption as ParallelComponentOption} from '../coord/parallel/ParallelModel';
 import type {CalendarOption as CalendarComponentOption} from '../coord/calendar/CalendarModel';
 import type {ToolboxOption} from '../component/toolbox/ToolboxModel';
-import type {TooltipOption as TooltipComponentOption} from '../component/tooltip/TooltipModel';
+import type {
+    TooltipOption as TooltipComponentOption,
+    TopLevelFormatterParams
+} from '../component/tooltip/TooltipModel';
 import type {AxisPointerOption as AxisPointerComponentOption} from '../component/axisPointer/AxisPointerModel';
 import type {BrushOption as BrushComponentOption} from '../component/brush/BrushModel';
 import type {TitleOption as TitleComponentOption} from '../component/title/install';
@@ -97,7 +100,21 @@ import type {ToolboxSaveAsImageFeatureOption} from '../component/toolbox/feature
 import type {ToolboxFeatureOption} from '../component/toolbox/featureManager';
 
 
-import type { ECBasicOption, SeriesTooltipOption, AriaOption as AriaComponentOption } from '../util/types';
+import type {
+    ECBasicOption,
+    SeriesTooltipOption,
+    AriaOption as AriaComponentOption,
+    TooltipFormatterCallback,
+    LabelFormatterCallback,
+    CallbackDataParams,
+    AnimationDurationCallback,
+    AnimationDelayCallback,
+    AnimationDelayCallbackParam,
+    LabelLayoutOptionCallbackParams,
+    LabelLayoutOptionCallback,
+    TooltipPositionCallback,
+    TooltipPositionCallbackParams
+} from '../util/types';
 
 interface ToolboxComponentOption extends ToolboxOption {
     feature?: {
@@ -234,4 +251,18 @@ export interface EChartsOption extends ECBasicOption {
 
     options?: EChartsOption[];
     baseOption?: EChartsOption;
-}
+}
+
+export {
+    AnimationDurationCallback,
+    AnimationDelayCallback,
+    AnimationDelayCallbackParam as AnimationDelayCallbackParams,
+    LabelFormatterCallback,
+    CallbackDataParams as DefaultLabelFormatterCallbackParams,
+    LabelLayoutOptionCallbackParams,
+    LabelLayoutOptionCallback,
+    TooltipFormatterCallback as TooltipComponentFormatterCallback,
+    TopLevelFormatterParams as TooltipComponentFormatterCallbackParams,
+    TooltipPositionCallback as TooltipComponentPositionCallback,
+    TooltipPositionCallbackParams as TooltipComponentPositionCallbackParams
+};
diff --git a/src/util/types.ts b/src/util/types.ts
@@ -1214,7 +1214,7 @@ export interface LabelLayoutOption {
 export type LabelLayoutOptionCallback = (params: LabelLayoutOptionCallbackParams) => LabelLayoutOption;
 
 
-interface TooltipFormatterCallback<T> {
+export interface TooltipFormatterCallback<T> {
     /**
      * For sync callback
      * params will be an array on axis trigger.
@@ -1232,16 +1232,19 @@ type TooltipBuiltinPosition = 'inside' | 'top' | 'left' | 'right' | 'bottom';
 type TooltipBoxLayoutOption = Pick<
     BoxLayoutOptionMixin, 'top' | 'left' | 'right' | 'bottom'
 >;
+
+export type TooltipPositionCallbackParams = CallbackDataParams | CallbackDataParams[];
+
 /**
  * Position relative to the hoverred element. Only available when trigger is item.
  */
-interface PositionCallback {
+export interface TooltipPositionCallback {
     (
         point: [number, number],
         /**
          * params will be an array on axis trigger.
          */
-        params: CallbackDataParams | CallbackDataParams[],
+        params: TooltipPositionCallbackParams,
         /**
          * Will be HTMLDivElement when renderMode is html
          * Otherwise it's graphic.Text
@@ -1288,7 +1291,7 @@ export interface CommonTooltipOption<FormatterParams> {
      *
      * Support to be a callback
      */
-    position?: (number | string)[] | TooltipBuiltinPosition | PositionCallback | TooltipBoxLayoutOption
+    position?: (number | string)[] | TooltipBuiltinPosition | TooltipPositionCallback | TooltipBoxLayoutOption
 
     confine?: boolean