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

package/lib/types/facade/chart-facade-types.d.ts

@@ -1,393 +0,0 @@
-import type { ChartBorderDashType, ChartStyle, IChartDataCategory, IChartDataSeries, IEchartTheme, LabelContentType, LinePointShape, RadarShape, WordCloudShapeEnum } from '@univerjs-pro/engine-chart';
-import type { IRange } from '@univerjs/core';
-import type { FChart } from './f-chart';
-export type DeepReadonly<T> = T extends (...args: any[]) => unknown ? T : T extends readonly (infer U)[] ? readonly DeepReadonly<U>[] : T extends object ? {
-    readonly [K in keyof T]: DeepReadonly<T[K]>;
-} : T;
-export type DeepPartial<T> = T extends (...args: any[]) => unknown ? T : T extends readonly (infer U)[] ? DeepPartial<U>[] : T extends object ? {
-    [K in keyof T]?: DeepPartial<T[K]>;
-} : T;
-export type ChartKnownTypeName = 'line' | 'column' | 'bar' | 'pie' | 'donut' | 'doughnut' | 'area' | 'radar' | 'scatter' | 'combo' | 'combination' | 'wordCloud';
-export type ChartTypeName = ChartKnownTypeName | 'unsupported';
-export type ChartSourceOrientation = 'auto' | 'row' | 'column' | 'rows' | 'columns' | 'rowsAsSeries' | 'columnsAsSeries';
-export type ChartRangeSpec = string | IRange;
-export type ChartSourceSpec = ChartRangeSpec | {
-    range: ChartRangeSpec;
-    sheetName?: string;
-    sheetId?: string;
-    unitId?: string;
-    orientation?: ChartSourceOrientation;
-};
-export type ChartAnchorSpec = string | {
-    row: number;
-    column: number;
-    rowOffset?: number;
-    columnOffset?: number;
-};
-export interface IChartSizeSpec {
-    width?: number;
-    height?: number;
-}
-export type ChartSizeSpec = IChartSizeSpec;
-export interface IChartLayoutPatch {
-    anchor?: ChartAnchorSpec;
-    position?: {
-        x: number;
-        y: number;
-    };
-    size?: ChartSizeSpec;
-}
-export type ChartLayoutPatch = IChartLayoutPatch;
-export type ChartTitleSpec = string | {
-    text?: string;
-    visible?: boolean;
-    position?: 'top' | 'bottom' | 'left' | 'right';
-    alignment?: 'left' | 'center' | 'right';
-    fontSize?: number;
-    color?: string;
-    bold?: boolean;
-};
-export type ChartLegendSpec = boolean | {
-    visible?: boolean;
-    position?: 'top' | 'bottom' | 'left' | 'right';
-    selectMode?: 'single' | 'multiple' | 'close';
-    fontSize?: number;
-    color?: string;
-    bold?: boolean;
-    italic?: boolean;
-};
-export interface IChartAxisSpec {
-    title?: string;
-    min?: number | null;
-    max?: number | null;
-    reverse?: boolean;
-    line?: {
-        visible?: boolean;
-        color?: string;
-        width?: number;
-    };
-    tick?: {
-        visible?: boolean;
-        color?: string;
-        width?: number;
-        length?: number;
-        position?: 'inside' | 'outside';
-    };
-    format?: string | null;
-    titleStyle?: {
-        color?: string;
-        fontSize?: number;
-        bold?: boolean;
-        italic?: boolean;
-        family?: string;
-    };
-    label?: {
-        visible?: boolean;
-        color?: string;
-        fontSize?: number;
-        rotate?: number;
-    };
-    gridLine?: {
-        visible?: boolean;
-        color?: string;
-        width?: number;
-    };
-}
-export type ChartAxisSpec = IChartAxisSpec;
-export interface IChartAxesSpec {
-    x?: ChartAxisSpec;
-    y?: ChartAxisSpec;
-    rightY?: Omit<ChartAxisSpec, 'reverse'>;
-}
-export type ChartAxesSpec = IChartAxesSpec;
-export type ChartSeriesSelector = {
-    index: number;
-} | {
-    name: string;
-};
-export interface IChartSeriesPatch {
-    selector: ChartSeriesSelector;
-    name?: string;
-    type?: 'column' | 'line' | 'area';
-    color?: string;
-    fillOpacity?: number;
-    border?: {
-        color?: string | null;
-        width?: number;
-        opacity?: number;
-        dashType?: ChartBorderDashType;
-    };
-    point?: {
-        shape?: LinePointShape;
-        size?: number;
-        color?: string | null;
-    };
-    rightAxis?: boolean;
-    label?: {
-        visible?: boolean;
-        position?: 'top' | 'bottom' | 'inside' | 'outside';
-        contentType?: LabelContentType;
-        color?: string;
-        fontSize?: number;
-        bold?: boolean;
-        italic?: boolean;
-    };
-    dataPoints?: Record<number, {
-        shape?: LinePointShape;
-        size?: number;
-        color?: string | null;
-        fillOpacity?: number;
-    }>;
-}
-export type ChartSeriesPatch = IChartSeriesPatch;
-export interface IChartWordCloudSpec {
-    shape?: WordCloudShapeEnum;
-    /**
-     * Stable wordcloud mask resource id/key known to the runtime.
-     *
-     * The public facade intentionally does not recommend arbitrary URL/data URL
-     * input in v1. Legacy URL/data URL values may still appear through rawStyle
-     * for expert/debug compatibility, but normal callers should use registered
-     * mask resource ids.
-     *
-     * Patch semantics:
-     * - omitted/undefined: keep the current mask image setting.
-     * - null: clear the persisted mask image and fall back to shape.
-     * - string: set the mask image id; the mask image takes precedence over shape.
-     */
-    maskImageId?: string | null;
-    repeat?: boolean;
-}
-export type ChartWordCloudSpec = IChartWordCloudSpec;
-export interface IChartWordCloudDescription {
-    shape?: WordCloudShapeEnum;
-    maskImageId?: string;
-    repeat?: boolean;
-    effectiveShapeSource: 'shape' | 'maskImage';
-}
-export type ChartWordCloudDescription = IChartWordCloudDescription;
-export interface IChartAppearanceSpec {
-    background?: {
-        color?: string | null;
-        gradient?: boolean;
-    };
-    border?: {
-        color?: string | null;
-        width?: number;
-    };
-    font?: {
-        color?: string;
-        size?: number;
-        family?: string;
-    };
-}
-export type ChartAppearanceSpec = IChartAppearanceSpec;
-export interface IChartMappingSpec {
-    categoryIndex?: number | null;
-    seriesIndexes?: number[] | null;
-    useDateAxis?: boolean | null;
-    bubble?: {
-        sizeSeriesIndex?: number | null;
-        xAxisIndex?: number | null;
-        yAxisIndex?: number | null;
-        labelIndex?: number | null;
-        seriesIndex?: number | null;
-    };
-}
-export type ChartMappingSpec = IChartMappingSpec;
-export interface IChartAggregationSpec {
-    aggregate?: boolean;
-    topN?: number | null;
-}
-export type ChartAggregationSpec = IChartAggregationSpec;
-export interface IChartPieSpec {
-    doughnutHole?: number | null;
-    borderColor?: string;
-    hasPaddingAngle?: boolean;
-    isHalfPie?: boolean;
-    rosePie?: boolean;
-    showLabelLine?: boolean;
-    valueScale?: number;
-    valueSuffix?: string;
-    digitalFixed?: number;
-    label?: {
-        visible?: boolean;
-        position?: 'inside' | 'outside';
-        contentType?: LabelContentType;
-        color?: string;
-        fontSize?: number;
-        bold?: boolean;
-        italic?: boolean;
-    };
-}
-export type ChartPieSpec = IChartPieSpec;
-export interface IChartRadarSpec {
-    shape?: RadarShape;
-    fill?: boolean;
-}
-export type ChartRadarSpec = IChartRadarSpec;
-export type ChartAdvancedStylePatch = DeepPartial<Pick<ChartStyle, 'tooltip' | 'area' | 'funnel' | 'relation' | 'waterfall'>>;
-export interface IChartCreateSpec {
-    type: ChartKnownTypeName;
-    source: ChartSourceSpec;
-    anchor?: ChartAnchorSpec;
-    position?: {
-        x: number;
-        y: number;
-    };
-    size?: ChartSizeSpec;
-    title?: ChartTitleSpec;
-    legend?: ChartLegendSpec;
-    axes?: ChartAxesSpec;
-    series?: ChartSeriesPatch[];
-    wordCloud?: ChartWordCloudSpec;
-    appearance?: ChartAppearanceSpec;
-    mapping?: ChartMappingSpec;
-    aggregation?: ChartAggregationSpec;
-    pie?: ChartPieSpec;
-    radar?: ChartRadarSpec;
-    advancedStyle?: ChartAdvancedStylePatch;
-    theme?: string;
-}
-export type ChartCreateSpec = IChartCreateSpec;
-export interface IChartUpdatePatch {
-    type?: ChartKnownTypeName;
-    source?: ChartSourceSpec;
-    title?: ChartTitleSpec;
-    legend?: ChartLegendSpec;
-    axes?: ChartAxesSpec;
-    series?: ChartSeriesPatch[];
-    wordCloud?: ChartWordCloudSpec;
-    appearance?: ChartAppearanceSpec;
-    mapping?: ChartMappingSpec;
-    aggregation?: ChartAggregationSpec;
-    pie?: ChartPieSpec;
-    radar?: ChartRadarSpec;
-    advancedStyle?: ChartAdvancedStylePatch;
-    theme?: string;
-    layout?: ChartLayoutPatch;
-}
-export type ChartUpdatePatch = IChartUpdatePatch;
-export type ChartDiagnosticCode = 'CHART_NOT_FOUND' | 'SERIES_NOT_FOUND' | 'AMBIGUOUS_SERIES_SELECTOR' | 'INVALID_RANGE' | 'SINGLE_CELL_SOURCE' | 'NO_NUMERIC_SERIES' | 'UNKNOWN_CHART_TYPE' | 'UNSUPPORTED_CHART_TYPE' | 'INVALID_SIZE' | 'INVALID_COLOR' | 'COMMAND_FAILED' | 'UNKNOWN_OPTION';
-export interface IChartDiagnostic {
-    code: ChartDiagnosticCode;
-    severity: 'error' | 'warning';
-    message: string;
-    path?: string;
-    details?: unknown;
-    allowedValues?: readonly unknown[];
-    suggestion?: string;
-}
-export type ChartDiagnostic = IChartDiagnostic;
-export interface IChartValidationResult<TNormalized = unknown> {
-    ok: boolean;
-    diagnostics: ChartDiagnostic[];
-    normalized?: DeepReadonly<TNormalized>;
-}
-export type ChartValidationResult<TNormalized = unknown> = IChartValidationResult<TNormalized>;
-export interface IChartUpdateResult {
-    ok: boolean;
-    chart: FChart | null;
-    diagnostics: ChartDiagnostic[];
-    changed: Array<'source' | 'type' | 'style' | 'data' | 'layout'>;
-}
-export type ChartUpdateResult = IChartUpdateResult;
-export interface IChartSuggestion {
-    type: ChartKnownTypeName;
-    orientation: 'rows' | 'columns';
-    reason?: string;
-}
-export type ChartSuggestion = IChartSuggestion;
-export interface IChartCapabilities {
-    version: string;
-    chartTypes: readonly ChartKnownTypeName[];
-    patchSemantics: {
-        omitted: 'noChange';
-        undefined: 'noChange';
-        null: 'clearWhereSupported';
-        object: 'semanticMerge';
-        array: 'replaceUnlessSelectorMerge';
-        unknownField: 'validationError';
-    };
-    createGroups: readonly string[];
-    updateGroups: readonly string[];
-    styleGroups: readonly string[];
-    advancedStyle: {
-        supported: boolean;
-    };
-}
-export type ChartCapabilities = IChartCapabilities;
-export interface IChartInstanceCapabilities extends IChartCapabilities {
-    chartId: string;
-    type: ChartTypeName;
-    rawType?: number;
-    unsupportedGroups: readonly string[];
-}
-export type ChartInstanceCapabilities = IChartInstanceCapabilities;
-export interface IChartSourceDescription {
-    range: IRange;
-    sheetName?: string;
-    sheetId: string;
-    unitId: string;
-    orientation: ChartSourceOrientation;
-}
-export type ChartSourceDescription = IChartSourceDescription;
-export interface IChartSeriesDescription {
-    index: number;
-    name: string;
-    type?: 'column' | 'line' | 'area';
-    color?: string | null;
-    fillOpacity?: number;
-    border?: ChartSeriesPatch['border'];
-    point?: ChartSeriesPatch['point'];
-    rightAxis?: boolean;
-    label?: {
-        visible?: boolean;
-        position?: 'top' | 'bottom' | 'inside' | 'outside';
-        contentType?: LabelContentType;
-        color?: string;
-        fontSize?: number;
-        bold?: boolean;
-        italic?: boolean;
-    };
-    dataPoints?: ChartSeriesPatch['dataPoints'];
-    data?: DeepReadonly<IChartDataSeries>;
-}
-export type ChartSeriesDescription = IChartSeriesDescription;
-export interface IChartLayoutDescription {
-    position?: {
-        x: number;
-        y: number;
-    };
-    size?: ChartSizeSpec;
-    anchor?: {
-        row: number;
-        column: number;
-        rowOffset?: number;
-        columnOffset?: number;
-    };
-}
-export type ChartLayoutDescription = IChartLayoutDescription;
-export interface IChartDescription {
-    id: string;
-    type: ChartTypeName;
-    rawType?: number;
-    diagnostics?: ChartDiagnostic[];
-    source: ChartSourceDescription | null;
-    title?: ChartTitleSpec;
-    legend?: ChartLegendSpec;
-    axes?: ChartAxesSpec;
-    wordCloud?: ChartWordCloudDescription;
-    appearance?: ChartAppearanceSpec;
-    mapping?: ChartMappingSpec;
-    aggregation?: ChartAggregationSpec;
-    pie?: ChartPieSpec;
-    radar?: ChartRadarSpec;
-    series: ChartSeriesDescription[];
-    category?: DeepReadonly<IChartDataCategory>;
-    theme?: string;
-    layout?: ChartLayoutDescription;
-    rawStyle?: DeepReadonly<ChartStyle>;
-}
-export type ChartDescription = IChartDescription;
-export type { IEchartTheme };

