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

package/lib/types/wordcloud-chart/adapters/echarts/layout-register.d.ts

@@ -1,5 +1,5 @@
-import type { echarts as EchartsType } from '../../../utils/echarts';
+import type { echarts } from '../../../utils/echarts';
 import { WORD_CLOUD_SERIES_TYPE } from './echarts-options';
 export type PerformWordCloudSeriesLayout = (seriesModel: unknown, ecModel: unknown, api: unknown) => void;
-export declare function registerWordCloudLayout(echarts: typeof EchartsType, performSeriesLayout: PerformWordCloudSeriesLayout): void;
+export declare function registerWordCloudLayout(echartsInstance: typeof echarts, performSeriesLayout: PerformWordCloudSeriesLayout): void;
 export { WORD_CLOUD_SERIES_TYPE };

package/lib/types/wordcloud-chart/adapters/echarts/runtime-cache.d.ts

@@ -0,0 +1,29 @@
+import type { IWordCloudEncodedWord } from '../../types';
+import type { IEChartsWordCloudRenderLayout } from './layout';
+import type { IEChartsWordCloudDesignWordsBuildResult } from './words';
+export interface IWordCloudRuntimeContext {
+    chartId?: string;
+}
+export interface IWordCloudFinalLayoutCachePayload {
+    placed: IEChartsWordCloudRenderLayout[];
+}
+interface ICacheCounter {
+    hit: number;
+    miss: number;
+}
+export interface IWordCloudRuntimeCacheStats {
+    designWords: ICacheCounter;
+    layoutWords: ICacheCounter;
+    finalLayout: ICacheCounter;
+}
+export declare function withWordCloudRuntimeContext<T>(context: IWordCloudRuntimeContext, fn: () => T): T;
+export declare function getCurrentWordCloudRuntimeContext(): IWordCloudRuntimeContext | undefined;
+export declare function getOrCreateCachedWordCloudDesignWords(chartId: string | undefined, key: string, factory: () => IEChartsWordCloudDesignWordsBuildResult): IEChartsWordCloudDesignWordsBuildResult;
+export declare function getOrCreateCachedWordCloudLayoutWords(chartId: string | undefined, key: string, factory: () => IWordCloudEncodedWord[]): IWordCloudEncodedWord[];
+export declare function getCachedWordCloudFinalLayout(chartId: string | undefined, key: string): IWordCloudFinalLayoutCachePayload | undefined;
+export declare function setCachedWordCloudFinalLayout(chartId: string | undefined, key: string, value: IWordCloudFinalLayoutCachePayload): void;
+export declare function clearWordCloudRuntimeCache(chartId: string): void;
+export declare function clearAllWordCloudRuntimeCache(): void;
+export declare function getWordCloudRuntimeCacheStats(chartId?: string): IWordCloudRuntimeCacheStats;
+export declare function createStableWordCloudCacheKey(parts: readonly unknown[]): string;
+export {};

package/lib/types/wordcloud-chart/adapters/echarts/series-model.d.ts

@@ -1,7 +1,7 @@
-import type { echarts as EchartsType } from '../../../utils/echarts';
+import type { echarts } from '../../../utils/echarts';
 import { WORD_CLOUD_DEFAULT_OPTION, WORD_CLOUD_SERIES_TYPE } from './echarts-options';
 export interface IWordCloudEChartsHelper {
     createDimensions(data: any[], options: Record<string, unknown>): any;
 }
-export declare function registerWordCloudSeriesModel(echarts: typeof EchartsType, helper: IWordCloudEChartsHelper): void;
+export declare function registerWordCloudSeriesModel(echartsInstance: typeof echarts, helper: IWordCloudEChartsHelper): void;
 export { WORD_CLOUD_DEFAULT_OPTION, WORD_CLOUD_SERIES_TYPE };

package/lib/types/wordcloud-chart/core/collision/box-shape-engine.d.ts

@@ -1,5 +1,5 @@
 import type { IWordCloudEncodedWord } from '../../types';
