@univerjs-pro/engine-chart 1.0.0-rc.0 → 1.0.0

package/lib/types/model/mode-converter/render-spec-operators/bubble-style.operator.d.ts

@@ -0,0 +1,2 @@
+import type { EChartRenderSpecOperator } from '../../../types';
+export declare const bubbleStyleOperator: EChartRenderSpecOperator;

package/lib/types/model/mode-converter/render-spec-operators/chart-axes.operator.d.ts

@@ -0,0 +1,2 @@
+import type { EChartRenderSpecOperator } from '../../../types';
+export declare const chartAxesOperator: EChartRenderSpecOperator;

package/lib/types/model/mode-converter/render-spec-operators/chart-box-style.operator.d.ts

@@ -0,0 +1,2 @@
+import type { EChartRenderSpecOperator } from '../../../types';
+export declare const chartBoxStyleOperator: EChartRenderSpecOperator;

package/lib/types/model/mode-converter/render-spec-operators/empty-style-operator.d.ts

@@ -0,0 +1,2 @@
+import type { EChartRenderSpecOperator } from '../../../types';
+export declare const emptyStyleOperator: EChartRenderSpecOperator;

package/lib/types/model/mode-converter/render-spec-operators/font-size.operator.d.ts

@@ -0,0 +1,2 @@
+import type { EChartRenderSpecOperator } from '../../../types';
+export declare const fontSizeOperator: EChartRenderSpecOperator;

package/lib/types/model/mode-converter/render-spec-operators/grid-operator.d.ts

@@ -0,0 +1,2 @@
+import type { EChartRenderSpecOperator } from '../../../types';
+export declare const gridStyleOperator: EChartRenderSpecOperator;

package/lib/types/model/mode-converter/render-spec-operators/heatmap-chart-operator.d.ts

@@ -0,0 +1,2 @@
+import type { EChartRenderSpecOperator } from '../../../types';
+export declare const heatmapChartOperator: EChartRenderSpecOperator;

package/lib/types/model/mode-converter/render-spec-operators/hover-mark-style.operator.d.ts

@@ -0,0 +1,2 @@
+import type { EChartRenderSpecOperator } from '../../../types';
+export declare const hoverMarkStyleOperator: EChartRenderSpecOperator;

package/lib/types/model/mode-converter/render-spec-operators/index.d.ts

@@ -0,0 +1,13 @@
+export { axisTitleStyleOperator } from './axis-title.operator';
+export { chartAxesOperator } from './chart-axes.operator';
+export { chartBoxStyleOperator } from './chart-box-style.operator';
+export { fontSizeOperator } from './font-size.operator';
+export { hoverMarkStyleOperator } from './hover-mark-style.operator';
+export { invalidValueStyleOperator } from './invalid-value-style.operator';
+export { legendStyleOperator } from './legend-style.operator';
+export { lineLikeStyleOperator } from './line-like-style.operator';
+export { pieStyleOperator } from './pie-style.operator';
+export { seriesStyleOperator } from './series-style-operator/series-style-operator';
+export { stackOperator } from './stack.operator';
+export { chartThemeOperator } from './theme.operator';
+export { chartTitleStyleOperator } from './title-style.operator';

package/lib/types/model/mode-converter/render-spec-operators/invalid-value-style.operator.d.ts

@@ -0,0 +1,2 @@
+import type { EChartRenderSpecOperator } from '../../../types';
+export declare const invalidValueStyleOperator: EChartRenderSpecOperator;

package/lib/types/model/mode-converter/render-spec-operators/legend-style.operator.d.ts

@@ -0,0 +1,2 @@
+import type { EChartRenderSpecOperator } from '../../../types';
+export declare const legendStyleOperator: EChartRenderSpecOperator;

package/lib/types/model/mode-converter/render-spec-operators/line-like-style.operator.d.ts

@@ -0,0 +1,2 @@
+import type { EChartRenderSpecOperator } from '../../../types';
+export declare const lineLikeStyleOperator: EChartRenderSpecOperator;