package/lib/types/facade/f-worksheet.d.ts

@@ -1,205 +0,0 @@
-import type { IEchartTheme } from '@univerjs-pro/engine-chart';
-import type { IChartBuilderInfo } from './chart-builder/chart-builder-base';
-import { FWorksheet } from '@univerjs/sheets/facade';
-import { FChartBuilderBase } from './chart-builder/chart-builder-base';
-import { FChart } from './f-chart';
-/**
- * @ignore
- */
-export interface IFWorksheetChartMixin {
-    /**
-     * Adds a new chart to this sheet.
-     * @param {IChartBuilderInfo} chartBuildInfo - The chart builder info.
-     * @returns {Promise<FChart>} - The new chart.
-     *
-     * @example
-     * ```ts
-     * const fWorkbook = univerAPI.getActiveWorkbook();
-     * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
-     * if (!fWorksheet) return;
-     *
-     * // Create a column chart with data source A1:D6.
-     * // The starting position is upper-left corner of cell B2.
-     * const chartInfo = fWorksheet.newChart()
-     *   .setChartType(univerAPI.Enum.ChartType.Column)
-     *   .addRange('A1:D6')
-     *   .setPosition(1, 1, 0, 0)
-     *   .build();
-     * await fWorksheet.insertChart(chartInfo);
-     * ```
-     */
-    insertChart(chartBuildInfo: IChartBuilderInfo): Promise<FChart>;
-    /**
-     * Updates the chart on this sheet. This api can not update source range, please use FChart.updateRange.
-     * @param {IChartBuilderInfo} chartBuildInfo - The chart builder info.
-     *
-     * @example
-     * ```ts
-     * const fWorkbook = univerAPI.getActiveWorkbook();
-     * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
-     * if (!fWorksheet) return;
-     *
-     * // Create a column chart with data source A1:D6.
-     * // The starting position is upper-left corner of cell B2.
-     * const chartInfo = fWorksheet.newChart()
-     *   .setChartType(univerAPI.Enum.ChartType.Column)
-     *   .addRange('A1:D6')
-     *   .setPosition(1, 1, 0, 0)
-     *   .build();
-     * await fWorksheet.insertChart(chartInfo);
-     *
-     * // Get all charts on the active sheet.
-     * const charts = fWorksheet.getCharts();
-     *
-     * // Update the first chart after 3 seconds.
-     * setTimeout(() => {
-     *   const newChartInfo = fWorksheet.newChart(charts[0])
-     *     .asLineChart()
-     *     .setOptions('legend.position', univerAPI.Enum.LegendPositionEnum.Right)
-     *     .build();
-     *   fWorksheet.updateChart(newChartInfo);
-     * }, 3000);
-     * ```
-     */
-    updateChart(chartBuildInfo: IChartBuilderInfo): void;
-    /**
-     * Returns a builder to create a new chart for this sheet.The builder will not automatically create the chart. You must call build() on the returned builder to create the chart by calling insertChart(chartBuilder).
-     * @description If the fChart is provided, the builder will be initialized with the existing chart's data.
-     * @param {FChart} [fChart] - The chart to update.
-     * @returns {FChartBuilderBase} - a new chart builder
-     *
-     * @example
-     * ```ts
-     * const fWorkbook = univerAPI.getActiveWorkbook();
-     * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
-     * if (!fWorksheet) return;
-     *
-     * // Create a column chart with data source A1:D6.
-     * // The starting position is upper-left corner of cell B2.
-     * // The width of the chart is 600 and the height is 400.
-     * const chartInfo = fWorksheet.newChart()
-     *   .setChartType(univerAPI.Enum.ChartType.Column)
-     *   .addRange('A1:D6')
-     *   .setPosition(1, 1, 0, 0)
-     *   .setWidth(600)
-     *   .setHeight(400)
-     *   .build();
-     * await fWorksheet.insertChart(chartInfo);
-     * ```
-     */
-    newChart(fChart?: FChart): FChartBuilderBase;
-    /**
-     * Returns an array of charts on this sheet.
-     * @returns {FChart[]} - An array of charts on this sheet.
-     *
-     * @example
-     * ```ts
-     * const fWorkbook = univerAPI.getActiveWorkbook();
-     * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
-     * if (!fWorksheet) return;
-     *
-     * // Get all charts on the active sheet.
-     * const charts = fWorksheet.getCharts();
-     * console.log(charts);
-     * ```
-     */
-    getCharts(): FChart[];
-    /**
-     * Removes a chart from the parent sheet.
-     * @param {FChart} chart - The chart to remove.
-     *
-     * @example
-     * ```ts
-     * const fWorkbook = univerAPI.getActiveWorkbook();
-     * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
-     * if (!fWorksheet) return;
-     *
-     * // Create a column chart with data source A1:D6.
-     * // The starting position is upper-left corner of cell B2.
-     * const chartInfo = fWorksheet.newChart()
-     *   .setChartType(univerAPI.Enum.ChartType.Column)
-     *   .addRange('A1:D6')
-     *   .setPosition(1, 1, 0, 0)
-     *   .build();
-     * await fWorksheet.insertChart(chartInfo);
-     *
-     * // Get all charts on the active sheet.
-     * const charts = fWorksheet.getCharts();
-     *
-     * // Remove the first chart after 3 seconds.
-     * setTimeout(async () => {
-     *   await fWorksheet.removeChart(charts[0]);
-     *   console.log(fWorksheet.getCharts());
-     * }, 3000);
-     * ```
-     */
-    removeChart(chart: FChart): Promise<boolean>;
-    /**
-     * Univer chart is base on echarts, you can register your own theme by echart theme builder.
-     * @description The theme object should be a valid echarts theme object.The online builder is available at https://echarts.apache.org/zh/theme-builder.html
-     * @param {string} themeName - The name of the theme.
-     * @param {IEchartTheme} theme - The theme object.
-     *
-     * @example
-     * ```ts
-     * const fWorkbook = univerAPI.getActiveWorkbook();
-     * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
-     * if (!fWorksheet) return;
-     *
-     * // register your theme
-     * const theme = { // your theme object
-     *   'version': 1,
-     *   'themeName': 'myTheme',
-     *   'theme': {
-     *     // ... Some code is omitted for brevity
-     *     color: [
-     *       '#893448',
-     *       '#d95850',
-     *       '#eb8146',
-     *       '#ffb248',
-     *       '#f2d643',
-     *       '#ebdba4'
-     *     ],
-     *     // ... Some code is omitted for brevity
-     *     visualMapColor: [
-     *       '#893448',
-     *       '#d95850',
-     *       '#eb8146',
-     *       '#ffb248',
-     *       '#f2d643',
-     *       'rgb(247,238,173)'
-     *     ],
-     *     // ... Some code is omitted for brevity
-     *     'axes': []
-     *     // ... Some code is omitted for brevity
-     *   }
-     * };
-     * fWorksheet.registerChartTheme('myTheme', theme);
-     *
-     * // use your theme for chart
-     * const chartInfo = fWorksheet.newChart()
-     *   .asLineChart()
-     *   .addRange('A1:D6')
-     *   .setPosition(1, 1, 0, 0)
-     *   .setTheme('myTheme')
-     *   .build();
-     * await fWorksheet.insertChart(chartInfo);
-     * ```
-     */
-    registerChartTheme(themeName: string, theme: IEchartTheme): void;
-}
-export declare class FWorksheetChartMixin extends FWorksheet implements IFWorksheetChartMixin {
-    insertChart(chartBuildInfo: IChartBuilderInfo): Promise<FChart>;
-    updateChart(chartBuilder: IChartBuilderInfo): void;
-    newChart(fChart?: FChart): FChartBuilderBase;
-    getCharts(): FChart[];
-    removeChart(chart: FChart): Promise<boolean>;
-    registerChartTheme(themeName: string, theme: IEchartTheme): void;
-}
-/**
- * @ignore
- */
-declare module '@univerjs/sheets/facade' {
-    interface FWorksheet extends IFWorksheetChartMixin {
-    }
-}