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

package/lib/types/models/chart-render-input-resolver.d.ts

@@ -0,0 +1,13 @@
+import type { ChartStyle, IChartRenderModelImageExportInput } from '../types';
+import type { ChartModel } from './chart-model';
+export interface IChartRenderInputRuntime {
+    chartId: string;
+    model: ChartModel;
+}
+export interface IResolveChartRenderModelImageExportInputParams {
+    runtime: IChartRenderInputRuntime;
+    direction: ChartStyle['direction'];
+    width: number;
+    height: number;
+}
+export declare function resolveChartRenderModelImageExportInput(params: IResolveChartRenderModelImageExportInputParams): IChartRenderModelImageExportInput | null;

package/lib/types/models/chart-render-model-manager.service.d.ts

@@ -0,0 +1,26 @@
+import type { IDisposable, Injector } from '@univerjs/core';
+import type { ChartHostRenderMode, IChartInstance, IChartRenderInstance, IChartRenderInstanceCreateContext, IChartRenderModel, IChartRenderModelImageExportInput, IChartRenderModelImageExportOptions, IChartRenderModelImageExportResult } from '../types';
+import { Disposable } from '@univerjs/core';
+export interface IChartRenderModelManagerService extends IDisposable {
+    registerRenderModel(name: string, renderModel: IChartRenderModel): void;
+    setRenderModel(name: string): void;
+    getRenderModel(name?: string): IChartRenderModel | undefined;
+    getCurrentRenderModel(): IChartRenderModel;
+    createChartInstance(): IChartInstance;
+    createChartInstance(mode: ChartHostRenderMode, context?: IChartRenderInstanceCreateContext): IChartRenderInstance;
+    exportImage(input: IChartRenderModelImageExportInput, options?: IChartRenderModelImageExportOptions): Promise<IChartRenderModelImageExportResult>;
+}
+export declare const IChartRenderModelManagerService: import("@wendellhu/redi").IdentifierDecorator<IChartRenderModelManagerService>;
+export declare class ChartRenderModelManagerService extends Disposable implements IChartRenderModelManagerService {
+    private readonly _renderModelMap;
+    private _currentRenderModel;
+    registerRenderModel(name: string, renderModel: IChartRenderModel): void;
+    setRenderModel(name: string): void;
+    getRenderModel(name?: string): IChartRenderModel | undefined;
+    getCurrentRenderModel(): IChartRenderModel;
+    createChartInstance(): IChartInstance;
+    createChartInstance(mode: ChartHostRenderMode, context?: IChartRenderInstanceCreateContext): IChartRenderInstance;
+    exportImage(input: IChartRenderModelImageExportInput, options?: IChartRenderModelImageExportOptions): Promise<IChartRenderModelImageExportResult>;
+    dispose(): void;
+}
+export declare function registerChartRenderModelManagerService(injector: Injector, defaultRenderModel?: IChartRenderModel): IChartRenderModelManagerService;

package/lib/types/models/chart-resource-serializer.d.ts

@@ -0,0 +1,10 @@
+import type { ChartStyle } from '../types';
+interface IChartResourceSnapshot {
+    style?: ChartStyle;
+}
+interface IChartResourceEnvelope<TChart extends IChartResourceSnapshot> {
+    charts: Record<string, TChart>;
+}
+/** Serializes a host chart resource while omitting non-canonical empty chart palettes. */
+export declare function serializeChartResource<TChart extends IChartResourceSnapshot, TResource extends IChartResourceEnvelope<TChart>>(resource: TResource): string;
+export {};

package/lib/types/models/chart-semantic-axes.d.ts

@@ -0,0 +1,4 @@
+import type { IChartAxisBinding, IRuntimeAxis } from '../types';
+import { ChartSemanticAxis, ChartTypeBits } from '../enum';
+/** Maps the renderer's transient axes to stable semantic roles used by Facade readback. */
+export declare function resolveChartSemanticAxisBindings(type: ChartTypeBits, axes: readonly IRuntimeAxis[]): Partial<Record<ChartSemanticAxis, IChartAxisBinding>> | undefined;

package/lib/types/models/constants/build-in-theme/index.d.ts

