@univerjs-pro/sheets-chart-ui 0.19.0 → 0.20.0

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

@@ -1,160 +0,0 @@
-import type { AreaLineStyle, LinePointShape } from '@univerjs-pro/engine-chart';
-import type { Injector, Workbook } from '@univerjs/core';
-import type { IChartBuilderInfo } from './chart-builder-base';
-import { FChartBuilderBase } from './chart-builder-base';
-/**
- * The builder for creating a line chart.
- * @hideconstructor
- */
-export declare class LineChartBuilder extends FChartBuilderBase {
-    /**
-     * @property {AreaLineStyle} lineStyle The line style of the line chart.
-     */
-    lineStyle: AreaLineStyle;
-    /**
-     * @property {LinePointShape} dataPointShape The shape of the data point in the line chart.
-     */
-    dataPointShape: LinePointShape;
-    /**
-     * @property {string} dataPointColor The color of the data point in the line chart.
-     */
-    dataPointColor: string;
-    /**
-     * @property {number} dataPointSize The size of the data point in the line chart.
-     */
-    dataPointSize: number;
-    constructor(unitId: string, subUnitId: string, workbook: Workbook, injector: Injector, chartId?: string);
-    /**
-     * The line style of the area chart.
-     * @param {AreaLineStyle} lineStyle The line style of the line chart.
-     * @returns {LineChartBuilder} - The builder, for chaining.
-     *
-     * @example
-     * ```ts
-     * const fWorkbook = univerAPI.getActiveWorkbook();
-     * const fWorksheet = fWorkbook.getActiveSheet();
-     *
-     * // Create a line chart builder with data source A1:D6.
-     * // The starting position is upper-left corner of cell B2.
-     * // The line style is set to the step type.
-     * const chartInfo = fWorksheet.newChart()
-     *   .asLineChart()
-     *   .addRange('A1:D6')
-     *   .setPosition(1, 1, 0, 0)
-     *   .setLineStyle('step')
-     *   .build();
-     * await fWorksheet.insertChart(chartInfo);
-     * ```
-     */
-    setLineStyle(lineStyle: AreaLineStyle): this;
-    /**
-     * The shape of the data point in the line chart.
-     * @param {LinePointShape} dataPointShape The shape of the data point in the line chart.
-     * @returns {LineChartBuilder} - The builder, for chaining.
-     *
-     * @example
-     * ```ts
-     * const fWorkbook = univerAPI.getActiveWorkbook();
-     * const fWorksheet = fWorkbook.getActiveSheet();
-     *
-     * // Create a line chart with data source A1:D6.
-     * // The starting position is upper-left corner of cell B2.
-     * // The data point shape is set to circle, color is red, and size is 10.
-     * const chartInfo = fWorksheet.newChart()
-     *   .asLineChart()
-     *   .addRange('A1:D6')
-     *   .setPosition(1, 1, 0, 0)
-     *   .setDataPointShape(univerAPI.Enum.LinePointShape.CIRCLE)
-     *   .setDataPointColor('#ff0000')
-     *   .setDataPointSize(10)
-     *   .build();
-     * await fWorksheet.insertChart(chartInfo);
-     * ```
-     */
-    setDataPointShape(dataPointShape: LinePointShape): this;
-    /**
-     * The color of the data point in the line chart.
-     * @param {string} dataPointColor The color of the data point in the line chart.
-     * @returns {LineChartBuilder}  The builder, for chaining.
-     *
-     * @example
-     * ```ts
-     * const fWorkbook = univerAPI.getActiveWorkbook();
-     * const fWorksheet = fWorkbook.getActiveSheet();
-     *
-     * // Create a line chart with data source A1:D6.
-     * // The starting position is upper-left corner of cell B2.
-     * // The data point shape is set to circle, color is red, and size is 10.
-     * const chartInfo = fWorksheet.newChart()
-     *   .asLineChart()
-     *   .addRange('A1:D6')
-     *   .setPosition(1, 1, 0, 0)
-     *   .setDataPointShape(univerAPI.Enum.LinePointShape.CIRCLE)
-     *   .setDataPointColor('#ff0000')
-     *   .setDataPointSize(10)
-     *   .build();
-     * await fWorksheet.insertChart(chartInfo);
-     * ```
-     */
-    setDataPointColor(dataPointColor: string): this;
-    /**
-     * The size of the data point in the line chart.
-     * @param {number} dataPointSize The size of the data point in the line chart.
-     * @returns {LineChartBuilder} The builder, for chaining.
-     *
-     * @example
-     * ```ts
-     * const fWorkbook = univerAPI.getActiveWorkbook();
-     * const fWorksheet = fWorkbook.getActiveSheet();
-     *
-     * // Create a line chart with data source A1:D6.
-     * // The starting position is upper-left corner of cell B2.
-     * // The data point shape is set to circle, color is red, and size is 10.
-     * const chartInfo = fWorksheet.newChart()
-     *   .asLineChart()
-     *   .addRange('A1:D6')
-     *   .setPosition(1, 1, 0, 0)
-     *   .setDataPointShape(univerAPI.Enum.LinePointShape.CIRCLE)
-     *   .setDataPointColor('#ff0000')
-     *   .setDataPointSize(10)
-     *   .build();
-     * await fWorksheet.insertChart(chartInfo);
-     * ```
-     */
-    setDataPointSize(dataPointSize: number): this;
-    /**
-     * Builds the chart to reflect all changes made to it.
-     * @description This method does not automatically draw the chart on top of the spreadsheet. A new chart must be inserted via sheet.insertChart(chart), and an existing chart should be updated via sheet.updateChart(chart).
-     * @returns {IChartBuilderInfo} The chart builder info.
-     *
-     * @example
-     * ```ts
-     * @example
-     * ```ts
-     * const fWorkbook = univerAPI.getActiveWorkbook();
-     * const fWorksheet = fWorkbook.getActiveSheet();
-     *
-     * // Create a line chart with data source A1:D6.
-     * // The starting position is upper-left corner of cell B2.
-     * // The line style is set to the step type.
-     * // The data point shape is set to circle, color is red, and size is 10.
-     * const chartInfo = fWorksheet.newChart()
-     *   .asLineChart()
-     *   .addRange('A1:D6')
-     *   .setPosition(1, 1, 0, 0)
-     *   .setLineStyle('step')
-     *   .setDataPointShape(univerAPI.Enum.LinePointShape.CIRCLE)
-     *   .setDataPointColor('#ff0000')
-     *   .setDataPointSize(10)
-     *   .build();
-     * await fWorksheet.insertChart(chartInfo);
-     * ```
-     */
-    build(): IChartBuilderInfo;
-}
-/**
- * @ignore
- */
-export declare class LineChartBuilderMixin extends FChartBuilderBase {
-    asLineChart(): LineChartBuilder;
-}

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

