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

package/lib/types/chart-builder/configuration/chord.d.ts

@@ -0,0 +1,12 @@
+import type { IChartChordEmphasisSpec, IChartChordLabelSpec, IChartChordLayoutSpec, IChartChordMappingSpec, IChartChordNodeStyleSpec, IChartChordRibbonStyleSpec } from '../../types';
+export declare function setChordMapping(value: IChartChordMappingSpec): import("./chart-config-operation").IChartConfigOperation;
+export declare const setChordLayout: (value: IChartChordLayoutSpec) => import("./chart-config-operation").IChartConfigOperation;
+export declare const resetChordLayout: () => import("./chart-config-operation").IChartConfigOperation;
+export declare const setChordNode: (value: IChartChordNodeStyleSpec) => import("./chart-config-operation").IChartConfigOperation;
+export declare const resetChordNode: () => import("./chart-config-operation").IChartConfigOperation;
+export declare const setChordLabel: (value: IChartChordLabelSpec) => import("./chart-config-operation").IChartConfigOperation;
+export declare const resetChordLabel: () => import("./chart-config-operation").IChartConfigOperation;
+export declare const setChordRibbon: (value: IChartChordRibbonStyleSpec) => import("./chart-config-operation").IChartConfigOperation;
+export declare const resetChordRibbon: () => import("./chart-config-operation").IChartConfigOperation;
+export declare const setChordEmphasis: (value: IChartChordEmphasisSpec) => import("./chart-config-operation").IChartConfigOperation;
+export declare const resetChordEmphasis: () => import("./chart-config-operation").IChartConfigOperation;

package/lib/types/chart-builder/configuration/gauge.d.ts

@@ -0,0 +1,31 @@
+import type { DeepNullish, IChartGaugeAnchorSpec, IChartGaugeAnglesSpec, IChartGaugeAxisLabelSpec, IChartGaugeAxisLineSpec, IChartGaugeAxisTickSpec, IChartGaugeDetailSpec, IChartGaugePointerSpec, IChartGaugeProgressSpec, IChartGaugeRangeSpec, IChartGaugeScaleSpec, IChartGaugeSplitLineSpec, IChartGaugeTitleSpec } from '../../types';
+import type { ChartGaugeMode } from '../../enum';
+import type { IChartGaugeTicksPatch } from '../chart-types';
+export declare function setGaugeValueField(index: number): import("./chart-config-operation").IChartConfigOperation;
+export declare const setGaugeMode: (value: ChartGaugeMode) => import("./chart-config-operation").IChartConfigOperation;
+export declare const resetGaugeMode: () => import("./chart-config-operation").IChartConfigOperation;
+export declare const setGaugeScale: (value: IChartGaugeScaleSpec) => import("./chart-config-operation").IChartConfigOperation;
+export declare const resetGaugeScale: () => import("./chart-config-operation").IChartConfigOperation;
+export declare const setGaugeTicks: (value: IChartGaugeTicksPatch) => import("./chart-config-operation").IChartConfigOperation;
+export declare const setGaugeAngles: (value: IChartGaugeAnglesSpec) => import("./chart-config-operation").IChartConfigOperation;
+export declare const resetGaugeAngles: () => import("./chart-config-operation").IChartConfigOperation;
+export declare const setGaugeRanges: (value: readonly IChartGaugeRangeSpec[]) => import("./chart-config-operation").IChartConfigOperation;
+export declare const resetGaugeRanges: () => import("./chart-config-operation").IChartConfigOperation;
+export declare const setGaugeAxisLine: (value: IChartGaugeAxisLineSpec) => import("./chart-config-operation").IChartConfigOperation;
+export declare const resetGaugeAxisLine: () => import("./chart-config-operation").IChartConfigOperation;
+export declare const setGaugeAxisTick: (value: IChartGaugeAxisTickSpec) => import("./chart-config-operation").IChartConfigOperation;
+export declare const resetGaugeAxisTick: () => import("./chart-config-operation").IChartConfigOperation;
+export declare const setGaugeSplitLine: (value: IChartGaugeSplitLineSpec) => import("./chart-config-operation").IChartConfigOperation;
+export declare const resetGaugeSplitLine: () => import("./chart-config-operation").IChartConfigOperation;
+export declare const setGaugeAxisLabel: (value: DeepNullish<IChartGaugeAxisLabelSpec>) => import("./chart-config-operation").IChartConfigOperation;
+export declare const resetGaugeAxisLabel: () => import("./chart-config-operation").IChartConfigOperation;
+export declare const setGaugePointer: (value: IChartGaugePointerSpec) => import("./chart-config-operation").IChartConfigOperation;
+export declare const resetGaugePointer: () => import("./chart-config-operation").IChartConfigOperation;
+export declare const setGaugeAnchor: (value: IChartGaugeAnchorSpec) => import("./chart-config-operation").IChartConfigOperation;
+export declare const resetGaugeAnchor: () => import("./chart-config-operation").IChartConfigOperation;
+export declare const setGaugeProgress: (value: IChartGaugeProgressSpec) => import("./chart-config-operation").IChartConfigOperation;
+export declare const resetGaugeProgress: () => import("./chart-config-operation").IChartConfigOperation;
+export declare const setGaugeTitle: (value: IChartGaugeTitleSpec) => import("./chart-config-operation").IChartConfigOperation;
+export declare const resetGaugeTitle: () => import("./chart-config-operation").IChartConfigOperation;
+export declare const setGaugeDetail: (value: DeepNullish<IChartGaugeDetailSpec>) => import("./chart-config-operation").IChartConfigOperation;
+export declare const resetGaugeDetail: () => import("./chart-config-operation").IChartConfigOperation;

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

