@univerjs-pro/engine-chart 1.0.0-alpha.2 → 1.0.0-alpha.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (87) hide show
  1. package/README.md +9 -3
  2. package/lib/cjs/index.js +1 -1
  3. package/lib/es/index.js +1 -1
  4. package/lib/index.js +1 -1
  5. package/lib/types/chart-model-api/chart-model-api.d.ts +2 -0
  6. package/lib/types/chart-model-api/chart-type-manifest.d.ts +128 -0
  7. package/lib/types/chart-model-api/chart-type-registry.d.ts +56 -0
  8. package/lib/types/chart-model-api/chart-type.d.ts +7 -0
  9. package/lib/types/chart-model-api/constants.d.ts +99 -0
  10. package/lib/types/chart-model-api/describe.d.ts +3 -0
  11. package/lib/types/chart-model-api/index.d.ts +8 -0
  12. package/lib/types/chart-model-api/patch-builder.d.ts +9 -0
  13. package/lib/types/chart-model-api/series-selector.d.ts +3 -0
  14. package/lib/types/chart-model-api/types.d.ts +452 -0
  15. package/lib/types/chart-model-api/utils.d.ts +10 -0
  16. package/lib/types/chart-model-api/validate.d.ts +5 -0
  17. package/lib/types/enum.d.ts +8 -0
  18. package/lib/types/f-base-chart.d.ts +25 -0
  19. package/lib/types/index.d.ts +118 -15
  20. package/lib/types/models/chart-data-operators/build-chart-data.d.ts +6 -1
  21. package/lib/types/models/chart-data-operators/cartesian-point-data.d.ts +43 -0
  22. package/lib/types/models/chart-data-operators/operators.d.ts +6 -6
  23. package/lib/types/models/chart-element-axis-id.d.ts +9 -0
  24. package/lib/types/models/chart-element-edit-overlay/chart-element-edit-overlay.d.ts +38 -0
  25. package/lib/types/models/chart-element-edit-overlay/index.d.ts +4 -0
  26. package/lib/types/models/chart-element-edit-overlay/palette.d.ts +2 -0
  27. package/lib/types/models/chart-element-edit-overlay/resolve-chart-element-hit-layout.d.ts +16 -0
  28. package/lib/types/models/chart-element-edit-overlay/types.d.ts +20 -0
  29. package/lib/types/models/chart-host-style.d.ts +35 -0
  30. package/lib/types/models/chart-model.d.ts +40 -31
  31. package/lib/types/models/chart-render-input-resolver.d.ts +13 -0
  32. package/lib/types/models/chart-render-model-manager.service.d.ts +26 -0
  33. package/lib/types/models/constants/build-in-theme/index.d.ts +12 -12
  34. package/lib/types/models/constants/build-in-theme/univer-gradient1.d.ts +1 -1
  35. package/lib/types/models/constants/build-in-theme/univer-gradient2.d.ts +1 -1
  36. package/lib/types/models/constants/build-in-theme/univer-gradient3.d.ts +1 -1
  37. package/lib/types/models/constants/build-in-theme/univer-gradient4.d.ts +1 -1
  38. package/lib/types/models/constants/build-in-theme/univer-gradient5.d.ts +1 -1
  39. package/lib/types/models/constants/build-in-theme/univer-gradient6.d.ts +1 -1
  40. package/lib/types/models/constants/build-in-theme/univer1.d.ts +1 -1
  41. package/lib/types/models/constants/build-in-theme/univer2.d.ts +1 -1
  42. package/lib/types/models/constants/build-in-theme/univer3.d.ts +1 -1
  43. package/lib/types/models/constants/build-in-theme/univer4.d.ts +1 -1
  44. package/lib/types/models/constants/build-in-theme/univer5.d.ts +1 -1
  45. package/lib/types/models/constants/build-in-theme/univer6.d.ts +1 -1
  46. package/lib/types/models/constants/default.d.ts +3 -1
  47. package/lib/types/models/echart-render-model.d.ts +37 -2
  48. package/lib/types/models/image-chart-host.d.ts +2 -1
  49. package/lib/types/models/mode-converter/mode-converter.d.ts +0 -2
  50. package/lib/types/models/mode-converter/render-spec-operators/legend-size.d.ts +2 -1
  51. package/lib/types/models/series-style/series-style-resolver.d.ts +9 -0
  52. package/lib/types/source/source-util.d.ts +1 -1
  53. package/lib/types/source/static-chart-source.d.ts +11 -3
  54. package/lib/types/types.d.ts +101 -37
  55. package/lib/types/util.d.ts +1 -1
  56. package/lib/types/wordcloud-chart/adapters/echarts/chart-view.d.ts +2 -2
  57. package/lib/types/wordcloud-chart/adapters/echarts/install.d.ts +2 -2
  58. package/lib/types/wordcloud-chart/adapters/echarts/layout-register.d.ts +2 -2
  59. package/lib/types/wordcloud-chart/adapters/echarts/series-model.d.ts +2 -2
  60. package/lib/types/wordcloud-chart/core/collision/box-shape-engine.d.ts +1 -1
  61. package/lib/types/wordcloud-chart/core/collision/engine.d.ts +1 -1
  62. package/lib/types/wordcloud-chart/core/collision/footprint.d.ts +1 -1
  63. package/lib/types/wordcloud-chart/core/collision/glyph-shape-engine.d.ts +1 -1
  64. package/lib/types/wordcloud-chart/core/collision/grid.d.ts +1 -1
  65. package/lib/types/wordcloud-chart/core/layout/candidates.d.ts +1 -1
  66. package/lib/types/wordcloud-chart/core/layout/layout-config.d.ts +1 -1
  67. package/lib/types/wordcloud-chart/core/layout/layout.d.ts +1 -2
  68. package/lib/types/wordcloud-chart/core/layout/phases.d.ts +1 -1
  69. package/lib/types/wordcloud-chart/core/layout/place-word.d.ts +1 -1
  70. package/lib/types/wordcloud-chart/core/layout/placement-stats.d.ts +1 -1
  71. package/lib/types/wordcloud-chart/core/layout/placement-types.d.ts +1 -1
  72. package/lib/types/wordcloud-chart/core/layout/placement-word-manager.d.ts +1 -1
  73. package/lib/types/wordcloud-chart/core/layout/runtime-mask.d.ts +1 -1
  74. package/lib/types/wordcloud-chart/core/layout/word-prepare.d.ts +1 -1
  75. package/lib/types/wordcloud-chart/core/shape/shape-mask.d.ts +1 -1
  76. package/lib/types/wordcloud-chart/index.d.ts +3 -2
  77. package/lib/types/wordcloud-chart/types.d.ts +2 -0
  78. package/lib/umd/index.js +1 -1
  79. package/package.json +5 -5
  80. package/lib/types/wordcloud-chart/core/collision/types.d.ts +0 -1
  81. package/lib/types/wordcloud-chart/core/layout/types.d.ts +0 -1
  82. package/lib/types/wordcloud-chart/core/shape/types.d.ts +0 -1
  83. package/lib/types/wordcloud-chart/core/text/types.d.ts +0 -1
  84. package/lib/types/wordcloud-chart/core/types/option.d.ts +0 -1
  85. package/lib/types/wordcloud-chart/core/types/shape.d.ts +0 -1
  86. package/lib/types/wordcloud-chart/core/types/word.d.ts +0 -1
  87. package/lib/types/wordcloud-chart/echarts.d.ts +0 -2
