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

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

@@ -1,7 +1,125 @@
-import type { DeepNullish, IChartPieCompositeSpec, IChartPieLabelSpec, IChartSliceStyleSpec } from '@univerjs-pro/engine-chart';
+import type { DeepNullish, IChartInfo, IChartPieCompositeSpec, IChartPieLabelSpec, IChartSliceStyleSpec } from '@univerjs-pro/engine-chart';
 import { FChartBuilderBase } from '../f-chart-builder-base';
-export declare class FPieChartBuilder extends FChartBuilderBase {
+/**
+ * Fluent, type-specific Builder for Pie and Donut Charts.
+ *
+ * For a conventional category/value source, select the slice-label field with
+ * `setCategoryField()` and select its numeric value field with `setValueFields([index])`.
+ * Field indexes are zero-based in the normalized data source. A value field is required;
+ * without an explicit category field, slices fall back to generated ordinal labels.
+ * Explicit mapping is recommended for ambiguous sources, especially Sheet ranges containing
+ * only numeric values, because automatic inference cannot determine the intended label column.
+ *
+ * A regular Pie uses the first selected value series. This example intentionally selects one
+ * value field so each source row becomes one labeled slice. Negative values render by absolute
+ * magnitude and retain a negative label and tooltip.
+ *
+ * @example Sheet
+ * ```ts
+ * const fWorkbook = univerAPI.getActiveWorkbook();
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+ * const chartInfo = fWorksheet
+ *   .newChart(univerAPI.Enum.ChartTypeString.Donut)
+ *   .setSource('A1:B8')
+ *   .setCategoryField(0)
+ *   .setValueFields([1])
+ *   .setDoughnutHole(0.4)
+ *   .setSliceStyle(0, { color: '#2563eb', fillOpacity: 0.8 })
+ *   .setExplosion(0.01)
+ *   .setSliceBorderColor('#ffffff')
+ *   .setPaddingAngleEnabled(true)
+ *   .setLabelLineVisible(true)
+ *   .setValueScale(1)
+ *   .setPieLabel({ visible: true, position: univerAPI.Enum.ChartPieLabelPosition.Outside })
+ *   .build();
+ * await fWorksheet.insertChart(chartInfo);
+ * ```
+ *
+ * @example Doc
+ * ```ts
+ * const fDocument = univerAPI.getActiveDocument();
+ * const chartInfo = fDocument
+ *   .newChart(univerAPI.Enum.ChartTypeString.Donut)
+ *   .setSource([['Channel', 'Sales'], ['Online', 180], ['Retail', 120]])
+ *   .setCategoryField(0)
+ *   .setValueFields([1])
+ *   .setDoughnutHole(0.4)
+ *   .setSliceStyle(0, { color: '#2563eb', fillOpacity: 0.8 })
+ *   .setExplosion(0.01)
+ *   .setSliceBorderColor('#ffffff')
+ *   .setPaddingAngleEnabled(true)
+ *   .setLabelLineVisible(true)
+ *   .setValueScale(1)
+ *   .setPieLabel({ visible: true, position: univerAPI.Enum.ChartPieLabelPosition.Outside })
+ *   .build();
+ * await fDocument.insertChart(chartInfo);
+ * ```
+ *
+ * @example Slide
+ * ```ts
+ * const fPresentation = univerAPI.getActivePresentation();
+ * const fSlide = fPresentation.getSlideByIndex(0);
+ * const chartInfo = fSlide
+ *   .newChart(univerAPI.Enum.ChartTypeString.Donut)
+ *   .setSource([['Channel', 'Sales'], ['Online', 180], ['Retail', 120]])
+ *   .setCategoryField(0)
+ *   .setValueFields([1])
+ *   .setDoughnutHole(0.4)
+ *   .setSliceStyle(0, { color: '#2563eb', fillOpacity: 0.8 })
+ *   .setExplosion(0.01)
+ *   .setSliceBorderColor('#ffffff')
+ *   .setPaddingAngleEnabled(true)
+ *   .setLabelLineVisible(true)
+ *   .setValueScale(1)
+ *   .setPieLabel({ visible: true, position: univerAPI.Enum.ChartPieLabelPosition.Outside })
+ *   .build();
+ * await fSlide.insertChart(chartInfo);
+ * ```
+ *
+ * @example Board
+ * ```ts
+ * const fBoard = univerAPI.getActiveBoard();
+ * const chartInfo = fBoard
+ *   .newChart(univerAPI.Enum.ChartTypeString.Donut)
+ *   .setSource([['Channel', 'Sales'], ['Online', 180], ['Retail', 120]])
+ *   .setCategoryField(0)
+ *   .setValueFields([1])
+ *   .setDoughnutHole(0.4)
+ *   .setSliceStyle(0, { color: '#2563eb', fillOpacity: 0.8 })
+ *   .setExplosion(0.01)
+ *   .setSliceBorderColor('#ffffff')
+ *   .setPaddingAngleEnabled(true)
+ *   .setLabelLineVisible(true)
+ *   .setValueScale(1)
+ *   .setPieLabel({ visible: true, position: univerAPI.Enum.ChartPieLabelPosition.Outside })
+ *   .build();
+ * await fBoard.insertChart(chartInfo);
+ * ```
+ */
+export declare class FPieChartBuilder<TSource = never[], TDataSource = TSource, TInfo extends IChartInfo<TDataSource> = IChartInfo<TDataSource>> extends FChartBuilderBase<TSource, TDataSource, TInfo> {
+    /**
+     * Sets secondary-plot and composite layout options for a Pie Chart.
+     *
+     * @param value The composite Pie specification.
+     * @returns This Builder for chaining.
+     * @example
+     * ```ts
+     * builder.setPieComposite({
+     *   enabled: true,
+     *   secondaryPlot: { type: univerAPI.Enum.ChartPieSecondaryPlotType.Pie },
+     * });
+     * ```
+     */
     setPieComposite(value: DeepNullish<IChartPieCompositeSpec>): this;
+    /**
+     * Clears composite Pie layout options.
+     *
+     * @returns This Builder for chaining.
+     * @example
+     * ```ts
+     * builder.clearPieComposite();
+     * ```
+     */
     clearPieComposite(): this;
     /**
      * Sets the style for the materialized slice at `index`.
@@ -15,8 +133,6 @@ export declare class FPieChartBuilder extends FChartBuilderBase {
      * ```ts
      * import { chartLinearGradient } from '@univerjs-pro/engine-chart';
      *
-     * const worksheet = univerAPI.getActiveWorkbook().getActiveSheet();
-     * const builder = worksheet.charts.create().setType(univerAPI.Enum.ChartTypeString.Pie);
      * const color = chartLinearGradient({
      *     start: { x: 0, y: 0 },
      *     end: { x: 1, y: 1 },
@@ -38,8 +154,6 @@ export declare class FPieChartBuilder extends FChartBuilderBase {
      * @returns This builder for chaining.
      * @example
      * ```ts
-     * const worksheet = univerAPI.getActiveWorkbook().getActiveSheet();
-     * const builder = worksheet.charts.create().setType(univerAPI.Enum.ChartTypeString.Pie);
      * builder.clearSliceStyle(0);
      * ```
      */
@@ -53,8 +167,6 @@ export declare class FPieChartBuilder extends FChartBuilderBase {
      * @returns This builder for chaining.
      * @example
      * ```ts
-     * const worksheet = univerAPI.getActiveWorkbook().getActiveSheet();
-     * const builder = worksheet.charts.create().setType(univerAPI.Enum.ChartTypeString.Pie);
      * builder.setDoughnutHole(0.6);
      * ```
      */
@@ -67,24 +179,22 @@ export declare class FPieChartBuilder extends FChartBuilderBase {
      * @returns This builder for chaining.
      * @example
      * ```ts
-     * const worksheet = univerAPI.getActiveWorkbook().getActiveSheet();
-     * const builder = worksheet.charts.create().setType(univerAPI.Enum.ChartTypeString.Pie);
      * builder.clearDoughnutHole();
      * ```
      */
     clearDoughnutHole(): this;
     /**
-     * Sets the explosion configuration and returns this builder for chaining.
+     * Sets the distance that every slice is offset from the Pie center.
      *
-     * This method executes synchronously.
+     * The value is a ratio of the Chart's shorter side, not a pixel distance. For example,
+     * `0.01` produces an offset of about 2.2 px in a 480 px square Chart. Large values can
+     * move every slice outside the visible plot area.
      *
-     * @param value The semantic value to record.
+     * @param value Non-negative explosion ratio.
      * @returns This builder for chaining.
      * @example
      * ```ts
-     * const worksheet = univerAPI.getActiveWorkbook().getActiveSheet();
-     * const builder = worksheet.charts.create().setType(univerAPI.Enum.ChartTypeString.Pie);
-     * builder.setExplosion(8);
+     * builder.setExplosion(0.01);
      * ```
      */
     setExplosion(value: number): this;
@@ -96,8 +206,6 @@ export declare class FPieChartBuilder extends FChartBuilderBase {
      * @returns This builder for chaining.
      * @example
      * ```ts
-     * const worksheet = univerAPI.getActiveWorkbook().getActiveSheet();
-     * const builder = worksheet.charts.create().setType(univerAPI.Enum.ChartTypeString.Pie);
      * builder.resetExplosion();
      * ```
      */
@@ -111,8 +219,6 @@ export declare class FPieChartBuilder extends FChartBuilderBase {
      * @returns This builder for chaining.
      * @example
      * ```ts
-     * const worksheet = univerAPI.getActiveWorkbook().getActiveSheet();
-     * const builder = worksheet.charts.create().setType(univerAPI.Enum.ChartTypeString.Pie);
      * builder.setSliceBorderColor('#ffffff');
      * ```
      */
@@ -125,8 +231,6 @@ export declare class FPieChartBuilder extends FChartBuilderBase {
      * @returns This builder for chaining.
      * @example
      * ```ts
-     * const worksheet = univerAPI.getActiveWorkbook().getActiveSheet();
-     * const builder = worksheet.charts.create().setType(univerAPI.Enum.ChartTypeString.Pie);
      * builder.clearSliceBorderColor();
      * ```
      */
@@ -140,8 +244,6 @@ export declare class FPieChartBuilder extends FChartBuilderBase {
      * @returns This builder for chaining.
      * @example
      * ```ts
-     * const worksheet = univerAPI.getActiveWorkbook().getActiveSheet();
-     * const builder = worksheet.charts.create().setType(univerAPI.Enum.ChartTypeString.Pie);
      * builder.setPaddingAngleEnabled(true);
      * ```
      */
@@ -154,8 +256,7 @@ export declare class FPieChartBuilder extends FChartBuilderBase {
      * @returns This builder for chaining.
      * @example
      * ```ts
-     * const worksheet = univerAPI.getActiveWorkbook().getActiveSheet();
-     * worksheet.charts.create().setType(univerAPI.Enum.ChartTypeString.Pie).resetPaddingAngleEnabled();
+     * builder.resetPaddingAngleEnabled();
      * ```
      */
     resetPaddingAngleEnabled(): this;
@@ -168,8 +269,6 @@ export declare class FPieChartBuilder extends FChartBuilderBase {
      * @returns This builder for chaining.
      * @example
      * ```ts
-     * const worksheet = univerAPI.getActiveWorkbook().getActiveSheet();
-     * const builder = worksheet.charts.create().setType(univerAPI.Enum.ChartTypeString.Pie);
      * builder.setHalfPie(true);
      * ```
      */
@@ -182,8 +281,7 @@ export declare class FPieChartBuilder extends FChartBuilderBase {
      * @returns This builder for chaining.
      * @example
      * ```ts
-     * const worksheet = univerAPI.getActiveWorkbook().getActiveSheet();
-     * worksheet.charts.create().setType(univerAPI.Enum.ChartTypeString.Pie).resetHalfPie();
+     * builder.resetHalfPie();
      * ```
      */
     resetHalfPie(): this;
@@ -196,8 +294,6 @@ export declare class FPieChartBuilder extends FChartBuilderBase {
      * @returns This builder for chaining.
      * @example
      * ```ts
-     * const worksheet = univerAPI.getActiveWorkbook().getActiveSheet();
-     * const builder = worksheet.charts.create().setType(univerAPI.Enum.ChartTypeString.Pie);
      * builder.setRosePie(true);
      * ```
      */
@@ -210,8 +306,7 @@ export declare class FPieChartBuilder extends FChartBuilderBase {
      * @returns This builder for chaining.
      * @example
      * ```ts
-     * const worksheet = univerAPI.getActiveWorkbook().getActiveSheet();
-     * worksheet.charts.create().setType(univerAPI.Enum.ChartTypeString.Pie).resetRosePie();
+     * builder.resetRosePie();
      * ```
      */
     resetRosePie(): this;
@@ -224,8 +319,6 @@ export declare class FPieChartBuilder extends FChartBuilderBase {
      * @returns This builder for chaining.
      * @example
      * ```ts
-     * const worksheet = univerAPI.getActiveWorkbook().getActiveSheet();
-     * const builder = worksheet.charts.create().setType(univerAPI.Enum.ChartTypeString.Pie);
      * builder.setLabelLineVisible(true);
      * ```
      */
@@ -238,8 +331,7 @@ export declare class FPieChartBuilder extends FChartBuilderBase {
      * @returns This builder for chaining.
      * @example
      * ```ts
-     * const worksheet = univerAPI.getActiveWorkbook().getActiveSheet();
-     * worksheet.charts.create().setType(univerAPI.Enum.ChartTypeString.Pie).resetLabelLineVisible();
+     * builder.resetLabelLineVisible();
      * ```
      */
     resetLabelLineVisible(): this;
@@ -252,8 +344,6 @@ export declare class FPieChartBuilder extends FChartBuilderBase {
      * @returns This builder for chaining.
      * @example
      * ```ts
-     * const worksheet = univerAPI.getActiveWorkbook().getActiveSheet();
-     * const builder = worksheet.charts.create().setType(univerAPI.Enum.ChartTypeString.Pie);
      * builder.setValueScale(1);
      * ```
      */
@@ -266,8 +356,6 @@ export declare class FPieChartBuilder extends FChartBuilderBase {
      * @returns This builder for chaining.
      * @example
      * ```ts
-     * const worksheet = univerAPI.getActiveWorkbook().getActiveSheet();
-     * const builder = worksheet.charts.create().setType(univerAPI.Enum.ChartTypeString.Pie);
      * builder.resetValueScale();
      * ```
      */
@@ -284,9 +372,7 @@ export declare class FPieChartBuilder extends FChartBuilderBase {
      * @returns This builder for chaining.
      * @example
      * ```ts
-     * const worksheet = univerAPI.getActiveWorkbook().getActiveSheet();
-     * const builder = worksheet.charts.create().setType(univerAPI.Enum.ChartTypeString.Pie);
-     * builder.setPieLabel({ visible: true, position: univerAPI.Enum.PieLabelPosition.Outside });
+     * builder.setPieLabel({ visible: true, position: univerAPI.Enum.ChartPieLabelPosition.Outside });
      * ```
      */
     setPieLabel(value: DeepNullish<IChartPieLabelSpec>): this;
@@ -299,8 +385,6 @@ export declare class FPieChartBuilder extends FChartBuilderBase {
      * @returns This builder for chaining.
      * @example
      * ```ts
-     * const worksheet = univerAPI.getActiveWorkbook().getActiveSheet();
-     * const builder = worksheet.charts.create().setType(univerAPI.Enum.ChartTypeString.Pie);
      * builder.clearPieLabel();
      * ```
      */

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

@@ -1,6 +1,67 @@
-import type { RadarShape } from '@univerjs-pro/engine-chart';
+import type { IChartInfo, RadarShape } from '@univerjs-pro/engine-chart';
 import { FChartBuilderBase } from '../f-chart-builder-base';
-export declare class FRadarChartBuilder extends FChartBuilderBase {
+/**
+ * Fluent, type-specific Builder for Radar Charts.
+ *
+ * @example Sheet
+ * ```ts
+ * const fWorkbook = univerAPI.getActiveWorkbook();
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+ * const chartInfo = fWorksheet
+ *   .newChart(univerAPI.Enum.ChartTypeString.Radar)
+ *   .setSource('A1:D8')
+ *   .setCategoryField(0)
+ *   .setValueFields([1, 2, 3])
+ *   .setShape(univerAPI.Enum.ChartRadarShape.Circle)
+ *   .setFill(true)
+ *   .build();
+ * await fWorksheet.insertChart(chartInfo);
+ * ```
+ *
+ * @example Doc
+ * ```ts
+ * const fDocument = univerAPI.getActiveDocument();
+ * const chartInfo = fDocument
+ *   .newChart(univerAPI.Enum.ChartTypeString.Radar)
+ *   .setSource([['Metric', 'Product A', 'Product B'], ['Speed', 80, 72], ['Quality', 90, 84]])
+ *   .setCategoryField(0)
+ *   .setValueFields([1, 2])
+ *   .setShape(univerAPI.Enum.ChartRadarShape.Circle)
+ *   .setFill(true)
+ *   .build();
+ * await fDocument.insertChart(chartInfo);
+ * ```
+ *
+ * @example Slide
+ * ```ts
+ * const fPresentation = univerAPI.getActivePresentation();
+ * const fSlide = fPresentation.getSlideByIndex(0);
+ * const chartInfo = fSlide
+ *   .newChart(univerAPI.Enum.ChartTypeString.Radar)
+ *   .setSource([['Metric', 'Product A', 'Product B'], ['Speed', 80, 72], ['Quality', 90, 84]])
+ *   .setCategoryField(0)
+ *   .setValueFields([1, 2])
+ *   .setShape(univerAPI.Enum.ChartRadarShape.Circle)
+ *   .setFill(true)
+ *   .build();
+ * await fSlide.insertChart(chartInfo);
+ * ```
+ *
+ * @example Board
+ * ```ts
+ * const fBoard = univerAPI.getActiveBoard();
+ * const chartInfo = fBoard
+ *   .newChart(univerAPI.Enum.ChartTypeString.Radar)
+ *   .setSource([['Metric', 'Product A', 'Product B'], ['Speed', 80, 72], ['Quality', 90, 84]])
+ *   .setCategoryField(0)
+ *   .setValueFields([1, 2])
+ *   .setShape(univerAPI.Enum.ChartRadarShape.Circle)
+ *   .setFill(true)
+ *   .build();
+ * await fBoard.insertChart(chartInfo);
+ * ```
+ */
+export declare class FRadarChartBuilder<TSource = never[], TDataSource = TSource, TInfo extends IChartInfo<TDataSource> = IChartInfo<TDataSource>> extends FChartBuilderBase<TSource, TDataSource, TInfo> {
     /**
      * Sets the shape configuration and returns this builder for chaining.
      *
@@ -10,9 +71,7 @@ export declare class FRadarChartBuilder extends FChartBuilderBase {
      * @returns This builder for chaining.
      * @example
      * ```ts
-     * const worksheet = univerAPI.getActiveWorkbook().getActiveSheet();
-     * const builder = worksheet.charts.create().setType(univerAPI.Enum.ChartTypeString.Radar);
-     * builder.setShape(univerAPI.Enum.RadarShape.Polygon);
+     * builder.setShape(univerAPI.Enum.ChartRadarShape.Polygon);
      * ```
      */
     setShape(value: RadarShape): this;
@@ -24,8 +83,6 @@ export declare class FRadarChartBuilder extends FChartBuilderBase {
      * @returns This builder for chaining.
      * @example
      * ```ts
-     * const worksheet = univerAPI.getActiveWorkbook().getActiveSheet();
-     * const builder = worksheet.charts.create().setType(univerAPI.Enum.ChartTypeString.Radar);
      * builder.resetShape();
      * ```
      */
@@ -39,8 +96,6 @@ export declare class FRadarChartBuilder extends FChartBuilderBase {
      * @returns This builder for chaining.
      * @example
      * ```ts
-     * const worksheet = univerAPI.getActiveWorkbook().getActiveSheet();
-     * const builder = worksheet.charts.create().setType(univerAPI.Enum.ChartTypeString.Radar);
      * builder.setFill(true);
      * ```
      */
@@ -53,8 +108,6 @@ export declare class FRadarChartBuilder extends FChartBuilderBase {
      * @returns This builder for chaining.
      * @example
      * ```ts
-     * const worksheet = univerAPI.getActiveWorkbook().getActiveSheet();
-     * const builder = worksheet.charts.create().setType(univerAPI.Enum.ChartTypeString.Radar);
      * builder.resetFill();
      * ```
      */

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

@@ -1,4 +1,4 @@
-import type { IChartRelationForceSpec, LinePointShape, RelationChartLayoutEnum } from '@univerjs-pro/engine-chart';
+import type { IChartInfo, IChartRelationForceSpec, LinePointShape, RelationChartLayoutEnum } from '@univerjs-pro/engine-chart';
 import { FChartBuilderBase } from '../f-chart-builder-base';
 /**
  * Configures a relation chart.
@@ -16,13 +16,14 @@ import { FChartBuilderBase } from '../f-chart-builder-base';
  *    values; without one, every link has weight `1`.
  *
  * A two-column edge list is treated as unweighted. A three-column edge list uses column `2` as its
- * weight automatically. If the range has more than three columns, select exactly one weight column
- * with {@link FChartBuilderBase.setValueFields}; selecting multiple weight columns or either endpoint
- * column makes the source invalid. A weighted edge list creates at most one category, named after
- * the selected weight column when that column has a non-empty header. An unweighted edge list
- * creates no categories.
+ * weight automatically. Use this canonical two- or three-column shape so the Source, Target, and
+ * optional Weight roles are inferred together. Do not call {@link FChartBuilderBase.setCategoryField}
+ * or {@link FChartBuilderBase.setValueFields} for this shape: those generic mapping methods cannot
+ * describe both endpoint roles and replace the automatic Relation mapping. A weighted edge list
+ * creates at most one category, named after the weight column when that column has a non-empty
+ * header. An unweighted edge list creates no categories.
  *
- * @example
+ * @example Sheet
  * A worksheet range `A1:C4` can contain this weighted edge list:
  *
  * | Source | Target | Weight |
@@ -32,13 +33,70 @@ import { FChartBuilderBase } from '../f-chart-builder-base';
  * | C | B | 2 |
  *
  * ```ts
- * worksheet.charts.create()
- *     .setSource('A1:C4')
- *     .setType(univerAPI.Enum.ChartTypeString.Relation)
- *     .setValueFields([2]);
+ * const fWorkbook = univerAPI.getActiveWorkbook();
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+ * const chartInfo = fWorksheet
+ *   .newChart(univerAPI.Enum.ChartTypeString.Relation)
+ *   .setSource({
+ *     range: 'A1:C4',
+ *     orientation: univerAPI.Enum.ChartSourceOrientation.Columns,
+ *   })
+ *   .setLayout(univerAPI.Enum.ChartRelationChartLayoutEnum.Force)
+ *   .setUseValueAsSymbolSize(true)
+ *   .setEmphasisEnabled(true)
+ *   .setForce({ gravity: 0.2, repulsion: 50 })
+ *   .setNodeShape(univerAPI.Enum.ChartLinePointShape.Circle)
+ *   .build();
+ * await fWorksheet.insertChart(chartInfo);
+ * ```
+ *
+ * @example Doc
+ * ```ts
+ * const fDocument = univerAPI.getActiveDocument();
+ * const chartInfo = fDocument
+ *   .newChart(univerAPI.Enum.ChartTypeString.Relation)
+ *   .setSource([['Source', 'Target', 'Weight'], ['A', 'B', 5], ['A', 'C', 3], ['C', 'B', 2]])
+ *   .setLayout(univerAPI.Enum.ChartRelationChartLayoutEnum.Force)
+ *   .setUseValueAsSymbolSize(true)
+ *   .setEmphasisEnabled(true)
+ *   .setForce({ gravity: 0.2, repulsion: 50 })
+ *   .setNodeShape(univerAPI.Enum.ChartLinePointShape.Circle)
+ *   .build();
+ * await fDocument.insertChart(chartInfo);
+ * ```
+ *
+ * @example Slide
+ * ```ts
+ * const fPresentation = univerAPI.getActivePresentation();
+ * const fSlide = fPresentation.getSlideByIndex(0);
+ * const chartInfo = fSlide
+ *   .newChart(univerAPI.Enum.ChartTypeString.Relation)
+ *   .setSource([['Source', 'Target', 'Weight'], ['A', 'B', 5], ['A', 'C', 3], ['C', 'B', 2]])
+ *   .setLayout(univerAPI.Enum.ChartRelationChartLayoutEnum.Force)
+ *   .setUseValueAsSymbolSize(true)
+ *   .setEmphasisEnabled(true)
+ *   .setForce({ gravity: 0.2, repulsion: 50 })
+ *   .setNodeShape(univerAPI.Enum.ChartLinePointShape.Circle)
+ *   .build();
+ * await fSlide.insertChart(chartInfo);
+ * ```
+ *
+ * @example Board
+ * ```ts
+ * const fBoard = univerAPI.getActiveBoard();
+ * const chartInfo = fBoard
+ *   .newChart(univerAPI.Enum.ChartTypeString.Relation)
+ *   .setSource([['Source', 'Target', 'Weight'], ['A', 'B', 5], ['A', 'C', 3], ['C', 'B', 2]])
+ *   .setLayout(univerAPI.Enum.ChartRelationChartLayoutEnum.Force)
+ *   .setUseValueAsSymbolSize(true)
+ *   .setEmphasisEnabled(true)
+ *   .setForce({ gravity: 0.2, repulsion: 50 })
+ *   .setNodeShape(univerAPI.Enum.ChartLinePointShape.Circle)
+ *   .build();
+ * await fBoard.insertChart(chartInfo);
  * ```
  */
-export declare class FRelationChartBuilder extends FChartBuilderBase {
+export declare class FRelationChartBuilder<TSource = never[], TDataSource = TSource, TInfo extends IChartInfo<TDataSource> = IChartInfo<TDataSource>> extends FChartBuilderBase<TSource, TDataSource, TInfo> {
     /**
      * Sets the layout configuration and returns this builder for chaining.
      *
@@ -48,9 +106,7 @@ export declare class FRelationChartBuilder extends FChartBuilderBase {
      * @returns This builder for chaining.
      * @example
      * ```ts
-     * const worksheet = univerAPI.getActiveWorkbook().getActiveSheet();
-     * const builder = worksheet.charts.create().setType(univerAPI.Enum.ChartTypeString.Relation);
-     * builder.setLayout(univerAPI.Enum.RelationChartLayoutEnum.Force);
+     * builder.setLayout(univerAPI.Enum.ChartRelationChartLayoutEnum.Force);
      * ```
      */
     setLayout(value: RelationChartLayoutEnum): this;
@@ -62,8 +118,6 @@ export declare class FRelationChartBuilder extends FChartBuilderBase {
      * @returns This builder for chaining.
      * @example
      * ```ts
-     * const worksheet = univerAPI.getActiveWorkbook().getActiveSheet();
-     * const builder = worksheet.charts.create().setType(univerAPI.Enum.ChartTypeString.Relation);
      * builder.resetLayout();
      * ```
      */
@@ -77,8 +131,6 @@ export declare class FRelationChartBuilder extends FChartBuilderBase {
      * @returns This builder for chaining.
      * @example
      * ```ts
-     * const worksheet = univerAPI.getActiveWorkbook().getActiveSheet();
-     * const builder = worksheet.charts.create().setType(univerAPI.Enum.ChartTypeString.Relation);
      * builder.setUseValueAsSymbolSize(true);
      * ```
      */
@@ -91,8 +143,6 @@ export declare class FRelationChartBuilder extends FChartBuilderBase {
      * @returns This builder for chaining.
      * @example
      * ```ts
-     * const worksheet = univerAPI.getActiveWorkbook().getActiveSheet();
-     * const builder = worksheet.charts.create().setType(univerAPI.Enum.ChartTypeString.Relation);
      * builder.resetUseValueAsSymbolSize();
      * ```
      */
@@ -106,8 +156,6 @@ export declare class FRelationChartBuilder extends FChartBuilderBase {
      * @returns This builder for chaining.
      * @example
      * ```ts
-     * const worksheet = univerAPI.getActiveWorkbook().getActiveSheet();
-     * const builder = worksheet.charts.create().setType(univerAPI.Enum.ChartTypeString.Relation);
      * builder.setEmphasisEnabled(true);
      * ```
      */
@@ -120,8 +168,6 @@ export declare class FRelationChartBuilder extends FChartBuilderBase {
      * @returns This builder for chaining.
      * @example
      * ```ts
-     * const worksheet = univerAPI.getActiveWorkbook().getActiveSheet();
-     * const builder = worksheet.charts.create().setType(univerAPI.Enum.ChartTypeString.Relation);
      * builder.resetEmphasisEnabled();
      * ```
      */
@@ -138,8 +184,6 @@ export declare class FRelationChartBuilder extends FChartBuilderBase {
      * @returns This builder for chaining.
      * @example
      * ```ts
-     * const worksheet = univerAPI.getActiveWorkbook().getActiveSheet();
-     * const builder = worksheet.charts.create().setType(univerAPI.Enum.ChartTypeString.Relation);
      * builder.setForce({ gravity: 0.2, repulsion: 50 });
      * ```
      */
@@ -155,8 +199,6 @@ export declare class FRelationChartBuilder extends FChartBuilderBase {
      * @returns This builder for chaining.
      * @example
      * ```ts
-     * const worksheet = univerAPI.getActiveWorkbook().getActiveSheet();
-     * const builder = worksheet.charts.create().setType(univerAPI.Enum.ChartTypeString.Relation);
      * builder.clearForce();
      * ```
      */
@@ -170,8 +212,6 @@ export declare class FRelationChartBuilder extends FChartBuilderBase {
      * @returns This builder for chaining.
      * @example
      * ```ts
-     * const worksheet = univerAPI.getActiveWorkbook().getActiveSheet();
-     * const builder = worksheet.charts.create().setType(univerAPI.Enum.ChartTypeString.Relation);
      * builder.setCircularLabelRotation(true);
      * ```
      */
@@ -184,8 +224,6 @@ export declare class FRelationChartBuilder extends FChartBuilderBase {
      * @returns This builder for chaining.
      * @example
      * ```ts
-     * const worksheet = univerAPI.getActiveWorkbook().getActiveSheet();
-     * const builder = worksheet.charts.create().setType(univerAPI.Enum.ChartTypeString.Relation);
      * builder.resetCircularLabelRotation();
      * ```
      */
@@ -199,9 +237,7 @@ export declare class FRelationChartBuilder extends FChartBuilderBase {
      * @returns This builder for chaining.
      * @example
      * ```ts
-     * const worksheet = univerAPI.getActiveWorkbook().getActiveSheet();
-     * const builder = worksheet.charts.create().setType(univerAPI.Enum.ChartTypeString.Relation);
-     * builder.setNodeShape(univerAPI.Enum.LinePointShape.Circle);
+     * builder.setNodeShape(univerAPI.Enum.ChartLinePointShape.Circle);
      * ```
      */
     setNodeShape(value: LinePointShape): this;
@@ -213,8 +249,6 @@ export declare class FRelationChartBuilder extends FChartBuilderBase {
      * @returns This builder for chaining.
      * @example
      * ```ts
-     * const worksheet = univerAPI.getActiveWorkbook().getActiveSheet();
-     * const builder = worksheet.charts.create().setType(univerAPI.Enum.ChartTypeString.Relation);
      * builder.resetNodeShape();
      * ```
      */