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

package/lib/types/services/sheets-chart-ui.service.d.ts

@@ -1,169 +1,43 @@
-import type { AreaLineStyle, ChartModel, ChartPendingConfig, ChartStyle, DeepPartial, IAllSeriesStyle, IAxisOptions, IChartCandlestickMappingSpec, IChartCandlestickSpec, IChartConfigOperation, IChartContext, IChartHistogramDataSpec, IChartHistogramStyleSpec, IChartStyle, IChartTreemapSpec, ILegendStyle, InvalidValueType, IPieLabelStyle, IRelationForceOptions, IRuntimeAxis, ITrendLine, IUniverDataSet, LinePointShape, RadarShape, RelationChartLayoutEnum, RightYAxisOptions, TitlePositionEnum, WaterfallStackTypeEnum, WordCloudShapeEnum } from '@univerjs-pro/engine-chart';
-import type { IChartSourceMultiRangeItem, IChartUpdateConfigCommandParams, IChartUpdateSourceCommandParams, ISheetChartSourceSingleRange, SheetChartModel } from '@univerjs-pro/sheets-chart';
-import type { Nullable } from '@univerjs/core';
-import type { Observable } from 'rxjs';
-import type { IChartEditPanelRoute, IChartPanelRouteState, IChartSelectedElementState } from './chart-panel-route';
-import { CategoryType, ChartTypeBits, DataOrientation } from '@univerjs-pro/engine-chart';
+import type { IChartEditPanelRoute, IChartPanelRouteState, IChartSelectedElementState } from '@univerjs-pro/chart-ui';
+import type { ChartModel } from '@univerjs-pro/engine-chart';
+import type { IChartSourceMultiRangeItem, IChartUpdateConfigCommandParams, ISheetChartDataSource, ISheetChartSourceSingleRange } from '@univerjs-pro/sheets-chart';
+import { ChartUIService, ChartViewStateRegistry } from '@univerjs-pro/chart-ui';
+import { DataOrientation } from '@univerjs-pro/engine-chart';
 import { ChartModelService, SheetsChartService } from '@univerjs-pro/sheets-chart';
