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

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

@@ -0,0 +1,202 @@
+import type { IChartChordEmphasisSpec, IChartChordLabelSpec, IChartChordLayoutSpec, IChartChordMappingSpec, IChartChordNodeStyleSpec, IChartChordRibbonStyleSpec, IChartInfo } from '@univerjs-pro/engine-chart';
+import { FChartBuilderBase } from '../f-chart-builder-base';
+/**
+ * Fluent semantic builder for an undirected Source/Target/optional-Value edge list.
+ *
+ * Final display labels own node identity. Duplicate and reverse rows aggregate,
+ * omitted Value means unit-weight counts, and blank endpoints, self-links, and
+ * non-positive/non-finite mapped weights are skipped without coercion. Aggregate
+ * values are formatted after summing. Defaults are renderer-owned and require the
+ * native ECharts 6.1 Chord series; no renderer nodes, links, or layout are persisted.
+ *
+ * @example Sheet
+ * ```ts
+ * const fWorkbook = univerAPI.getActiveWorkbook();
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+ * const chartInfo = fWorksheet
+ *   .newChart(univerAPI.Enum.ChartTypeString.Chord)
+ *   .setSource('A1:C8')
+ *   .setChordMapping({ sourceIndex: 0, targetIndex: 1, valueIndex: 2 })
+ *   .setChordLayout({ startAngle: 90, clockwise: true, innerRadiusRatio: 0.4, outerRadiusRatio: 0.8 })
+ *   .setChordNode({ color: '#2563eb', opacity: 0.8 })
+ *   .setChordLabel({ visible: true, position: univerAPI.Enum.ChartChordLabelPosition.Outside, color: '#334155' })
+ *   .setChordRibbon({ color: univerAPI.Enum.ChartChordRibbonColorMode.Gradient, opacity: 0.6 })
+ *   .setChordEmphasis({ focus: univerAPI.Enum.ChartChordFocusMode.Adjacency })
+ *   .build();
+ * await fWorksheet.insertChart(chartInfo);
+ * ```
+ *
+ * @example Doc
+ * ```ts
+ * const fDocument = univerAPI.getActiveDocument();
+ * const chartInfo = fDocument
+ *   .newChart(univerAPI.Enum.ChartTypeString.Chord)
+ *   .setSource([['Source', 'Target', 'Value'], ['A', 'B', 5], ['A', 'C', 3], ['B', 'C', 2]])
+ *   .setChordMapping({ sourceIndex: 0, targetIndex: 1, valueIndex: 2 })
+ *   .setChordLayout({ startAngle: 90, clockwise: true, innerRadiusRatio: 0.4, outerRadiusRatio: 0.8 })
+ *   .setChordNode({ color: '#2563eb', opacity: 0.8 })
+ *   .setChordLabel({ visible: true, position: univerAPI.Enum.ChartChordLabelPosition.Outside, color: '#334155' })
+ *   .setChordRibbon({ color: univerAPI.Enum.ChartChordRibbonColorMode.Gradient, opacity: 0.6 })
+ *   .setChordEmphasis({ focus: univerAPI.Enum.ChartChordFocusMode.Adjacency })
+ *   .build();
+ * await fDocument.insertChart(chartInfo);
+ * ```
+ *
+ * @example Slide
+ * ```ts
+ * const fPresentation = univerAPI.getActivePresentation();
+ * const fSlide = fPresentation.getSlideByIndex(0);
+ * const chartInfo = fSlide
+ *   .newChart(univerAPI.Enum.ChartTypeString.Chord)
+ *   .setSource([['Source', 'Target', 'Value'], ['A', 'B', 5], ['A', 'C', 3], ['B', 'C', 2]])
+ *   .setChordMapping({ sourceIndex: 0, targetIndex: 1, valueIndex: 2 })
+ *   .setChordLayout({ startAngle: 90, clockwise: true, innerRadiusRatio: 0.4, outerRadiusRatio: 0.8 })
+ *   .setChordNode({ color: '#2563eb', opacity: 0.8 })
+ *   .setChordLabel({ visible: true, position: univerAPI.Enum.ChartChordLabelPosition.Outside, color: '#334155' })
+ *   .setChordRibbon({ color: univerAPI.Enum.ChartChordRibbonColorMode.Gradient, opacity: 0.6 })
+ *   .setChordEmphasis({ focus: univerAPI.Enum.ChartChordFocusMode.Adjacency })
+ *   .build();
+ * await fSlide.insertChart(chartInfo);
+ * ```
+ *
+ * @example Board
+ * ```ts
+ * const fBoard = univerAPI.getActiveBoard();
+ * const chartInfo = fBoard
+ *   .newChart(univerAPI.Enum.ChartTypeString.Chord)
+ *   .setSource([['Source', 'Target', 'Value'], ['A', 'B', 5], ['A', 'C', 3], ['B', 'C', 2]])
+ *   .setChordMapping({ sourceIndex: 0, targetIndex: 1, valueIndex: 2 })
+ *   .setChordLayout({ startAngle: 90, clockwise: true, innerRadiusRatio: 0.4, outerRadiusRatio: 0.8 })
+ *   .setChordNode({ color: '#2563eb', opacity: 0.8 })
+ *   .setChordLabel({ visible: true, position: univerAPI.Enum.ChartChordLabelPosition.Outside, color: '#334155' })
+ *   .setChordRibbon({ color: univerAPI.Enum.ChartChordRibbonColorMode.Gradient, opacity: 0.6 })
+ *   .setChordEmphasis({ focus: univerAPI.Enum.ChartChordFocusMode.Adjacency })
+ *   .build();
+ * await fBoard.insertChart(chartInfo);
+ * ```
+ */
+export declare class FChordChartBuilder<TSource = never[], TDataSource = TSource, TInfo extends IChartInfo<TDataSource> = IChartInfo<TDataSource>> extends FChartBuilderBase<TSource, TDataSource, TInfo> {
+    /**
+     * Sets the Source, Target, and optional Value field indexes for Chord edges.
+     *
+     * @param value Zero-based field indexes for each edge component.
+     * @returns This builder for chaining.
+     * @example
+     * ```ts
+     * builder.setChordMapping({ sourceIndex: 0, targetIndex: 1, valueIndex: 2 });
+     * ```
+     */
+    setChordMapping(value: IChartChordMappingSpec): this;
+    /**
+     * Sets the Chord radius, rotation, and spacing layout.
+     *
+     * @param value Chord layout settings.
+     * @returns This builder for chaining.
+     * @example
+     * ```ts
+     * builder.setChordLayout({ startAngle: 90, clockwise: true });
+     * ```
+     */
+    setChordLayout(value: IChartChordLayoutSpec): this;
+    /**
+     * Resets the Chord layout to renderer defaults.
+     *
+     * @returns This builder for chaining.
+     * @example
+     * ```ts
+     * builder.resetChordLayout();
+     * ```
+     */
+    resetChordLayout(): this;
+    /**
+     * Sets Chart-wide Chord node styling.
+     *
+     * @param value Chord node appearance settings.
+     * @returns This builder for chaining.
+     * @example
+     * ```ts
+     * builder.setChordNode({ color: '#2563eb', opacity: 0.8 });
+     * ```
+     */
+    setChordNode(value: IChartChordNodeStyleSpec): this;
+    /**
+     * Resets Chord node styling to renderer defaults.
+     *
+     * @returns This builder for chaining.
+     * @example
+     * ```ts
+     * builder.resetChordNode();
+     * ```
+     */
+    resetChordNode(): this;
+    /**
+     * Sets Chord node-label visibility, position, and styling.
+     *
+     * @param value Chord label settings.
+     * @returns This builder for chaining.
+     * @example
+     * ```ts
+     * builder.setChordLabel({
+     *   visible: true,
+     *   position: univerAPI.Enum.ChartChordLabelPosition.Outside,
+     *   color: '#334155',
+     * });
+     * ```
+     */
+    setChordLabel(value: IChartChordLabelSpec): this;
+    /**
+     * Resets Chord labels to renderer defaults.
+     *
+     * @returns This builder for chaining.
+     * @example
+     * ```ts
+     * builder.resetChordLabel();
+     * ```
+     */
+    resetChordLabel(): this;
+    /**
+     * Sets Chord ribbon color, opacity, and border styling.
+     *
+     * @param value Chord ribbon appearance settings.
+     * @returns This builder for chaining.
+     * @example
+     * ```ts
+     * builder.setChordRibbon({
+     *   color: univerAPI.Enum.ChartChordRibbonColorMode.Gradient,
+     *   opacity: 0.6,
+     * });
+     * ```
+     */
+    setChordRibbon(value: IChartChordRibbonStyleSpec): this;
+    /**
+     * Resets Chord ribbon styling to renderer defaults.
+     *
+     * @returns This builder for chaining.
+     * @example
+     * ```ts
+     * builder.resetChordRibbon();
+     * ```
+     */
+    resetChordRibbon(): this;
+    /**
+     * Sets hover emphasis and focus behavior.
+     *
+     * @param value Chord emphasis settings.
+     * @returns This builder for chaining.
+     * @example
+     * ```ts
+     * builder.setChordEmphasis({ focus: univerAPI.Enum.ChartChordFocusMode.Adjacency });
+     * ```
+     */
+    setChordEmphasis(value: IChartChordEmphasisSpec): this;
+    /**
+     * Resets Chord emphasis behavior to renderer defaults.
+     *
+     * @returns This builder for chaining.
+     * @example
+     * ```ts
+     * builder.resetChordEmphasis();
+     * ```
+     */
+    resetChordEmphasis(): this;
+}

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

