@univerjs-pro/bases-dashboard-ui 1.0.0-rc.0

package/lib/types/locale/en-US.d.ts

@@ -0,0 +1,240 @@
+declare const locale: {
+    'bases-dashboard-ui': {
+        chart: {
+            chartTypes: {
+                line: string;
+                column: string;
+                columnStacked: string;
+                columnPercentStacked: string;
+                bar: string;
+                barStacked: string;
+                barPercentStacked: string;
+                pie: string;
+                donut: string;
+                pieOfPie: string;
+                barOfPie: string;
+                area: string;
+                areaStacked: string;
+                areaPercentStacked: string;
+                radar: string;
+                scatter: string;
+                combination: string;
+                wordCloud: string;
+                funnel: string;
+                bubble: string;
+                relation: string;
+                waterfall: string;
+                pareto: string;
+                sankey: string;
+                heatmap: string;
+                boxplot: string;
+                candlestick: string;
+                histogram: string;
+                treemap: string;
+                sunburst: string;
+                gauge: string;
+                chord: string;
+            };
+            common: {
+                editChart: string;
+                setup: string;
+                customize: string;
+                switchRowColumn: string;
+                chartStyle: string;
+                chartAndAxisTitles: string;
+                series: string;
+                heatmap: string;
+                legend: string;
+                horizontalAxis: string;
+                verticalAxis: string;
+                rightVerticalAxis: string;
+                trendline: string;
+            };
+            section: {
+                waterfall: string;
+                paretoBar: string;
+                paretoLine: string;
+                pie: string;
+                wordCloud: string;
+                radar: string;
+                funnel: string;
+                relation: string;
+                lineAndArea: string;
+                gridlinesAndTicks: string;
+                indicatorLine: string;
+                candlestick: string;
+                histogram: string;
+                treemap: string;
+                sunburst: string;
+                gauge: string;
+                chord: string;
+            };
+            waterfall: {
+                subtotal: string;
+                positive: string;
+                negative: string;
+            };
+        };
+        pivot: {
+            name: string;
+            description: string;
+            defaultName: string;
+            chartConfiguration: string;
+            pivotConfiguration: string;
+            chartType: string;
+            display: string;
+            chartAndTable: string;
+            chartOnly: string;
+            tableOnly: string;
+            orientation: string;
+            seriesByColumn: string;
+            seriesByRow: string;
+            fieldHint: string;
+            unused: string;
+            rows: string;
+            columns: string;
+            values: string;
+            filters: string;
+            dataSource: string;
+            fields: string;
+            options: string;
+            sourceFields: string;
+            searchFields: string;
+            addToRow: string;
+            addToColumn: string;
+            addToValue: string;
+            addToFilter: string;
+            dropFieldsHere: string;
+            removeField: string;
+            filterField: string;
+            fieldSettings: string;
+            ascending: string;
+            descending: string;
+            selectAll: string;
+            blank: string;
+            clearFilter: string;
+            grandTotal: string;
+            cancel: string;
+            confirm: string;
+            displayName: string;
+            summarizeBy: string;
+            sum: string;
+            count: string;
+            countNumbers: string;
+            average: string;
+            max: string;
+            min: string;
+            product: string;
+            stdDev: string;
+            stdDevPopulation: string;
+            variance: string;
+            variancePopulation: string;
+            numberFormat: string;
+            layout: string;
+            layoutTabular: string;
+            layoutCompact: string;
+            layoutOutline: string;
+            repeatRowLabels: string;
+            repeatColumnLabels: string;
+            showRowSubtotal: string;
+            showRowGrandTotal: string;
+            showColumnSubtotal: string;
+            showColumnGrandTotal: string;
+            rowSubtotalPosition: string;
+            top: string;
+            bottom: string;
+            valuePosition: string;
+            pageWrap: string;
+            pageDirection: string;
+            downThenAcross: string;
+            acrossThenDown: string;
+            calculating: string;
+            calculationFailed: string;
+        };
+        dashboard: {
+            add: string;
+            configure: string;
+            delete: string;
+            new: string;
+            rename: string;
+            search: string;
+            section: string;
+            defaultName: string;
+            addWidget: string;
+            pivotChart: string;
+            tableFilter: string;
+            text: string;
+            image: string;
+            formulaShape: string;
+            widgetActions: string;
+            editWidget: string;
+            deleteWidget: string;
+            resizeWidget: string;
+            undo: string;
+            redo: string;
+            fullScreen: string;
+        };
+        dashboardInspector: {
+            alignment: string;
+            autoFit: string;
+            backgroundColor: string;
+            backgroundImage: string;
+            center: string;
+            close: string;
+            compact: string;
+            contain: string;
+            cover: string;
+            currency: string;
+            currencyCode: string;
+            custom: string;
+            data: string;
+            dataSource: string;
+            decimalPlaces: string;
+            description: string;
+            dragWidget: string;
+            editData: string;
+            editFormula: string;
+            formula: string;
+            general: string;
+            grouped: string;
+            left: string;
+            loading: string;
+            number: string;
+            numberFormat: string;
+            percent: string;
+            removeImage: string;
+            replaceImage: string;
+            repeat: string;
+            originalSize: string;
+            reset: string;
+            right: string;
+            sourceUnavailable: string;
+            style: string;
+            textColor: string;
+            textSize: string;
+            uploadImage: string;
+            delete: string;
+            newCondition: string;
+            clear: string;
+            checked: string;
+            unchecked: string;
+            selectOption: string;
+            enterValue: string;
+        };
+        operators: {
+            is: string;
+            isNot: string;
+            contains: string;
+            notContains: string;
+            isEmpty: string;
+            isNotEmpty: string;
+            greaterThan: string;
+            greaterThanOrEqual: string;
+            lessThan: string;
+            lessThanOrEqual: string;
+            before: string;
+            after: string;
+        };
+    };
+};
+export default locale;