-import { Disposable, ICommandService, IUniverInstanceService, LocaleService } from '@univerjs/core';
-import { IChartHostProviderService } from './sheets-chart-host-provider.service';
-export declare function registryChartConfigState(service: ISheetsChartUIService): void;
-export interface IChartOptionType {
-    label: string;
-    value: string;
-}
-export declare function getChartDataResourceOptions(dataSet: IUniverDataSet, headers: string[] | undefined, getFallback: (index: number) => string): IChartOptionType[];
-export interface IChartConfigStateMap {
-    headers: IChartConfigState<IChartContext['headers']>;
-    dataResourceList: IChartConfigState<IChartOptionType[]>;
-    orient: IChartConfigState<Nullable<DataOrientation>>;
-    aggregate: IChartConfigState<boolean>;
-    gradientFill: IChartConfigState<Nullable<boolean>>;
-    indicator: IChartConfigState<Nullable<ChartStyle['tooltip']>>;
-    chartType: IChartConfigState<ChartTypeBits>;
-    dataRange: IChartConfigState<Nullable<ISheetChartSourceSingleRange | IChartSourceMultiRangeItem[]>>;
-    /** Series & Category */
-    categoryIndex: IChartConfigState<Nullable<number>>;
-    categoryType: IChartConfigState<Nullable<CategoryType>>;
-    candlestickMapping: IChartConfigState<IChartCandlestickMappingSpec | undefined, IChartCandlestickMappingSpec>;
-    candlestickStyle: IChartConfigState<IChartCandlestickSpec | undefined, Exclude<ChartPendingConfig['candlestick'], null | undefined>>;
-    histogramData: IChartConfigState<IChartHistogramDataSpec | undefined, IChartHistogramDataSpec | undefined>;
-    histogramStyle: IChartConfigState<IChartHistogramStyleSpec | undefined, IChartHistogramStyleSpec | undefined>;
-    treemapHierarchyIndexes: IChartConfigState<number[]>;
-    treemapValueIndex: IChartConfigState<number | undefined, number | undefined>;
-    treemapStyle: IChartConfigState<IChartTreemapSpec | undefined, IChartTreemapSpec | undefined>;
-    categoryList: IChartConfigState<IChartOptionType[]>;
-    bubbleCategoryList: IChartConfigState<IChartOptionType[]>;
-    seriesValues: IChartConfigState<number[]>;
-    trendlineValues: IChartConfigState<ITrendLine[] | undefined>;
-    seriesList: IChartConfigState<IChartOptionType[]>;
-    seriesResourceList: IChartConfigState<IChartOptionType[]>;
-    asCategory: IChartConfigState<boolean>;
-    backgroundColor: IChartConfigState<Nullable<string>>;
-    borderColor: IChartConfigState<Nullable<string>>;
-    fontSize: IChartConfigState<number | undefined, number>;
-    titleFontSize: IChartConfigState<number | undefined, number>;
-    titles: IChartConfigState<Nullable<DeepPartial<IChartStyle['titles']>>, DeepPartial<IChartStyle['titles']>>;
-    allSeriesStyle: IChartConfigState<Nullable<DeepPartial<IAllSeriesStyle>>, IAllSeriesStyle>;
-    seriesStyleMap: IChartConfigState<ChartStyle['seriesStyleMap']>;
-    legendStyle: IChartConfigState<Nullable<DeepPartial<ILegendStyle>>, Partial<ILegendStyle>>;
-    /** Axes */
-    xAxisOptions: IChartConfigState<Nullable<DeepPartial<IAxisOptions>>, Partial<IAxisOptions>>;
-    yAxisOptions: IChartConfigState<Nullable<DeepPartial<IAxisOptions>>, Partial<IAxisOptions>>;
-    rightYAxisOptions: IChartConfigState<Nullable<DeepPartial<RightYAxisOptions>>, Partial<RightYAxisOptions>>;
-    runtimeAxes: IChartConfigState<Nullable<IRuntimeAxis[]>>;
-    areaLineStyle: IChartConfigState<Nullable<AreaLineStyle>>;
-    pieLabelStyle: IChartConfigState<Nullable<DeepPartial<IPieLabelStyle>>>;
-    wordCloudShape: IChartConfigState<Nullable<WordCloudShapeEnum>> | undefined;
-    wordCloudMask: IChartConfigState<Nullable<string>> | undefined;
-    wordCloudRepeat: IChartConfigState<Nullable<boolean>> | undefined;
-    funnelGap: IChartConfigState<Nullable<number>>;
-    funnelUseAbsValue: IChartConfigState<Nullable<boolean>>;
-    padAngleStyle: IChartConfigState<Nullable<boolean>, boolean>;
-    isHalfPie: IChartConfigState<Nullable<boolean>, boolean>;
-    isRosePie: IChartConfigState<Nullable<boolean>, boolean>;
-    showLabelLine: IChartConfigState<Nullable<boolean>, boolean>;
-    doughnutHole: IChartConfigState<Nullable<number>, number>;
-    pieBorderColor: IChartConfigState<Nullable<string>, string>;
-    radarShape: IChartConfigState<Nullable<RadarShape>, RadarShape>;
-    radarFill: IChartConfigState<Nullable<boolean>, boolean>;
-    invalidValueType: IChartConfigState<Nullable<InvalidValueType>, InvalidValueType>;
-    dataPointsOptions: IChartConfigState<Nullable<IChartOptionType[]>>;
-    chartThemeColorType: IChartConfigState<Nullable<string>>;
-    titlePosition: IChartConfigState<Nullable<TitlePositionEnum>, TitlePositionEnum>;
-    bubbleSizeIndex: IChartConfigState<Nullable<number>, number | undefined>;
-    scatterXIndex: IChartConfigState<Nullable<number>, number>;
-    scatterYIndex: IChartConfigState<Nullable<number>, number>;
-    scatterLabelIndex: IChartConfigState<Nullable<number>, number>;
-    bubbleSeriesIndex: IChartConfigState<Nullable<number>, number>;
-    relationLayout: IChartConfigState<Nullable<RelationChartLayoutEnum>, RelationChartLayoutEnum>;
-    useValueAsSymbolSize: IChartConfigState<Nullable<boolean>, boolean>;
-    forceOption: IChartConfigState<Nullable<IRelationForceOptions>, IRelationForceOptions | undefined>;
-    rotateLabel: IChartConfigState<Nullable<boolean>, boolean>;
-    useEmphasis: IChartConfigState<Nullable<boolean>, boolean>;
-    relationNodeShape: IChartConfigState<Nullable<LinePointShape>, LinePointShape>;
-    useDateAxis: IChartConfigState<Nullable<boolean>, boolean>;
-    waterfallStack: IChartConfigState<Nullable<WaterfallStackTypeEnum>, WaterfallStackTypeEnum>;
-    useSubtotal: IChartConfigState<Nullable<boolean>, boolean>;
-    paretoStyle: IChartConfigState<Nullable<ChartStyle['pareto']>, ChartStyle['pareto']>;
-    paretoDataPointsOptions: IChartConfigState<Nullable<IChartOptionType[]>>;
-    visualMapType: IChartConfigState<Nullable<'continuous' | 'piecewise'>, 'continuous' | 'piecewise'>;
-    heatmapMax: IChartConfigState<Nullable<number>, number>;
-    heatmapMin: IChartConfigState<Nullable<number>, number>;
-    valueSuffix: IChartConfigState<Nullable<string>, string>;
-    valueScale: IChartConfigState<Nullable<number>, number>;
-    digitalFixed: IChartConfigState<Nullable<number>, number>;
-}
-export type ChartConfigStateKey = keyof IChartConfigStateMap;
-export type ChartConfigStateValue = InferChartConfigStateValue<ChartConfigStateKey>;
-export type InferChartConfigStateValue<T extends ChartConfigStateKey, M = IChartConfigStateMap[T]> = M extends {
-    get(): Observable<infer V> | undefined;
-} ? V : M extends Observable<infer V> ? V : never;
-export type IChartConfigState<GetValue, SetValue = GetValue> = {
-    set?(value: SetValue): void;
-    get(): Observable<GetValue> | undefined;
-} | Observable<GetValue>;
-export interface ISheetsChartUIService {
-    readonly activeChartModel: Nullable<SheetChartModel>;
-    readonly activeChartModel$: Observable<Nullable<SheetChartModel>>;
-    readonly activeEditChart: string | null;
-    readonly activeEditChart$: Observable<string | null>;
-    readonly direction$: LocaleService['direction$'];
-    readonly panelRoute$: Observable<IChartPanelRouteState | null>;
-    readonly rangeSelectMode: boolean;
-    readonly selectedElement$: Observable<IChartSelectedElementState | null>;
-    setActiveEditChart(chartId: string | null): void;
-    setRangeSelectMode(on: boolean): void;
-    isElementEditModeActive(chartId: string): boolean;
-    setSelectedElement(state: IChartSelectedElementState | null): void;
-    setPanelRoute(chartId: string, route: IChartEditPanelRoute | null): void;
-    clearPanelRoute(): void;
-    getDataSource(id: string): ReturnType<SheetsChartService['getChartDataSource']>;
-    registerViewState<T extends ChartConfigStateKey = ChartConfigStateKey>(id: T, state: (chartModel: ChartModel) => IChartConfigStateMap[T]): void;
-    getViewState<V extends ChartConfigStateValue = ChartConfigStateValue>(id: ChartConfigStateKey, activeChartModel?: Nullable<SheetChartModel>): IChartConfigState<V> | undefined;
-    applyChartConfigOperation(operation: IChartConfigOperation): void;
-    executeChartUpdateConfig(params: Omit<IChartUpdateConfigCommandParams, 'unitId'>): void;
-    executeChartUpdateSourceConfig(params: Omit<IChartUpdateSourceCommandParams, 'unitId'>): void;
-    removeViewState(id: ChartConfigStateKey): void;
-    setBorder(id: string, color: string): void;
-    t(...args: Parameters<LocaleService['t']>): string;
-}
-export declare const ISheetsChartUIService: import("@wendellhu/redi").IdentifierDecorator<ISheetsChartUIService>;
-export declare class SheetsChartUIService extends Disposable implements ISheetsChartUIService {
+import { ICommandService, IUniverInstanceService, LocaleService } from '@univerjs/core';
+type SheetsChartUpdateConfigParams = Omit<IChartUpdateConfigCommandParams, 'unitId'>;
+export type ISheetsChartUIService = SheetsChartUIService;
+export declare const ISheetsChartUIService: import("@wendellhu/redi").IdentifierDecorator<SheetsChartUIService>;
+export declare class SheetsChartUIService extends ChartUIService<ChartModel<ISheetChartDataSource>, SheetsChartUpdateConfigParams> {
     private readonly _chartModelService;
     private readonly _sheetsChartService;
     private readonly _commandService;
     private readonly _localeService;
-    private readonly _chartHostProviderService;
-    private _univerInstanceService;
-    private _viewState;
+    private readonly _univerInstanceService;
     private _rangeSelectMode;
     private readonly _activeEditChart$;
     private readonly _selectedElement$;
     private readonly _panelRoute$;
-    readonly activeEditChart$: Observable<string | null>;
-    readonly selectedElement$: Observable<IChartSelectedElementState | null>;
-    readonly panelRoute$: Observable<IChartPanelRouteState | null>;
-    constructor(_chartModelService: ChartModelService, _sheetsChartService: SheetsChartService, _commandService: ICommandService, _localeService: LocaleService, _chartHostProviderService: IChartHostProviderService, _univerInstanceService: IUniverInstanceService);
-    get activeChartModel(): Nullable<SheetChartModel>;
-    get activeChartModel$(): Observable<Nullable<SheetChartModel>>;
-    get rangeSelectMode(): boolean;
+    readonly activeEditChart$: import("rxjs").Observable<string | null>;
+    readonly selectedElement$: import("rxjs").Observable<IChartSelectedElementState | null>;
+    readonly panelRoute$: import("rxjs").Observable<IChartPanelRouteState | null>;
+    constructor(_chartModelService: ChartModelService, _sheetsChartService: SheetsChartService, _commandService: ICommandService, _localeService: LocaleService, _univerInstanceService: IUniverInstanceService, viewStates: ChartViewStateRegistry);
+    get activeRuntimeModel(): ChartModel<ISheetChartDataSource> | null;
+    get activeChartModel(): import("@univerjs/core").Nullable<ChartModel<ISheetChartDataSource>>;
+    get activeChartModel$(): import("rxjs").Observable<import("@univerjs/core").Nullable<ChartModel<ISheetChartDataSource>>>;
     get activeEditChart(): string | null;
-    get direction$(): Observable<"ltr" | "rtl">;
+    get direction$(): import("rxjs").Observable<"ltr" | "rtl">;
+    get rangeSelectMode(): boolean;
     setRangeSelectMode(on: boolean): void;
     setActiveEditChart(chartId: string | null): void;
     isElementEditModeActive(chartId: string): boolean;
     setSelectedElement(state: IChartSelectedElementState | null): void;
     setPanelRoute(chartId: string, route: IChartEditPanelRoute | null): void;
     clearPanelRoute(): void;
-    getDataSource(id: string): import("@univerjs-pro/sheets-chart").ISheetChartDataSource | undefined;
-    registerViewState<T extends ChartConfigStateKey = ChartConfigStateKey>(id: T, state: (chartModel: ChartModel) => IChartConfigStateMap[T]): void;
-    getViewState<V extends ChartConfigStateValue = ChartConfigStateValue>(id: ChartConfigStateKey, activeChartModel?: Nullable<SheetChartModel>): IChartConfigState<V> | undefined;
-    applyChartConfigOperation(operation: IChartConfigOperation): void;
-    executeChartUpdateConfig(params: Omit<IChartUpdateConfigCommandParams, 'unitId'>): void;
-    executeChartUpdateSourceConfig(params: Omit<IChartUpdateSourceCommandParams, 'unitId'>): void;
-    removeViewState(id: ChartConfigStateKey): void;
-    setBorder(id: string, color: string): void;
-    t(...args: Parameters<LocaleService['t']>): string;
+    setDataRange(range: ISheetChartSourceSingleRange | IChartSourceMultiRangeItem[]): void;
+    setOrientation(orientation: DataOrientation): void;
+    executeChartUpdateConfig(params: SheetsChartUpdateConfigParams): void;
+    private _executeChartUpdateSourceConfig;
     dispose(): void;
 }
+export {};

package/lib/types/util.d.ts

@@ -1,13 +1,16 @@
+import type { ChartTypeBits, PieSecondaryPlotType } from '@univerjs-pro/engine-chart';
 import type { IChartSourceMultiRangeItem, ISheetChartSourceSingleRange } from '@univerjs-pro/sheets-chart';
 import type { IUniverInstanceService, Nullable } from '@univerjs/core';
-import type { LocaleKey } from './locale/types';
-import { ChartTypeBits } from '@univerjs-pro/engine-chart';
+import type { IValueOption } from '@univerjs/ui';
+import { CHART_TYPE_CATALOG } from '@univerjs-pro/chart-ui';
 export declare function serializeChartDataRange(rangeInfo: Nullable<ISheetChartSourceSingleRange | IChartSourceMultiRangeItem[]>, univerInstanceService: IUniverInstanceService): string;
 export interface IChartTypeOption {
-    label: LocaleKey;
+    id?: string;
+    labelId: Exclude<typeof CHART_TYPE_CATALOG[number]['labelId'], 'columnStacked' | 'columnPercentStacked'>;
+    pieSecondaryPlotType?: PieSecondaryPlotType;
     value: ChartTypeBits;
     icon: string;
 }
 export declare const chartTypeOptions: IChartTypeOption[];
-export declare function getChartMenuSelection(): IChartTypeOption[];
+export declare function getChartMenuSelection(options?: readonly IChartTypeOption[]): Array<IValueOption<string>>;
 export declare const getOptionsList: (optionsList: IChartTypeOption[], allowTypes: ChartTypeBits[] | [string]) => IChartTypeOption[];

package/lib/types/views/chart-edit-panel/ChartEditPanel.d.ts

@@ -1,4 +1,4 @@
 export declare function ChartEditPanel(props: {
     className?: string;
-}): import("react").JSX.Element;
+}): import("react").JSX.Element | null;
 export declare const CHART_EDIT_PANEL_KEY = "sheet.chart.edit.panel";