package/lib/types/model/mode-converter/render-spec-operators/operator-types.d.ts

@@ -0,0 +1,7 @@
+export interface ISpecGrid {
+    left: number;
+    right: number;
+    top: number;
+    bottom: number;
+    containLabel: boolean;
+}

package/lib/types/model/mode-converter/render-spec-operators/pie-style.operator.d.ts

@@ -0,0 +1,2 @@
+import type { EChartRenderSpecOperator } from '../../../types';
+export declare const pieStyleOperator: EChartRenderSpecOperator;

package/lib/types/model/mode-converter/render-spec-operators/radar-style.operator.d.ts

@@ -0,0 +1,2 @@
+import type { EChartRenderSpecOperator } from '../../../types';
+export declare const radarStyleOperator: EChartRenderSpecOperator;

package/lib/types/model/mode-converter/render-spec-operators/relation-chart-operator/relation-chart-operator.d.ts

@@ -0,0 +1,2 @@
+import type { EChartRenderSpecOperator } from '../../../../types';
+export declare const relationChartOperator: EChartRenderSpecOperator;

package/lib/types/model/mode-converter/render-spec-operators/relation-chart-operator/relation-force-directed-layout.d.ts

@@ -0,0 +1,28 @@
+interface INode {
+    id: string;
+    x?: number;
+    y?: number;
+    vx?: number;
+    vy?: number;
+    fixed?: boolean;
+    [key: string]: any;
+}
+interface ILink {
+    source: string;
+    target: string;
+    value?: number;
+}
+interface ILayoutOptions {
+    iterations?: number;
+    repulsion?: number;
+    attraction?: number;
+    theta?: number;
+}
+export declare function processEChartsGraphData(data: {
+    nodes: INode[];
+    links: ILink[];
+}, canvasWidth?: number, canvasHeight?: number, options?: ILayoutOptions): {
+    nodes: INode[];
+    links: ILink[];
+};
+export {};

package/lib/types/model/mode-converter/render-spec-operators/sankey-chart-operator.d.ts

@@ -0,0 +1,2 @@
+import type { EChartRenderSpecOperator } from '../../../types';
+export declare const sankeyChartOperator: EChartRenderSpecOperator;

package/lib/types/model/mode-converter/render-spec-operators/scatter-style.operator.d.ts

@@ -0,0 +1,2 @@
+import type { EChartRenderSpecOperator } from '../../../types';
+export declare const scatterStyleOperator: EChartRenderSpecOperator;

package/lib/types/model/mode-converter/render-spec-operators/series-style-operator/pareto-series-style.handler.d.ts

@@ -0,0 +1,2 @@
+import type { EChartRenderSpecOperator } from '../../../../types';
+export declare const paretoSeriesStyleOperator: EChartRenderSpecOperator;

package/lib/types/model/mode-converter/render-spec-operators/series-style-operator/series-chart-style.handler.d.ts

@@ -0,0 +1,2 @@
+import type { SeriesItemHandler } from './series-style-operator';
+export declare const seriesChartStyleHandler: SeriesItemHandler;

package/lib/types/model/mode-converter/render-spec-operators/series-style-operator/series-data-label.handler.d.ts

@@ -0,0 +1,2 @@
+import type { SeriesItemHandler } from './series-style-operator';
+export declare const seriesDataLabelHandler: SeriesItemHandler;

package/lib/types/model/mode-converter/render-spec-operators/series-style-operator/series-style-operator.d.ts

@@ -0,0 +1,11 @@
+import type { ChartStyle, DeepPartial, EChartRenderSpecOperator, EChartSeriesItem, ISeriesStyle } from '../../../../types';
+import { ChartTypeBits } from '../../../../enum';
+export interface ISeriesStyleHandlerContext {
+    seriesItem: EChartSeriesItem;
+    seriesIndex: number;
+    seriesStyle: DeepPartial<ISeriesStyle> | undefined;
+    chartStyle: ChartStyle;
+    chartType: ChartTypeBits;
+}
+export type SeriesItemHandler = (context: ISeriesStyleHandlerContext, isVerticalSeriesValue: boolean) => void;
+export declare const seriesStyleOperator: EChartRenderSpecOperator;