@@ -1,189 +0,0 @@
-import type { Injector, Workbook } from '@univerjs/core';
-import type { IChartBuilderInfo } from './chart-builder-base';
-import { FChartBuilderBase } from './chart-builder-base';
-/**
- * The builder for creating a pie chart.
- * @hideconstructor
- */
-export declare class PieChartBuilder extends FChartBuilderBase {
-    doughnutHole: number;
-    borderColor: string;
-    hasPaddingAngle: boolean;
-    isHalfPie: boolean;
-    rosePie: boolean;
-    showLabelLine: boolean;
-    constructor(unitId: string, subUnitId: string, workbook: Workbook, injector: Injector, chartId?: string);
-    /**
-     * Sets the size of the hole in the center of the pie chart as a percentage of the chart size.The value should be in the range 0-1.
-     * @param {number} doughnutHole The size of the hole in the center of the pie chart as a percentage of the chart size.
-     * @returns {PieChartBuilder} this builder, for chaining.
-     *
-     * @example
-     * ```ts
-     * const fWorkbook = univerAPI.getActiveWorkbook();
-     * const fWorksheet = fWorkbook.getActiveSheet();
-     *
-     * // Create a pie chart with data source A1:D6.
-     * // The starting position is upper-left corner of cell B2.
-     * // The doughnut hole is set to 0.5.
-     * const chartInfo = fWorksheet.newChart()
-     *   .asPieChart()
-     *   .addRange('A1:D6')
-     *   .setPosition(1, 1, 0, 0)
-     *   .setDoughnutHole(0.5)
-     *   .build();
-     * await fWorksheet.insertChart(chartInfo);
-     * ```
-     */
-    setDoughnutHole(doughnutHole: number): this;
-    /**
-     * Sets the color of the border around the pie chart.
-     * @param {string} borderColor The color of the border around the pie chart.
-     * @returns {PieChartBuilder} this builder, for chaining.
-     *
-     * @example
-     * ```ts
-     * const fWorkbook = univerAPI.getActiveWorkbook();
-     * const fWorksheet = fWorkbook.getActiveSheet();
-     *
-     * // Create a pie chart with data source A1:D6.
-     * // The starting position is upper-left corner of cell B2.
-     * // The border color is set to red.
-     * const chartInfo = fWorksheet.newChart()
-     *   .asPieChart()
-     *   .addRange('A1:D6')
-     *   .setPosition(1, 1, 0, 0)
-     *   .setBorderColor('#ff0000')
-     *   .build();
-     * await fWorksheet.insertChart(chartInfo);
-     * ```
-     */
-    setBorderColor(borderColor: string): this;
-    /**
-     * Sets whether the pie chart has a padding angle.
-     * @param {boolean} hasPaddingAngle True if the pie chart has a padding angle; false otherwise.
-     * @returns {PieChartBuilder} this builder, for chaining.
-     *
-     * @example
-     * ```ts
-     * const fWorkbook = univerAPI.getActiveWorkbook();
-     * const fWorksheet = fWorkbook.getActiveSheet();
-     *
-     * // Create a pie chart with data source A1:D6.
-     * // The starting position is upper-left corner of cell B2.
-     * // The pie chart has a padding angle.
-     * const chartInfo = fWorksheet.newChart()
-     *   .asPieChart()
-     *   .addRange('A1:D6')
-     *   .setPosition(1, 1, 0, 0)
-     *   .setHasPaddingAngle(true)
-     *   .build();
-     * await fWorksheet.insertChart(chartInfo);
-     * ```
-     */
-    setHasPaddingAngle(hasPaddingAngle: boolean): this;
-    /**
-     * Sets whether the pie chart is a half pie chart.
-     * @param {boolean} isHalfPie True if the pie chart is a half pie chart; false otherwise.
-     * @returns {PieChartBuilder} this builder, for chaining.
-     *
-     * @example
-     * ```ts
-     * const fWorkbook = univerAPI.getActiveWorkbook();
-     * const fWorksheet = fWorkbook.getActiveSheet();
-     *
-     * // Create a pie chart with data source A1:D6.
-     * // The starting position is upper-left corner of cell B2.
-     * // The pie chart is a half pie chart.
-     * const chartInfo = fWorksheet.newChart()
-     *   .asPieChart()
-     *   .addRange('A1:D6')
-     *   .setPosition(1, 1, 0, 0)
-     *   .setIsHalfPie(true)
-     *   .build();
-     * await fWorksheet.insertChart(chartInfo);
-     * ```
-     */
-    setIsHalfPie(isHalfPie: boolean): this;
-    /**
-     * Sets whether the pie chart is a rose pie chart.
-     * @param {boolean} rosePie True if the pie chart is a rose pie chart; false otherwise.
-     * @returns {PieChartBuilder} this builder, for chaining.
-     *
-     * @example
-     * ```ts
-     * const fWorkbook = univerAPI.getActiveWorkbook();
-     * const fWorksheet = fWorkbook.getActiveSheet();
-     *
-     * // Create a pie chart with data source A1:D6.
-     * // The starting position is upper-left corner of cell B2.
-     * // The pie chart is a rose pie chart.
-     * const chartInfo = fWorksheet.newChart()
-     *   .asPieChart()
-     *   .addRange('A1:D6')
-     *   .setPosition(1, 1, 0, 0)
-     *   .setRosePie(true)
-     *   .build();
-     * await fWorksheet.insertChart(chartInfo);
-     * ```
-     */
-    setRosePie(rosePie: boolean): this;
-    /**
-     * Sets whether the pie chart shows label lines.
-     * @param {boolean} showLabelLine True if the pie chart shows label lines; false otherwise.
-     * @returns {PieChartBuilder} this builder, for chaining.
-     *
-     * @example
-     * ```ts
-     * const fWorkbook = univerAPI.getActiveWorkbook();
-     * const fWorksheet = fWorkbook.getActiveSheet();
-     *
-     * // Create a pie chart with data source A1:D6.
-     * // The starting position is upper-left corner of cell B2.
-     * // The pie chart does not show label lines.
-     * const chartInfo = fWorksheet.newChart()
-     *   .asPieChart()
-     *   .addRange('A1:D6')
-     *   .setPosition(1, 1, 0, 0)
-     *   .setShowLabelLine(false)
-     *   .build();
-     * await fWorksheet.insertChart(chartInfo);
-     * ```
-     */
-    setShowLabelLine(showLabelLine: boolean): this;
-    /**
-     * Builds the chart to reflect all changes made to it.
-     * @description This method does not automatically draw the chart on top of the spreadsheet. A new chart must be inserted via sheet.insertChart(chart), and an existing chart should be updated via sheet.updateChart(chart).
-     * @returns {IChartBuilderInfo} The chart builder info.
-     *
-     * @example
-     * ```ts
-     * const fWorkbook = univerAPI.getActiveWorkbook();
-     * const fWorksheet = fWorkbook.getActiveSheet();
-     *
-     * // Create a pie chart with data source A1:D6.
-     * // The starting position is upper-left corner of cell B2.
-     * // The doughnut hole is set to 0.5.
-     * // The border color is set to red.
-     * // The pie chart has a padding angle.
-     * // The pie chart is a half pie chart.
-     * const chartInfo = fWorksheet.newChart()
-     *   .asPieChart()
-     *   .addRange('A1:D6')
-     *   .setPosition(1, 1, 0, 0)
-     *   .setDoughnutHole(0.5)
-     *   .setBorderColor('#ff0000')
-     *   .setHasPaddingAngle(true)
-     *   .setIsHalfPie(true)
-     *   .build();
-     * await fWorksheet.insertChart(chartInfo);
-     * ```
-     */
-    build(): IChartBuilderInfo;
-}
-/**
- * @ignore
- */
-export declare class PieChartBuilderMixin extends FChartBuilderBase {
-    asPieChart(): PieChartBuilder;
-}

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