package/lib/types/views/chart-edit-panel/chart-editor-default-values.d.ts

@@ -0,0 +1,79 @@
+export declare const SHEET_CHART_EDITOR_DEFAULT_VALUES: {
+    readonly axis: {
+        readonly primaryGridLineVisible: false;
+        readonly secondaryGridLineVisible: true;
+        readonly color: string;
+        readonly dateAxisRotation: number;
+        readonly gridlineWidth: number;
+        readonly labelFontSize: number;
+        readonly labelRotation: number;
+        readonly labelVisible: boolean;
+        readonly reverse: boolean;
+        readonly tickLength: string;
+        readonly tickPosition: import("@univerjs-pro/engine-chart").ChartAxisTickPosition;
+        readonly tickVisible: boolean;
+        readonly tickWidth: string;
+    };
+    readonly funnel: import("@univerjs-pro/chart-ui").IChartFunnelDefaultValues;
+    readonly heatmap: import("@univerjs-pro/chart-ui").IChartHeatmapDefaultValues;
+    readonly indicatorLine: import("@univerjs-pro/chart-ui").IChartIndicatorLineDefaultValues;
+    readonly legend: import("@univerjs-pro/chart-ui").IChartLegendDefaultValues;
+    readonly lineAndArea: import("@univerjs-pro/chart-ui").IChartLineAndAreaDefaultValues;
+    readonly pareto: import("@univerjs-pro/chart-ui").IChartParetoDefaultValues;
+    readonly pie: {
+        readonly doughnutHole: 0.5;
+        readonly pieHole: 0;
+        readonly borderColor: string;
+        readonly hasPaddingAngle: boolean;
+        readonly isHalfPie: boolean;
+        readonly labelContentType: import("@univerjs-pro/engine-chart").LabelContentType;
+        readonly labelPosition: import("@univerjs-pro/engine-chart").PieLabelPosition;
+        readonly labelVisible: boolean;
+        readonly rosePie: boolean;
+        readonly showLabelLine: boolean;
+        readonly textColor: string;
+        readonly valueScale: number;
+    };
+    readonly relation: {
+        readonly useValueAsSymbolSize: true;
+        readonly circularLabelRotation: boolean;
+        readonly emphasisEnabled: boolean;
+        readonly force: {
+            gravity: number;
+            repulsion: number;
+        };
+        readonly layout: import("@univerjs-pro/engine-chart").RelationChartLayoutEnum;
+        readonly nodeShape: import("@univerjs-pro/engine-chart").LinePointShape;
+    };
+    readonly radar: import("@univerjs-pro/chart-ui").IChartRadarDefaultValues;
+    readonly series: {
+        readonly radarFillOpacity: 0.2;
+        readonly rightAxis: {
+            readonly ltr: false;
+            readonly rtl: boolean;
+        };
+        readonly borderDashType: import("@univerjs-pro/engine-chart").ChartBorderDashType;
+        readonly borderOpacity: number;
+        readonly borderWidth: number;
+        readonly color: string;
+        readonly labelContentType: import("@univerjs-pro/engine-chart").LabelContentType;
+        readonly labelFontSize: number;
+        readonly labelPosition: import("@univerjs-pro/engine-chart").SeriesLabelPosition;
+        readonly labelVisible: boolean;
+        readonly lineOrAreaBorderWidth: number;
+        readonly pointShape: import("@univerjs-pro/engine-chart").LinePointShape;
+        readonly pointSize: number;
+        readonly radarBorderWidth: number;
+        readonly scatterPointSize: number;
+        readonly seriesFillOpacity: number;
+    };
+    readonly style: import("@univerjs-pro/chart-ui").IChartStyleDefaultValues;
+    readonly titles: import("@univerjs-pro/chart-ui").IChartTitleDefaultValues;
+    readonly trendline: import("@univerjs-pro/chart-ui").IChartTrendlineDefaultValues;
+    readonly waterfall: {
+        readonly useSubtotal: true;
+        readonly stackType: import("@univerjs-pro/engine-chart").WaterfallStackTypeEnum;
+    };
+    readonly waterfallStyle: import("@univerjs-pro/chart-ui").IChartWaterfallStyleDefaultValues;
+    readonly wordCloud: import("@univerjs-pro/chart-ui").IChartWordCloudDefaultValues;
+};

