@univerjs-pro/sheets-chart 0.5.0-alpha.0 → 0.5.0-beta.1

package/lib/types/locale/en-US.d.ts

@@ -0,0 +1,3 @@
+import { default as zhCN } from './zh-CN';
+declare const locale: typeof zhCN;
+export default locale;

package/lib/types/locale/ru-RU.d.ts

@@ -0,0 +1,3 @@
+import { default as zhCN } from './zh-CN';
+declare const locale: typeof zhCN;
+export default locale;

package/lib/types/locale/vi-VN.d.ts

@@ -0,0 +1,3 @@
+import { default as zhCN } from './zh-CN';
+declare const locale: typeof zhCN;
+export default locale;

package/lib/types/locale/zh-CN.d.ts

@@ -0,0 +1,22 @@
+/**
+ * Copyright 2023-present DreamNum Inc.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+declare const locale: {
+    chart: {
+        category: string;
+        series: string;
+    };
+};
+export default locale;

package/lib/types/locale/zh-TW.d.ts

@@ -0,0 +1,3 @@
+import { default as zhCN } from './zh-CN';
+declare const locale: typeof zhCN;
+export default locale;

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

@@ -0,0 +1,3 @@
+import { LocaleService } from '@univerjs/core';
+import { IChartContext, IChartData, IUniverDataSet } from '../types';
+export declare function buildChartData(dataSource: IUniverDataSet, chartContext: IChartContext, isRowDirection: boolean, localeService: LocaleService): IChartData;

package/lib/types/models/chart-data-operators/index.d.ts

@@ -0,0 +1,17 @@
+/**
+ * Copyright 2023-present DreamNum Inc.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+export * from './build-chart-data';
+export * from './operators';

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

@@ -0,0 +1,24 @@
+import { ChartDataSourceValue, ChartDataSourceValues, IChartContext, IChartDataAggregation, IChartDataSource, OptionDataValue } from '../types';
+export type IChartContextOperator = (dataSource: IChartDataSource, context: IChartContext) => IChartContext;
+export type IChartDataAggregateOperator = (dataSource: ChartDataSourceValues, context: IChartContext, dataAggregation: IChartDataAggregation) => ChartDataSourceValues | void;
+type Nil = null | undefined;
+export declare function isNil(value: any): value is Nil;
+export declare function countTypesFromArray(arrayData: OptionDataValue[]): {
+    numbers: number;
+    strings: number;
+};
+export declare function toString(value: ChartDataSourceValue): string;
+export declare function toNumber(value: ChartDataSourceValue): number;
+export declare function toColumnOrient<T = any>(dataSource: T[][]): T[][];
+export declare function findCategoryIndexes(dataSource: IChartDataSource): number[];
+export declare function groupBy<T = any>(ary: T[], selector: (item: T, index: number) => string): {
+    name: string;
+    values: T[];
+}[];
+export declare function sumArray(ary: ChartDataSourceValue[]): number;
+export declare const findHeaderOperator: IChartContextOperator;
+export declare const findCategoryOperator: IChartContextOperator;
+export declare const findSeriesOperator: IChartContextOperator;
+export declare const aggregateOperator: IChartDataAggregateOperator;
+export declare const topNOperator: IChartDataAggregateOperator;
+export {};

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

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

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

@@ -0,0 +1,15 @@
+export { themeDefault } from './default';
+export { getThemeAxesByType, getThemeProps } from './theme-util';
+export type { IEchartTheme } from './types';
+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 { 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';

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

@@ -0,0 +1,77 @@
+interface IEchartThemeAxisConfig {
+    type: string;
+    name: string;
+    axisLineShow: boolean;
+    axisLineColor: string;
+    axisTickShow: boolean;
+    axisTickColor: string;
+    axisLabelShow: boolean;
+    axisLabelColor: string;
+    splitLineShow: boolean;
+    splitLineColor: string[];
+    splitAreaShow: boolean;
+    splitAreaColor: string[];
+}
+interface IEchartThemeContent {
+    seriesCnt: string;
+    backgroundColor: string;
+    titleColor: string;
+    subtitleColor: string;
+    textColorShow: boolean;
+    textColor: string;
+    markTextColor: string;
+    color: string[];
+    borderColor: string;
+    borderWidth: string | number;
+    visualMapColor: string[];
+    legendTextColor: string;
+    kColor: string;
+    kColor0: string;
+    kBorderColor: string;
+    kBorderColor0: string;
+    kBorderWidth: string | number;
+    lineWidth: string | number;
+    symbolSize: string | number;
+    symbol: string;
+    symbolBorderWidth: string | number;
+    lineSmooth: boolean;
+    graphLineWidth: string | number;
+    graphLineColor: string;
+    mapLabelColor: string;
+    mapLabelColorE: string;
+    mapBorderColor: string;
+    mapBorderColorE: string;
+    mapBorderWidth: string | number;
+    mapBorderWidthE: string | number;
+    mapAreaColor: string;
+    mapAreaColorE: string;
+    axes: IEchartThemeAxisConfig[];
+    axisSeperateSetting: boolean;
+    toolboxColor: string;
+    toolboxEmphasisColor: string;
+    tooltipAxisColor: string;
+    tooltipAxisWidth: string | number;
+    timelineLineColor: string;
+    timelineLineWidth: string | number;
+    timelineItemColor: string;
+    timelineItemColorE: string;
+    timelineCheckColor: string;
+    timelineCheckBorderColor: string;
+    timelineItemBorderWidth: string | number;
+    timelineControlColor: string;
+    timelineControlBorderColor: string;
+    timelineControlBorderWidth: string | number;
+    timelineLabelColor: string;
+    datazoomBackgroundColor: string;
+    datazoomDataColor: string;
+    datazoomFillColor: string;
+    datazoomHandleColor: string;
+    datazoomHandleWidth: string;
+    datazoomLabelColor: string;
+}
+export interface IEchartTheme {
+    version: number | string;
+    themeName: string;
+    theme: IEchartThemeContent;
+}
+export {};

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

@@ -0,0 +1,63 @@
+import { ChartTypeBits } from '../constants';
+import { AreaLineStyle, AxisAlignEnum, ChartBorderDashType, InvalidValueType, LabelContentType, LegendPositionEnum, LinePointShape, PieLabelPosition, RadarShape, SeriesLabelPosition, TextAlign, TitlePositionEnum } from '../style.types';
+export declare const themeColors: string[];
+export declare const defaultChartConfig: {
+    allSeriesId: string;
+    invalidValueType: InvalidValueType;
+    point: {
+        shape: LinePointShape;
+        size: number;
+    };
+    backgroundColor: string;
+    axis: {
+        labelVisible: boolean;
+        reverse: boolean;
+        titleAlign: AxisAlignEnum;
+    };
+    legend: {
+        position: LegendPositionEnum;
+    };
+    borderStyle: {
+        opacity: number;
+        width: number;
+        specialChartWidthMap: {
+            2: number;
+            16: number;
+            32: number;
+        };
+        dashType: ChartBorderDashType;
+    };
+    textStyle: {
+        fontSize: number;
+        subTitleFontSize: number;
+        titleFontSize: number;
+        color: string;
+        align: string;
+        position: SeriesLabelPosition;
+        bold: boolean;
+        family: string;
+        italic: boolean;
+    };
+    titlePosition: TitlePositionEnum;
+    titlePositionAlign: TextAlign;
+    titleFontSize: number;
+    area: {
+        lineStyle: AreaLineStyle;
+    };
+    labelContentType: LabelContentType;
+    pie: {
+        labelContentType: number;
+        radius: number;
+        doughnutHole: number;
+        borderColor: string;
+        labelPosition: PieLabelPosition;
+        hasPaddingAngle: boolean;
+    };
+    combination: {
+        firstChartType: ChartTypeBits;
+        otherChartType: ChartTypeBits;
+    };
+    radar: {
+        shape: RadarShape;
+    };
+};

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

@@ -0,0 +1,59 @@
+/**
+ * Copyright 2023-present DreamNum Inc.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+export declare enum ChartAttributeBits {
+    Stack = 1073741824,
+    PercentStack = 1610612736,
+    Horizontal = 268435456
+}
+export declare enum ChartTypeBits {
+    None = 0,
+    /** Line chart */
+    Line = 2,
+    /** Bar chart */
+    Column = 4,
+    ColumnStacked = 1073741828,
+    ColumnPercentStacked = 1610612740,
+    Bar = 268435460,
+    BarStacked = 1342177284,
+    BarPercentStacked = 1879048196,
+    /** Pie chart */
+    Pie = 8,
+    Doughnut = 264,
+    /** Area chart */
+    Area = 16,
+    AreaStacked = 1073741840,
+    AreaPercentStacked = 1610612752,
+    /** Radar chart */
+    Radar = 32,
+    /** Scatter chart */
+    Scatter = 64,
+    /** Combination chart */
+    Combination = 128
+}
+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" | "radar" | "scatter" | "combination";
+};
+export declare enum DataOrientation {
+    Row = "Row",
+    Column = "Column"
+}
+export declare enum CategoryType {
+    Linear = "Linear",
+    Text = "Text"
+}