@@ -1,6 +1,59 @@
-import type { ChartPublicSeriesSelector, ChartSeriesAxis, ChartSeriesTypeString } from '@univerjs-pro/engine-chart';
+import type { ChartPublicSeriesSelector, ChartSeriesAxis, ChartSeriesTypeString, IChartInfo, IChartSeriesPatch, IChartSeriesStyleSpec } from '@univerjs-pro/engine-chart';
 import { FCartesianChartBuilder } from '../f-cartesian-chart-builder';
-export declare class FCombinationChartBuilder extends FCartesianChartBuilder {
+/**
+ * Fluent, type-specific Builder for mixed Column, Line, and Area Combination Charts.
+ *
+ * @example Sheet
+ * ```ts
+ * const fWorkbook = univerAPI.getActiveWorkbook();
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+ * const chartInfo = fWorksheet
+ *   .newChart(univerAPI.Enum.ChartTypeString.Combination)
+ *   .setSource('A1:D8')
+ *   .setSeriesType(0, univerAPI.Enum.ChartSeriesTypeString.Line)
+ *   .setSeriesAxis(0, univerAPI.Enum.ChartSeriesAxis.Right)
+ *   .build();
+ * await fWorksheet.insertChart(chartInfo);
+ * ```
+ *
+ * @example Doc
+ * ```ts
+ * const fDocument = univerAPI.getActiveDocument();
+ * const chartInfo = fDocument
+ *   .newChart(univerAPI.Enum.ChartTypeString.Combination)
+ *   .setSource([['Month', 'Sales', 'Profit'], ['Jan', 120, 24], ['Feb', 180, 38]])
+ *   .setSeriesType(0, univerAPI.Enum.ChartSeriesTypeString.Line)
+ *   .setSeriesAxis(0, univerAPI.Enum.ChartSeriesAxis.Right)
+ *   .build();
+ * await fDocument.insertChart(chartInfo);
+ * ```
+ *
+ * @example Slide
+ * ```ts
+ * const fPresentation = univerAPI.getActivePresentation();
+ * const fSlide = fPresentation.getSlideByIndex(0);
+ * const chartInfo = fSlide
+ *   .newChart(univerAPI.Enum.ChartTypeString.Combination)
+ *   .setSource([['Month', 'Sales', 'Profit'], ['Jan', 120, 24], ['Feb', 180, 38]])
+ *   .setSeriesType(0, univerAPI.Enum.ChartSeriesTypeString.Line)
+ *   .setSeriesAxis(0, univerAPI.Enum.ChartSeriesAxis.Right)
+ *   .build();
+ * await fSlide.insertChart(chartInfo);
+ * ```
+ *
+ * @example Board
+ * ```ts
+ * const fBoard = univerAPI.getActiveBoard();
+ * const chartInfo = fBoard
+ *   .newChart(univerAPI.Enum.ChartTypeString.Combination)
+ *   .setSource([['Month', 'Sales', 'Profit'], ['Jan', 120, 24], ['Feb', 180, 38]])
+ *   .setSeriesType(0, univerAPI.Enum.ChartSeriesTypeString.Line)
+ *   .setSeriesAxis(0, univerAPI.Enum.ChartSeriesAxis.Right)
+ *   .build();
+ * await fBoard.insertChart(chartInfo);
+ * ```
+ */
+export declare class FCombinationChartBuilder<TSource = never[], TDataSource = TSource, TInfo extends IChartInfo<TDataSource> = IChartInfo<TDataSource>> extends FCartesianChartBuilder<Omit<IChartSeriesPatch, 'selector'>, IChartSeriesStyleSpec, TSource, TDataSource, TInfo> {
     /**
      * Sets the series type configuration and returns this builder for chaining.
      *
@@ -11,8 +64,6 @@ export declare class FCombinationChartBuilder extends FCartesianChartBuilder {
      * @returns This builder for chaining.
      * @example
      * ```ts
-     * const worksheet = univerAPI.getActiveWorkbook().getActiveSheet();
-     * const builder = worksheet.charts.create().setType(univerAPI.Enum.ChartTypeString.Combination);
      * builder.setSeriesType(0, univerAPI.Enum.ChartSeriesTypeString.Line);
      * ```
      */
@@ -26,8 +77,6 @@ export declare class FCombinationChartBuilder extends FCartesianChartBuilder {
      * @returns This builder for chaining.
      * @example
      * ```ts
-     * const worksheet = univerAPI.getActiveWorkbook().getActiveSheet();
-     * const builder = worksheet.charts.create().setType(univerAPI.Enum.ChartTypeString.Combination);
      * builder.resetSeriesType(0);
      * ```
      */
@@ -42,8 +91,6 @@ export declare class FCombinationChartBuilder extends FCartesianChartBuilder {
      * @returns This builder for chaining.
      * @example
      * ```ts
-     * const worksheet = univerAPI.getActiveWorkbook().getActiveSheet();
-     * const builder = worksheet.charts.create().setType(univerAPI.Enum.ChartTypeString.Combination);
      * builder.setSeriesAxis(0, univerAPI.Enum.ChartSeriesAxis.Right);
      * ```
      */
@@ -57,8 +104,6 @@ export declare class FCombinationChartBuilder extends FCartesianChartBuilder {
      * @returns This builder for chaining.
      * @example
      * ```ts
-     * const worksheet = univerAPI.getActiveWorkbook().getActiveSheet();
-     * const builder = worksheet.charts.create().setType(univerAPI.Enum.ChartTypeString.Combination);
      * builder.resetSeriesAxis(0);
      * ```
      */

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

@@ -1,5 +1,59 @@
+import type { IChartInfo } from '@univerjs-pro/engine-chart';
 import { FChartBuilderBase } from '../f-chart-builder-base';
-export declare class FFunnelChartBuilder extends FChartBuilderBase {
+/**
+ * Fluent, type-specific Builder for Funnel Charts.
+ *
+ * @example Sheet
+ * ```ts
+ * const fWorkbook = univerAPI.getActiveWorkbook();
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+ * const chartInfo = fWorksheet
+ *   .newChart(univerAPI.Enum.ChartTypeString.Funnel)
+ *   .setSource('A1:B8')
+ *   .setGap(4)
+ *   .setUseAbsoluteValue(true)
+ *   .build();
+ * await fWorksheet.insertChart(chartInfo);
+ * ```
+ *
+ * @example Doc
+ * ```ts
+ * const fDocument = univerAPI.getActiveDocument();
+ * const chartInfo = fDocument
+ *   .newChart(univerAPI.Enum.ChartTypeString.Funnel)
+ *   .setSource([['Stage', 'Users'], ['Visited', 1000], ['Signed up', 420], ['Purchased', 160]])
+ *   .setGap(4)
+ *   .setUseAbsoluteValue(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.Funnel)
+ *   .setSource([['Stage', 'Users'], ['Visited', 1000], ['Signed up', 420], ['Purchased', 160]])
+ *   .setGap(4)
+ *   .setUseAbsoluteValue(true)
+ *   .build();
+ * await fSlide.insertChart(chartInfo);
+ * ```
+ *
+ * @example Board
+ * ```ts
+ * const fBoard = univerAPI.getActiveBoard();
+ * const chartInfo = fBoard
+ *   .newChart(univerAPI.Enum.ChartTypeString.Funnel)
+ *   .setSource([['Stage', 'Users'], ['Visited', 1000], ['Signed up', 420], ['Purchased', 160]])
+ *   .setGap(4)
+ *   .setUseAbsoluteValue(true)
+ *   .build();
+ * await fBoard.insertChart(chartInfo);
+ * ```
+ */
+export declare class FFunnelChartBuilder<TSource = never[], TDataSource = TSource, TInfo extends IChartInfo<TDataSource> = IChartInfo<TDataSource>> extends FChartBuilderBase<TSource, TDataSource, TInfo> {
     /**
      * Sets the gap configuration and returns this builder for chaining.
      *
@@ -9,8 +63,6 @@ export declare class FFunnelChartBuilder extends FChartBuilderBase {
      * @returns This builder for chaining.
      * @example
      * ```ts
-     * const worksheet = univerAPI.getActiveWorkbook().getActiveSheet();
-     * const builder = worksheet.charts.create().setType(univerAPI.Enum.ChartTypeString.Funnel);
      * builder.setGap(8);
      * ```
      */
@@ -23,8 +75,6 @@ export declare class FFunnelChartBuilder extends FChartBuilderBase {
      * @returns This builder for chaining.
      * @example
      * ```ts
-     * const worksheet = univerAPI.getActiveWorkbook().getActiveSheet();
-     * const builder = worksheet.charts.create().setType(univerAPI.Enum.ChartTypeString.Funnel);
      * builder.resetGap();
      * ```
      */
@@ -38,8 +88,6 @@ export declare class FFunnelChartBuilder extends FChartBuilderBase {
      * @returns This builder for chaining.
      * @example
      * ```ts
-     * const worksheet = univerAPI.getActiveWorkbook().getActiveSheet();
-     * const builder = worksheet.charts.create().setType(univerAPI.Enum.ChartTypeString.Funnel);
      * builder.setUseAbsoluteValue(true);
      * ```
      */
@@ -52,8 +100,6 @@ export declare class FFunnelChartBuilder extends FChartBuilderBase {
      * @returns This builder for chaining.
      * @example
      * ```ts
-     * const worksheet = univerAPI.getActiveWorkbook().getActiveSheet();
-     * const builder = worksheet.charts.create().setType(univerAPI.Enum.ChartTypeString.Funnel);
      * builder.resetUseAbsoluteValue();
      * ```
      */