@univerjs-pro/engine-chart 0.6.7 → 0.6.8

package/lib/types/model/constants/build-in-theme/theme-util.d.ts

@@ -0,0 +1,5 @@
+import { IEchartTheme } from './types';
+export type axesType = 'category' | 'value' | 'time' | 'log' | 'all' | undefined;
+export declare function getThemeAxesByType(themeInfo: IEchartTheme, axesType: axesType): import('./types').IEchartThemeAxisConfig | undefined;
+export declare function getThemeTitleColor(themeInfo: IEchartTheme): string | undefined;
+export declare function getThemeProps(themeInfo: IEchartTheme | undefined, key: string): undefined;

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

@@ -1,4 +1,4 @@
-interface IEchartThemeAxisConfig {
+export interface IEchartThemeAxisConfig {
     type: string;
     name: string;
     axisLineShow: boolean;
@@ -74,4 +74,3 @@ export interface IEchartTheme {
     themeName: string;
     theme: IEchartThemeContent;
 }
-export {};

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

@@ -57,12 +57,29 @@ export declare const defaultChartConfig: {
         firstChartType: ChartTypeBits;
         otherChartType: ChartTypeBits;
     };
+    funnel: {
+        gap: number;
+    };
     radar: {
         shape: RadarShape;
         symbolSize: number;
         symbolType: LinePointShape;
         areaOpacity: number;
     };
+    wordCloud: {
+        maskImage: string;
+        repeat: boolean;
+    };
+    trendline: {
+        period: number;
+        order: number;
+        opacity: number;
+        width: number;
+        dashType: ChartBorderDashType;
+        color: string;
+        showFormula: boolean;
+        showR2: boolean;
+    };
     tooltipAxisLabelBackground: string;
     tooltipAxisLabelColor: string;
     indicatorLineType: ChartBorderDashType;

package/lib/types/model/data-context-transformers/word-cloud-data-context-transform.d.ts

@@ -0,0 +1,3 @@
+import { ChartModel } from '../chart-model';
+import { ChartTypeBits } from '../../enum';
+export declare const wordCloudDataContextTransformer: (fromType: ChartTypeBits, toType: ChartTypeBits, model: ChartModel) => void;

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

@@ -22,11 +22,11 @@ export declare class EChartRenderEngine extends Disposable implements EChartInst
     constructor();
     getDevicePixelRatio(): 1 | 2 | undefined;
     mount(id: string | HTMLElement): void;
-    resize(): void;
+    resize(echartsProvider?: any): void;
     private _ensureChartInstance;
     get containerElement(): HTMLElement | null;
-    render(spec: EChartSpec): void;
-    exportImg(): Promise<string>;
+    render(spec: EChartSpec, echartsProvider?: any): void;
+    exportImg(echartsProvider?: any): Promise<string>;
     onDispose(): void;
     dispose(): void;
 }

package/lib/types/model/mode-converter/converters/funnel-chart-converter.d.ts

@@ -0,0 +1,2 @@
+import { EChartSpec, IChartRenderSpecConverter } from '../../../types';
+export declare const funnelChartConverter: IChartRenderSpecConverter<EChartSpec>;

package/lib/types/model/mode-converter/converters/scatter-chart-converter.d.ts

@@ -0,0 +1,2 @@
+import { EChartSpec, IChartRenderSpecConverter } from '../../../types';
+export declare const scatterChartConverter: IChartRenderSpecConverter<EChartSpec>;

package/lib/types/model/mode-converter/converters/word-cloud-converter.d.ts

@@ -0,0 +1,75 @@
+import { EChartSpec, IChartRenderSpecConverter } from '../../../types';
+interface IWordCloudTextStyle {
+    color?: string;
+    fontStyle?: string;
+    fontWeight?: string | number;
+    fontFamily?: string;
+    fontSize?: number | string;
+    align?: string;
+    verticalAlign?: string;
+    baseline?: string;
+    opacity?: number;
+    lineHeight?: number;
+    backgroundColor?: string | {
+        image: HTMLImageElement | HTMLCanvasElement | string;
+    };
+    borderColor?: string;
+    borderWidth?: number;
+    borderType?: string;
+    borderDashOffset?: number;
+    borderRadius?: number | number[];
+    padding?: number | number[];
+    width?: number | string;
+    height?: number;
+    textBorderColor?: string;
+    textBorderWidth?: number;
+    textBorderType?: string;
+    textBorderDashOffset?: number;
+    textShadowBlur?: number;
+    textShadowColor?: string;
+    textShadowOffsetX?: number;
+    textShadowOffsetY?: number;
+}
+export interface IWorldCloudDataItem {
+    name?: string;
+    value?: number | number[];
+    textStyle?: IWordCloudTextStyle;
+    emphasis?: {
+        textStyle?: IWordCloudTextStyle;
+    };
+}
+export interface IWordCloudSeriesOption {
+    mainType?: 'series';
+    type?: 'wordCloud';
+    silent?: boolean;
+    blendMode?: string;
+    /**
+     * Cursor when mouse on the elements
+     */
+    cursor?: string;
+    width?: number | string;
+    height?: number | string;
+    top?: number | string;
+    right?: number | string;
+    bottom?: number | string;
+    left?: number | string;
+    textStyle?: IWordCloudTextStyle | {
+        color?: (params?: any) => string;
+    };
+    emphasis?: {
+        focus?: 'self' | 'series' | 'none';
+        blurScope?: 'coordinateSystem' | 'global' | 'series';
+        textStyle?: IWordCloudTextStyle;
+    };
+    shape?: string;
+    maskImage?: HTMLImageElement | HTMLCanvasElement;
+    sizeRange?: number[];
+    rotationRange?: number[];
+    rotationStep?: number;
+    gridSize?: number;
+    drawOutOfBound?: boolean;
+    layoutAnimation?: boolean;
+    data?: IWorldCloudDataItem[];
+}
+export declare const wordCloudChartConverter: IChartRenderSpecConverter<EChartSpec>;
+export {};

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

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

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

@@ -0,0 +1,2 @@
+import { 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/word-cloud-musk-image.service.d.ts

@@ -0,0 +1,16 @@
+import { Injector, 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/source/static-chart-source.d.ts

@@ -1,6 +1,8 @@
 import { IUniverDataSet } from '../types';
+import { BehaviorSubject } from 'rxjs';
 import { ChartDataSource } from './chart-source';
 export declare class StaticChartSource extends ChartDataSource {
+    _canSwitchOrient$: BehaviorSubject<boolean>;
     private _columnDirectionDataSetCache;
     constructor();
     initData(data: IUniverDataSet, isRowDirection?: boolean): void;

package/lib/types/types.d.ts

@@ -1,6 +1,6 @@
 import { CellValue, IDisposable, LocaleService, Nullable } from '@univerjs/core';
 import { Observable } from 'rxjs';
-import { AreaLineStyle, AxisAlignEnum, AxisValueType, CategoryType, ChartBorderDashType, ChartTypeBits, DataOrientation, InvalidValueType, IRuntimeAxisPosition, IRuntimeAxisPriority, LabelAlignEnum, LegendPositionEnum, LinePointShape, PieLabelPosition, RadarShape, SelectModeEnum, SeriesLabelPosition, TitlePositionEnum } from './enum';
+import { AreaLineStyle, AxisAlignEnum, AxisValueType, CategoryType, ChartBorderDashType, ChartTrendlineType, ChartTypeBits, DataOrientation, InvalidValueType, IRuntimeAxisPosition, IRuntimeAxisPriority, LabelAlignEnum, LegendPositionEnum, LinePointShape, PieLabelPosition, RadarShape, SelectModeEnum, SeriesLabelPosition, TitlePositionEnum, WordCloudShapeEnum } from './enum';
 import { IEchartTheme } from './model/constants/build-in-theme';
 export type DeepPartial<T> = T extends Record<string, any> ? T extends any[] ? T : {
     [key in keyof T]+?: DeepPartial<T[key]>;
@@ -63,7 +63,7 @@ export interface IChartDataSeries {
     name: string;
     items: IChartDataItem[];
 }
-interface IChartDataItem {
+export interface IChartDataItem {
     value: OptionDataValue;
     label: string;
 }
@@ -79,6 +79,7 @@ export interface IChartRuntimeContext {
     hasSecondaryAxis: boolean;
     localeService: LocaleService;
     emptyTips: string;
+    wordCloudImageMaskMap: Map<string, HTMLImageElement>;
 }
 export interface ILabelStyle {
     visible: boolean;
@@ -95,6 +96,7 @@ export interface ILabelStyle {
     axisTitleAlign?: AxisAlignEnum | undefined;
     showMaxLabel?: boolean;
     showMinLabel?: boolean;
+    rotate?: number;
 }
 export interface ILegendStyle {
     position?: LegendPositionEnum;
@@ -157,6 +159,21 @@ export interface ISeriesStyle {
 export type RightYAxisOptions = Omit<IAxisOptions, 'reverse'>;
 export interface IAllSeriesStyle extends Pick<ISeriesStyle, 'border' | 'label' | 'rightYAxis' | 'point' | 'color'> {
 }
+export interface ITrendLine {
+    seriesIndex: number;
+    type: ChartTrendlineType;
+    name: string;
+    color?: string;
+    width?: number;
+    opacity?: number;
+    dashType?: ChartBorderDashType;
+    order?: number;
+    period?: number;
+    showFormula?: boolean;
+    showR2?: boolean;
+    r2Color?: string;
+    formulaColor?: string;
+}
 export interface IChartStyle {
     runtime: IChartRuntimeContext;
     width: number;
@@ -185,6 +202,7 @@ export interface IChartStyle {
     seriesStyleMap: {
         [id: string]: ISeriesStyle;
     };
+    trendlines: ITrendLine[];
     pie: {
         doughnutHole: Nullable<number>;
         labelStyle: IPieLabelStyle;
@@ -201,6 +219,15 @@ export interface IChartStyle {
         shape: RadarShape;
         fill: boolean;
     };
+    funnel: {
+        gap: number;
+        useAbsValue: boolean;
+    };
+    wordCloud: {
+        shape: WordCloudShapeEnum;
+        maskImage: string;
+        repeat: boolean;
+    };
     tooltip: {
         indicatorLabelColor: string;
         indicatorLineType: ChartBorderDashType;
@@ -247,7 +274,7 @@ export interface IChartThemeOptions {
 export interface IChartInstance<Spec = Record<string, any>> extends IDisposable {
     container: HTMLElement | string;
     mount(id: string | HTMLElement): void;
-    render(spec: Spec): void;
+    render(spec: Spec, echartsProvider?: any): void;
     exportImg(): Promise<string>;
     onDispose?(dispose: () => void): void;
     resize(): void;
@@ -268,4 +295,3 @@ export interface IChartHostRect {
     width: number;
     height: number;
 }
-export {};

package/lib/types/util.d.ts

@@ -3,7 +3,7 @@ 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" | "pie" | "bar" | "scatter" | "radar" | "combination";
+    chartBitToString(bit: ChartTypeBits): "" | "line" | "pie" | "bar" | "scatter" | "radar" | "funnel" | "combination" | "wordCloud";
 };
 export declare const setProperty: (data: Record<string, any>, propertyPath: string, value: any) => void;
 /**
@@ -19,4 +19,10 @@ interface ISize {
 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 {};

package/lib/types/word-cloud-resource/word-cloud-resource-config.d.ts

@@ -0,0 +1,5 @@
+interface IWordCloudResource {
+    [iconName: string]: string;
+}
+export declare const WordCloudResourceConfig: IWordCloudResource;
+export {};