change to stackPercent boolean instead of stackStrategy percent

Author: sjcobb

src/component/tooltip/seriesFormatTooltip.ts

@@ -27,7 +27,7 @@ import {
     TooltipMarkupSection
 } from './tooltipMarkup';
 import { retrieveRawValue } from '../../data/helper/dataProvider';
-import { isNameSpecified, getStackStrategy } from '../../util/model';
+import { isNameSpecified } from '../../util/model';
 
 
 export function defaultSeriesFormatTooltip(opt: {
@@ -65,9 +65,9 @@ export function defaultSeriesFormatTooltip(opt: {
         const dimInfo = data.getDimensionInfo(tooltipDims[0]);
         sortParam = inlineValue = retrieveRawValue(data, dataIndex, tooltipDims[0]);
         inlineValueType = dimInfo.type;
-        const stackStrategy = getStackStrategy(series);
-        if (stackStrategy === 'percent') {
-            // Append the normalized value (as a percent of the total stack) when 'percent' stackStrategy is used.
+        const isPercentStackEnabled = data.getCalculationInfo('isPercentStackEnabled');
+        if (isPercentStackEnabled) {
+            // Append the normalized value (as a percent of the total stack) when stackPercent is true.
             const stackResultDim = data.getCalculationInfo('stackResultDimension');
             const stackedOverDim = data.getCalculationInfo('stackedOverDimension');
             const stackTop = data.get(stackResultDim, dataIndex) as number;

src/data/SeriesData.ts

@@ -135,6 +135,7 @@ export interface DataCalculationInfo<SERIES_MODEL> {
     stackedOverDimension: DimensionName;
     stackResultDimension: DimensionName;
     stackedOnSeries?: SERIES_MODEL;
+    isPercentStackEnabled?: boolean;
 }
 
 // -----------------------------

src/data/helper/dataStackHelper.ts

@@ -69,6 +69,7 @@ export function enableDataStack(
     | 'isStackedByIndex'
     | 'stackedOverDimension'
     | 'stackResultDimension'
+    | 'isPercentStackEnabled'
 > {
     opt = opt || {};
     let byIndex = opt.byIndex;
@@ -192,7 +193,8 @@ export function enableDataStack(
         stackedByDimension: stackedByDimInfo && stackedByDimInfo.name,
         isStackedByIndex: byIndex,
         stackedOverDimension: stackedOverDimension,
-        stackResultDimension: stackResultDimension
+        stackResultDimension: stackResultDimension,
+        isPercentStackEnabled: seriesModel.get('stackPercent'),
     };
 }
 

src/layout/barGrid.ts

@@ -487,14 +487,13 @@ export function createProgressiveLayout(seriesType: string): StageHandler {
             const isLarge = isInLargeMode(seriesModel);
             const barMinHeight = seriesModel.get('barMinHeight') || 0;
 
-            // Determine stacked dimensions and account for stackStrategy.
+            // Determine stacked dimensions.
             const stackResultDim = data.getCalculationInfo('stackResultDimension');
             const stackedDimIdx = stackResultDim && data.getDimensionIndex(stackResultDim);
             const stackedOverDim = data.getCalculationInfo('stackedOverDimension');
             const stackedOverDimIdx = stackedOverDim && data.getDimensionIndex(stackedOverDim);
-            const stackStrategy = seriesModel.get('stackStrategy');
-            const isPercentStack = stackStrategy === 'percent';
-            const stacked = isPercentStack
+            const isPercentStackEnabled = seriesModel.get('stackPercent');
+            const stacked = isPercentStackEnabled
             || (isDimensionStacked(data, valueDim) && !!data.getCalculationInfo('stackedOnSeries'));
 
             // Layout info.
@@ -524,13 +523,13 @@ export function createProgressiveLayout(seriesType: string): StageHandler {
                         // Because of the barMinHeight, we can not use the value in
                         // stackResultDimension directly.
                         if (stacked) {
-                            if (isPercentStack) {
-                                // For 'percent' stackStrategy, use the normalized bottom edge (stackedOverDimension)
+                            if (isPercentStackEnabled) {
+                                // When percentStack is true, use the normalized bottom edge (stackedOverDimension)
                                 // as the start value of the bar segment.
                                 stackStartValue = store.get(stackedOverDimIdx, dataIndex);
                             }
                             else {
-                                // For standard (non-percent) stackStrategy, subtract the original value from the
+                                // For standard (non-percent) stack, subtract the original value from the
                                 // stacked total to compute the bar segment's start value.
                                 stackStartValue = +value - (store.get(valueDimIdx, dataIndex) as number);
                             }

src/processor/dataStack.ts

@@ -66,8 +66,8 @@ export default function dataStack(ecModel: GlobalModel) {
     });
 
     stackInfoMap.each(function (stackInfoList) {
-        const isPercentStack = stackInfoList.some((info) => info.seriesModel.get('stackStrategy') === 'percent');
-        if (isPercentStack) {
+        const isPercentStackEnabled = stackInfoList.some((info) => info.seriesModel.get('stackPercent'));
+        if (isPercentStackEnabled) {
             calculatePercentStack(stackInfoList);
         }
         else {

src/util/model.ts

@@ -45,8 +45,7 @@ import {
     Payload,
     OptionId,
     OptionName,
-    InterpolatableValue,
-    SeriesStackOptionMixin
+    InterpolatableValue
 } from './types';
 import { Dictionary } from 'zrender/src/core/types';
 import SeriesModel from '../model/Series';
@@ -1094,8 +1093,4 @@ export function interpolateRawValues(
         }
         return interpolated;
     }
-}
-
-export function getStackStrategy(series: SeriesModel): SeriesStackOptionMixin['stackStrategy'] | undefined {
-    return (series.get as (path: string) => unknown)('stackStrategy') as SeriesStackOptionMixin['stackStrategy'];
-}
+}

src/util/types.ts

@@ -1678,7 +1678,8 @@ export interface SeriesLargeOptionMixin {
 }
 export interface SeriesStackOptionMixin {
     stack?: string
-    stackStrategy?: 'samesign' | 'all' | 'positive' | 'negative' | 'percent';
+    stackStrategy?: 'samesign' | 'all' | 'positive' | 'negative';
+    stackPercent?: boolean;
 }
 
 export type StackInfo = Pick<
@@ -1688,6 +1689,7 @@ export type StackInfo = Pick<
     | 'stackedByDimension'
     | 'stackResultDimension'
     | 'stackedOverDimension'
+    | 'isPercentStackEnabled'
 > & {
     data: SeriesData
     seriesModel: SeriesModel<SeriesOption & SeriesStackOptionMixin>