@@ -1,97 +0,0 @@
-import type { RadarShape } from '@univerjs-pro/engine-chart';
-import type { Injector, Workbook } from '@univerjs/core';
-import type { IChartBuilderInfo } from './chart-builder-base';
-import { FChartBuilderBase } from './chart-builder-base';
-/**
- * The builder for creating a radar chart.
- *  @hideconstructor
- */
-export declare class RadarChartBuilder extends FChartBuilderBase {
-    /**
-     * @property {RadarShape} shape The shape of the radar chart. The possible values are 'Polygon' and 'Circle'.
-     */
-    shape: RadarShape;
-    /**
-     * @property {boolean} fill True if the radar chart is filled; false otherwise.
-     */
-    fill: boolean;
-    constructor(unitId: string, subUnitId: string, workbook: Workbook, injector: Injector, chartId?: string);
-    /**
-     * Sets the shape of the radar chart.
-     * @param {RadarShape} shape The shape of the radar chart.
-     * @returns {RadarChartBuilder} this builder, for chaining.
-     *
-     * @example
-     * ```ts
-     * const fWorkbook = univerAPI.getActiveWorkbook();
-     * const fWorksheet = fWorkbook.getActiveSheet();
-     *
-     * // Create a radar chart with data source A1:D6.
-     * // The starting position is upper-left corner of cell B2.
-     * // The shape of the radar chart is set to polygon and filled with red color.
-     * const chartInfo = fWorksheet.newChart()
-     *   .asRadarChart()
-     *   .addRange('A1:D6')
-     *   .setPosition(1, 1, 0, 0)
-     *   .setShape(univerAPI.Enum.RadarShape.Polygon)
-     *   .setFill(true)
-     *   .build();
-     * await fWorksheet.insertChart(chartInfo);
-     * ```
-     */
-    setShape(shape: RadarShape): this;
-    /**
-     * Sets whether the radar chart is filled.
-     * @param {boolean} fill True if the radar chart is filled; false otherwise.
-     * @returns {RadarChartBuilder} this builder, for chaining.
-     *
-     * @example
-     * ```ts
-     * const fWorkbook = univerAPI.getActiveWorkbook();
-     * const fWorksheet = fWorkbook.getActiveSheet();
-     *
-     * // Create a radar chart with data source A1:D6.
-     * // The starting position is upper-left corner of cell B2.
-     * // The shape of the radar chart is set to polygon and filled with red color.
-     * const chartInfo = fWorksheet.newChart()
-     *   .asRadarChart()
-     *   .addRange('A1:D6')
-     *   .setPosition(1, 1, 0, 0)
-     *   .setShape(univerAPI.Enum.RadarShape.Polygon)
-     *   .setFill(true)
-     *   .build();
-     * await fWorksheet.insertChart(chartInfo);
-     * ```
-     */
-    setFill(fill: boolean): this;
-    /**
-     * Builds the chart to reflect all changes made to it.
-     * @description This method does not automatically draw the chart on top of the spreadsheet. A new chart must be inserted via sheet.insertChart(chart), and an existing chart should be updated via sheet.updateChart(chart).
-     * @returns {IChartBuilderInfo} The chart builder info.
-     *
-     * @example
-     * ```ts
-     * const fWorkbook = univerAPI.getActiveWorkbook();
-     * const fWorksheet = fWorkbook.getActiveSheet();
-     *
-     * // Create a radar chart with data source A1:D6.
-     * // The starting position is upper-left corner of cell B2.
-     * // The shape of the radar chart is set to polygon and filled with red color.
-     * const chartInfo = fWorksheet.newChart()
-     *   .asRadarChart()
-     *   .addRange('A1:D6')
-     *   .setPosition(1, 1, 0, 0)
-     *   .setShape(univerAPI.Enum.RadarShape.Polygon)
-     *   .setFill(true)
-     *   .build();
-     * await fWorksheet.insertChart(chartInfo);
-     * ```
-     */
-    build(): IChartBuilderInfo;
-}
-/**
- * @ignore
- */
-export declare class RadarChartBuilderMixin extends FChartBuilderBase {
-    asRadarChart(): RadarChartBuilder;
-}

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