package/lib/types/models/data-context-transformers/bar-data-context-transformer.d.ts

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

package/lib/types/models/data-context-transformers/pie-data-context-transformer.d.ts

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

package/lib/types/models/runtime-context.types.d.ts

@@ -0,0 +1,28 @@
+import { LocaleService } from '@univerjs/core';
+import { IEchartTheme } from './constants/build-in-theme';
+export declare enum AxisValueType {
+    Text = 1,
+    Numeric = 2
+}
+export declare enum IRuntimeAxisPosition {
+    Left = "left",
+    Right = "right",
+    Bottom = "bottom"
+}
+export declare enum IRuntimeAxisPriority {
+    Primary = 1,
+    Secondary = 2,
+    Tertiary = 3
+}
+export interface IRuntimeAxis {
+    priority: IRuntimeAxisPriority;
+    position: IRuntimeAxisPosition;
+    type: AxisValueType;
+}
+export interface IChartRuntimeContext {
+    themeColors?: string[];
+    axes: IRuntimeAxis[];
+    themeInfo: IEchartTheme;
+    hasSecondaryAxis: boolean;
+    localeService: LocaleService;
+}

package/lib/types/models/style.types.d.ts

@@ -0,0 +1,213 @@
+import { Nullable } from '@univerjs/core';
+import { ChartTypeBits } from './constants';
+import { IChartRuntimeContext } from './runtime-context.types';
+export type DeepPartial<T> = T extends Record<string, any> ? T extends any[] ? T : {
+    [key in keyof T]+?: DeepPartial<T[key]>;
+} : T;
+export declare enum SeriesLabelPosition {
+    Auto = "auto",
+    Top = "top",
+    Bottom = "bottom",
+    Left = "left",
+    Inside = "inside",
+    Outside = "outside"
+}
+export declare enum PieLabelPosition {
+    Inside = "inside",
+    Outside = "outside"
+}
+export declare enum RadarShape {
+    Polygon = "polygon",
+    Circle = "circle"
+}
+export declare enum LabelContentType {
+    Empty = 0,
+    CategoryName = 2,
+    SeriesName = 4,
+    Value = 8,
+    Percentage = 16
+}
+export declare enum LabelAlignEnum {
+    Left = "left",
+    Right = "right",
+    Center = "center"
+}
+export interface ILabelStyle {
+    visible: boolean;
+    content: string;
+    fontSize: number;
+    color: string;
+    align: LabelAlignEnum;
+    bold: boolean;
+    family: string;
+    strikethrough: boolean;
+    italic: boolean;
+    underline: boolean;
+    padAngle: boolean;
+    axisTitleAlign?: AxisAlignEnum | undefined;
+    showMaxLabel?: boolean;
+    showMinLabel?: boolean;
+}
+export interface ISeriesLabelStyle extends ILabelStyle {
+    contentType: number;
+    position: SeriesLabelPosition;
+}
+export interface IPieLabelStyle extends Omit<ILabelStyle, 'align' | 'content'> {
+    contentType: number;
+    position: PieLabelPosition;
+}
+export declare enum LinePointShape {
+    Circle = "circle",
+    Square = "square",
+    Triangle = "triangle",
+    Diamond = "diamond"
+}
+export interface IPointStyle {
+    shape: LinePointShape;
+    size: number;
+    color: Nullable<string>;
+}
+export interface IDataPointStyle extends IPointStyle {
+}
+export declare enum ChartBorderDashType {
+    Solid = "solid",
+    Dashed = "dashed",
+    Dotted = "dotted"
+}
+export declare enum ChartCartesianAxisPosition {
+    Left = "left",
+    Right = "right"
+}
+export interface ISeriesStyle {
+    chartType?: ChartTypeBits.Line | ChartTypeBits.Column | ChartTypeBits.Area;
+    rightYAxis?: boolean;
+    color: Nullable<string>;
+    fillOpacity: number;
+    border: {
+        opacity: number;
+        color: Nullable<string>;
+        width: number;
+        dashType: ChartBorderDashType;
+    };
+    label: ISeriesLabelStyle;
+    point: IPointStyle;
+    dataPoints: {
+        [index: number]: IDataPointStyle;
+    };
+}
+export interface IAllSeriesStyle extends Pick<ISeriesStyle, 'border' | 'label' | 'rightYAxis' | 'point' | 'color'> {
+}
+export declare enum StackType {
+    Stacked = "0",
+    Percent = "1"
+}
+export declare enum TextVerticalAlign {
+    Top = "top",
+    Middle = "middle",
+    Bottom = "bottom"
+}
+export declare enum TextAlign {
+    Left = "left",
+    Center = "center",
+    Right = "right"
+}
+export declare enum LegendPositionEnum {
+    Top = "top",
+    Left = "left",
+    Right = "right",
+    Bottom = "bottom",
+    Hide = "hide"
+}
+export declare enum TitlePositionEnum {
+    Top = "top",
+    Left = "left",
+    Right = "right",
+    Bottom = "bottom",
+    Hide = "hide"
+}
+export declare enum AxisAlignEnum {
+    Start = "start",
+    Center = "center",
+    End = "end"
+}
+export interface ILegendStyle {
+    position?: LegendPositionEnum;
+    label?: Omit<ILabelStyle, 'visible' | 'align' | 'content'>;
+}
+export interface IGridLineStyle {
+    visible: boolean;
+    color: string;
+    width: number;
+}
+export interface IAxisOptions {
+    lineVisible: boolean;
+    label: Omit<ILabelStyle, 'align' | 'content'>;
+    gridLine: IGridLineStyle;
+    tick: {
+        visible: boolean;
+        lineWidth: number;
+        lineColor: string;
+        length: number;
+        position: PieLabelPosition;
+    };
+    reverse?: boolean;
+    min?: number | null;
+    max?: number | null;
+}
+export type RightYAxisOptions = Omit<IAxisOptions, 'reverse'>;
+export declare enum AreaLineStyle {
+    Line = "line",
+    Smooth = "smooth",
+    Step = "step"
+}
+export declare enum InvalidValueType {
+    Zero = "zero",
+    Break = "break",
+    Link = "link"
+}
+export interface IChartStyle {
+    runtime: IChartRuntimeContext;
+    width: number;
+    height: number;
+    theme: string;
+    invalidValueType: InvalidValueType;
+    gradientFill: boolean;
+    backgroundColor: Nullable<string>;
+    titleFontSize: number;
+    fontSize: number;
+    fontColor: string;
+    borderColor: Nullable<string>;
+    titles: {
+        title: Omit<ILabelStyle, 'visible'>;
+        subtitle: Omit<ILabelStyle, 'visible'>;
+        xAxisTitle: Omit<ILabelStyle, 'visible'>;
+        yAxisTitle: Omit<ILabelStyle, 'visible'>;
+        rightYAxisTitle: Omit<ILabelStyle, 'visible'>;
+        titlePosition: TitlePositionEnum;
+    };
+    legend: ILegendStyle;
+    xAxis: IAxisOptions;
+    yAxis: IAxisOptions;
+    rightYAxis: RightYAxisOptions;
+    allSeriesStyle: IAllSeriesStyle;
+    seriesStyleMap: {
+        [id: string]: ISeriesStyle;
+    };
+    pie: {
+        doughnutHole: Nullable<number>;
+        labelStyle: IPieLabelStyle;
+        borderColor: string;
+        hasPaddingAngle: boolean;
+        isHalfPie: boolean;
+        rosePie: boolean;
+        showLabelLine: boolean;
+    };
+    area: {
+        lineStyle: AreaLineStyle;
+    };
+    radar: {
+        shape: RadarShape;
+        fill: boolean;
+    };
+}
+export type ChartStyle = DeepPartial<IChartStyle>;