package/lib/types/locale/es-ES.d.ts

@@ -0,0 +1,3 @@
+import type enUS from './en-US';
+declare const locale: typeof enUS;
+export default locale;

package/lib/types/locale/fa-IR.d.ts

@@ -0,0 +1,3 @@
+import type enUS from './en-US';
+declare const locale: typeof enUS;
+export default locale;

package/lib/types/locale/fr-FR.d.ts

@@ -0,0 +1,3 @@
+import type enUS from './en-US';
+declare const locale: typeof enUS;
+export default locale;

package/lib/types/locale/id-ID.d.ts

@@ -0,0 +1,3 @@
+import type enUS from './en-US';
+declare const locale: typeof enUS;
+export default locale;

package/lib/types/locale/it-IT.d.ts

@@ -0,0 +1,3 @@
+import type enUS from './en-US';
+declare const locale: typeof enUS;
+export default locale;

package/lib/types/locale/ja-JP.d.ts

@@ -0,0 +1,3 @@
+import type enUS from './en-US';
+declare const locale: typeof enUS;
+export default locale;

package/lib/types/locale/ko-KR.d.ts

@@ -0,0 +1,3 @@
+import type enUS from './en-US';
+declare const locale: typeof enUS;
+export default locale;

package/lib/types/locale/nl-NL.d.ts

@@ -0,0 +1,3 @@
+import type enUS from './en-US';
+declare const locale: typeof enUS;
+export default locale;

package/lib/types/locale/pl-PL.d.ts

@@ -0,0 +1,3 @@
+import type enUS from './en-US';
+declare const locale: typeof enUS;
+export default locale;

package/lib/types/locale/pt-BR.d.ts

@@ -0,0 +1,3 @@
+import type enUS from './en-US';
+declare const locale: typeof enUS;
+export default locale;

package/lib/types/locale/ru-RU.d.ts

@@ -0,0 +1,3 @@
+import type enUS from './en-US';
+declare const locale: typeof enUS;
+export default locale;

package/lib/types/locale/sk-SK.d.ts

@@ -0,0 +1,3 @@
+import type enUS from './en-US';
+declare const locale: typeof enUS;
+export default locale;

package/lib/types/locale/th-TH.d.ts

@@ -0,0 +1,3 @@
+import type enUS from './en-US';
+declare const locale: typeof enUS;
+export default locale;

package/lib/types/locale/tr-TR.d.ts

@@ -0,0 +1,3 @@
+import type enUS from './en-US';
+declare const locale: typeof enUS;
+export default locale;

package/lib/types/locale/types.d.ts