@@ -1,15 +1,15 @@
 export { themeDefault } from './default';
 export { getThemeAxesByType, getThemeProps } from './theme-util';
 export type { IEchartTheme } from './types';
-export { univer1 as UniverTheme1 } from './univer1';
-export { univer2 as UniverTheme2 } from './univer2';
-export { univer3 as UniverTheme3 } from './univer3';
-export { univer4 as UniverTheme4 } from './univer4';
-export { univer5 as UniverTheme5 } from './univer5';
-export { univer6 as UniverTheme6 } from './univer6';
-export { univerGradient1 as UniverThemeGradient1 } from './univer-gradient1';
-export { univerGradient2 as UniverThemeGradient2 } from './univer-gradient2';
-export { univerGradient3 as UniverThemeGradient3 } from './univer-gradient3';
-export { univerGradient4 as UniverThemeGradient4 } from './univer-gradient4';
-export { univerGradient5 as UniverThemeGradient5 } from './univer-gradient5';
-export { univerGradient6 as UniverThemeGradient6 } from './univer-gradient6';
+export { UniverTheme1 } from './univer1';
+export { UniverTheme2 } from './univer2';
+export { UniverTheme3 } from './univer3';
+export { UniverTheme4 } from './univer4';
+export { UniverTheme5 } from './univer5';
+export { UniverTheme6 } from './univer6';
+export { UniverThemeGradient1 } from './univer-gradient1';
+export { UniverThemeGradient2 } from './univer-gradient2';
+export { UniverThemeGradient3 } from './univer-gradient3';
+export { UniverThemeGradient4 } from './univer-gradient4';
+export { UniverThemeGradient5 } from './univer-gradient5';
+export { UniverThemeGradient6 } from './univer-gradient6';

package/lib/types/models/constants/build-in-theme/univer-gradient1.d.ts

@@ -1,2 +1,2 @@
 import type { IEchartTheme } from './types';
-export declare const univerGradient1: IEchartTheme;
+export declare const UniverThemeGradient1: IEchartTheme;

package/lib/types/models/constants/build-in-theme/univer-gradient2.d.ts

@@ -1,2 +1,2 @@
 import type { IEchartTheme } from './types';
-export declare const univerGradient2: IEchartTheme;
+export declare const UniverThemeGradient2: IEchartTheme;

package/lib/types/models/constants/build-in-theme/univer-gradient3.d.ts

@@ -1,2 +1,2 @@
 import type { IEchartTheme } from './types';
-export declare const univerGradient3: IEchartTheme;
+export declare const UniverThemeGradient3: IEchartTheme;

package/lib/types/models/constants/build-in-theme/univer-gradient4.d.ts

@@ -1,2 +1,2 @@
 import type { IEchartTheme } from './types';
-export declare const univerGradient4: IEchartTheme;
+export declare const UniverThemeGradient4: IEchartTheme;

package/lib/types/models/constants/build-in-theme/univer-gradient5.d.ts

@@ -1,2 +1,2 @@
 import type { IEchartTheme } from './types';
-export declare const univerGradient5: IEchartTheme;
+export declare const UniverThemeGradient5: IEchartTheme;

package/lib/types/models/constants/build-in-theme/univer-gradient6.d.ts

@@ -1,2 +1,2 @@
 import type { IEchartTheme } from './types';
-export declare const univerGradient6: IEchartTheme;
+export declare const UniverThemeGradient6: IEchartTheme;

package/lib/types/models/constants/build-in-theme/univer1.d.ts

@@ -1,2 +1,2 @@
 import type { IEchartTheme } from './types';
-export declare const univer1: IEchartTheme;
+export declare const UniverTheme1: IEchartTheme;

package/lib/types/models/constants/build-in-theme/univer2.d.ts

@@ -1,2 +1,2 @@
 import type { IEchartTheme } from './types';
-export declare const univer2: IEchartTheme;
+export declare const UniverTheme2: IEchartTheme;

package/lib/types/models/constants/build-in-theme/univer3.d.ts

@@ -1,2 +1,2 @@
 import type { IEchartTheme } from './types';