-import type { IBoxFootprint, IWordCloudLayoutGrid } from '../layout/types';
+import type { IBoxFootprint, IWordCloudLayoutGrid } from '../types/layout';
 import type { ICollisionCandidate, ICollisionEngine, ICollisionEngineStats, ICollisionTextStyle } from './engine';
 export declare class BoxShapeEngine implements ICollisionEngine<IBoxFootprint> {
     private readonly _grid;

package/lib/types/wordcloud-chart/core/collision/engine.d.ts

@@ -1,5 +1,5 @@
 import type { IWordCloudBounds, IWordCloudClipMask, IWordCloudEncodedWord, IWordCloudTextMeasurer, IWordCloudTextSprite } from '../../types';
-import type { IWordCloudLayoutGrid } from '../layout/types';
+import type { IWordCloudLayoutGrid } from '../types/layout';
 export type WordCloudCollisionShape = 'box' | 'glyph';
 export type WordCloudRejectReason = 'collision' | 'shape';
 export interface ICollisionEngineStats {

package/lib/types/wordcloud-chart/core/collision/footprint.d.ts

@@ -1,5 +1,5 @@
 import type { IWordCloudBounds, IWordCloudMeasureResult } from '../../types';
-import type { IBoxFootprint, IWordCloudLayoutGrid } from './types';
+import type { IBoxFootprint, IWordCloudLayoutGrid } from '../types/layout';
 export interface IBoxTightTextBox {
     readonly width: number;
     readonly height: number;

package/lib/types/wordcloud-chart/core/collision/glyph-shape-engine.d.ts

@@ -1,5 +1,5 @@
 import type { IWordCloudBounds, IWordCloudClipMask, IWordCloudEncodedWord, IWordCloudTextMeasurer } from '../../types';
-import type { IWordCloudLayoutGrid } from '../layout/types';
+import type { IWordCloudLayoutGrid } from '../types/layout';
 import type { IPixelBitsetSprite } from './bitset-board';
 import type { ICollisionCandidate, ICollisionEngine, ICollisionFootprint, ICollisionTextStyle } from './engine';
 interface IPixelSpan {

package/lib/types/wordcloud-chart/core/collision/grid.d.ts

@@ -1,4 +1,4 @@
-import type { IBoxFootprint, IWordCloudLayoutGrid } from './types';
+import type { IBoxFootprint, IWordCloudLayoutGrid } from '../types/layout';
 export declare function createWordCloudGrid(width: number, height: number, cellSize: number): IWordCloudLayoutGrid;
 export declare function getCellCenter(grid: IWordCloudLayoutGrid, index: number): {
     row: number;

package/lib/types/wordcloud-chart/core/layout/candidates.d.ts

@@ -1,7 +1,7 @@
 import type { ICollisionCandidate } from '../collision/engine';
 import type { IWordCloudShapeProfile } from '../shape/shape-profile';
+import type { IPreparedWordCloudWord, IWordCloudLayoutConfig, IWordCloudLayoutGrid, IWordCloudLayoutRuntime } from '../types/layout';
 import type { IWordCloudPlacementContext } from './placement-types';
-import type { IPreparedWordCloudWord, IWordCloudLayoutConfig, IWordCloudLayoutGrid, IWordCloudLayoutRuntime } from './types';
 export interface IEnumerateCandidatePointsOptions {
     readonly grid: IWordCloudLayoutGrid;
     readonly shapeGrid: Uint8Array;

package/lib/types/wordcloud-chart/core/layout/layout-config.d.ts

@@ -1,3 +1,3 @@
 import type { IWordCloudLayoutOptions } from '../../types';
-import type { IWordCloudLayoutConfig } from './types';
+import type { IWordCloudLayoutConfig } from '../types/layout';
 export declare function resolveWordCloudLayoutConfig(options: IWordCloudLayoutOptions): IWordCloudLayoutConfig;

package/lib/types/wordcloud-chart/core/layout/layout.d.ts

@@ -1,4 +1,3 @@
 import type { IWordCloudEncodedWord, IWordCloudLayoutOptions, IWordCloudLayoutResult } from '../../types';
-import type { IWordCloudLayoutRuntime } from './types';
+import type { IWordCloudLayoutRuntime } from '../types/layout';
 export declare function layoutWordCloudGridWords(words: readonly IWordCloudEncodedWord[], options: IWordCloudLayoutOptions, runtime: IWordCloudLayoutRuntime): IWordCloudLayoutResult;
-export declare const layoutWordCloud: typeof layoutWordCloudGridWords;

package/lib/types/wordcloud-chart/core/layout/phases.d.ts

@@ -1,6 +1,6 @@
 import type { IWordCloudEncodedWord, IWordCloudPlacedWord } from '../../types';
-import type { IPreparedWordCloudWord, IWordCloudLayoutConfig, IWordCloudLayoutGrid, IWordCloudLayoutRuntime } from './types';
 import type { IWordCloudShapeProfile } from '../shape/shape-profile';
+import type { IPreparedWordCloudWord, IWordCloudLayoutConfig, IWordCloudLayoutGrid, IWordCloudLayoutRuntime } from '../types/layout';
 import { layoutWords } from './place-word';
 export interface IWordCloudLayoutPhasesResult {
     readonly prepared: IPreparedWordCloudWord[];

package/lib/types/wordcloud-chart/core/layout/place-word.d.ts

@@ -1,7 +1,7 @@
 import type { IWordCloudLayoutStats, IWordCloudPlacedWord } from '../../types';
+import type { IPreparedWordCloudWord, IWordCloudPlacement } from '../types/layout';
 import type { IWordCloudPlacementContext, IWordCloudTryPlaceResult } from './placement-types';
 import type { PlacementSearchPlan } from './search-plan';
-import type { IPreparedWordCloudWord, IWordCloudPlacement } from './types';
 export declare function tryPlaceWord(context: IWordCloudPlacementContext, word: IPreparedWordCloudWord, phase: 1 | 2, rank: number, searchPlan?: Extract<PlacementSearchPlan, {
     action: 'process';
 }>): IWordCloudTryPlaceResult;

package/lib/types/wordcloud-chart/core/layout/placement-stats.d.ts

@@ -1,6 +1,6 @@
 import type { IWordCloudLayoutStats, IWordCloudPlacedWord } from '../../types';
+import type { IPreparedWordCloudWord, IWordCloudLayoutConfig } from '../types/layout';
 import type { IWordCloudTryPlaceResult } from './placement-types';
-import type { IPreparedWordCloudWord, IWordCloudLayoutConfig } from './types';
 export declare function createPlacementStats(): IWordCloudLayoutStats;
 export declare function recordPlacementResult(stats: IWordCloudLayoutStats | undefined, result: IWordCloudTryPlaceResult): void;
 export declare function recordSkippedPlacementResult(stats: IWordCloudLayoutStats | undefined, count?: number): void;

package/lib/types/wordcloud-chart/core/layout/placement-types.d.ts

@@ -2,8 +2,8 @@ import type { IWordCloudLayoutStats } from '../../types';
 import type { ICollisionCandidate, ICollisionEngine } from '../collision/engine';
 import type { WordCloudFailureCache } from '../collision/failure-cache';
 import type { IWordCloudShapeProfile } from '../shape/shape-profile';
+import type { IWordCloudLayoutConfig, IWordCloudLayoutGrid, IWordCloudLayoutRuntime, IWordCloudPlacement } from '../types/layout';
 import type { PlacementWordManager } from './placement-word-manager';
-import type { IWordCloudLayoutConfig, IWordCloudLayoutGrid, IWordCloudLayoutRuntime, IWordCloudPlacement } from './types';
 export interface IWordCloudPlacementContext {
     readonly config: IWordCloudLayoutConfig;
     readonly runtime: IWordCloudLayoutRuntime;

package/lib/types/wordcloud-chart/core/layout/placement-word-manager.d.ts

@@ -1,6 +1,6 @@
 import type { IWordCloudEncodedWord } from '../../types';
 import type { ICollisionEngine, ICollisionFootprint } from '../collision/engine';
-import type { IPreparedWordCloudWord, IWordCloudLayoutConfig, IWordCloudLayoutRuntime } from './types';
+import type { IPreparedWordCloudWord, IWordCloudLayoutConfig, IWordCloudLayoutRuntime } from '../types/layout';
 export interface IResolvedPlacementWord {
     readonly word: IWordCloudEncodedWord;
     readonly footprint: ICollisionFootprint;

package/lib/types/wordcloud-chart/core/layout/runtime-mask.d.ts

@@ -1,6 +1,6 @@
 import type { IWordCloudBounds, IWordCloudEncodedWord } from '../../types';
 import type { ICollisionCandidate, ICollisionEngine, ICollisionFootprint } from '../collision/engine';
-import type { IWordCloudLayoutConfig, IWordCloudLayoutRuntime } from './types';
+import type { IWordCloudLayoutConfig, IWordCloudLayoutRuntime } from '../types/layout';
 export declare function isCandidateInsideLayout(collisionEngine: ICollisionEngine, footprint: ICollisionFootprint, candidate: ICollisionCandidate, config: IWordCloudLayoutConfig): boolean;
 export declare function runtimeMaskNeedsBounds(word: IWordCloudEncodedWord, runtime: IWordCloudLayoutRuntime, config: IWordCloudLayoutConfig): boolean;
 export declare function isCandidateInsideRuntimeMask(word: IWordCloudEncodedWord, bounds: IWordCloudBounds, runtime: IWordCloudLayoutRuntime, config: IWordCloudLayoutConfig): boolean;

package/lib/types/wordcloud-chart/core/layout/word-prepare.d.ts

@@ -1,3 +1,3 @@
 import type { IWordCloudEncodedWord } from '../../types';
-import type { IPreparedWordCloudWord, IWordCloudLayoutConfig } from './types';
+import type { IPreparedWordCloudWord, IWordCloudLayoutConfig } from '../types/layout';
 export declare function prepareWordCloudWords(words: readonly IWordCloudEncodedWord[], config: IWordCloudLayoutConfig): IPreparedWordCloudWord[];

package/lib/types/wordcloud-chart/core/shape/shape-mask.d.ts

@@ -1,5 +1,5 @@
 import type { IWordCloudLayoutOptions, IWordCloudMaskGrid, WordCloudShape } from '../../types';
-import type { IWordCloudLayoutGrid, IWordCloudLayoutRuntime } from './types';
+import type { IWordCloudLayoutGrid, IWordCloudLayoutRuntime } from '../types/layout';
 export interface IWordCloudShapeGridOptions {
     sampleSize?: number;
     insideRatio?: number;

package/lib/types/wordcloud-chart/index.d.ts

@@ -1,10 +1,11 @@
+export { WORD_CLOUD_DEFAULT_OPTION, WORD_CLOUD_SERIES_TYPE } from './adapters/echarts/echarts-options';
+export { registerWordCloudChart } from './adapters/echarts/install';
 export { layoutWordCloudChart, resolveLayoutOptions } from './canvas';
 export * from './core/layout/font-scale';
-export { createBuiltinMaskGrid, createMaskGridFromShape, createTextMaskGrid, normalizeMaskGrid, segmentMaskGrid } from './core/shape/built-in-shapes';
+export { createBuiltinMaskGrid, createMaskGridFromShape, createTextMaskGrid, normalizeMaskGrid, segmentMaskGrid, } from './core/shape/built-in-shapes';
 export { encodeWordCloudWords } from './core/text/formatter';
 export { normalizeWordCloudData } from './core/text/normalize';
 export { DEFAULT_WORD_CLOUD_CHART_SPEC, resolveWordCloudSpec } from './defaults';
-export { registerWordCloudChart, WORD_CLOUD_DEFAULT_OPTION, WORD_CLOUD_SERIES_TYPE } from './echarts';
 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';
 export { DEFAULT_WORD_CLOUD_SHAPE, normalizeWordCloudShape, SUPPORTED_WORD_CLOUD_SHAPES } from './types';
 export { DEFAULT_WORD_CLOUD_RENDER_CONFIG, resolveWordCloudRenderConfig, } from './word-cloud-render-config';

package/lib/types/wordcloud-chart/types.d.ts

@@ -31,6 +31,8 @@ export type IWordCloudEChartsMaskSource = {
 };
 export interface IWordCloudEChartsSeriesOption {
     type: 'wordCloud';
+    /** Selected weight-measure name carried from the compact chart-model series. */
+    name?: string;
     data?: IWordCloudEChartsSeriesDataItem[];
     left?: number | string;
     top?: number | string;