@@ -1,34 +0,0 @@
-import type { LineChartBuilder } from './line-chart-builder';
-import type { PieChartBuilder } from './pie-chart-builder';
-import type { RadarChartBuilder } from './radar-chart-builder';
-/**
- * @ignore
- */
-export interface IPieChartBuilderMixin {
-    asPieChart(): PieChartBuilder;
-}
-/**
- * @ignore
- */
-export interface IRadarChartBuilderMixin {
-    asRadarChart(): RadarChartBuilder;
-}
-/**
- * @ignore
- */
-export interface ILineChartBuilderMixin {
-    asLineChart(): LineChartBuilder;
-}
-/**
- * @ignore
- */
-export interface IPieChartBuilderInfo {
-    pie?: {
-        doughnutHole: number;
-        borderColor: string;
-        hasPaddingAngle: boolean;
-        isHalfPie: boolean;
-        rosePie: boolean;
-        showLabelLine: boolean;
-    };
-}

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

@@ -1,127 +0,0 @@
-import type { IChartDataCategory, IChartDataSeries } from '@univerjs-pro/engine-chart';
-import type { ISheetChartSourceSingleRange } from '@univerjs-pro/sheets-chart';
-import type { Injector } from '@univerjs/core';
-import { FChartBuilderBase } from './chart-builder/chart-builder-base';
-/**
- * The facade class for the chart.
- * @hideconstructor
- */
-export declare class FChart {
-    /**
-     * @ignore
-     */
-    unitId: string;
-    /**
-     * @ignore
-     */
-    subUnitId: string;
-    /**
-     * @ignore
-     */
-    chartId: string;
-    private _injector;
-    constructor(unitId: string, subUnitId: string, chartId: string, injector: Injector);
-    /**
-     * Get the chart id.
-     * @returns {string} The chart id.
-     *
-     * @example
-     * ```ts
-     * const fWorkbook = univerAPI.getActiveWorkbook();
-     * const fWorksheet = fWorkbook.getActiveSheet();
-     * const charts = fWorksheet.getCharts();
-     * console.log(charts[0]?.getChartId());
-     * ```
-     */
-    getChartId(): string;
-    /**
-     * Get the range of the chart.
-     * @returns {ISheetChartSourceSingleRange|undefined} The range of the chart.
-     *
-     * @example
-     * ```ts
-     * const fWorkbook = univerAPI.getActiveWorkbook();
-     * const fWorksheet = fWorkbook.getActiveSheet();
-     * const charts = fWorksheet.getCharts();
-     * console.log(charts[0]?.getRange());
-     * ```
-     */
-    getRange(): ISheetChartSourceSingleRange | undefined;
-    /**
-     * Update the range info of the chart. The range info includes the range of the chart and the direction in source.
-     * @param {ISheetChartSourceSingleRange} rangeInfo The new range of the chart.
-     * @param {IRange} rangeInfo.range.range The new range of the chart.
-     * @param {string} rangeInfo.range.subUnitId The new sheet id of the chart.
-     * @param {string} rangeInfo.range.unitId The new workbook id of the chart.
-     * @param {boolean} [rangeInfo.isRowDirection] Is treat row as category.
-     * @returns {Promise<boolean>} Whether the update is successful.
-     *
-     * @example
-     * ```ts
-     * const fWorkbook = univerAPI.getActiveWorkbook();
-     * const fWorksheet = fWorkbook.getActiveSheet();
-     *
-     * // Get all charts on the active sheet.
-     * const charts = fWorksheet.getCharts();
-     *
-     * // Switch chart row direction
-     * if (charts.length > 0){
-     *   const rangeInfo = { ...charts[0].getRange() };
-     *   rangeInfo.isRowDirection = !rangeInfo.isRowDirection;
-     *   charts[0].updateRange(rangeInfo);
-     * }
-     * ```
-     */
-    updateRange(rangeInfo: ISheetChartSourceSingleRange): Promise<boolean>;
-    /**
-     * Get the series data list of the chart.
-     * @typedef ChartSeriesData
-     * @property {string} name The name of the series.
-     * @property {number} index The index of the series.
-     * @property {ChartSeriesItem[]} items The data of the series.
-     * @property {number} items.value The value of the series.
-     * @property {string} items.label The label of the series.
-     * @returns {IChartDataSeries[]|undefined} The series data list of the chart.
-     *
-     * @example
-     * ```ts
-     * const fWorkbook = univerAPI.getActiveWorkbook();
-     * const fWorksheet = fWorkbook.getActiveSheet();
-     * const charts = fWorksheet.getCharts();
-     * if (charts.length > 0){
-     *   const seriesData = charts[0].getSeriesData();
-     *   console.log(seriesData);
-     * }
-     * ```
-     */
-    getSeriesData(): IChartDataSeries[] | undefined;
-    /**
-     * Get the category data of the chart.
-     * @type ChartCategoryData
-     * @property {string} name The name of the category.
-     * @property {number} index The index of the category.
-     * @property {CategoryType} type The type of the category.
-     * @property {string[]} keys The keys of the category.
-     * @property {IChartDataItem[]} items The data of the category.
-     * @property {number} items.value The value of the category.
-     * @property {string} items.label The label of the category.
-     * @returns The category data of the chart.
-     *
-     * @example
-     * ```ts
-     * const fWorkbook = univerAPI.getActiveWorkbook();
-     * const fWorksheet = fWorkbook.getActiveSheet();
-     * const charts = fWorksheet.getCharts();
-     * if (charts.length > 0){
-     *   const categoryData = charts[0].getCategoryData();
-     *   console.log(categoryData);
-     * }
-     * ```
-     */
-    getCategoryData(): IChartDataCategory | undefined;
-    /**
-     * Returns a new FChartBuilderBase instance that modifies this chart.
-     * @returns {FChartBuilderBase} The new FChartBuilderBase instance.
-     */
-    modify(): FChartBuilderBase;
-}