@univerjs-pro/engine-chart 1.0.0-beta.0 → 1.0.0-beta.1

package/lib/types/facade/builders/f-scatter-chart-builder.d.ts

@@ -1,6 +1,62 @@
-import type { IChartScatterMappingSpec, IChartSolidSeriesPatch, IChartSolidSeriesStyleSpec } from '@univerjs-pro/engine-chart';
+import type { IChartInfo, IChartScatterMappingSpec, IChartSolidSeriesPatch, IChartSolidSeriesStyleSpec } from '@univerjs-pro/engine-chart';
 import { FCartesianChartBuilder } from '../f-cartesian-chart-builder';
-export declare class FScatterChartBuilder extends FCartesianChartBuilder<Omit<IChartSolidSeriesPatch, 'selector'>, IChartSolidSeriesStyleSpec> {
+/**
+ * Fluent, type-specific Builder for Scatter Charts.
+ *
+ * The data source is an observation table: each row represents one point. Map two
+ * numeric fields to X and Y; an optional label field supplies point labels. All mapped
+ * fields are aligned by row, so their source vectors must have the same length.
+ *
+ * @example Sheet
+ * ```ts
+ * const fWorkbook = univerAPI.getActiveWorkbook();
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+ * const chartInfo = fWorksheet
+ *   .newChart(univerAPI.Enum.ChartTypeString.Scatter)
+ *   .setSource({
+ *     range: 'A1:C8',
+ *     orientation: univerAPI.Enum.ChartSourceOrientation.Columns,
+ *   })
+ *   .setScatterMapping({ xIndex: 0, yIndex: 1, labelIndex: 2 })
+ *   .build();
+ * await fWorksheet.insertChart(chartInfo);
+ * ```
+ *
+ * @example Doc
+ * ```ts
+ * const fDocument = univerAPI.getActiveDocument();
+ * const chartInfo = fDocument
+ *   .newChart(univerAPI.Enum.ChartTypeString.Scatter)
+ *   .setSource([['X', 'Y'], [10, 20], [18, 32], [24, 28]])
+ *   .setScatterMapping({ xIndex: 0, yIndex: 1 })
+ *   .build();
+ * await fDocument.insertChart(chartInfo);
+ * ```
+ *
+ * @example Slide
+ * ```ts
+ * const fPresentation = univerAPI.getActivePresentation();
+ * const fSlide = fPresentation.getSlideByIndex(0);
+ * const chartInfo = fSlide
+ *   .newChart(univerAPI.Enum.ChartTypeString.Scatter)
+ *   .setSource([['X', 'Y'], [10, 20], [18, 32], [24, 28]])
+ *   .setScatterMapping({ xIndex: 0, yIndex: 1 })
+ *   .build();
+ * await fSlide.insertChart(chartInfo);
+ * ```
+ *
+ * @example Board
+ * ```ts
+ * const fBoard = univerAPI.getActiveBoard();
+ * const chartInfo = fBoard
+ *   .newChart(univerAPI.Enum.ChartTypeString.Scatter)
+ *   .setSource([['X', 'Y'], [10, 20], [18, 32], [24, 28]])
+ *   .setScatterMapping({ xIndex: 0, yIndex: 1 })
+ *   .build();
+ * await fBoard.insertChart(chartInfo);
+ * ```
+ */
+export declare class FScatterChartBuilder<TSource = never[], TDataSource = TSource, TInfo extends IChartInfo<TDataSource> = IChartInfo<TDataSource>> extends FCartesianChartBuilder<Omit<IChartSolidSeriesPatch, 'selector'>, IChartSolidSeriesStyleSpec, TSource, TDataSource, TInfo> {
     /**
      * Sets the scatter mapping configuration and returns this builder for chaining.
      *
@@ -10,8 +66,6 @@ export declare class FScatterChartBuilder extends FCartesianChartBuilder<Omit<IC
      * @returns This builder for chaining.
      * @example
      * ```ts
-     * const worksheet = univerAPI.getActiveWorkbook().getActiveSheet();
-     * const builder = worksheet.charts.create().setType(univerAPI.Enum.ChartTypeString.Scatter);
      * builder.setScatterMapping({ xIndex: 0, yIndex: 1 });
      * ```
      */
@@ -24,8 +78,6 @@ export declare class FScatterChartBuilder extends FCartesianChartBuilder<Omit<IC
      * @returns This builder for chaining.
      * @example
      * ```ts
-     * const worksheet = univerAPI.getActiveWorkbook().getActiveSheet();
-     * const builder = worksheet.charts.create().setType(univerAPI.Enum.ChartTypeString.Scatter);
      * builder.clearScatterMapping();
      * ```
      */

package/lib/types/facade/builders/f-sunburst-chart-builder.d.ts

@@ -1,4 +1,4 @@
-import type { DeepNullish, IChartSunburstCenterLabelSpec, IChartSunburstLabelSpec } from '@univerjs-pro/engine-chart';
+import type { DeepNullish, IChartInfo, IChartSunburstCenterLabelSpec, IChartSunburstLabelSpec } from '@univerjs-pro/engine-chart';
 import { FChartBuilderBase } from '../f-chart-builder-base';
 /**
  * Fluent semantic builder for an automatically laid-out Sunburst chart.
@@ -7,18 +7,132 @@ import { FChartBuilderBase } from '../f-chart-builder-base';
  * least one ordered hierarchy field and exactly one value field. Duplicate complete paths
  * sum finite numeric values; sparse hierarchy values inherit within ancestor scope; parent
  * facts add to child totals. Ring layout is automatic and root navigation is disabled.
+ *
+ * @example Sheet
+ * ```ts
+ * const fWorkbook = univerAPI.getActiveWorkbook();
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+ * const chartInfo = fWorksheet
+ *   .newChart(univerAPI.Enum.ChartTypeString.Sunburst)
+ *   .setSource('A1:D8')
+ *   .setHierarchyFields([0, 1, 2])
+ *   .setValueField(3)
+ *   .setSunburstLabel({ visible: true, position: univerAPI.Enum.ChartSunburstLabelPosition.Outside, color: '#334155' })
+ *   .setCenterLabel({ visible: true, color: '#0f172a' })
+ *   .build();
+ * await fWorksheet.insertChart(chartInfo);
+ * ```
+ *
+ * @example Doc
+ * ```ts
+ * const fDocument = univerAPI.getActiveDocument();
+ * const chartInfo = fDocument
+ *   .newChart(univerAPI.Enum.ChartTypeString.Sunburst)
+ *   .setSource([['Region', 'Country', 'City', 'Sales'], ['Europe', 'France', 'Paris', 120], ['Asia', 'Japan', 'Tokyo', 180]])
+ *   .setHierarchyFields([0, 1, 2])
+ *   .setValueField(3)
+ *   .setSunburstLabel({ visible: true, position: univerAPI.Enum.ChartSunburstLabelPosition.Outside, color: '#334155' })
+ *   .setCenterLabel({ visible: true, color: '#0f172a' })
+ *   .build();
+ * await fDocument.insertChart(chartInfo);
+ * ```
+ *
+ * @example Slide
+ * ```ts
+ * const fPresentation = univerAPI.getActivePresentation();
+ * const fSlide = fPresentation.getSlideByIndex(0);
+ * const chartInfo = fSlide
+ *   .newChart(univerAPI.Enum.ChartTypeString.Sunburst)
+ *   .setSource([['Region', 'Country', 'City', 'Sales'], ['Europe', 'France', 'Paris', 120], ['Asia', 'Japan', 'Tokyo', 180]])
+ *   .setHierarchyFields([0, 1, 2])
+ *   .setValueField(3)
+ *   .setSunburstLabel({ visible: true, position: univerAPI.Enum.ChartSunburstLabelPosition.Outside, color: '#334155' })
+ *   .setCenterLabel({ visible: true, color: '#0f172a' })
+ *   .build();
+ * await fSlide.insertChart(chartInfo);
+ * ```
+ *
+ * @example Board
+ * ```ts
+ * const fBoard = univerAPI.getActiveBoard();
+ * const chartInfo = fBoard
+ *   .newChart(univerAPI.Enum.ChartTypeString.Sunburst)
+ *   .setSource([['Region', 'Country', 'City', 'Sales'], ['Europe', 'France', 'Paris', 120], ['Asia', 'Japan', 'Tokyo', 180]])
+ *   .setHierarchyFields([0, 1, 2])
+ *   .setValueField(3)
+ *   .setSunburstLabel({ visible: true, position: univerAPI.Enum.ChartSunburstLabelPosition.Outside, color: '#334155' })
+ *   .setCenterLabel({ visible: true, color: '#0f172a' })
+ *   .build();
+ * await fBoard.insertChart(chartInfo);
+ * ```
  */
-export declare class FSunburstChartBuilder extends FChartBuilderBase {
-    /** Replaces the ordered inner-to-outer hierarchy with zero-based field indexes. */
+export declare class FSunburstChartBuilder<TSource = never[], TDataSource = TSource, TInfo extends IChartInfo<TDataSource> = IChartInfo<TDataSource>> extends FChartBuilderBase<TSource, TDataSource, TInfo> {
+    /**
+     * Replaces the ordered inner-to-outer hierarchy with zero-based field indexes.
+     *
+     * @param indexes Ordered hierarchy field indexes.
+     * @returns This builder for chaining.
+     * @example
+     * ```ts
+     * builder.setHierarchyFields([0, 1, 2]);
+     * ```
+     */
     setHierarchyFields(indexes: readonly number[]): this;
-    /** Replaces the sole numeric value field with a zero-based field index. */
+    /**
+     * Replaces the sole numeric value field with a zero-based field index.
+     *
+     * @param index Numeric value field index.
+     * @returns This builder for chaining.
+     * @example
+     * ```ts
+     * builder.setValueField(3);
+     * ```
+     */
     setValueField(index: number): this;
-    /** Sets label visibility, CategoryName/Value content, and font appearance. */
+    /**
+     * Sets label visibility, content, position, and font appearance.
+     *
+     * @param label Sunburst label settings.
+     * @returns This builder for chaining.
+     * @example
+     * ```ts
+     * builder.setSunburstLabel({
+     *   visible: true,
+     *   position: univerAPI.Enum.ChartSunburstLabelPosition.Outside,
+     *   color: '#334155',
+     * });
+     * ```
+     */
     setSunburstLabel(label: DeepNullish<IChartSunburstLabelSpec>): this;
-    /** Removes explicit label style and restores visible category-name labels. */
+    /**
+     * Removes explicit label style and restores visible category-name labels.
+     *
+     * @returns This builder for chaining.
+     * @example
+     * ```ts
+     * builder.resetSunburstLabel();
+     * ```
+     */
     resetSunburstLabel(): this;
-    /** Sets visibility, number format, and font appearance for the aggregate center value. */
+    /**
+     * Sets visibility, number format, and font appearance for the aggregate center value.
+     *
+     * @param centerLabel Center-label settings.
+     * @returns This builder for chaining.
+     * @example
+     * ```ts
+     * builder.setCenterLabel({ visible: true, color: '#0f172a' });
+     * ```
+     */
     setCenterLabel(centerLabel: DeepNullish<IChartSunburstCenterLabelSpec>): this;
-    /** Removes the authored center-label style and restores its hidden default. */
+    /**
+     * Removes the authored center-label style and restores its hidden default.
+     *
+     * @returns This builder for chaining.
+     * @example
+     * ```ts
+     * builder.resetCenterLabel();
+     * ```
+     */
     resetCenterLabel(): this;
 }

package/lib/types/facade/builders/f-treemap-chart-builder.d.ts

@@ -1,4 +1,4 @@
-import type { DeepNullish, IChartTreemapLabelSpec, TreemapParentLabelLayout } from '@univerjs-pro/engine-chart';
+import type { DeepNullish, IChartInfo, IChartTreemapLabelSpec, TreemapParentLabelLayout } from '@univerjs-pro/engine-chart';
 import { FChartBuilderBase } from '../f-chart-builder-base';
 /**
  * Fluent semantic builder for an automatically laid-out Treemap.
@@ -10,25 +10,127 @@ import { FChartBuilderBase } from '../f-chart-builder-base';
  * is disabled. The runtime defaults are banner parent labels and visible category-name
  * leaf labels; labels may hide when their rectangle cannot fit the complete content.
  *
- * @example
- * const chart = worksheet.charts.create()
- *   .setType(univerAPI.Enum.ChartTypeString.Treemap)
+ * @example Sheet
+ * ```ts
+ * const fWorkbook = univerAPI.getActiveWorkbook();
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+ * const chartInfo = fWorksheet
+ *   .newChart(univerAPI.Enum.ChartTypeString.Treemap)
+ *   .setSource('A1:D8')
  *   .setHierarchyFields([0, 1, 2])
  *   .setValueField(3)
- *   .setParentLabelLayout('banner')
- *   .setTreemapLabel({ visible: true, contentType: univerAPI.Enum.LabelContentType.CategoryName });
+ *   .setParentLabelLayout(univerAPI.Enum.ChartTreemapParentLabelLayout.Banner)
+ *   .setTreemapLabel({ visible: true, color: '#334155' })
+ *   .build();
+ * await fWorksheet.insertChart(chartInfo);
+ * ```
+ *
+ * @example Doc
+ * ```ts
+ * const fDocument = univerAPI.getActiveDocument();
+ * const chartInfo = fDocument
+ *   .newChart(univerAPI.Enum.ChartTypeString.Treemap)
+ *   .setSource([['Region', 'Country', 'City', 'Sales'], ['Europe', 'France', 'Paris', 120], ['Asia', 'Japan', 'Tokyo', 180]])
+ *   .setHierarchyFields([0, 1, 2])
+ *   .setValueField(3)
+ *   .setParentLabelLayout(univerAPI.Enum.ChartTreemapParentLabelLayout.Banner)
+ *   .setTreemapLabel({ visible: true, color: '#334155' })
+ *   .build();
+ * await fDocument.insertChart(chartInfo);
+ * ```
+ *
+ * @example Slide
+ * ```ts
+ * const fPresentation = univerAPI.getActivePresentation();
+ * const fSlide = fPresentation.getSlideByIndex(0);
+ * const chartInfo = fSlide
+ *   .newChart(univerAPI.Enum.ChartTypeString.Treemap)
+ *   .setSource([['Region', 'Country', 'City', 'Sales'], ['Europe', 'France', 'Paris', 120], ['Asia', 'Japan', 'Tokyo', 180]])
+ *   .setHierarchyFields([0, 1, 2])
+ *   .setValueField(3)
+ *   .setParentLabelLayout(univerAPI.Enum.ChartTreemapParentLabelLayout.Banner)
+ *   .setTreemapLabel({ visible: true, color: '#334155' })
+ *   .build();
+ * await fSlide.insertChart(chartInfo);
+ * ```
+ *
+ * @example Board
+ * ```ts
+ * const fBoard = univerAPI.getActiveBoard();
+ * const chartInfo = fBoard
+ *   .newChart(univerAPI.Enum.ChartTypeString.Treemap)
+ *   .setSource([['Region', 'Country', 'City', 'Sales'], ['Europe', 'France', 'Paris', 120], ['Asia', 'Japan', 'Tokyo', 180]])
+ *   .setHierarchyFields([0, 1, 2])
+ *   .setValueField(3)
+ *   .setParentLabelLayout(univerAPI.Enum.ChartTreemapParentLabelLayout.Banner)
+ *   .setTreemapLabel({ visible: true, color: '#334155' })
+ *   .build();
+ * await fBoard.insertChart(chartInfo);
+ * ```
  */
-export declare class FTreemapChartBuilder extends FChartBuilderBase {
-    /** Replaces the ordered root-to-leaf hierarchy with zero-based field indexes. */
+export declare class FTreemapChartBuilder<TSource = never[], TDataSource = TSource, TInfo extends IChartInfo<TDataSource> = IChartInfo<TDataSource>> extends FChartBuilderBase<TSource, TDataSource, TInfo> {
+    /**
+     * Replaces the ordered root-to-leaf hierarchy with zero-based field indexes.
+     *
+     * @param indexes Ordered hierarchy field indexes.
+     * @returns This builder for chaining.
+     * @example
+     * ```ts
+     * builder.setHierarchyFields([0, 1, 2]);
+     * ```
+     */
     setHierarchyFields(indexes: readonly number[]): this;
-    /** Replaces the sole numeric value field with a zero-based field index. */
+    /**
+     * Replaces the sole numeric value field with a zero-based field index.
+     *
+     * @param index Numeric value field index.
+     * @returns This builder for chaining.
+     * @example
+     * ```ts
+     * builder.setValueField(3);
+     * ```
+     */
     setValueField(index: number): this;
-    /** Sets parent names to a reserved banner, overlapping text, or hidden. */
+    /**
+     * Sets parent names to a reserved banner, overlapping text, or hidden.
+     *
+     * @param layout Parent-label layout mode.
+     * @returns This builder for chaining.
+     * @example
+     * ```ts
+     * builder.setParentLabelLayout(univerAPI.Enum.ChartTreemapParentLabelLayout.Banner);
+     * ```
+     */
     setParentLabelLayout(layout: TreemapParentLabelLayout): this;
-    /** Removes the explicit parent layout and restores the runtime banner default. */
+    /**
+     * Removes the explicit parent layout and restores the runtime banner default.
+     *
+     * @returns This builder for chaining.
+     * @example
+     * ```ts
+     * builder.resetParentLabelLayout();
+     * ```
+     */
     resetParentLabelLayout(): this;
-    /** Sets leaf font and CategoryName/Value content. Other content bits are inert. */
+    /**
+     * Sets leaf visibility, content, and font appearance.
+     *
+     * @param label Treemap leaf-label settings.
+     * @returns This builder for chaining.
+     * @example
+     * ```ts
+     * builder.setTreemapLabel({ visible: true, color: '#334155' });
+     * ```
+     */
     setTreemapLabel(label: DeepNullish<IChartTreemapLabelSpec>): this;
-    /** Removes explicit leaf-label style and restores visible category-name labels. */
+    /**
+     * Removes explicit leaf-label style and restores visible category-name labels.
+     *
+     * @returns This builder for chaining.
+     * @example
+     * ```ts
+     * builder.resetTreemapLabel();
+     * ```
+     */
     resetTreemapLabel(): this;
 }

package/lib/types/facade/builders/f-waterfall-chart-builder.d.ts

@@ -1,19 +1,79 @@
-import type { ChartPublicSeriesSelector, IChartSeriesPatch, IChartWaterfallConnectorStyleSpec, IChartWaterfallPointRoleSpec, WaterfallStackTypeEnum } from '@univerjs-pro/engine-chart';
-import type { DeepReadonly } from '@univerjs/core';
+import type { ChartPublicSeriesSelector, IChartInfo, IChartSeriesPatch, IChartSeriesStyleSpec, IChartWaterfallConnectorStyleSpec, IChartWaterfallPointRoleSpec, WaterfallStackTypeEnum } from '@univerjs-pro/engine-chart';
 import { FCartesianChartBuilder } from '../f-cartesian-chart-builder';
-export declare class FWaterfallChartBuilder extends FCartesianChartBuilder {
-    /**
-     * Returns the canonical point-role list, including pending changes.
-     *
-     * @returns The current Waterfall point roles in canonical order.
-     * @example
-     * ```ts
-     * const worksheet = univerAPI.getActiveWorkbook().getActiveSheet();
-     * const builder = worksheet.charts.create().setType(univerAPI.Enum.ChartTypeString.Waterfall);
-     * const roles = builder.getPointRoles();
-     * ```
-     */
-    getPointRoles(): DeepReadonly<IChartWaterfallPointRoleSpec[]>;
+/**
+ * Fluent, type-specific Builder for Waterfall Charts.
+ *
+ * @example Sheet
+ * ```ts
+ * const fWorkbook = univerAPI.getActiveWorkbook();
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+ * const chartInfo = fWorksheet
+ *   .newChart(univerAPI.Enum.ChartTypeString.Waterfall)
+ *   .setSource('A1:B8')
+ *   .setPointRoles([{ series: 0, dataPointIndex: 3, role: univerAPI.Enum.ChartWaterfallPointRole.Total }])
+ *   .setConnector(true)
+ *   .setStackType(univerAPI.Enum.ChartWaterfallStackTypeEnum.Arrangement)
+ *   .setUseSubtotal(true)
+ *   .setPositiveStyle(0, { color: '#16a34a' })
+ *   .setNegativeStyle(0, { color: '#dc2626' })
+ *   .setSubtotalStyle(0, { color: '#2563eb' })
+ *   .build();
+ * await fWorksheet.insertChart(chartInfo);
+ * ```
+ *
+ * @example Doc
+ * ```ts
+ * const fDocument = univerAPI.getActiveDocument();
+ * const chartInfo = fDocument
+ *   .newChart(univerAPI.Enum.ChartTypeString.Waterfall)
+ *   .setSource([['Stage', 'Change'], ['Revenue', 300], ['Costs', -180], ['Profit', 120]])
+ *   .setPointRoles([{ series: 0, dataPointIndex: 2, role: univerAPI.Enum.ChartWaterfallPointRole.Total }])
+ *   .setConnector(true)
+ *   .setStackType(univerAPI.Enum.ChartWaterfallStackTypeEnum.Arrangement)
+ *   .setUseSubtotal(true)
+ *   .setPositiveStyle(0, { color: '#16a34a' })
+ *   .setNegativeStyle(0, { color: '#dc2626' })
+ *   .setSubtotalStyle(0, { color: '#2563eb' })
+ *   .build();
+ * await fDocument.insertChart(chartInfo);
+ * ```
+ *
+ * @example Slide
+ * ```ts
+ * const fPresentation = univerAPI.getActivePresentation();
+ * const fSlide = fPresentation.getSlideByIndex(0);
+ * const chartInfo = fSlide
+ *   .newChart(univerAPI.Enum.ChartTypeString.Waterfall)
+ *   .setSource([['Stage', 'Change'], ['Revenue', 300], ['Costs', -180], ['Profit', 120]])
+ *   .setPointRoles([{ series: 0, dataPointIndex: 2, role: univerAPI.Enum.ChartWaterfallPointRole.Total }])
+ *   .setConnector(true)
+ *   .setStackType(univerAPI.Enum.ChartWaterfallStackTypeEnum.Arrangement)
+ *   .setUseSubtotal(true)
+ *   .setPositiveStyle(0, { color: '#16a34a' })
+ *   .setNegativeStyle(0, { color: '#dc2626' })
+ *   .setSubtotalStyle(0, { color: '#2563eb' })
+ *   .build();
+ * await fSlide.insertChart(chartInfo);
+ * ```
+ *
+ * @example Board
+ * ```ts
+ * const fBoard = univerAPI.getActiveBoard();
+ * const chartInfo = fBoard
+ *   .newChart(univerAPI.Enum.ChartTypeString.Waterfall)
+ *   .setSource([['Stage', 'Change'], ['Revenue', 300], ['Costs', -180], ['Profit', 120]])
+ *   .setPointRoles([{ series: 0, dataPointIndex: 2, role: univerAPI.Enum.ChartWaterfallPointRole.Total }])
+ *   .setConnector(true)
+ *   .setStackType(univerAPI.Enum.ChartWaterfallStackTypeEnum.Arrangement)
+ *   .setUseSubtotal(true)
+ *   .setPositiveStyle(0, { color: '#16a34a' })
+ *   .setNegativeStyle(0, { color: '#dc2626' })
+ *   .setSubtotalStyle(0, { color: '#2563eb' })
+ *   .build();
+ * await fBoard.insertChart(chartInfo);
+ * ```
+ */
+export declare class FWaterfallChartBuilder<TSource = never[], TDataSource = TSource, TInfo extends IChartInfo<TDataSource> = IChartInfo<TDataSource>> extends FCartesianChartBuilder<Omit<IChartSeriesPatch, 'selector'>, IChartSeriesStyleSpec, TSource, TDataSource, TInfo> {
     /**
      * Replaces all Waterfall point roles.
      *
@@ -23,10 +83,8 @@ export declare class FWaterfallChartBuilder extends FCartesianChartBuilder {
      * @returns This builder for chaining.
      * @example
      * ```ts
-     * const worksheet = univerAPI.getActiveWorkbook().getActiveSheet();
-     * const builder = worksheet.charts.create().setType(univerAPI.Enum.ChartTypeString.Waterfall);
      * builder.setPointRoles([{ series: 0, dataPointIndex: 0, role: univerAPI.Enum.ChartWaterfallPointRole.Total }]);
-     * const roles = builder.getPointRoles();
+     * const roles = builder.build().config.waterfall?.pointRoles;
      * ```
      */
     setPointRoles(roles: readonly IChartWaterfallPointRoleSpec[]): this;
@@ -37,16 +95,14 @@ export declare class FWaterfallChartBuilder extends FCartesianChartBuilder {
      * and a neutral `#8C8C8C` base color that is adapted by the active light or dark theme. An object
      * starts from those defaults and overrides only the supplied fields. Pass `false` to hide it.
      *
-     * Read the current value from `builder.describe().waterfall?.connector`.
+     * Read the current value from `builder.build().config.waterfall?.connector`.
      *
      * @param value `false` disables, `true` enables the default dashed style, and an object enables style overrides.
      * @returns This builder for chaining.
      * @example
      * ```ts
-     * const worksheet = univerAPI.getActiveWorkbook().getActiveSheet();
-     * const builder = worksheet.charts.create().setType(univerAPI.Enum.ChartTypeString.Waterfall);
      * builder.setConnector(true);
-     * const connector = builder.describe().waterfall?.connector;
+     * const connector = builder.build().config.waterfall?.connector;
      * ```
      */
     setConnector(value: boolean | IChartWaterfallConnectorStyleSpec): this;
@@ -54,15 +110,13 @@ export declare class FWaterfallChartBuilder extends FCartesianChartBuilder {
      * Clears connector configuration. With no persisted connector setting, the renderer does not
      * draw connectors; call `setConnector(true)` to restore the default dashed connector.
      *
-     * Read the cleared value from `builder.describe().waterfall?.connector`.
+     * Read the cleared value from `builder.build().config.waterfall?.connector`.
      *
      * @returns This builder for chaining.
      * @example
      * ```ts
-     * const worksheet = univerAPI.getActiveWorkbook().getActiveSheet();
-     * const builder = worksheet.charts.create().setType(univerAPI.Enum.ChartTypeString.Waterfall);
      * builder.clearConnector();
-     * const connector = builder.describe().waterfall?.connector;
+     * const connector = builder.build().config.waterfall?.connector;
      * ```
      */
     clearConnector(): this;
@@ -75,9 +129,7 @@ export declare class FWaterfallChartBuilder extends FCartesianChartBuilder {
      * @returns This builder for chaining.
      * @example
      * ```ts
-     * const worksheet = univerAPI.getActiveWorkbook().getActiveSheet();
-     * const builder = worksheet.charts.create().setType(univerAPI.Enum.ChartTypeString.Waterfall);
-     * builder.setStackType(univerAPI.Enum.WaterfallStackTypeEnum.Arrangement);
+     * builder.setStackType(univerAPI.Enum.ChartWaterfallStackTypeEnum.Arrangement);
      * ```
      */
     setStackType(value: WaterfallStackTypeEnum): this;
@@ -89,8 +141,6 @@ export declare class FWaterfallChartBuilder extends FCartesianChartBuilder {
      * @returns This builder for chaining.
      * @example
      * ```ts
-     * const worksheet = univerAPI.getActiveWorkbook().getActiveSheet();
-     * const builder = worksheet.charts.create().setType(univerAPI.Enum.ChartTypeString.Waterfall);
      * builder.resetStackType();
      * ```
      */
@@ -104,8 +154,6 @@ export declare class FWaterfallChartBuilder extends FCartesianChartBuilder {
      * @returns This builder for chaining.
      * @example
      * ```ts
-     * const worksheet = univerAPI.getActiveWorkbook().getActiveSheet();
-     * const builder = worksheet.charts.create().setType(univerAPI.Enum.ChartTypeString.Waterfall);
      * builder.setUseSubtotal(true);
      * ```
      */
@@ -118,8 +166,6 @@ export declare class FWaterfallChartBuilder extends FCartesianChartBuilder {
      * @returns This builder for chaining.
      * @example
      * ```ts
-     * const worksheet = univerAPI.getActiveWorkbook().getActiveSheet();
-     * const builder = worksheet.charts.create().setType(univerAPI.Enum.ChartTypeString.Waterfall);
      * builder.resetUseSubtotal();
      * ```
      */
@@ -134,10 +180,8 @@ export declare class FWaterfallChartBuilder extends FCartesianChartBuilder {
      * @returns This builder for chaining.
      * @example
      * ```ts
-     * const worksheet = univerAPI.getActiveWorkbook().getActiveSheet();
-     * const builder = worksheet.charts.create().setType(univerAPI.Enum.ChartTypeString.Waterfall);
      * builder.setPositiveStyle(0, { color: '#52c41a' });
-     * const positive = builder.describe().series[0]?.waterfallStyles?.positive;
+     * const positive = builder.build().config.series[0]?.waterfallStyles?.positive;
      * ```
      */
     setPositiveStyle(selector: ChartPublicSeriesSelector, value: Omit<IChartSeriesPatch, 'selector'>): this;
@@ -150,10 +194,8 @@ export declare class FWaterfallChartBuilder extends FCartesianChartBuilder {
      * @returns This builder for chaining.
      * @example
      * ```ts
-     * const worksheet = univerAPI.getActiveWorkbook().getActiveSheet();
-     * const builder = worksheet.charts.create().setType(univerAPI.Enum.ChartTypeString.Waterfall);
      * builder.clearPositiveStyle(0);
-     * const positive = builder.describe().series[0]?.waterfallStyles?.positive;
+     * const positive = builder.build().config.series[0]?.waterfallStyles?.positive;
      * ```
      */
     clearPositiveStyle(selector: ChartPublicSeriesSelector): this;
@@ -167,10 +209,8 @@ export declare class FWaterfallChartBuilder extends FCartesianChartBuilder {
      * @returns This builder for chaining.
      * @example
      * ```ts
-     * const worksheet = univerAPI.getActiveWorkbook().getActiveSheet();
-     * const builder = worksheet.charts.create().setType(univerAPI.Enum.ChartTypeString.Waterfall);
      * builder.setNegativeStyle(0, { color: '#f5222d' });
-     * const negative = builder.describe().series[0]?.waterfallStyles?.negative;
+     * const negative = builder.build().config.series[0]?.waterfallStyles?.negative;
      * ```
      */
     setNegativeStyle(selector: ChartPublicSeriesSelector, value: Omit<IChartSeriesPatch, 'selector'>): this;
@@ -183,10 +223,8 @@ export declare class FWaterfallChartBuilder extends FCartesianChartBuilder {
      * @returns This builder for chaining.
      * @example
      * ```ts
-     * const worksheet = univerAPI.getActiveWorkbook().getActiveSheet();
-     * const builder = worksheet.charts.create().setType(univerAPI.Enum.ChartTypeString.Waterfall);
      * builder.clearNegativeStyle(0);
-     * const negative = builder.describe().series[0]?.waterfallStyles?.negative;
+     * const negative = builder.build().config.series[0]?.waterfallStyles?.negative;
      * ```
      */
     clearNegativeStyle(selector: ChartPublicSeriesSelector): this;
@@ -200,10 +238,8 @@ export declare class FWaterfallChartBuilder extends FCartesianChartBuilder {
      * @returns This builder for chaining.
      * @example
      * ```ts
-     * const worksheet = univerAPI.getActiveWorkbook().getActiveSheet();
-     * const builder = worksheet.charts.create().setType(univerAPI.Enum.ChartTypeString.Waterfall);
      * builder.setSubtotalStyle(0, { color: '#1677ff' });
-     * const subtotal = builder.describe().series[0]?.waterfallStyles?.subtotal;
+     * const subtotal = builder.build().config.series[0]?.waterfallStyles?.subtotal;
      * ```
      */
     setSubtotalStyle(selector: ChartPublicSeriesSelector, value: Omit<IChartSeriesPatch, 'selector'>): this;
@@ -216,10 +252,8 @@ export declare class FWaterfallChartBuilder extends FCartesianChartBuilder {
      * @returns This builder for chaining.
      * @example
      * ```ts
-     * const worksheet = univerAPI.getActiveWorkbook().getActiveSheet();
-     * const builder = worksheet.charts.create().setType(univerAPI.Enum.ChartTypeString.Waterfall);
      * builder.clearSubtotalStyle(0);
-     * const subtotal = builder.describe().series[0]?.waterfallStyles?.subtotal;
+     * const subtotal = builder.build().config.series[0]?.waterfallStyles?.subtotal;
      * ```
      */
     clearSubtotalStyle(selector: ChartPublicSeriesSelector): this;