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

package/lib/types/types.d.ts

@@ -1,6 +1,7 @@
 import type { IDisposable, Nullable } from '@univerjs/core';
 import type { Observable } from 'rxjs';
-import type { AreaLineStyle, AxisAlignEnum, AxisValueType, CategoryType, ChartBorderDashType, ChartSourceDataTypeEnum, ChartTrendlineType, ChartTypeBits, DataOrientation, InvalidValueType, IRuntimeAxisPosition, IRuntimeAxisPriority, LabelAlignEnum, LegendPositionEnum, LinePointShape, PieLabelPosition, RadarShape, RelationChartLayoutEnum, SelectModeEnum, SeriesLabelPosition, TitlePositionEnum, WaterfallSeriesTypeEnum, WaterfallStackTypeEnum, WordCloudShapeEnum } from './enum';
+import type { AreaLineStyle, AxisAlignEnum, AxisValueType, BarShape, CategoryType, ChartAxisDimension, ChartBorderDashType, ChartMarkLineLabelPosition, ChartSemanticAxis, ChartSourceDataTypeEnum, ChartTrendlineType, ChartTypeBits, ChartWaterfallPointRole, DataOrientation, InvalidValueType, IRuntimeAxisPosition, IRuntimeAxisPriority, LabelAlignEnum, LegendPositionEnum, LinePointShape, PieLabelPosition, RadarShape, RelationChartLayoutEnum, SelectModeEnum, SeriesLabelPosition, TitlePositionEnum, WaterfallSeriesTypeEnum, WaterfallStackTypeEnum, WordCloudShapeEnum } from './enum';
+import type { ICartesianPointData } from './models/chart-data-operators/cartesian-point-data';
 import type { IChartLocaleTexts } from './models/chart-locale-texts';
 import type { IEchartTheme } from './models/constants/build-in-theme';
 import type { BarSeriesOption } from './utils/echarts';
@@ -28,6 +29,17 @@ export type DimensionDefinitionLoose = IDimensionDefinition['name'] | IDimension
 export type OptionDataValue = string | number | Date | null | undefined;
 export type ChartDataSourceValue = OptionDataValue;
 export type ChartDataSourceValues = ChartDataSourceValue[][];