@@ -0,0 +1,7 @@
+import type { LocaleLeafKeys } from '@univerjs/core';
+import type enUS from './en-US';
+export type LocaleKey = LocaleLeafKeys<typeof enUS>;
+type LocaleKeySuffix<TKey, TPrefix extends string> = TKey extends `${TPrefix}${infer TSuffix}` ? TSuffix : never;
+export type ChartLocaleKeySuffix = LocaleKeySuffix<LocaleKey, 'bases-dashboard-ui.chart.'>;
+export type DashboardInspectorLocaleKeySuffix = LocaleKeySuffix<LocaleKey, 'bases-dashboard-ui.dashboardInspector.'>;
+export {};

package/lib/types/locale/uk-UA.d.ts

@@ -0,0 +1,3 @@
+import type enUS from './en-US';
+declare const locale: typeof enUS;
+export default locale;

package/lib/types/locale/vi-VN.d.ts

@@ -0,0 +1,3 @@
+import type enUS from './en-US';
+declare const locale: typeof enUS;
+export default locale;

package/lib/types/locale/zh-CN.d.ts

@@ -0,0 +1,3 @@
+import type enUS from './en-US';
+declare const locale: typeof enUS;
+export default locale;

package/lib/types/locale/zh-HK.d.ts

@@ -0,0 +1,3 @@
+import type enUS from './en-US';
+declare const locale: typeof enUS;
+export default locale;

package/lib/types/locale/zh-TW.d.ts

@@ -0,0 +1,3 @@
+import type enUS from './en-US';
+declare const locale: typeof enUS;
+export default locale;

package/lib/types/plugin.d.ts

@@ -0,0 +1,14 @@
+import type { IUniverBaseDashboardUIConfig } from './config/config';
+import { IConfigService, Injector, Plugin, UniverInstanceType } from '@univerjs/core';
+export declare class UniverBaseDashboardUIPlugin extends Plugin {
+    private readonly _config;
+    protected readonly _injector: Injector;
+    private readonly _configService;
+    static type: UniverInstanceType;
+    static pluginName: string;
+    static packageName: string;
+    static version: string;
+    constructor(_config: IUniverBaseDashboardUIConfig | undefined, _injector: Injector, _configService: IConfigService);
+    onStarting(): void;
+    onReady(): void;
+}

package/lib/types/services/base-dashboard-chart-render.service.d.ts

@@ -0,0 +1,16 @@
+import type { ChartRuntimeStyle, IChartHostStyle, IChartModelBinding, IChartRenderInstance } from '@univerjs-pro/engine-chart';
+import { ChartThemeService, IChartRenderModelManagerService } from '@univerjs-pro/engine-chart';
+import { LocaleService } from '@univerjs/core';
+export declare class BaseDashboardChartRenderService {
+    private readonly _localeService;
+    private readonly _chartThemeService;
+    private readonly _renderModelManager;
+    constructor(_localeService: LocaleService, _chartThemeService: ChartThemeService, _renderModelManager: IChartRenderModelManagerService);
+    createDomChartInstance(): IChartRenderInstance;
+    createRenderInput(runtime: IChartModelBinding): {
+        config: NonNullable<IChartModelBinding['model']['config']>;
+        style: ChartRuntimeStyle;
+    };
+    private _createContext;
+}
+export declare function applyDashboardChartHostStyle(host: HTMLElement, style: IChartHostStyle): void;

package/lib/types/services/base-dashboard-dom-chart-host.d.ts

@@ -0,0 +1,16 @@
+import type { IChartHostRect, IChartHostStyle, IDomChartHost } from '@univerjs-pro/engine-chart';
+import { ChartRenderMode } from '@univerjs-pro/engine-chart';
+import { Disposable } from '@univerjs/core';
+export declare class BaseDashboardDomChartHost extends Disposable implements IDomChartHost {
+    readonly chartId: string;
+    private readonly _element;
+    readonly mode = ChartRenderMode.Dom;
+    constructor(chartId: string, _element: HTMLElement);
+    getRect(): IChartHostRect;
+    setStyle(style: IChartHostStyle): void;
+    ensureMount(): Promise<HTMLElement>;
+    checkMounted(): boolean;
+    syncLayout(): void;
+    markReady(): void;
+    markNotReady(): void;
+}

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

@@ -0,0 +1,7 @@
+import type { IChartModelBinding } from '@univerjs-pro/engine-chart';
+import { ChartUIService, ChartViewStateRegistry } from '@univerjs-pro/chart-ui';
+export declare class BasePivotChartUIService extends ChartUIService<IChartModelBinding, never> {
+    readonly activeRuntimeModel: null;
+    constructor(viewStates: ChartViewStateRegistry);
+    executeChartUpdateConfig(_params: never): void;
+}

