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

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

@@ -1,212 +0,0 @@
-import type { ChartKnownTypeName, ChartModelCapabilities, ChartModelChangedGroup, ChartModelCreateSpec, ChartModelDescription, ChartModelPatch, ChartModelPatchGroup, ChartTypeName, DeepReadonly, FChartDescription, FChartUpdateResult, IChartRenderModelImageExportOptions, IChartRenderModelImageExportResult, IEchartTheme } from '@univerjs-pro/engine-chart';
-import type { IRange } from '@univerjs/core';
-import type { FChart } from './f-chart';
-export declare const ChartSourceOrientation: {
-    readonly Auto: "auto";
-    readonly Row: "row";
-    readonly Column: "column";
-    readonly Rows: "rows";
-    readonly Columns: "columns";
-    readonly RowsAsSeries: "rowsAsSeries";
-    readonly ColumnsAsSeries: "columnsAsSeries";
-};
-export type ChartSourceOrientation = typeof ChartSourceOrientation[keyof typeof ChartSourceOrientation];
-export declare enum ChartSourceKind {
-    Range = "range",
-    Ranges = "ranges"
-}
-export type ChartRangeSpec = string | IRange;
-export interface IChartSourceVectorSpec {
-    /** One row or one column of values. All vectors are aligned by position. */
-    range: ChartRangeSpec;
-    /** Optional single-cell display name. It never consumes a value from `range`. */
-    header?: ChartRangeSpec;
-}
-export type ChartSourceVectorSpec = IChartSourceVectorSpec;
-interface IChartSourceLocationSpec {
-    sheetName?: string;
-    sheetId?: string;
-    unitId?: string;
-    orientation?: ChartSourceOrientation;
-}
-/**
- * Chart data from either one rectangular table or explicit positional vectors.
- * Exactly one of `range` and `ranges` may be provided.
- *
- * @example Single rectangular table
- * ```ts
- * { sheetName: 'Sales', range: 'A1:C7', orientation: 'columns' }
- * ```
- *
- * @example Equal-length positional vectors with optional single-cell headers
- * ```ts
- * {
- *   sheetName: 'Sales',
- *   orientation: 'columns',
- *   ranges: [
- *     { header: 'A1', range: 'A2:A7' },
- *     { header: 'C1', range: 'C2:C7' },
- *   ],
- * }
- * ```
- * Vector array order defines mapping indexes. Vectors must have equal lengths
- * and a common row-or-column orientation; no join or padding is performed.
- */
-export type ChartSourceSpec = ChartRangeSpec | (IChartSourceLocationSpec & {
-    range: ChartRangeSpec;
-    ranges?: never;
-}) | (IChartSourceLocationSpec & {
-    range?: never;
-    ranges: readonly ChartSourceVectorSpec[];
-});
-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 interface IChartCreateSpec extends ChartModelCreateSpec {
-    source: ChartSourceSpec;
-    anchor?: ChartAnchorSpec;
-    position?: {
-        x: number;
-        y: number;
-    };
-    size?: ChartSizeSpec;
-}
-export type ChartCreateSpec = IChartCreateSpec;
-export interface IChartUpdatePatch extends ChartModelPatch {
-    source?: ChartSourceSpec;
-    layout?: ChartLayoutPatch;
-}
-export type ChartUpdatePatch = IChartUpdatePatch;
-export declare const ChartDiagnosticCode: {
-    readonly ChartNotFound: "CHART_NOT_FOUND";
-    readonly SeriesNotFound: "SERIES_NOT_FOUND";
-    readonly AmbiguousSeriesSelector: "AMBIGUOUS_SERIES_SELECTOR";
-    readonly InvalidRange: "INVALID_RANGE";
-    readonly SingleCellSource: "SINGLE_CELL_SOURCE";
-    readonly NoNumericSeries: "NO_NUMERIC_SERIES";
-    readonly NoPositiveParetoValues: "NO_POSITIVE_PARETO_VALUES";
-    readonly UnknownChartType: "UNKNOWN_CHART_TYPE";
-    readonly UnsupportedChartType: "UNSUPPORTED_CHART_TYPE";
-    readonly InvalidSize: "INVALID_SIZE";
-    readonly InvalidColor: "INVALID_COLOR";
-    readonly CommandFailed: "COMMAND_FAILED";
-    readonly UnknownOption: "UNKNOWN_OPTION";
-};
-export type ChartDiagnosticCode = typeof ChartDiagnosticCode[keyof typeof ChartDiagnosticCode];
-export declare enum ChartFacadeHostGroup {
-    Source = "source",
-    Layout = "layout"
-}
-export declare enum ChartFacadeCreateLayoutKey {
-    Anchor = "anchor",
-    Position = "position",
-    Size = "size"
-}
-export type ChartFacadeCapabilityGroup = ChartModelPatchGroup | ChartFacadeHostGroup;
-export type ChartChangedGroup = ChartModelChangedGroup | ChartFacadeHostGroup;
-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 extends FChartUpdateResult<FChart, ChartChangedGroup, ChartDiagnostic> {
-    ok: boolean;
-    chart: FChart | null;
-    diagnostics: ChartDiagnostic[];
-    changed: ChartChangedGroup[];
-}
-export type ChartUpdateResult = IChartUpdateResult;
-export interface IChartSuggestion {
-    type: ChartKnownTypeName;
-    orientation: 'rows' | 'columns';
-    reason?: string;
-}
-export type ChartSuggestion = IChartSuggestion;
-export interface IChartCapabilities extends Omit<ChartModelCapabilities, 'createGroups' | 'updateGroups'> {
-    createGroups: readonly ChartFacadeCapabilityGroup[];
-    updateGroups: readonly ChartFacadeCapabilityGroup[];
-}
-export type ChartCapabilities = IChartCapabilities;
-export interface IChartInstanceCapabilities extends IChartCapabilities {
-    chartId: string;
-    type: ChartTypeName;
-    rawType?: number;
-    unsupportedGroups: readonly ChartFacadeCapabilityGroup[];
-}
-export type ChartInstanceCapabilities = IChartInstanceCapabilities;
-export type ChartExportImageOptions = IChartRenderModelImageExportOptions;
-export type ChartExportImageResult = IChartRenderModelImageExportResult;
-export interface IChartRangeSourceDescription {
-    range: IRange;
-    ranges?: never;
-    sheetName?: string;
-    sheetId: string;
-    unitId: string;
-    orientation: ChartSourceOrientation;
-}
-export interface IChartSourceVectorDescription {
-    range: IChartRangeSourceDescription;
-    header?: IChartRangeSourceDescription;
-}
-export interface IChartMultiRangeSourceDescription {
-    range?: never;
-    ranges: IChartSourceVectorDescription[];
-    orientation: 'rows' | 'columns';
-}
-export type ChartSourceDescription = IChartRangeSourceDescription | IChartMultiRangeSourceDescription;
-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 extends Omit<ChartModelDescription, 'diagnostics'>, FChartDescription<{
-    unitId: string;
-    subUnitId: string;
-    chartId: string;
-}, {
-    kind: ChartSourceKind;
-    source: ChartSourceDescription | null;
-}> {
-    diagnostics?: ChartDiagnostic[];
-    source: ChartSourceDescription | null;
-    layout?: ChartLayoutDescription;
-}
-export type ChartDescription = IChartDescription;
-export type { IEchartTheme };

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

@@ -1,208 +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);
-     * ```
-     * @see {@link FWorksheetCharts.create} for structured specs and validation diagnostics.
-     */
-    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);
-     * ```
-     * @see {@link FChart.update} for semantic merge patches and structured diagnostics.
-     */
-    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);
-     * ```
-     * @see {@link FWorksheetCharts} for the canonical structured chart Interface.
-     */
-    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 {
-    }
-}