-export declare const univer3: IEchartTheme;
+export declare const UniverTheme3: IEchartTheme;

package/lib/types/models/constants/build-in-theme/univer4.d.ts

@@ -1,2 +1,2 @@
 import type { IEchartTheme } from './types';
-export declare const univer4: IEchartTheme;
+export declare const UniverTheme4: IEchartTheme;

package/lib/types/models/constants/build-in-theme/univer5.d.ts

@@ -1,2 +1,2 @@
 import type { IEchartTheme } from './types';
-export declare const univer5: IEchartTheme;
+export declare const UniverTheme5: IEchartTheme;

package/lib/types/models/constants/build-in-theme/univer6.d.ts

@@ -1,2 +1,2 @@
 import type { IEchartTheme } from './types';
-export declare const univer6: IEchartTheme;
+export declare const UniverTheme6: IEchartTheme;

package/lib/types/models/constants/default-chart-style.d.ts

@@ -1,5 +1,5 @@
 import type { ChartStyle } from '../../types';
-import { AreaLineStyle, AxisAlignEnum, ChartBorderDashType, ChartTypeBits, InvalidValueType, LabelContentType, LegendPositionEnum, LinePointShape, PieLabelPosition, RadarShape, SelectModeEnum, SeriesLabelPosition, TextAlign, TitlePositionEnum, WaterfallStackTypeEnum, WordCloudShapeEnum } from '../../enum';
+import { AreaLineStyle, AxisAlignEnum, BarShape, ChartBorderDashType, ChartTypeBits, InvalidValueType, LabelContentType, LegendPositionEnum, LinePointShape, PieLabelPosition, RadarShape, SelectModeEnum, SeriesLabelPosition, TextAlign, TitlePositionEnum, WaterfallStackTypeEnum, WordCloudShapeEnum } from '../../enum';
 export declare const themeColors: string[];
 export declare const RTLChartStyle: ChartStyle;
 export declare const defaultChartConfig: {
@@ -47,6 +47,12 @@ export declare const defaultChartConfig: {
     area: {
         lineStyle: AreaLineStyle;
     };
+    bar: {
+        is3D: boolean;
+        shape: BarShape;
+        rotX: number;
+        rotY: number;
+    };
     labelContentType: LabelContentType;
     pie: {
         labelContentType: number;
@@ -55,6 +61,7 @@ export declare const defaultChartConfig: {
         borderColor: string;
         labelPosition: PieLabelPosition;
         hasPaddingAngle: boolean;
+        is3D: boolean;
     };
     combination: {
         firstChartType: ChartTypeBits;
@@ -76,6 +83,14 @@ export declare const defaultChartConfig: {
     waterfall: {
         stackType: WaterfallStackTypeEnum;
         useSubtotal: boolean;
+        pointRoles: never[];
+        connector: boolean;
+        connectorStyle: {
+            color: string;
+            width: number;
+            opacity: number;
+            dashType: ChartBorderDashType;
+        };
         subtotalColor: string;
     };
     trendline: {
@@ -88,6 +103,11 @@ export declare const defaultChartConfig: {
         showFormula: boolean;
         showR2: boolean;
     };
+    semanticLine: {
+        width: number;
+        opacity: number;
+        dashType: ChartBorderDashType;
+    };
     relation: {
         force: {
             gravity: number;

package/lib/types/models/constants/default.d.ts

@@ -1,10 +1,12 @@
+import type { ChartStyle } from '../../types';
 export declare const EChartRenderEngineName = "EChartRenderEngine";
 export declare const defaultChartWidth = 468;
 export declare const defaultChartHeight = 369;
 export declare const LegendPadding = 15;
 export declare const TitleOrLegendPadding = 12;
 export declare const TitleDefaultStartPosition = 8;
-export declare const defaultChartPadding = 14;
+export declare const DEFAULT_CHART_LAYOUT_PADDING = 14;
+export declare function getChartLayoutPadding(style?: ChartStyle): number;
 export declare const TitleLineHeightBase = 1.2;
 export declare const AxisLabelMaxPercent = 0.15;
 export declare const defaultBubbleSize = 0.12;

package/lib/types/models/echart-render-model.d.ts

@@ -1,6 +1,7 @@
-import type { ChartHostRenderMode, ChartImageSource, ChartStyle, EChartInstance, EChartSpec, IChartConfig, IChartHostRect, IChartInstance, IChartRenderAsImageOptions, IChartRenderInstance, IChartRenderInstanceCreateContext, IChartRenderModel, IChartRenderModelStylizeInit, IChartRenderRuntimeOptions } from '../types';
+import type { ChartElementEventHandler, ChartElementEventType, ChartImageSource, ChartStyle, EChartInstance, EChartSpec, IChartConfig, IChartHostRect, IChartInstance, IChartRenderAsImageOptions, IChartRenderInstance, IChartRenderInstanceCreateContext, IChartRenderModel, IChartRenderModelImageExportInput, IChartRenderModelImageExportOptions, IChartRenderModelImageExportResult, IChartRenderModelStylizeInit, IChartRenderRuntimeOptions } from '../types';
 import type { IWordCloudRenderConfig } from '../wordcloud-chart/word-cloud-render-config';
 import { Disposable } from '@univerjs/core';
+import { ChartHostRenderMode } from '../types';
 export interface IEChartRenderModelOptions {
     wordCloudRenderConfig?: IWordCloudRenderConfig;
 }
@@ -22,20 +23,54 @@ export declare class EChartRenderModel extends Disposable implements IChartRende
     stylizeSpec(spec: EChartSpec, stylizeInit: IChartRenderModelStylizeInit<EChartSpec>, rect: IChartHostRect): import("echarts").EChartsOption | {
         backgroundColor: string;
     };
+    exportImage(input: IChartRenderModelImageExportInput, options?: IChartRenderModelImageExportOptions): Promise<IChartRenderModelImageExportResult>;
 }
 export declare class EChartRenderEngine extends Disposable implements EChartInstance {
     static engineName: string;
     private _instance;
     container: HTMLElement | string;
     private _devicePixelRatio;
+    private _lastSpec;
+    private readonly _eventHandlers;
+    private readonly _nativeEventHandlers;
+    private readonly _nativeZrBlankEventHandlers;
+    private readonly _elementEditModeHandlers;
+    private _elementEditModeZrMouseMoveHandler;
+    private _elementEditModeZrClickHandler;
+    private _elementEditModeEnabled;
+    private _editOverlay;
+    private readonly _emittedElementEventKeys;
+    private _emittedElementEventKeysClearQueued;
     constructor();
     getDevicePixelRatio(): 1 | 2 | undefined;
     mount(id: string | HTMLElement): void;
-    resize(echartsProvider?: any): void;
+    resize(echartsProviderOrOptions?: any | IChartRenderRuntimeOptions): void;
     private _ensureChartInstance;
     get containerElement(): HTMLElement | null;
     render(spec: EChartSpec, echartsProviderOrOptions?: any | IChartRenderRuntimeOptions): void;
     renderAsImage(spec: EChartSpec, options: IChartRenderAsImageOptions): Promise<ChartImageSource>;
+    on(type: ChartElementEventType, handler: ChartElementEventHandler): {
+        dispose: () => void;
+    };
+    setElementEditMode(enabled: boolean): void;
+    private _bindAllNativeEvents;
+    private _bindNativeEvent;
+    private _unbindNativeEvent;
+    private _bindNativeZrBlankEvent;
+    private _unbindNativeZrBlankEvent;
+    private _bindElementEditModeEvents;
+    private _unbindElementEditModeEvents;
+    private _emitChartElementEvent;
+    private _shouldSkipDuplicateElementEvent;
+    private _handleElementEditHover;
+    private _handleElementEditZrHover;
+    private _handleElementEditClick;
+    private _handleElementEditZrClick;
+    private _hideTooltip;
+    private _ensureEditOverlay;
+    private _removeEditOverlay;
+    private _clearHoverBorder;
+    private _clearFixedBorder;
     exportImg(echartsProvider?: any): Promise<string>;
     dispose(): void;
 }

package/lib/types/models/image-chart-host.d.ts

@@ -1,9 +1,10 @@
 import type { ChartImageSource, IChartHostLease, IChartHostRect, IChartHostStyle, IImageChartHost } from '../types';
 import { Disposable } from '@univerjs/core';
+import { ChartHostRenderMode } from '../types';
 export declare function chartImageSourceToDataUrl(image: ChartImageSource): string;
 export declare abstract class ImageChartHost extends Disposable implements IImageChartHost {
     readonly chartId: string;
-    readonly mode: "image";
+    readonly mode = ChartHostRenderMode.Image;
     private readonly _offscreenChartHost;
     constructor(chartId: string);
     abstract getRect(): IChartHostRect | null;

package/lib/types/models/mode-converter/converters/waterfall-layout.d.ts

@@ -0,0 +1,34 @@
+import type { IChartDataSeries, IWaterfallPointRole } from '../../../types';
+import { ChartWaterfallPointRole } from '../../../enum';
+export declare enum WaterfallPointClassification {
+    Increase = "increase",
+    Decrease = "decrease",
+    Total = "total"
+}
+export interface IResolvedWaterfallPoint {
+    seriesIndex: number;
+    dataPointIndex: number;
+    categoryIndex: number;
+    role: ChartWaterfallPointRole;
+    classification: WaterfallPointClassification;
+    value: number;
+    start: number;
+    end: number;
+}
+export interface IResolvedWaterfallConnector {
+    from: {
+        categoryIndex: number;
+        value: number;
+    };
+    to: {
+        categoryIndex: number;
+        value: number;
+    };
+}
+export interface IResolvedWaterfallLayout {
+    points: IResolvedWaterfallPoint[];
+    connectors: IResolvedWaterfallConnector[];
+    cumulative: number;
+}
+/** Resolves persisted Waterfall semantics without renderer or theme concerns. */
+export declare function resolveArrangementWaterfallLayout(series: IChartDataSeries[], roles?: readonly IWaterfallPointRole[]): IResolvedWaterfallLayout;

package/lib/types/models/mode-converter/mode-converter.d.ts

@@ -2,7 +2,6 @@ import type { Injector } from '@univerjs/core';
 import type { ChartTypeBits } from '../../enum';
 import type { ChartStyle, IChartContext, IChartHostRect, IUniverDataSet } from '../../types';
 import type { IChartLocaleTexts } from '../chart-locale-texts';
-import { StaticChartSource } from '../../source/static-chart-source';
 import { ChartModel } from '../chart-model';
 /**
  * The parameters for initializing a chart model.
@@ -53,7 +52,6 @@ export interface IChartModelInitParams {
     isRowDirection?: boolean;
     localeTexts?: IChartLocaleTexts;
 }
-export declare function generateChartModelContext(chartModel: ChartModel, dataSource: StaticChartSource): IChartContext;
 /**
  * Convert the initial data to a chart model.
  * @param initJson The initial data of the chart model.

package/lib/types/models/mode-converter/render-spec-operators/legend-size.d.ts

@@ -1,2 +1,3 @@
+import type { ChartStyle } from '../../../types';
 export declare const MinLegendTextWidth = 48;
-export declare function getLegendTextWidthLimit(width?: number): number;
+export declare function getLegendTextWidthLimit(width?: number, style?: ChartStyle): number;

package/lib/types/models/mode-converter/render-spec-operators/mark-line.operator.d.ts

@@ -0,0 +1,3 @@
+import type { EChartRenderSpecOperator } from '../../../types';
+/** Attaches persisted semantic fixed-axis lines to visible business series. */
+export declare const markLineOperator: EChartRenderSpecOperator;

package/lib/types/models/mode-converter/render-spec-operators/tools.d.ts

@@ -1,12 +1,11 @@
-import type { ChartStyle, EChartSeriesItem, EChartSpec, IChartConfig, ILabelStyle } from '../../../types';
+import type { ChartStyle, EChartSeriesItem, EChartSpec, ILabelStyle } from '../../../types';
 import type { ISpecGrid } from './operator-types';
-type PartialLabelStyle = Partial<Pick<ILabelStyle, 'visible' | 'color' | 'fontSize' | 'italic' | 'bold' | 'underline' | 'strikethrough' | 'showMaxLabel' | 'showMinLabel'>>;
+type PartialLabelStyle = Partial<Pick<ILabelStyle, 'visible' | 'color' | 'fontSize' | 'family' | 'italic' | 'bold' | 'underline' | 'strikethrough' | 'showMaxLabel' | 'showMinLabel'>>;
 export declare function applyLabelStyle(spec: Record<string, any>, path: string, labelStyle: PartialLabelStyle): void;
 export declare function applyLineStyle(spec: Record<string, any>, path: string, labelStyle: PartialLabelStyle): void;
 export declare function toArray<T = unknown>(value: T | T[]): T[];
 export declare function seriesForEach(series: EChartSpec['series'], func: (item: EChartSeriesItem, index: number) => void): void;
 export declare function toPercentage(value: number, fixed?: number): string;
-export declare const getLegendOrSeriesMaxWidth: (gridInfo: ISpecGrid, config: IChartConfig, style: ChartStyle) => number;
 export declare const getCategoryLabelVertical: (gridInfo: ISpecGrid, style: ChartStyle) => number;
 export declare const getCategoryLabelHorizontal: (gridInfo: ISpecGrid, style: ChartStyle, seriesCount: number, axisLabelMaxWidth?: number) => number;
 export declare const getIntegerValue: (value: number, digit?: number) => number;

package/lib/types/models/series-style/series-style-resolver.d.ts

@@ -0,0 +1,9 @@
+type SeriesStyleKeyInput = string | number | null | undefined;
+export interface ISeriesStyleSource {
+    seriesId?: SeriesStyleKeyInput;
+    seriesIndex?: SeriesStyleKeyInput;
+    baseSeriesIndex?: SeriesStyleKeyInput;
+}
+export declare function getSeriesStyleKey(source: ISeriesStyleSource): string | undefined;
+export declare function resolveSeriesStyle<T extends object>(seriesStyleMap: Partial<Record<string, T | undefined>> | undefined, source: ISeriesStyleSource, fallbackSources?: readonly ISeriesStyleSource[]): T | undefined;
+export {};

package/lib/types/source/chart-data-item.d.ts

@@ -0,0 +1,3 @@
+import type { IChartDataItem } from '../types';
+/** Normalizes a host cell value for semantic chart-series inspection. */
+export declare function toChartDataItem(value: unknown): IChartDataItem;

package/lib/types/source/source-util.d.ts

@@ -1,6 +1,6 @@
 import type { OptionDataValue } from '../types';
 import { ChartSourceDataTypeEnum } from '../enum';
-export declare function getCategoryData(source: OptionDataValue[][], categoryIndex: number, isRowDirection: boolean, sourceType?: ChartSourceDataTypeEnum[][]): {
+export declare function getCategoryData(source: OptionDataValue[][], categoryIndex: number, sourceType?: ChartSourceDataTypeEnum[][]): {
     categoryData: Array<OptionDataValue | undefined>;
     isAllDateTime: boolean;
 };

package/lib/types/source/static-chart-source.d.ts

@@ -1,14 +1,22 @@
 import type { IUniverDataSet } from '../types';
 import { BehaviorSubject } from 'rxjs';
 import { ChartDataSource } from './chart-source';
+/**
+ * Legacy static init data uses `dimensions` as the table header row and
+ * `source` as row-major table cells. StaticChartSource adapts that input to the
+ * canonical vector-based IUniverDataSet returned by convertDataSet().
+ */
+type ILegacyTableDataSet = IUniverDataSet;
 export declare class StaticChartSource extends ChartDataSource {
     _canSwitchOrient$: BehaviorSubject<boolean>;
-    private _columnDirectionDataSetCache;
+    private _rawDataSet;
+    private _convertedDataSetCache;
     constructor();
-    initData(data: IUniverDataSet, isRowDirection?: boolean): void;
-    setData(data: IUniverDataSet): void;
+    initData(data: ILegacyTableDataSet, isRowDirection?: boolean): void;
+    setData(data: ILegacyTableDataSet): void;
     updateIsRowDirection(flag: boolean): void;
     refresh(): void;
     convertDataSet(): IUniverDataSet;
     dispose(): void;
 }
+export {};