fix(MarkerLine): add missing value type string | number to `symbolO…

…ffset` and add missing return type `string | number` to `SymbolOffsetCallback`.
damianof · Apr 21, 2021 · ad05359 · ad05359
1 parent 03fd554
commit ad05359
Show file tree

Hide file tree

Showing 4 changed files with 25 additions and 8 deletions.
diff --git a/src/chart/helper/Line.ts b/src/chart/helper/Line.ts
@@ -81,7 +81,7 @@ function createSymbol(name: 'fromSymbol' | 'toSymbol', lineData: LineList, idx:
         ? symbolOffset : [symbolOffset, symbolOffset];
 
     symbolOffsetArr[0] = parsePercent(symbolOffsetArr[0], symbolSizeArr[0]);
-    symbolOffsetArr[1] = parsePercent(retrieve2(symbolOffsetArr[1], symbolOffsetArr[0]),symbolSizeArr[1]);
+    symbolOffsetArr[1] = parsePercent(retrieve2(symbolOffsetArr[1], symbolOffsetArr[0]), symbolSizeArr[1]);
 
     const symbolPath = symbolUtil.createSymbol(
         symbolType,

diff --git a/src/component/marker/MarkLineView.ts b/src/component/marker/MarkLineView.ts
@@ -318,10 +318,15 @@ class MarkLineView extends MarkerView {
         // Line data for tooltip and formatter
         mlModel.setData(lineData);
 
+        // TODO
+        // Functionally, `symbolSize` & `symbolOffset` can also be 2D array now.
+        // But the related logic and type definition are not finished yet.
+        // Finish it if required
         let symbolType = mlModel.get('symbol');
         let symbolSize = mlModel.get('symbolSize');
         let symbolRotate = mlModel.get('symbolRotate');
         let symbolOffset = mlModel.get('symbolOffset');
+        // TODO: support callback function like markPoint
         if (!isArray(symbolType)) {
             symbolType = [symbolType, symbolType];
         }
@@ -401,10 +406,22 @@ class MarkLineView extends MarkerView {
             data.setItemVisual(idx, {
                 symbolKeepAspect: itemModel.get('symbolKeepAspect'),
                 // `0` should be considered as a valid value, so use `retrieve2` instead of `||`
-                symbolOffset: retrieve2(itemModel.get('symbolOffset'), (symbolOffset as (string | number)[])[isFrom ? 0 : 1]),
-                symbolRotate: retrieve2(itemModel.get('symbolRotate', true), (symbolRotate as number[])[isFrom ? 0 : 1]),
-                symbolSize: retrieve2(itemModel.get('symbolSize'), (symbolSize as number[])[isFrom ? 0 : 1]),
-                symbol: retrieve2(itemModel.get('symbol', true), (symbolType as string[])[isFrom ? 0 : 1]),
+                symbolOffset: retrieve2(
+                    itemModel.get('symbolOffset', true),
+                    (symbolOffset as (string | number)[])[isFrom ? 0 : 1]
+                ),
+                symbolRotate: retrieve2(
+                    itemModel.get('symbolRotate', true),
+                    (symbolRotate as number[])[isFrom ? 0 : 1]
+                ),
+                symbolSize: retrieve2(
+                    itemModel.get('symbolSize', true),
+                    (symbolSize as number[])[isFrom ? 0 : 1]
+                ),
+                symbol: retrieve2(
+                    itemModel.get('symbol', true),
+                    (symbolType as string[])[isFrom ? 0 : 1]
+                ),
                 style
             });
         }

diff --git a/src/util/types.ts b/src/util/types.ts
@@ -922,7 +922,7 @@ export interface RoamOptionMixin {
 export type SymbolSizeCallback<T> = (rawValue: any, params: T) => number | number[];
 export type SymbolCallback<T> = (rawValue: any, params: T) => string;
 export type SymbolRotateCallback<T> = (rawValue: any, params: T) => number;
-export type SymbolOffsetCallback<T> = (rawValue: any, params: T) => (string | number)[];
+export type SymbolOffsetCallback<T> = (rawValue: any, params: T) => string | number | (string | number)[];
 /**
  * Mixin of option set to control the element symbol.
  * Include type of symbol, and size of symbol.
@@ -941,7 +941,7 @@ export interface SymbolOptionMixin<T = unknown> {
 
     symbolKeepAspect?: boolean
 
-    symbolOffset?: (string | number)[] | (unknown extends T ? never : SymbolOffsetCallback<T>)
+    symbolOffset?: string | number | (string | number)[] | (unknown extends T ? never : SymbolOffsetCallback<T>)
 }
 
 /**

diff --git a/src/visual/symbol.ts b/src/visual/symbol.ts
@@ -83,7 +83,7 @@ const seriesSymbolTask: StageHandler = {
             symbolSize: seriesSymbolSize as number | number[],
             symbolKeepAspect: keepAspect,
             symbolRotate: seriesSymbolRotate as number,
-            symbolOffset: seriesSymbolOffset as (string | number)[]
+            symbolOffset: seriesSymbolOffset as string | number | (string | number)[]
         });
 
         // Only visible series has each data be visual encoded