package/lib/types/model/mode-converter/render-spec-operators/series-style-operator/waterfall-series-style-operator.d.ts

@@ -0,0 +1,3 @@
+import type { EChartRenderSpecOperator } from '../../../../types';
+export declare const waterfallSeriesStyleOperator: EChartRenderSpecOperator;
+export declare const waterfallSeriesDataLabelHandler: EChartRenderSpecOperator;

package/lib/types/model/mode-converter/render-spec-operators/stack.operator.d.ts

@@ -0,0 +1,2 @@
+import type { EChartRenderSpecOperator } from '../../../types';
+export declare const stackOperator: EChartRenderSpecOperator;

package/lib/types/model/mode-converter/render-spec-operators/theme.operator.d.ts

@@ -0,0 +1,2 @@
+import type { EChartRenderSpecOperator } from '../../../types';
+export declare const chartThemeOperator: EChartRenderSpecOperator;

package/lib/types/model/mode-converter/render-spec-operators/title-style.operator.d.ts

@@ -0,0 +1,2 @@
+import type { EChartRenderSpecOperator } from '../../../types';
+export declare const chartTitleStyleOperator: EChartRenderSpecOperator;

package/lib/types/model/mode-converter/render-spec-operators/tool-tip-operator.d.ts

@@ -0,0 +1,3 @@
+import type { EChartRenderSpecOperator } from '../../../types';
+export declare function excelDateToUnixMilliseconds(excelDate: number, useDefault1900DateSystem?: boolean): number;
+export declare const toolTipStyleOperator: EChartRenderSpecOperator;

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

@@ -0,0 +1,26 @@
+import type { ChartStyle, EChartSeriesItem, EChartSpec, IChartConfig, ILabelStyle } from '../../../types';
+import type { ISpecGrid } from './operator-types';
+type PartialLabelStyle = Partial<Pick<ILabelStyle, 'visible' | 'color' | 'fontSize' | '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;
+export declare const getGradientColor: (color: string, gradientFill: boolean) => string | {
+    gradient: string;
+    x: number;
+    y: number;
+    x2: number;
+    y2: number;
+    colorStops: {
+        offset: number;
+        color: string;
+    }[];
+};
+type RenderColorFunc = (color: string) => string;
+export declare const getRenderColorFunc: (style: ChartStyle) => RenderColorFunc;
+export {};

package/lib/types/model/mode-converter/render-spec-operators/trend-line/trend-line.operator.d.ts

@@ -0,0 +1,2 @@
+import type { EChartRenderSpecOperator } from '../../../../types';
+export declare const trendlineOperator: EChartRenderSpecOperator;

package/lib/types/model/mode-converter/render-spec-operators/trend-line/trendline-util.d.ts

@@ -0,0 +1,13 @@
+type DataPoint = [number, number];
+interface IRegressionResult {
+    formula: string;
+    execute: (x: number) => number;
+    R2: number;
+}
+declare function linearRegression(data: DataPoint[]): IRegressionResult;
+declare function exponentialRegression(data: DataPoint[]): IRegressionResult;
+declare function logarithmicRegression(data: DataPoint[]): IRegressionResult;
+declare function powerRegression(data: DataPoint[]): IRegressionResult;
+declare function polynomialRegression(data: DataPoint[], degree: number): IRegressionResult;
+declare function movingAverage(data: DataPoint[], period: number): (number | null)[];
+export { exponentialRegression, linearRegression, logarithmicRegression, movingAverage, polynomialRegression, powerRegression, };

package/lib/types/model/mode-converter/render-spec-operators/visual-map-operator.d.ts

@@ -0,0 +1,2 @@
+import type { EChartRenderSpecOperator } from '../../../types';
+export declare const visualMapOperator: EChartRenderSpecOperator;