package/lib/types/views/chart-edit-panel/data-tab-panel/DataTabPanel.d.ts

@@ -1 +1,4 @@
-export declare const DataTabPanel: () => import("react").JSX.Element;
+import type { SHEET_CHART_EDITOR_DEFAULT_VALUES } from '../chart-editor-default-values';
+export declare const DataTabPanel: (props: {
+    defaultValues: typeof SHEET_CHART_EDITOR_DEFAULT_VALUES;
+}) => import("react").JSX.Element;

package/lib/types/views/chart-edit-panel/style-tab-panel/StyleTabPanel.d.ts

@@ -1,5 +1,4 @@
-import type { IRuntimeAxis } from '@univerjs-pro/engine-chart';
-import type { Nullable } from '@univerjs/core';
-export declare function getPrimaryVerticalAxis(runtimeAxes: Nullable<IRuntimeAxis[]> | undefined): IRuntimeAxis | undefined;
-/** The vertical axis panel edits the persisted primary vertical axis bucket (`style.yAxis`). */
-export declare const StyleTabPanel: () => import("react").JSX.Element;
+import type { SHEET_CHART_EDITOR_DEFAULT_VALUES } from '../chart-editor-default-values';
+export declare const StyleTabPanel: (props: {
+    defaultValues: typeof SHEET_CHART_EDITOR_DEFAULT_VALUES;
+}) => import("react").JSX.Element;