@@ -1,4 +1,5 @@
-import type { IChartPieLabelSpec, IChartSliceStyleSpec } from '../chart-types';
+import type { DeepNullish } from '../../types';
+import type { IChartPieCompositeSpec, IChartPieLabelSpec, IChartSliceStyleSpec } from '../chart-types';
 export declare const setDoughnutHole: (value: number) => import("./chart-config-operation").IChartConfigOperation;
 export declare const clearDoughnutHole: () => import("./chart-config-operation").IChartConfigOperation;
 export declare const setExplosion: (value: number) => import("./chart-config-operation").IChartConfigOperation;
@@ -15,13 +16,11 @@ export declare const setLabelLineVisible: (value: boolean) => import("./chart-co
 export declare const resetLabelLineVisible: () => import("./chart-config-operation").IChartConfigOperation;
 export declare const setValueScale: (value: number) => import("./chart-config-operation").IChartConfigOperation;
 export declare const resetValueScale: () => import("./chart-config-operation").IChartConfigOperation;
-export declare const setValueSuffix: (value: string) => import("./chart-config-operation").IChartConfigOperation;
-export declare const clearValueSuffix: () => import("./chart-config-operation").IChartConfigOperation;
-export declare const setDecimalPlaces: (value: number) => import("./chart-config-operation").IChartConfigOperation;
-export declare const resetDecimalPlaces: () => import("./chart-config-operation").IChartConfigOperation;
-export declare const setPieLabel: (value: IChartPieLabelSpec) => import("./chart-config-operation").IChartConfigOperation;
+export declare const setPieLabel: (value: DeepNullish<IChartPieLabelSpec>) => import("./chart-config-operation").IChartConfigOperation;
 export declare const clearPieLabel: () => import("./chart-config-operation").IChartConfigOperation;
 /** Records the authored style for one materialized Pie or Donut slice. */
 export declare const setSliceStyle: (index: number, value: IChartSliceStyleSpec) => import("./chart-config-operation").IChartConfigOperation;
 /** Clears the authored style for one materialized Pie or Donut slice. */
 export declare const clearSliceStyle: (index: number) => import("./chart-config-operation").IChartConfigOperation;
+export declare const setPieComposite: (value: DeepNullish<IChartPieCompositeSpec>) => import("./chart-config-operation").IChartConfigOperation;
+export declare const clearPieComposite: () => import("./chart-config-operation").IChartConfigOperation;

package/lib/types/chart-builder/configuration/sunburst.d.ts

@@ -0,0 +1,7 @@
+import type { DeepNullish, IChartSunburstCenterLabelSpec, IChartSunburstLabelSpec } from '../../types';
+export declare const setSunburstHierarchyFields: (indexes: readonly number[]) => import("./chart-config-operation").IChartConfigOperation;
+export declare const setSunburstValueField: (index: number) => import("./chart-config-operation").IChartConfigOperation;
+export declare const setSunburstLabel: (label: DeepNullish<IChartSunburstLabelSpec>) => import("./chart-config-operation").IChartConfigOperation;
+export declare const resetSunburstLabel: () => import("./chart-config-operation").IChartConfigOperation;
+export declare const setSunburstCenterLabel: (centerLabel: DeepNullish<IChartSunburstCenterLabelSpec>) => import("./chart-config-operation").IChartConfigOperation;
+export declare const resetSunburstCenterLabel: () => import("./chart-config-operation").IChartConfigOperation;

package/lib/types/chart-builder/configuration/treemap.d.ts

@@ -1,8 +1,8 @@
 import type { TreemapParentLabelLayout } from '../../enum';
-import type { IChartTreemapLabelSpec } from '../../types';
+import type { DeepNullish, IChartTreemapLabelSpec } from '../../types';
 export declare const setTreemapHierarchyFields: (indexes: readonly number[]) => import("./chart-config-operation").IChartConfigOperation;
 export declare const setTreemapValueField: (index: number) => import("./chart-config-operation").IChartConfigOperation;
 export declare const setTreemapParentLabelLayout: (layout: TreemapParentLabelLayout) => import("./chart-config-operation").IChartConfigOperation;
 export declare const resetTreemapParentLabelLayout: () => import("./chart-config-operation").IChartConfigOperation;
-export declare const setTreemapLabel: (label: IChartTreemapLabelSpec) => import("./chart-config-operation").IChartConfigOperation;
+export declare const setTreemapLabel: (label: DeepNullish<IChartTreemapLabelSpec>) => import("./chart-config-operation").IChartConfigOperation;
 export declare const resetTreemapLabel: () => import("./chart-config-operation").IChartConfigOperation;

package/lib/types/chart-builder/configuration/waterfall.d.ts

@@ -8,5 +8,7 @@ export declare const resetUseSubtotal: () => import("./chart-config-operation").
 export declare const setWaterfallPointRoles: (roles: readonly IChartWaterfallPointRoleSpec[]) => import("./chart-config-operation").IChartConfigOperation;
 export declare const setWaterfallConnector: (value: boolean | IChartWaterfallConnectorStyleSpec) => import("./chart-config-operation").IChartConfigOperation;
 export declare const clearWaterfallConnector: () => import("./chart-config-operation").IChartConfigOperation;
-export declare const setWaterfallStyle: (selector: ChartPublicSeriesSelector, target: ChartWaterfallStyleTarget, value: Omit<IChartSeriesPatch, "selector">) => import("./chart-config-operation").IChartConfigOperation;
+export declare const setWaterfallStyle: (selector: ChartPublicSeriesSelector, target: ChartWaterfallStyleTarget, value: Omit<IChartSeriesPatch, "selector" | "waterfallStyles"> & {
+    name?: string;
+}) => import("./chart-config-operation").IChartConfigOperation;
 export declare const clearWaterfallStyle: (selector: ChartPublicSeriesSelector, target: ChartWaterfallStyleTarget) => import("./chart-config-operation").IChartConfigOperation;

package/lib/types/chart-builder/conversion/chart-config-converter.d.ts

@@ -1,4 +1,5 @@
-import type { ChartStyle, DeepNullish, IChartContext, IChartDataAggregation, IChartDataSeries } from '../../types';
+import type { IChartDataAggregation } from '../../chart-data-aggregation';
+import type { ChartStyle, DeepNullish, IChartContext, IChartDataSeries } from '../../types';
 import type { ChartPendingConfig, IChartDescription } from '../chart-types';
 import { ChartTypeBits } from '../../enum';
 interface IChartConfigConversionOptions {
@@ -26,4 +27,5 @@ export interface ICompleteChartModelConfig {
 }
 export declare function toChartModelConfig(config: ChartPendingConfig | IChartDescription, options?: IChartConfigConversionOptions): IChartModelConfigUpdate;
 export declare function toCompleteChartModelConfig(configChange: ChartPendingConfig, options?: IChartConfigConversionOptions): ICompleteChartModelConfig;
+export declare function applyChartStylePatch(current: ChartStyle | undefined, patch: DeepNullish<ChartStyle>): ChartStyle;
 export {};

package/lib/types/chart-builder/conversion/chart-context-patch.d.ts

@@ -1,5 +1,5 @@
 import type { DeepNullish, IChartContext } from '../../types';
-/** Validates and clones a complete context received at a replacement boundary. */
+/** Validates a complete persisted context and returns the canonical snapshot fields only. */
 export declare function canonicalizeChartContext(value: unknown): IChartContext;
 /** Internal Pending boundary used before a command payload is created. */
 export declare function applyPendingChartContext(current: IChartContext | undefined, value: DeepNullish<IChartContext>): IChartContext;

package/lib/types/chart-builder/conversion/chart-model-fields.d.ts

@@ -3,6 +3,7 @@ export declare enum ChartStyleField {
     AllSeriesStyle = "allSeriesStyle",
     Area = "area",
     Bar = "bar",
+    Bubble = "bubble",
     BackgroundColor = "backgroundColor",
     BorderColor = "borderColor",
     BorderWidth = "borderWidth",
@@ -11,15 +12,19 @@ export declare enum ChartStyleField {
     FontFamily = "fontFamily",
     FontSize = "fontSize",
     Funnel = "funnel",
+    Gauge = "gauge",
+    Chord = "chord",
     GradientFill = "gradientFill",
     Heatmap = "heatmap",
     Histogram = "histogram",
+    Sunburst = "sunburst",
     Treemap = "treemap",
     InvalidValueType = "invalidValueType",
     MarkLines = "markLines",
     Palette = "palette",
     Pareto = "pareto",
     Pie = "pie",
+    PlotArea = "plotArea",
     Radar = "radar",
     Relation = "relation",
     RightYAxis = "rightYAxis",
@@ -33,15 +38,8 @@ export declare enum ChartStyleField {
     YAxis = "yAxis"
 }
 export declare enum ChartContextField {
-    BubbleSeriesIndex = "bubbleSeriesIndex",
-    BubbleSizeIndex = "bubbleSizeIndex",
-    CategoryIndex = "categoryIndex",
-    Candlestick = "candlestick",
+    CategoryIndexes = "categoryIndexes",
     Histogram = "histogram",
-    HierarchyIndexes = "hierarchyIndexes",
-    ScatterLabelIndex = "scatterLabelIndex",
-    ScatterXIndex = "scatterXIndex",
-    ScatterYIndex = "scatterYIndex",
     SeriesIndexes = "seriesIndexes",
     UseDateAxis = "useDateAxis"
 }
@@ -55,8 +53,10 @@ export declare enum ChartAxisTitleField {
     YAxisTitle = "yAxisTitle"
 }
 export declare enum ChartAxisStyleField {
+    AxisTitleAlignment = "label.axisTitleAlign",
     Format = "format",
     GridLineColor = "gridLine.color",
+    GridLineDashType = "gridLine.dashType",
     GridLineVisible = "gridLine.visible",
     GridLineWidth = "gridLine.width",
     LabelColor = "label.color",
@@ -105,6 +105,7 @@ export declare enum ChartSeriesStyleField {
     LabelContentType = "label.contentType",
     LabelFontSize = "label.fontSize",
     LabelFamily = "label.family",
+    LabelFormat = "label.format",
     LabelItalic = "label.italic",
     LabelPosition = "label.position",
     LabelVisible = "label.visible",

package/lib/types/chart-builder/conversion/chart-type-converter.d.ts

@@ -1,6 +1,8 @@
 import type { ChartStyle } from '../../types';
-import { ChartTypeBits } from '../../enum';
+import { ChartTypeBits, StackType } from '../../enum';
 import { ChartTypeString } from '../chart-types';
 export declare function chartTypeToBits(type: ChartTypeString): ChartTypeBits;
 export declare function chartBitsToType(bits: ChartTypeBits, style?: ChartStyle): ChartTypeString;
+export declare function getChartStackType(chartType: ChartTypeBits | undefined): StackType | undefined;
+export declare function withChartStackType(chartType: ChartTypeBits, stackType: StackType | ''): ChartTypeBits;
 export declare function getInitialChartStyle(type: ChartTypeString): ChartStyle | undefined;