957485f632c7e57c23514a2bdded01b12ff1f0694a0b053e3328d999c7848ebdfd986127888a1af85975b89125d26db93f50389ffca7c1688d81a87f0c60b4 1.8 KB

1234567891011121314151617181920212223242526272829303132333435363738
  1. import SeriesDimensionDefine from '../SeriesDimensionDefine.js';
  2. import SeriesModel from '../../model/Series.js';
  3. import SeriesData, { DataCalculationInfo } from '../SeriesData.js';
  4. import type { SeriesOption, SeriesStackOptionMixin, DimensionName } from '../../util/types.js';
  5. import { SeriesDataSchema } from './SeriesDataSchema.js';
  6. import DataStore from '../DataStore.js';
  7. declare type EnableDataStackDimensionsInput = {
  8. schema: SeriesDataSchema;
  9. store?: DataStore;
  10. };
  11. declare type EnableDataStackDimensionsInputLegacy = (SeriesDimensionDefine | string)[];
  12. /**
  13. * Note that it is too complicated to support 3d stack by value
  14. * (have to create two-dimension inverted index), so in 3d case
  15. * we just support that stacked by index.
  16. *
  17. * @param seriesModel
  18. * @param dimensionsInput The same as the input of <module:echarts/data/SeriesData>.
  19. * The input will be modified.
  20. * @param opt
  21. * @param opt.stackedCoordDimension Specify a coord dimension if needed.
  22. * @param opt.byIndex=false
  23. * @return calculationInfo
  24. * {
  25. * stackedDimension: string
  26. * stackedByDimension: string
  27. * isStackedByIndex: boolean
  28. * stackedOverDimension: string
  29. * stackResultDimension: string
  30. * }
  31. */
  32. export declare function enableDataStack(seriesModel: SeriesModel<SeriesOption & SeriesStackOptionMixin>, dimensionsInput: EnableDataStackDimensionsInput | EnableDataStackDimensionsInputLegacy, opt?: {
  33. stackedCoordDimension?: string;
  34. byIndex?: boolean;
  35. }): Pick<DataCalculationInfo<unknown>, 'stackedDimension' | 'stackedByDimension' | 'isStackedByIndex' | 'stackedOverDimension' | 'stackResultDimension'>;
  36. export declare function isDimensionStacked(data: SeriesData, stackedDim: string): boolean;
  37. export declare function getStackedDimension(data: SeriesData, targetDim: string): DimensionName;
  38. export {};