package/lib/types/utils/dashboard-formula-shape.d.ts

@@ -0,0 +1,14 @@
+import type { BaseDashboardFormulaShapeNumberFormat, IBaseDashboardFormulaShapeAppearance, IBaseDashboardFormulaShapeWidget } from '@univerjs-pro/bases-dashboard';
+export declare const DASHBOARD_FORMULA_SHAPE_DEFAULT_APPEARANCE: {
+    readonly alignment: "left";
+    readonly currency: "USD";
+    readonly decimalPlaces: 0;
+    readonly fontSize: 40;
+    readonly fontSizeMode: "auto";
+    readonly numberFormat: "general";
+};
+export type ResolvedDashboardFormulaShapeAppearance = Required<Omit<IBaseDashboardFormulaShapeAppearance, 'backgroundColor' | 'backgroundImage' | 'textColor'>> & Pick<IBaseDashboardFormulaShapeAppearance, 'backgroundColor' | 'backgroundImage' | 'textColor'>;
+export declare function resolveDashboardFormulaShapeAppearance(widget: IBaseDashboardFormulaShapeWidget): ResolvedDashboardFormulaShapeAppearance;
+export declare function updateDashboardFormulaShapeAppearance(widget: IBaseDashboardFormulaShapeWidget, patch: Partial<IBaseDashboardFormulaShapeAppearance>): IBaseDashboardFormulaShapeWidget;
+export declare function createDashboardFormulaShapeNumberFormatPattern(format: BaseDashboardFormulaShapeNumberFormat, decimalPlaces: number, currency: string): string;
+export declare function formatDashboardFormulaShapeValue(displayText: string, value: unknown, appearance: IBaseDashboardFormulaShapeAppearance): string;

package/lib/types/utils/dashboard-grid.d.ts

@@ -0,0 +1,8 @@
+import type { IBaseDashboardLayout } from '@univerjs-pro/bases-dashboard';
+export declare const DASHBOARD_EDGE_SCROLL_THRESHOLD = 56;
+export declare const DASHBOARD_EDGE_SCROLL_MAX_SPEED = 22;
+export type DashboardResizeDirection = 'n' | 'ne' | 'e' | 'se' | 's' | 'sw' | 'w' | 'nw';
+export declare function resizeDashboardLayout(layout: IBaseDashboardLayout, direction: DashboardResizeDirection, columnDelta: number, rowDelta: number): IBaseDashboardLayout;
+export declare function normalizeDashboardLayout(layout: IBaseDashboardLayout): IBaseDashboardLayout;
+export declare function resolveDashboardLayouts(layouts: ReadonlyMap<string, IBaseDashboardLayout>, activeId: string, activeLayout: IBaseDashboardLayout): Map<string, IBaseDashboardLayout>;
+export declare function getDashboardEdgeScrollDelta(pointerY: number, top: number, bottom: number, threshold?: number, maxSpeed?: number): number;

package/lib/types/utils/dashboard-image.d.ts

@@ -0,0 +1,3 @@
+import type { BaseDashboardImageDisplayMode } from '@univerjs-pro/bases-dashboard';
+import type { CSSProperties } from 'react';
+export declare function resolveDashboardImageBackgroundStyle(source: string, displayMode?: BaseDashboardImageDisplayMode): CSSProperties;

package/lib/types/utils/dashboard-text.d.ts

@@ -0,0 +1,11 @@
+import type { IBaseDashboardTextAppearance, IBaseDashboardTextWidget } from '@univerjs-pro/bases-dashboard';
+import type { IDocumentData } from '@univerjs/core';
+export declare const DASHBOARD_TEXT_DEFAULT_APPEARANCE: {
+    readonly alignment: "left";
+    readonly fontSize: 18;
+    readonly fontSizeMode: "auto";
+};
+export type ResolvedDashboardTextAppearance = Required<Pick<IBaseDashboardTextAppearance, 'alignment' | 'fontSize' | 'fontSizeMode'>> & Pick<IBaseDashboardTextAppearance, 'backgroundColor' | 'textColor'>;
+export declare function resolveDashboardTextAppearance(widget: IBaseDashboardTextWidget): ResolvedDashboardTextAppearance;
+export declare function getDashboardTextDocumentText(document: IDocumentData): string;
+export declare function updateDashboardTextDocument(document: IDocumentData, text: string): IDocumentData;