@@ -1,4 +1,3 @@
1
1
  import type { IWordCloudEncodedWord, IWordCloudLayoutOptions, IWordCloudLayoutResult } from '../../types';
2
- import type { IWordCloudLayoutRuntime } from './types';
2
+ import type { IWordCloudLayoutRuntime } from '../types/layout';
3
3
  export declare function layoutWordCloudGridWords(words: readonly IWordCloudEncodedWord[], options: IWordCloudLayoutOptions, runtime: IWordCloudLayoutRuntime): IWordCloudLayoutResult;
4
- export declare const layoutWordCloud: typeof layoutWordCloudGridWords;
@@ -1,6 +1,6 @@
1
1
  import type { IWordCloudEncodedWord, IWordCloudPlacedWord } from '../../types';
2
- import type { IPreparedWordCloudWord, IWordCloudLayoutConfig, IWordCloudLayoutGrid, IWordCloudLayoutRuntime } from './types';
3
2
  import type { IWordCloudShapeProfile } from '../shape/shape-profile';
3
+ import type { IPreparedWordCloudWord, IWordCloudLayoutConfig, IWordCloudLayoutGrid, IWordCloudLayoutRuntime } from '../types/layout';
4
4
  import { layoutWords } from './place-word';
5
5
  export interface IWordCloudLayoutPhasesResult {
6
6
  readonly prepared: IPreparedWordCloudWord[];
@@ -1,7 +1,7 @@
1
1
  import type { IWordCloudLayoutStats, IWordCloudPlacedWord } from '../../types';
2
+ import type { IPreparedWordCloudWord, IWordCloudPlacement } from '../types/layout';
2
3
  import type { IWordCloudPlacementContext, IWordCloudTryPlaceResult } from './placement-types';
3
4
  import type { PlacementSearchPlan } from './search-plan';
4
- import type { IPreparedWordCloudWord, IWordCloudPlacement } from './types';
5
5
  export declare function tryPlaceWord(context: IWordCloudPlacementContext, word: IPreparedWordCloudWord, phase: 1 | 2, rank: number, searchPlan?: Extract<PlacementSearchPlan, {
6
6
  action: 'process';
7
7
  }>): IWordCloudTryPlaceResult;
@@ -1,6 +1,6 @@
1
1
  import type { IWordCloudLayoutStats, IWordCloudPlacedWord } from '../../types';
2
+ import type { IPreparedWordCloudWord, IWordCloudLayoutConfig } from '../types/layout';
2
3
  import type { IWordCloudTryPlaceResult } from './placement-types';
3
- import type { IPreparedWordCloudWord, IWordCloudLayoutConfig } from './types';
4
4
  export declare function createPlacementStats(): IWordCloudLayoutStats;
5
5
  export declare function recordPlacementResult(stats: IWordCloudLayoutStats | undefined, result: IWordCloudTryPlaceResult): void;
6
6
  export declare function recordSkippedPlacementResult(stats: IWordCloudLayoutStats | undefined, count?: number): void;
@@ -2,8 +2,8 @@ import type { IWordCloudLayoutStats } from '../../types';
2
2
  import type { ICollisionCandidate, ICollisionEngine } from '../collision/engine';
3
3
  import type { WordCloudFailureCache } from '../collision/failure-cache';
4
4
  import type { IWordCloudShapeProfile } from '../shape/shape-profile';
5
+ import type { IWordCloudLayoutConfig, IWordCloudLayoutGrid, IWordCloudLayoutRuntime, IWordCloudPlacement } from '../types/layout';
5
6
  import type { PlacementWordManager } from './placement-word-manager';
6
- import type { IWordCloudLayoutConfig, IWordCloudLayoutGrid, IWordCloudLayoutRuntime, IWordCloudPlacement } from './types';
7
7
  export interface IWordCloudPlacementContext {
8
8
  readonly config: IWordCloudLayoutConfig;
9
9
  readonly runtime: IWordCloudLayoutRuntime;
@@ -1,6 +1,6 @@
1
1
  import type { IWordCloudEncodedWord } from '../../types';
2
2
  import type { ICollisionEngine, ICollisionFootprint } from '../collision/engine';
3
- import type { IPreparedWordCloudWord, IWordCloudLayoutConfig, IWordCloudLayoutRuntime } from './types';
3
+ import type { IPreparedWordCloudWord, IWordCloudLayoutConfig, IWordCloudLayoutRuntime } from '../types/layout';
4
4
  export interface IResolvedPlacementWord {
5
5
  readonly word: IWordCloudEncodedWord;
6
6
  readonly footprint: ICollisionFootprint;
@@ -1,6 +1,6 @@
1
1
  import type { IWordCloudBounds, IWordCloudEncodedWord } from '../../types';
2
2
  import type { ICollisionCandidate, ICollisionEngine, ICollisionFootprint } from '../collision/engine';
3
- import type { IWordCloudLayoutConfig, IWordCloudLayoutRuntime } from './types';
3
+ import type { IWordCloudLayoutConfig, IWordCloudLayoutRuntime } from '../types/layout';
4
4
  export declare function isCandidateInsideLayout(collisionEngine: ICollisionEngine, footprint: ICollisionFootprint, candidate: ICollisionCandidate, config: IWordCloudLayoutConfig): boolean;
5
5
  export declare function runtimeMaskNeedsBounds(word: IWordCloudEncodedWord, runtime: IWordCloudLayoutRuntime, config: IWordCloudLayoutConfig): boolean;
6
6
  export declare function isCandidateInsideRuntimeMask(word: IWordCloudEncodedWord, bounds: IWordCloudBounds, runtime: IWordCloudLayoutRuntime, config: IWordCloudLayoutConfig): boolean;
@@ -1,3 +1,3 @@
1
1
  import type { IWordCloudEncodedWord } from '../../types';
2
- import type { IPreparedWordCloudWord, IWordCloudLayoutConfig } from './types';
2
+ import type { IPreparedWordCloudWord, IWordCloudLayoutConfig } from '../types/layout';
3
3
  export declare function prepareWordCloudWords(words: readonly IWordCloudEncodedWord[], config: IWordCloudLayoutConfig): IPreparedWordCloudWord[];
@@ -1,5 +1,5 @@
1
1
  import type { IWordCloudLayoutOptions, IWordCloudMaskGrid, WordCloudShape } from '../../types';
2
- import type { IWordCloudLayoutGrid, IWordCloudLayoutRuntime } from './types';
2
+ import type { IWordCloudLayoutGrid, IWordCloudLayoutRuntime } from '../types/layout';
3
3
  export interface IWordCloudShapeGridOptions {
4
4
  sampleSize?: number;
5
5
  insideRatio?: number;
@@ -1,10 +1,11 @@
1
+ export { WORD_CLOUD_DEFAULT_OPTION, WORD_CLOUD_SERIES_TYPE } from './adapters/echarts/echarts-options';
2
+ export { registerWordCloudChart } from './adapters/echarts/install';
1
3
  export { layoutWordCloudChart, resolveLayoutOptions } from './canvas';
2
4
  export * from './core/layout/font-scale';
3
- export { createBuiltinMaskGrid, createMaskGridFromShape, createTextMaskGrid, normalizeMaskGrid, segmentMaskGrid } from './core/shape/built-in-shapes';
5
+ export { createBuiltinMaskGrid, createMaskGridFromShape, createTextMaskGrid, normalizeMaskGrid, segmentMaskGrid, } from './core/shape/built-in-shapes';
4
6
  export { encodeWordCloudWords } from './core/text/formatter';
5
7
  export { normalizeWordCloudData } from './core/text/normalize';
6
8
  export { DEFAULT_WORD_CLOUD_CHART_SPEC, resolveWordCloudSpec } from './defaults';
7
- export { registerWordCloudChart, WORD_CLOUD_DEFAULT_OPTION, WORD_CLOUD_SERIES_TYPE } from './echarts';
8
9
  export type { INormalizedWordCloudDatum, IResolvedWordCloudSpec, IWordCloudBounds, IWordCloudChartSpec, IWordCloudDataSource, IWordCloudEChartsMaskSource, IWordCloudEChartsSeriesDataItem, IWordCloudEChartsSeriesOption, IWordCloudEncodedWord, IWordCloudEncoding, IWordCloudFieldMapping, IWordCloudLayoutMask, IWordCloudLayoutOptions, IWordCloudLayoutResult, IWordCloudMaskGrid, IWordCloudMaskShapeSpec, IWordCloudPlacedWord, IWordCloudProtocolSpec, IWordCloudSegmentationRegion, IWordCloudSegmentationResult, IWordCloudSeriesDataItem, IWordCloudSeriesOption, IWordCloudSpecBase, IWordCloudTextMarkAttrs, IWordCloudTextMarkSpec, IWordCloudTextMeasurer, IWordCloudTextSprite, WordCloudFontSizeRange, WordCloudShape, } from './types';
9
10
  export { DEFAULT_WORD_CLOUD_SHAPE, normalizeWordCloudShape, SUPPORTED_WORD_CLOUD_SHAPES } from './types';
10
11
  export { DEFAULT_WORD_CLOUD_RENDER_CONFIG, resolveWordCloudRenderConfig, } from './word-cloud-render-config';
@@ -31,6 +31,8 @@ export type IWordCloudEChartsMaskSource = {
31
31
  };
32
32
  export interface IWordCloudEChartsSeriesOption {
33
33
  type: 'wordCloud';
34
+ /** Selected weight-measure name carried from the compact chart-model series. */
35
+ name?: string;
34
36
  data?: IWordCloudEChartsSeriesDataItem[];
35
37
  left?: number | string;
36
38
  top?: number | string;