package/lib/types/model/mode-converter/render-spec-operators/watermark.operator.d.ts

@@ -0,0 +1,2 @@
+import type { EChartRenderSpecOperator } from '../../../types';
+export declare const chartWaterMarkerOperator: EChartRenderSpecOperator;

package/lib/types/model/spec-converter/spec-converter.d.ts

@@ -0,0 +1 @@
+export declare function convertToSpecFromModel(model: any): any;

package/lib/types/model/word-cloud-musk-image.service.d.ts

@@ -0,0 +1,17 @@
+import type { Injector } from '@univerjs/core';
+import { Disposable } from '@univerjs/core';
+export declare class WordCloudMuskImageService extends Disposable {
+    private _wordCloudMuskImageCollection;
+    constructor();
+    loadMuskImage(name: string, url: string): void;
+    loadMuskImages(): void;
+    getWordCloudImageMask(imgName: string): HTMLImageElement | undefined;
+    getWordCloudImageMaskMap(): Map<string, HTMLImageElement>;
+    dispose(): void;
+}
+/**
+ * This function is used to register the WordCloudMuskImageService service avoiding the repeated registration of the service.
+ * @param injector The injector to register the service.
+ * @returns {void}
+ */
+export declare function registerWordCloudChartMakImageService(injector: Injector): void;

package/lib/types/models/chart-context/chart-field-selection.d.ts

@@ -4,9 +4,6 @@ export interface IChartFieldSelection {
     categoryIndexes: number[];
     seriesIndexes: number[];
 }
-type ChartContextWithHistoricalCategoryIndex = Partial<IChartContext> & {
-    categoryIndex?: unknown;
-};
 export declare function countChartFieldTypes(field: Array<OptionDataValue | undefined>, sourceTypes?: Array<ChartSourceDataTypeEnum | undefined>): {
     numbers: number;
     strings: number;
@@ -14,8 +11,7 @@ export declare function countChartFieldTypes(field: Array<OptionDataValue | unde
 };
 export declare function classifyChartFields(dataSet: Pick<IUniverDataSet, 'source' | 'sourceType' | 'categorySpans'>): IChartFieldSelection;
 export declare function resolveChartFieldSelectionContext(dataSet: IUniverDataSet, context: IChartContext, initializeSelection?: boolean): IChartContext;
-/** The single compatibility boundary for the historical scalar snapshot field. */
+/** Reads historical field names through the shared context compatibility boundary. */
 export declare function normalizeChartSnapshotContext(context: IChartSnapshotContext): IChartContext;
-/** Decodes the only supported historical field while preserving every canonical context field. */
-export declare function decodeHistoricalCategoryIndex(context: ChartContextWithHistoricalCategoryIndex): Partial<IChartContext>;
-export {};
+/** Historical snapshots and command patches must remain readable after field renames. */
+export declare function decodeHistoricalChartContext(context: object): Partial<IChartContext>;

package/lib/types/models/chart-data/build-chart-data.d.ts

@@ -1,5 +1,5 @@
 import type { IChartDataAggregation } from '../../chart-data-aggregation';
-import type { ChartTypeBits } from '../../enum';
 import type { IChartContext, IChartData, IUniverDataSet } from '../../types';
 import type { IChartLocaleTexts } from '../common/chart-locale-texts';
+import { ChartTypeBits } from '../../enum';
 export declare function buildChartData(dataSet: IUniverDataSet, chartContext: IChartContext, chartType: ChartTypeBits, localeTexts: IChartLocaleTexts, dataAggregation?: IChartDataAggregation): IChartData;

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

@@ -0,0 +1,5 @@
+import type { IAccessor } from '@univerjs/core';
+/** Validates chart grants independently of the replaceable License plugin and module. */
+export declare function isChartFeatureAuthorized(accessor: IAccessor, feature: 'sf' | 'df' | 'uf'): boolean;
+/** Returns undefined for the free tier; callers own its available chart types. */
+export declare function getSheetChartLicenseTypes(accessor: IAccessor): string[] | undefined;