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

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

@@ -1,899 +0,0 @@
-import type { AreaLineStyle, AxisAlignEnum, ChartBorderDashType, ChartTypeBits, IAllSeriesStyle, IAxisOptions, InvalidValueType, ISeriesStyle, LabelAlignEnum, LegendPositionEnum, RadarShape, SelectModeEnum, TitlePositionEnum } from '@univerjs-pro/engine-chart';
-import type { Injector, IRange, Workbook } from '@univerjs/core';
-import { FBase } from '@univerjs/core/facade';
-/**
- * The chart builder info.
- */
-export interface IChartBuilderInfo {
-    /**
-     * @property {string} unitId The workbook id where the chart is located.
-     */
-    unitId: string;
-    /**
-     * @property {string} subUnitId The worksheet id where the chart is located.
-     */
-    subUnitId: string;
-    /**
-     * @property {string} chartId The id of the chart.
-     */
-    chartId: string;
-    /**
-     * @property {IRange} range The data source range of the chart.
-     */
-    range: IRange | undefined;
-    /**
-     * @property {string} sourceSheetName The name of the worksheet which the data source range of the chart belongs to.
-     * If not set, the data source range is in the current active worksheet.
-     */
-    sourceSheetName: string | undefined;
-    /**
-     * @property {number} x The x-coordinate of the chart.
-     */
-    x: number;
-    /**
-     * @property {number} y The y-coordinate of the chart.
-     */
-    y: number;
-    /**
-     * @property {number} width The width of the chart.
-     */
-    width: number;
-    /**
-     * @property {number} height The height of the chart.
-     */
-    height: number;
-    /**
-     * @property {ChartTypeBits} chartType The type of the chart.
-     */
-    chartType: ChartTypeBits;
-    /**
-     * @property {IChartBuildOptions} options The options of the chart.
-     */
-    options: IChartBuildOptions;
-    /**
-     * @property {boolean} isRowDirection Whether to read the data in the range as row direction.
-     */
-    isRowDirection: boolean;
-}
-/**
- * The chart text style.
- */
-export interface IChartTextStyle {
-    /**
-     * @property {string} [titleContent] The content of the chart title.
-     */
-    content?: string;
-    /**
-     * @property {number} [font] The font family for the chart title.
-     */
-    font?: number;
-    /**
-     * @property {number} [fontSize] The font size for the chart title.
-     */
-    fontSize?: number;
-    /**
-     * @property {string} [fontColor] The font color for the chart title.
-     */
-    fontColor?: string;
-    /**
-     * @property {string} [fontStyle] The font style for the chart title.
-     */
-    fontStyle?: string;
-    /**
-     * @property {boolean} [bold] The font is bold.
-     */
-    bold?: boolean;
-    /**
-     * @property {AxisAlignEnum} [axisAlignment] The alignment of the chart axis.The possible values are 'start', 'center' & 'end'.
-     */
-    axisAlignment?: AxisAlignEnum;
-}
-/**
- * The chart build options.
- */
-export interface IChartBuildOptions {
-    /**
-     * @property {string} [title] The title of the chart.
-     */
-    title?: {
-        /**
-         * @property {string} [titlePosition] The position of the chart title.
-         */
-        position?: TitlePositionEnum;
-        /**
-         * @property {string} [titleAlignment] The alignment of the chart title.The possible values are 'left', 'center' & 'right'.
-         */
-        titleAlignment: LabelAlignEnum;
-    } & IChartTextStyle;
-    /**
-     * @property {string} [legend] The legend of the chart.
-     */
-    legend?: {
-        /**
-         * @property {string} [legendPosition] The position of the legend.The possible values are 'top', 'bottom', 'left', 'right' & 'hide'.
-         */
-        position?: LegendPositionEnum;
-        /**
-         * @property {number} [fontSize] The font size of the legend.
-         */
-        fontSize?: number;
-        /**
-         * @property {string} [color] The font color of the legend.
-         */
-        color?: string;
-        /**
-         * @property {string} [bold] The font style of the legend.
-         */
-        bold?: boolean;
-        /**
-         * @property {string} [italic] The font weight of the legend.
-         */
-        italic?: boolean;
-        /**
-         * @property {SelectModeEnum} [selectMode] The select mode of the legend.The possible values are 'single', 'multiple' & 'close'.
-         */
-        selectMode?: SelectModeEnum;
-    };
-    /**
-     * @property {string} [xAxisTitle] The x-axis title of the chart.
-     *
-     * @example
-     * ```ts
-     * chartBuilder.setOptions('xAxisTitle.content', 'xAxis Title text')
-     * .setOptions('xAxisTitle.font', 1)
-     * .setOptions('xAxisTitle.fontSize', 12)
-     * .setOptions('xAxisTitle.fontColor', '#ff0000')
-     * .build();
-     * ```
-     */
-    xAxisTitle?: IChartTextStyle;
-    /**
-     * @property {string} [rightYAxisTitle] The right y-axis title of the chart.
-     */
-    yAxisTitle?: IChartTextStyle;
-    /**
-     * @property {string} [rightYAxisTitle] The right y-axis title of the chart.
-     */
-    rightYAxisTitle?: IChartTextStyle;
-    /**
-     * @property {IAxisOptions} [xAxis] The x-axis option of the chart.
-     */
-    xAxis?: IAxisOptions;
-    /**
-     * @property {IAxisOptions} [yAxis] The y-axis option of the chart.
-     */
-    yAxis?: IAxisOptions;
-    /**
-     * @property {IAxisOptions} [yRightAxis] The right y-axis option of the chart.
-     */
-    yRightAxis?: IAxisOptions;
-    /**
-     * The axis pointer of the chart.
-     */
-    axisPointer?: {
-        /**
-         * @property {string} [indicatorLineType] The line type of the axis pointer.
-         */
-        indicatorLineType?: string;
-        /**
-         * @property {ChartBorderDashType} [indicatorLineColor] The line color of the axis pointer.The maybe values are 'solid', 'dotted', 'dashed'.
-         */
-        indicatorLineColor?: ChartBorderDashType;
-        /**
-         * @property {string} [indicatorLabelColor] The line width of the axis pointer.
-         */
-        indicatorLabelColor?: string;
-        /**
-         * @property {string} [indicatorLabelTextColor] The font color of the axis pointer.
-         */
-        indicatorLabelTextColor?: string;
-    };
-    /**
-     * @property {IAllSeriesStyle} [allSeriesStyle] The style of all series.
-     */
-    allSeriesStyle?: Partial<IAllSeriesStyle>;
-    /**
-     * @property {string} [seriesStyleMap] The style of the series.
-     */
-    seriesStyleMap?: {
-        [id: string]: ISeriesStyle;
-    };
-    /**
-     * @property {string} [area] The area of line/area chart.
-     */
-    area?: {
-        lineStyle: AreaLineStyle;
-    };
-    /**
-     * @property {string} [backgroundColor] The background color of the chart.
-     */
-    backgroundColor?: string;
-    /**
-     * @property {string} [borderColor] The border color of the chart.
-     */
-    borderColor?: string;
-    /**
-     * @property {boolean} [gradientFill] Whether to fill the chart with a gradient.
-     */
-    gradientFill?: boolean;
-    /**
-     * @property {string} [theme] The theme of the chart.
-     */
-    theme?: string;
-    /**
-     * @property {InvalidValueType} [invalidValueType] The invalid value type of the chart.
-     */
-    invalidValueType?: InvalidValueType;
-    /**
-     * @property {RadarShape} [radar] The radar of the chart.
-     */
-    radar?: {
-        /**
-         * @property {RadarShape} [shape] The shape of the radar chart.
-         */
-        shape?: RadarShape;
-        /**
-         * @property {boolean} [fill] True if the radar chart is filled; false otherwise.
-         */
-        fill?: boolean;
-    };
-}
-/**
- * The base class for chart builder.The chart builder is used to create a chart in the sheet.For line chart , radar chart and pie chart, you use the LineChartBuilder, RadarChartBuilder and PieChartBuilder classes respectively.
- * @ignore
- * @hideconstructor
- */
-export declare class FChartBuilderBase extends FBase {
-    protected readonly _workbook: Workbook;
-    protected readonly _injector: Injector;
-    /**
-     * @property {string} unitId The workbook id where the chart is located.
-     */
-    unitId: string;
-    /**
-     * @property {string} subUnitId The worksheet id where the chart is located.
-     */
-    subUnitId: string;
-    /**
-     * @property {string} chartId The id of the chart.
-     */
-    chartId: string;
-    /**
-     * @property {IRange} range The data source range of the chart.
-     */
-    range: IRange | undefined;
-    /**
-     * @property {string} sourceSheetName The name of the worksheet which the data source range of the chart belongs to.
-     * If not set, the data source range is in the current active worksheet.
-     */
-    sourceSheetName: string | undefined;
-    /**
-     * @property {number} x The x-coordinate of the chart.
-     */
-    x: number;
-    /**
-     * @property {number} y The y-coordinate of the chart.
-     */
-    y: number;
-    /**
-     * @property {number} width The width of the chart.
-     */
-    width: number;
-    /**
-     * @property {number} height The height of the chart.
-     */
-    height: number;
-    /**
-     * @property {ChartTypeBits} chartType The type of the chart.
-     */
-    chartType: ChartTypeBits;
-    /**
-     * @property {IChartBuildOptions} options The options of the chart.
-     */
-    options: IChartBuildOptions;
-    /**
-     * @property {boolean} transposeRowsAndColumns Whether to read the data in the range as row direction.
-     */
-    transposeRowsAndColumns: boolean;
-    constructor(unitId: string, subUnitId: string, workbook: Workbook, injector: Injector, chartId?: string);
-    /**
-     * Gets the chart type of the chart this builder modifies.
-     * @description The chart type of the chart this builder modifies. The chart type (ChartTypeBits) can be found from package @univerjs-pro/sheets-chart.
-     * Please pay attention to the type of the chart you are creating,  a Pie chart have a property of Doughnut is donut chart, and a Pie chart have a property of Rose is rose pie chart.But the chart builder will not change the chart type to the corresponding chart type.
-     * @returns {ChartTypeBits} ChartType - The chart type of the chart this builder modifies.
-     */
-    getChartType(): ChartTypeBits;
-    /**
-     * Adds a range to the chart this builder modifies
-     * @param {IRange | string} range The range string or object to add for chart source data.The should be not a single cell.
-     * @returns {FChartBuilderBase} -this builder, for chaining
-     *
-     * @example
-     * ```ts
-     * const fWorkbook = univerAPI.getActiveWorkbook();
-     * const fWorksheet = fWorkbook.getActiveSheet();
-     *
-     * // 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);
-     * ```
-     */
-    addRange(range: IRange | string): this;
-    /**
-     * Clears the range from the chart this builder modifies
-     * @returns {FChartBuilderBase} -this builder, for chaining
-     */
-    clearRange(): this;
-    /**
-     * Sets the position, changing where the chart appears on the sheet. anchorRowPos and anchorColPos are 0-indexed.This api can only work in the active sheet.
-     * @description The chart's start anchor position is the top left-hand corner of the chart. The rowOffset and columnOffset are the pixel offsets from the anchor position.
-     * @param {number} anchorRowPos The chart's top side is anchored in this row.
-     * @param {number} anchorColPos The chart's left side is anchored in this column.
-     * @param {number} rowOffset The chart's top left-hand corner is offset by this many pixels.
-     * @param {number} columnOffset The chart's lower left-hand corner is offset by this many pixels.
-     * @returns {FChartBuilderBase} -this builder, for chaining.
-     *
-     * @example
-     * ```ts
-     * const fWorkbook = univerAPI.getActiveWorkbook();
-     * const fWorksheet = fWorkbook.getActiveSheet();
-     *
-     * // Create a column chart with data source A1:D6
-     * // The starting position is upper-left corner of cell F3 and offset 20 pixels to the right and down.
-     * const chartInfo = fWorksheet.newChart()
-     *   .setChartType(univerAPI.Enum.ChartType.Column)
-     *   .addRange('A1:D6')
-     *   .setPosition(2, 5, 20, 20)
-     *   .build();
-     * await fWorksheet.insertChart(chartInfo);
-     * ```
-     */
-    setPosition(anchorRowPos: number, anchorColPos: number, rowOffset: number, columnOffset: number): this;
-    /**
-     * Sets the position, changing where the chart appears on the sheet by pixel.
-     * @description The chart's start anchor position is the top left-hand corner of the chart. This api is opposite to setPosition.
-     * @param {number} x The x-coordinate of the chart's top left-hand corner.
-     * @param {number} y The y-coordinate of the chart's top left-hand corner.
-     * @returns {FChartBuilderBase} -this builder, for chaining.
-     *
-     * @example
-     * ```ts
-     * const fWorkbook = univerAPI.getActiveWorkbook();
-     * const fWorksheet = fWorkbook.getActiveSheet();
-     *
-     * // Create a column chart with data source A1:D6
-     * // The starting position is (100, 200) pixels from the top left-hand corner of the sheet.
-     * const chartInfo = fWorksheet.newChart()
-     *   .setChartType(univerAPI.Enum.ChartType.Column)
-     *   .addRange('A1:D6')
-     *   .setAbsolutePosition(100, 200)
-     *   .build();
-     * await fWorksheet.insertChart(chartInfo);
-     * ```
-     */
-    setAbsolutePosition(x: number, y: number): this;
-    /**
-     * The type of chart to create.
-     * @param {ChartTypeBits} chartType The type of chart to create.Which can be found from package @univerjs-pro/sheets-chart.
-     * @description The type of chart to create. The following are the possible values: Line,Column,ColumnStacked,ColumnPercentStacked,Bar,BarStacked,BarPercentStacked,Pie,Doughnut,Area,AreaStacked,AreaPercentStacked,Radar,Scatter,Combination
-     * @returns {FChartBuilderBase} -this builder, for chaining.
-     *
-     * @example
-     * ```ts
-     * const fWorkbook = univerAPI.getActiveWorkbook();
-     * const fWorksheet = fWorkbook.getActiveSheet();
-     *
-     * // 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 type to line after 3 seconds.
-     * setTimeout(() => {
-     *   const newChartInfo = fWorksheet.newChart(charts[0])
-     *     .setChartType(univerAPI.Enum.ChartType.Line)
-     *     .build();
-     *   fWorksheet.updateChart(newChartInfo);
-     * }, 3000);
-     * ```
-     */
-    setChartType(chartType: ChartTypeBits): this;
-    /**
-     * Sets the width of the chart in pixels.
-     * @param {number} width The width of the chart in pixels.
-     * @returns {FChartBuilderBase} -this builder, for chaining.
-     *
-     * @example
-     * ```ts
-     * const fWorkbook = univerAPI.getActiveWorkbook();
-     * const fWorksheet = fWorkbook.getActiveSheet();
-     *
-     * // 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);
-     * ```
-     */
-    setWidth(width: number): this;
-    /**
-     * Sets the height of the chart in pixels.
-     * @param {number} height The height of the chart in pixels.
-     * @returns {FChartBuilderBase} -this builder, for chaining.
-     *
-     * @example
-     * ```ts
-     * const fWorkbook = univerAPI.getActiveWorkbook();
-     * const fWorksheet = fWorkbook.getActiveSheet();
-     *
-     * // 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);
-     * ```
-     */
-    setHeight(height: number): this;
-    /**
-     * The options for the chart. This function will overwrite  existing options and merge new options property.
-     * @param {string} optionPath The path of the option to set. A '' path means the root of the options object.
-     * @param {object|number|string} optionVal The value to set. Undefined value will be ignore , and null means delete the property.If a path is '', the value must be the whole options object.
-     * @returns {FChartBuilderBase} The builder, for chaining.
-     *
-     * @example
-     * ```ts
-     * const fWorkbook = univerAPI.getActiveWorkbook();
-     * const fWorkSheet = fWorkbook.getActiveSheet();
-     * const chartBuilder = fWorkSheet.newChart().asPieChart();
-     * const chartBuilderInfo1 = chartBuilder
-     *   .addRange('A1:D6')
-     *   .setOptions('title.content', 'Chart Title')
-     *   .setOptions('legend.position', 'right')
-     *   .setDoughnutHole(0.5)
-     *   .setHasPaddingAngle(true)
-     *   .setRosePie(true)
-     *   .setIsHalfPie(true)
-     *   .build();
-     * // setOptions can be replaced by setOptions('', { ... })
-     * const chartBuilderInfo2 = chartBuilder
-     *   .addRange('A1:D6')
-     *   .setOptions('', {
-     *     "title": {
-     *       "content": "Chart Title"
-     *     },
-     *     "legend": {
-     *       "position": "right"
-     *     },
-     *     "pie": {
-     *       "doughnutHole": 0.5,
-     *       "hasPaddingAngle": true,
-     *       "isHalfPie": true,
-     *       "rosePie": true
-     *     }
-     *   })
-     *   .build();
-     * await fWorkSheet.insertChart(chartBuilderInfo1);
-     * // or they are same effect
-     * // await fWorkSheet.insertChart(chartBuilderInfo2);
-     * ```
-     */
-    setOptions(optionPath: string, optionVal: unknown): this;
-    /**
-     * Sets whether to transpose the rows and columns of the chart.
-     * @param {boolean} transposeRowsAndColumns Whether to transpose the rows and columns of the chart.The default value is false.
-     * @returns {FChartBuilderBase} -this builder, for chaining.
-     *
-     * @example
-     * ```ts
-     * const fWorkbook = univerAPI.getActiveWorkbook();
-     * const fWorksheet = fWorkbook.getActiveSheet();
-     *
-     * // Create a column chart with data source A1:D6
-     * // The starting position is upper-left corner of cell B2.
-     * // The chart will transpose the rows and columns.
-     * const chartInfo = fWorksheet.newChart()
-     *   .setChartType(univerAPI.Enum.ChartType.Column)
-     *   .addRange('A1:D6')
-     *   .setPosition(1, 1, 0, 0)
-     *   // the chart will transpose the rows and columns
-     *   .setTransposeRowsAndColumns(true)
-     *   .build();
-     * await fWorksheet.insertChart(chartInfo);
-     * ```
-     */
-    setTransposeRowsAndColumns(transposeRowsAndColumns: boolean): this;
-    /**
-     * Sets the theme of the chart. If the theme name not registered, a default theme will be used.
-     * @param {string} theme The theme name of the chart.
-     * @returns {{FChartBuilderBase}} -this builder, for chaining.
-     *
-     * @example
-     * ```ts
-     * const fWorkbook = univerAPI.getActiveWorkbook();
-     * const fWorksheet = fWorkbook.getActiveSheet();
-     *
-     * // 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
-     *     ]
-     *     // ... 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);
-     * ```
-     */
-    setTheme(theme: string): this;
-    /**
-     * Sets the title of the chart x-axis.
-     * @param {string} title The title of the chart x-axis.
-     * @returns {FChartBuilderBase} -this builder, for chaining.
-     *
-     * @example
-     * ```ts
-     * const fWorkbook = univerAPI.getActiveWorkbook();
-     * const fWorksheet = fWorkbook.getActiveSheet();
-     *
-     * // Create a column chart with data source A1:D6
-     * // The starting position is upper-left corner of cell B2.
-     * // The x-axis title is 'xAxis Title text'.
-     * const chartInfo = fWorksheet.newChart()
-     *   .setChartType(univerAPI.Enum.ChartType.Column)
-     *   .addRange('A1:D6')
-     *   .setPosition(1, 1, 0, 0)
-     *   .setXAxisTitle('xAxis Title text')
-     *   .build();
-     * await fWorksheet.insertChart(chartInfo);
-     * ```
-     */
-    setXAxisTitle(title: string): this;
-    /**
-     * Sets the title of the chart y-axis.
-     * @param {string} title The title of the chart y-axis.
-     * @returns {FChartBuilderBase} -this 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 y-axis title is 'yAxis Title text'.
-     * const chartInfo = fWorksheet.newChart()
-     *   .asLineChart()
-     *   .addRange('A1:D6')
-     *   .setPosition(1, 1, 0, 0)
-     *   .setYAxisTitle('yAxis Title text')
-     *   .build();
-     * await fWorksheet.insertChart(chartInfo);
-     * ```
-     */
-    setYAxisTitle(title: string): this;
-    /**
-     * Sets the title of the chart right y-axis.
-     * @param {string} title The title of the chart right y-axis.
-     * @returns {FChartBuilderBase} -this 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 right y-axis title is 'rightYAxis Title text'.
-     * const chartInfo = fWorksheet.newChart()
-     *   .asLineChart()
-     *   .addRange('A1:D6')
-     *   .setPosition(1, 1, 0, 0)
-     *   .setRightYAxisTitle('rightYAxis Title text')
-     *   .build();
-     * await fWorksheet.insertChart(chartInfo);
-     * ```
-     */
-    setRightYAxisTitle(title: string): this;
-    /**
-     * Sets the text style for the chart x-axis.
-     * @param {IChartTextStyle} textStyle The text style for the chart x-axis.
-     * @returns {FChartBuilderBase} -this builder, for chaining.
-     *
-     * @example
-     * ```ts
-     * const fWorkbook = univerAPI.getActiveWorkbook();
-     * const fWorksheet = fWorkbook.getActiveSheet();
-     *
-     * // Create a column chart with data source A1:D6
-     * // The starting position is upper-left corner of cell B2.
-     * // The x-axis style is set.
-     * const chartInfo = fWorksheet.newChart()
-     *   .setChartType(univerAPI.Enum.ChartType.Column)
-     *   .addRange('A1:D6')
-     *   .setPosition(1, 1, 0, 0)
-     *   .setXAxisTextStyle({
-     *     content: 'xAxis Title text',
-     *     fontSize: 12,
-     *     fontColor: '#ff0000'
-     *   })
-     *   .build();
-     * await fWorksheet.insertChart(chartInfo);
-     * ```
-     */
-    setXAxisTextStyle(textStyle: IChartTextStyle): this;
-    /**
-     * Sets the text style for the chart y-axis.
-     * @param {IChartTextStyle} textStyle The text style for the chart y-axis.
-     * @returns {FChartBuilderBase} -this 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 y-axis style is set.
-     * const chartInfo = fWorksheet.newChart()
-     *   .asLineChart()
-     *   .addRange('A1:D6')
-     *   .setPosition(1, 1, 0, 0)
-     *   .setYAxisTextStyle({
-     *     content: 'yAxis Title text',
-     *     fontSize: 12,
-     *     fontColor: '#ff0000'
-     *   })
-     *   .build();
-     * await fWorksheet.insertChart(chartInfo);
-     * ```
-     */
-    setYAxisTextStyle(textStyle: IChartTextStyle): this;
-    /**
-     * Sets the text style for the chart right y-axis. Only works in charts have right y-axis.
-     * @param {IChartTextStyle} textStyle The text style for the chart right y-axis.
-     * @returns {FChartBuilderBase} -this 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 right y-axis style is set.
-     * const chartInfo = fWorksheet.newChart()
-     *   .asLineChart()
-     *   .addRange('A1:D6')
-     *   .setPosition(1, 1, 0, 0)
-     *   .setRightYAxisTextStyle({
-     *     content: 'rightYAxis Title text',
-     *     fontSize: 12,
-     *     fontColor: '#ff0000'
-     *   })
-     *   .build();
-     * await fWorksheet.insertChart(chartInfo);
-     * ```
-     */
-    setRightYAxisTextStyle(textStyle: IChartTextStyle): this;
-    /**
-     * Sets how to handle invalid data in the chart.The possible values are 'zero', 'break' & 'link'.
-     * @description The default value is 'zero'. It means that invalid data will be treated as zero. 'break' means that the chart will have a gap where the invalid data is. 'link' means that the chart will connect the data points on either side of the invalid data.
-     * @param {InvalidValueType} invalidValueType The type of invalid value to use.
-     * @returns {FChartBuilderBase} -this 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 invalid value is set as zero.
-     * const chartInfo = fWorksheet.newChart()
-     *   .asLineChart()
-     *   .addRange('A1:D6')
-     *   .setPosition(1, 1, 0, 0)
-     *   .setInvalidValueStrategy('zero')
-     *   .build();
-     * await fWorksheet.insertChart(chartInfo);
-     * ```
-     */
-    setInvalidValueStrategy(invalidValueType: InvalidValueType): this;
-    /**
-     * Sets the axis pointer style
-     * @param {IChartBuildOptions['axisPointer']} style The style for the axis pointer.
-     * @typedef AxisPointerStyle
-     * @property {string} [AxisPointerStyle.indicatorLabelColor] The line color of the axis pointer.
-     * @property {string} [AxisPointerStyle.indicatorLabelTextColor] The font color of the axis pointer.
-     * @property {ChartBorderDashType} [AxisPointerStyle.indicatorLineType] The line type of the axis pointer.
-     * @property {string} [AxisPointerStyle.indicatorLineColor] The line width of the axis pointer.
-     * @returns {FChartBuilderBase} -this 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 axis pointer style is set.
-     * const chartInfo = fWorksheet.newChart()
-     *   .asLineChart()
-     *   .addRange('A1:D6')
-     *   .setPosition(1, 1, 0, 0)
-     *   .setAxisPointerStyle({
-     *     indicatorLabelColor: '#ff0000',
-     *     indicatorLineType: univerAPI.Enum.ChartBorderDashType.Solid,
-     *     indicatorLineColor: '#00ff00',
-     *     indicatorLabelTextColor: '#0000ff',
-     *   })
-     *   .build();
-     * await fWorksheet.insertChart(chartInfo);
-     *
-     * // a AxisPointerStyle can be defined like following:
-     * const chartInfo = fWorksheet.newChart().setOptions('axisPointer.indicatorLineColor', '#ff0000')
-     *   .setOptions('axisPointer.indicatorLineType', univerAPI.Enum.ChartBorderDashType.Solid)
-     *   .setOptions('axisPointer.indicatorLineColor', '#00ff00')
-     *   .setOptions('axisPointer.indicatorLabelTextColor', '#0000ff')
-     *   .build();
-     * ```
-     */
-    setAxisPointerStyle(style: IChartBuildOptions['axisPointer']): this;
-    /**
-     * Sets styles for all series.
-     * @typedef allSeriesStyle
-     * @property {ChartTypeBits} [chartType] The chart type of the series.It only works in combination chart, and the value must be one of ChartTypeBits.Line | ChartTypeBits.Column | ChartTypeBits.Area;
-     * @property {boolean} [rightYAxis] Use the right y-axis for the series.
-     * @property {string} [color] The color of the series.
-     * @property {number} [fillOpacity] The opacity of the series fill.
-     * @property {object} [border] The border style of the series.
-     * @property {string} [border.color] The color of the series border.
-     * @property {number} [border.opacity] The opacity of the series border.
-     * @property {number} [border.width] The width of the series border.
-     * @property {ChartBorderDashType} [border.dashType] The dash type of the series border.
-     * @property {ISeriesLabelStyle} [label] The label style of the series.
-     * @property {IPointStyle} [point] The point style of the series.
-     * @property {IDataPointStyle} [dataPoints] The data point style of the series.Radar chart does not support this property.
-     * @param {allSeriesStyle} allSeriesStyle The style for all series.
-     * @returns {FChartBuilderBase} -this 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 all series style is set.
-     * const chartInfo = fWorksheet.newChart()
-     *   .asLineChart()
-     *   .addRange('A1:D6')
-     *   .setPosition(1, 1, 0, 0)
-     *   .setAllSeriesStyle({
-     *     rightYAxis: false,
-     *     color: '#ff0000',
-     *     border: {
-     *       color: '#00ff00',
-     *       opacity: 0.5,
-     *       width: 1,
-     *       dashType: univerAPI.Enum.ChartBorderDashType.Solid,
-     *     },
-     *   })
-     *   .build();
-     * await fWorksheet.insertChart(chartInfo);
-     * ```
-     */
-    setAllSeriesStyle(allSeriesStyle: Partial<IAllSeriesStyle>): this;
-    /**
-     * Sets the series style by series index.
-     * @description Like setALLSeriesStyle, this difference is the style only set for the provide sty
-     * @param {number | string} index The index of the series to set the style for.
-     * @param {ISeriesStyle} seriesStyle The style for the series.
-     * @returns {FChartBuilderBase} -this 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.
-     * const chartInfo = fWorksheet.newChart()
-     *   .asLineChart()
-     *   .addRange('A1:D6')
-     *   .setPosition(1, 1, 0, 0)
-     *   .build();
-     * const fChart = await fWorksheet.insertChart(chartInfo);
-     *
-     * // Update the first series style after 3 seconds.
-     * setTimeout(() => {
-     *   const first = fChart.getSeriesData()[0];
-     *   const newChartInfo = fWorksheet.newChart(fChart)
-     *     .setSeriesStyle(first.index, {
-     *       color: '#ff0000',
-     *     })
-     *     .build();
-     *   fWorksheet.updateChart(newChartInfo);
-     * }, 3000);
-     * ```
-     */
-    setSeriesStyle(index: number | string, seriesStyle: ISeriesStyle): 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 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);
-     * ```
-     */
-    build(): IChartBuilderInfo;
-}