+/**
+ * Canonical chart dataset used by chart context operators and chart-data builders.
+ *
+ * Adapters must normalize their raw input before exposing this shape:
+ * - `dimensions[index]` is the optional header label for `source[index]`.
+ * - `source[index]` is one logical data vector, already oriented by the adapter.
+ * - `sourceType` and `sourceLabels`, when present, have the same vector shape as `source`.
+ *
+ * Category detection reads from `source` vectors only. `dimensions` must not be
+ * used as a fallback category vector.
+ */
 export interface IUniverDataSet {
     source: OptionDataValue[][];
     dimensions: Array<DimensionDefinitionLoose>;
@@ -49,15 +61,15 @@ export interface IChartContext {
         categoryIndex?: number;
         seriesIndexes?: number[];
     };
-    bubbleSizeSeriesId?: number;
-    bubbleXAxis?: number;
-    bubbleYAxis?: number;
-    bubbleLabel?: number;
-    bubbleSeries?: number;
+    scatterXIndex?: number;
+    scatterYIndex?: number;
+    scatterLabelIndex?: number;
+    bubbleSizeIndex?: number;
+    bubbleSeriesIndex?: number;
 }
 export interface IRelationNodes {
     id: string;
-    category: string;
+    category?: string;
     name: string;
     value: number;
     symbolSize?: number;
@@ -80,34 +92,7 @@ export interface IChartData {
      * the dataset of the chart, it should match echart dataset option
      */
     dataset?: IUniverDataSet;
-    bubble?: {
-        bubbleSizeData?: {
-            id: string;
-            name: string;
-            items: IChartDataItem[];
-        };
-        bubbleXData?: {
-            id: string;
-            name: string;
-            items: IChartDataItem[];
-        };
-        bubbleYData?: {
-            id: string;
-            name: string;
-            items: IChartDataItem[];
-        };
-        bubbleLabelData?: {
-            id: string;
-            name: string;
-            items: IChartDataItem[];
-        };
-        bubbleSeriesData?: {
-            id: string;
-            name: string;
-            items: IChartDataItem[];
-        };
-        isValidateBubbleSource?: boolean;
-    };
+    cartesianPoint?: ICartesianPointData;
     heatmapData?: {
         xData: string[];
         yData: string[];
@@ -167,6 +152,8 @@ export interface IChartRuntimeContext {
     axes: IRuntimeAxis[];
     themeInfo: IEchartTheme;
     wordCloudRenderConfig?: IWordCloudRenderConfig;
+    /** Runtime-only extra inset reserved by host adapters around chart content. */
+    layoutInset?: number;
     /**
      * The function to transform the color to the render color with considering the system theme is dark mode or not.
      * @param {string} color - The color to be rendered.
@@ -201,6 +188,8 @@ export interface ILegendStyle {
     position?: LegendPositionEnum;
     label?: Omit<ILabelStyle, 'visible' | 'align' | 'content'>;
     selectMode?: SelectModeEnum;
+    /** Allow a horizontal legend to flow onto multiple rows instead of using pagination. */
+    wrap?: boolean;
 }
 export interface IGridLineStyle {
     visible: boolean;
@@ -272,7 +261,7 @@ export interface ISeriesStyle {
     };
 }
 export type RightYAxisOptions = Omit<IAxisOptions, 'reverse'>;
-export interface IAllSeriesStyle extends Pick<ISeriesStyle, 'border' | 'label' | 'rightYAxis' | 'point' | 'color' | 'waterfall'> {
+export interface IAllSeriesStyle extends Pick<ISeriesStyle, 'border' | 'label' | 'rightYAxis' | 'point' | 'color' | 'fillOpacity' | 'waterfall'> {
 }
 export interface ITrendLine {
     seriesIndex: number;
@@ -289,6 +278,51 @@ export interface ITrendLine {
     r2Color?: string;
     formulaColor?: string;
 }
+export interface IWaterfallPointRole {
+    seriesIndex: number;
+    dataPointIndex: number;
+    role: ChartWaterfallPointRole;
+}
+export interface IWaterfallConnectorStyle {
+    color?: string;
+    width?: number;
+    opacity?: number;
+    dashType?: ChartBorderDashType;
+}
+export interface IChartAxisBinding {
+    dimension: ChartAxisDimension;
+    position: IRuntimeAxisPosition;
+}
+export interface IChartMarkLineLabel {
+    visible?: boolean;
+    text?: string;
+    position?: ChartMarkLineLabelPosition;
+    color?: string;
+    fontSize?: number;
+    bold?: boolean;
+}
+export type IChartMarkLine = {
+    label?: IChartMarkLineLabel;
+    color?: string;
+    width?: number;
+    opacity?: number;
+    dashType?: ChartBorderDashType;
+} & ({
+    axis: ChartSemanticAxis.Category | ChartSemanticAxis.SecondaryCategory;
+    categoryIndex: number;
+} | {
+    axis: ChartSemanticAxis.PrimaryValue | ChartSemanticAxis.SecondaryValue;
+    value: number;
+});
+export interface IBarStyle {
+    /** Exchange metadata. Renderers without 3D support may ignore these fields. */
+    is3D: boolean;
+    shape: BarShape;
+    /** OOXML view rotation around the horizontal axis, in degrees. */
+    rotX: number;
+    /** OOXML view rotation around the vertical axis, in degrees. */
+    rotY: number;
+}
 export interface IChartStyle {
     runtime: IChartRuntimeContext;
     /** Runtime-only locale direction. It must not be persisted in chart snapshots. */
@@ -296,13 +330,17 @@ export interface IChartStyle {
     width: number;
     height: number;
     theme: string;
+    /** Persisted absolute series colors. A non-empty value overrides theme colors. */
+    palette?: string[];
     invalidValueType: InvalidValueType;
     gradientFill: boolean;
     backgroundColor: Nullable<string>;
     titleFontSize: number;
     fontSize: number;
     fontColor: string;
+    fontFamily: string;
     borderColor: Nullable<string>;
+    borderWidth: number;
     titles: {
         title: Omit<ILabelStyle, 'visible'>;
         subtitle: Omit<ILabelStyle, 'visible'>;
@@ -323,12 +361,17 @@ export interface IChartStyle {
     seriesStyleMap: {
         [id: string]: ISeriesStyle;
     };
+    bar: IBarStyle;
     trendlines: ITrendLine[];
     pie: {
         doughnutHole: Nullable<number>;
+        /** Slice offset as a ratio of the pie radius. */
+        explosion?: number;
         labelStyle: IPieLabelStyle;
         borderColor: string;
         hasPaddingAngle: boolean;
+        /** Exchange metadata. Renderers without 3D support may ignore this field. */
+        is3D: boolean;
         isHalfPie: boolean;
         rosePie: boolean;
         showLabelLine: boolean;
@@ -365,7 +408,10 @@ export interface IChartStyle {
     waterfall: {
         stackType: WaterfallStackTypeEnum;
         useSubtotal: boolean;
+        pointRoles: IWaterfallPointRole[];
+        connector: boolean | IWaterfallConnectorStyle;
     };
+    markLines: IChartMarkLine[];
     tooltip: {
         indicatorLabelColor: string;
         indicatorLineType: ChartBorderDashType;
@@ -375,11 +421,14 @@ export interface IChartStyle {
     pareto: {
         lineStyle: ISeriesStyle;
         barStyle: ISeriesStyle;
+        includeZeroValues?: boolean;
     };
     heatmap: {
         visualMapType: 'continuous' | 'piecewise';
         max?: number;
         min?: number;
+        unit?: string;
+        label?: ISeriesLabelStyle;
     };
 }
 export interface IRelationForceOptions {
@@ -413,10 +462,19 @@ export interface IChartRenderSpecConverter<ChartRenderSpec = Record<string, any>
 }
 export type ChartConfigInterceptor = (config: IChartConfig) => IChartConfig;
 export type RenderSpecOperator<ChartRenderSpec> = (spec: ChartRenderSpec, style: ChartStyle, config: IChartConfig, instance: IChartInstance) => void;
-export type ChartHostRenderMode = 'image' | 'dom';
+export declare enum ChartHostRenderMode {
+    Image = "image",
+    Dom = "dom"
+}
+export interface IChartHostBorderStyle {
+    color?: string;
+    width?: number;
+}
 export interface IChartHostStyle {
     stroke?: string;
     fill?: string;
+    border?: IChartHostBorderStyle;
+    radius?: number;
     [key: string]: any;
 }
 export interface IChartHostLease extends IDisposable {
@@ -429,7 +487,7 @@ export interface IChartHost extends IDisposable {
     setStyle(style: IChartHostStyle): void;
 }
 export interface IImageChartHost extends IChartHost {
-    readonly mode: 'image';
+    readonly mode: ChartHostRenderMode.Image;
     nextVersion(): number;
     commitSnapshot(image: ChartImageSource, version: number): boolean;
     requestPaint(): void;
@@ -437,7 +495,7 @@ export interface IImageChartHost extends IChartHost {
     acquireOffscreenHost(rect: IChartHostRect): IChartHostLease;
 }
 export interface IDomChartHost extends IChartHost {
-    readonly mode: 'dom';
+    readonly mode: ChartHostRenderMode.Dom;
     ensureMount(): Promise<HTMLElement | null>;
     checkMounted(): boolean;
     syncLayout(): void;
@@ -449,11 +507,28 @@ export interface IChartRenderInput {
     config: IChartConfig;
     style: ChartStyle;
 }
+export interface IChartRenderModelImageExportInput extends IChartRenderInput {
+    width: number;
+    height: number;
+}
+export interface IChartRenderModelImageExportOptions {
+    pixelRatio?: number;
+    backgroundColor?: string | null;
+}
+export interface IChartRenderModelImageExportResult {
+    dataUrl: string;
+    width: number;
+    height: number;
+    pixelRatio: number;
+}
 export interface IChartRenderInstance extends IDisposable {
     readonly mode: ChartHostRenderMode;
     bind(host: IChartHost): void;
     render(input: IChartRenderInput): Promise<void>;
+    exportImg(): Promise<string | undefined>;
     resize(): void;
+    on(type: ChartElementEventType, handler: ChartElementEventHandler): IDisposable;
+    setElementEditMode(enabled: boolean): void;
 }
 export interface IChartRenderInstanceStyleInput<Spec = Record<string, any>> extends IChartRenderInput {
     mode: ChartHostRenderMode;
@@ -478,6 +553,7 @@ export interface IChartRenderModelStylizeInit<Spec> {
 export interface IChartRenderModel<Spec extends Record<string, any> = Record<string, any>> extends IDisposable {
     toSpec(chartConfig: IChartConfig, style: ChartStyle): Spec;
     stylizeSpec(spec: Spec, stylizeInit: IChartRenderModelStylizeInit<Spec>, rect: IChartHostRect): Spec;
+    exportImage(input: IChartRenderModelImageExportInput, options?: IChartRenderModelImageExportOptions): Promise<IChartRenderModelImageExportResult>;
     updateWatermark(addWatermark: boolean): void;
     createChartInstance(): IChartInstance<Spec>;
     createChartInstance(mode: ChartHostRenderMode, context?: IChartRenderInstanceCreateContext<Spec>): IChartRenderInstance;
@@ -515,13 +591,60 @@ export interface IChartRenderAsImageOptions {
 export interface IChartRenderRuntimeOptions {
     echartsProvider?: any;
     chartId?: string;
+    width?: number;
+    height?: number;
+}
+export type ChartElementKind = 'blank' | 'chartArea' | 'title' | 'subtitle' | 'xAxisTitle' | 'yAxisTitle' | 'rightYAxisTitle' | 'xAxisLabel' | 'yAxisLabel' | 'rightYAxisLabel' | 'xAxisLine' | 'yAxisLine' | 'rightYAxisLine' | 'gridLine' | 'tick' | 'legend' | 'legendItem' | 'mark' | 'series' | 'dataPoint' | 'dataLabel';
+export interface IChartElementBounds {
+    left: number;
+    top: number;
+    right: number;
+    bottom: number;
+}
+export interface IChartElementOverlay {
+    type: 'rect' | 'circle' | 'polyline' | 'polygon' | 'sector';
+    bounds: IChartElementBounds;
+    shape?: Record<string, any>;
+    padding?: number;
+    items?: IChartElementOverlay[];
+}
+export interface IChartElementHit {
+    kind: ChartElementKind;
+    bounds?: IChartElementBounds;
+    overlay?: IChartElementOverlay;
+    axisId?: 'xAxis' | 'yAxis' | 'rightYAxis';
+    axisIndex?: number;
+    axisPosition?: 'top' | 'right' | 'bottom' | 'left';
+    legendIndex?: number;
+    legendName?: string;
+    seriesIndex?: number;
+    seriesId?: string;
+    seriesName?: string;
+    dataIndex?: number;
+    baseSeriesIndex?: string;
+    waterfallSeriesType?: WaterfallSeriesTypeEnum;
+}
+export type ChartElementEventType = 'click' | 'dblclick' | 'pointerdown' | 'pointerup' | 'pointermove' | 'pointerenter' | 'pointerleave';
+export interface IChartElementEvent {
+    type: ChartElementEventType;
+    hit: IChartElementHit;
+    localPoint: {
+        x: number;
+        y: number;
+    };
+    button?: number;
+    nativeEvent?: Event;
+    preventDefault?(): void;
 }
+export type ChartElementEventHandler = (event: IChartElementEvent) => void;
 export interface IChartInstance<Spec = Record<string, any>> extends IDisposable {
     container: HTMLElement | string;
     mount(id: string | HTMLElement): void;
     render(spec: Spec, echartsProvider?: any): void;
     render(spec: Spec, options?: IChartRenderRuntimeOptions): void;
     renderAsImage(spec: Spec, options: IChartRenderAsImageOptions): Promise<ChartImageSource>;
+    on(type: ChartElementEventType, handler: ChartElementEventHandler): IDisposable;
+    setElementEditMode(enabled: boolean): void;
     exportImg(): Promise<string>;
     resize(): void;
 }

package/lib/types/util.d.ts

@@ -3,8 +3,9 @@ export declare const chartBitsUtils: {
     has(bit: number, attribute: number): boolean;
     baseOn(bit: number, base: number): boolean;
     remove(bit: number, attribute: number): number;
-    chartBitToString(bit: ChartTypeBits): "" | "line" | "wordCloud" | "bar" | "scatter" | "pie" | "radar" | "graph" | "funnel" | "sankey" | "boxplot" | "heatmap" | "combination";
+    chartBitToString(bit: ChartTypeBits): "" | "line" | "bar" | "wordCloud" | "scatter" | "pie" | "radar" | "graph" | "funnel" | "sankey" | "boxplot" | "heatmap" | "combination";
 };
+export declare function mergeChartConfig<T extends object>(current: T | undefined, update: Partial<T>): T;
 export declare const setProperty: (data: Record<string, any>, propertyPath: string, value: any) => void;
 export declare const getProperty: <T = any>(data: Record<string, any> | undefined, propertyPath: string) => T | undefined;
 /**
@@ -17,15 +18,12 @@ interface ISize {
     width: number;
     height: number;
 }
-export declare const ChartTextMeasureCache: Map<string, ISize>;
 export declare const calcPosition: (text: string, font: string) => ISize;
-export declare const clearChartTextMeasureCache: () => void;
 /**
  * We define the chart type can use trend line. In excel it also can use for combined chart ro bar chart.
  * @param {ChartTypeBits} chartType The test chart type.
  * @returns {boolean} If the chart type can use trend line, return true, otherwise return false.
  */
 export declare const chartTypeCanUseTrendLine: (chartType: ChartTypeBits) => boolean;
-export declare const numfmtRedCache: Map<string, boolean>;
 export declare function isNegativeRedCached(fmt: string): boolean | undefined;
 export {};

package/lib/types/utils/compact.d.ts

@@ -0,0 +1,4 @@
+/** Deep-clones a value while removing own properties whose value is undefined. */
+export declare function cloneWithoutUndefined<T>(value: T): T;
+/** Returns an undefined-free record, or undefined when no fields remain. */
+export declare function compactRecord<T extends object>(value: T): T | undefined;

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

@@ -1,7 +1,7 @@
-import type { echarts as EchartsType } from '../../../utils/echarts';
+import type { echarts } from '../../../utils/echarts';
 import { WORD_CLOUD_SERIES_TYPE } from './echarts-options';
 export interface IRegisterWordCloudChartViewContext {
     createTextElement(layout: any, data: any, dataIndex: number, seriesModel: any): unknown;
 }
-export declare function registerWordCloudChartView(echarts: typeof EchartsType, context: IRegisterWordCloudChartViewContext): void;
+export declare function registerWordCloudChartView(echartsInstance: typeof echarts, context: IRegisterWordCloudChartViewContext): void;
 export { WORD_CLOUD_SERIES_TYPE };

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

@@ -1,5 +1,5 @@
-import type { echarts as EchartsType } from '../../../utils/echarts';
+import type { echarts } from '../../../utils/echarts';
 import type { IWordCloudEChartsSeriesOption } from '../../types';
-export declare function registerWordCloudChart(echarts: typeof EchartsType): typeof EchartsType;
+export declare function registerWordCloudChart(echartsInstance: typeof echarts): typeof echarts;
 export declare function waitForWordCloudImageResourcesReady(spec: unknown, timeout?: number): Promise<void>;
 export type { IWordCloudEChartsSeriesOption };

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/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;