@odoo/o-spreadsheet 16.2.0-alpha.1 → 16.2.0-alpha.3

package/dist/o_spreadsheet.d.ts

@@ -672,6 +672,7 @@ interface WorkbookData {
         };
     };
     revisionId: UID;
+    uniqueFigureIds: boolean;
 }
 interface ExcelWorkbookData extends WorkbookData {
     sheets: ExcelSheetData[];
@@ -1865,7 +1866,7 @@ interface FocusInputCommand {
     /**
      * Range to focus
      */
-    rangeId: string;
+    rangeId: number;
 }
 /**
  * Add an empty range at the end of a SelectionComponent state
@@ -1884,7 +1885,7 @@ interface RemoveRangeCommand {
     /** SelectionComponent id */
     id: string;
     /** The range to be removed */
-    rangeId: string;
+    rangeId: number;
 }
 /**
  * Set a new value for a given range of a SelectionComponent state.
@@ -1894,7 +1895,7 @@ interface ChangeRangeCommand {
     /** SelectionComponent id */
     id: string;
     /** The range to be changed */
-    rangeId: string;
+    rangeId: number;
     /**
      * Range to set in the input. Invalid ranges are also accepted.
      * e.g. "B2:B3" or the invalid "A5:"
@@ -2076,7 +2077,7 @@ declare const enum CommandResult {
     InvalidRange = 25,
     InvalidZones = 26,
     InvalidSheetId = 27,
-    DuplicatedImageId = 28,
+    InvalidFigureId = 28,
     InputAlreadyFocused = 29,
     MaximumRangesReached = 30,
     InvalidChartDefinition = 31,
@@ -2132,7 +2133,8 @@ declare const enum CommandResult {
     NonContinuousTargets = 81,
     DuplicatedFigureId = 82,
     InvalidSelectionStep = 83,
-    DuplicatedChartId = 84
+    DuplicatedChartId = 84,
+    ChartDoesNotExist = 85
 }
 interface CommandHandler<T> {
     allowDispatch(command: T): CommandResult | CommandResult[];
@@ -3179,24 +3181,22 @@ declare abstract class AbstractChart {
  * This plugin manages charts
  * */
 interface ChartState {
-    readonly charts: {
-        [sheetId: UID]: Record<UID, AbstractChart | undefined> | undefined;
-    };
+    readonly charts: Record<UID, AbstractChart | undefined>;
 }
 declare class ChartPlugin extends CorePlugin<ChartState> implements ChartState {
     static getters: readonly ["isChartDefined", "getChartDefinition", "getChartType", "getChartIds", "getChart", "getContextCreationChart"];
-    readonly charts: ChartState["charts"];
+    readonly charts: Record<UID, AbstractChart | undefined>;
     private createChart;
     private validateChartDefinition;
     adaptRanges(applyChange: ApplyRangeChange): void;
     allowDispatch(cmd: Command): CommandResult | CommandResult[];
     handle(cmd: CoreCommand): void;
-    getContextCreationChart(sheetId: UID, figureId: UID): ChartCreationContext | undefined;
-    getChart(sheetId: UID, figureId: UID): AbstractChart | undefined;
-    getChartType(sheetId: UID, figureId: UID): ChartType;
-    isChartDefined(sheetId: UID, figureId: UID): boolean;
+    getContextCreationChart(figureId: UID): ChartCreationContext | undefined;
+    getChart(figureId: UID): AbstractChart | undefined;
+    getChartType(figureId: UID): ChartType;
+    isChartDefined(figureId: UID): boolean;
     getChartIds(sheetId: UID): string[];
-    getChartDefinition(sheetId: UID, figureId: UID): ChartDefinition;
+    getChartDefinition(figureId: UID): ChartDefinition;
     import(data: WorkbookData): void;
     export(data: WorkbookData): void;
     exportForExcel(data: ExcelWorkbookData): void;
@@ -3210,6 +3210,7 @@ declare class ChartPlugin extends CorePlugin<ChartState> implements ChartState {
      */
     private addChart;
     private checkChartDuplicate;
+    private checkChartExists;
 }
 
 interface ConditionalFormatState {
@@ -3260,12 +3261,14 @@ declare class ConditionalFormatPlugin extends CorePlugin<ConditionalFormatState>
 
 interface FigureState {
     readonly figures: {
-        [sheet: UID]: Record<UID, Figure | undefined> | undefined;
+        [sheet: string]: Record<UID, Figure | undefined> | undefined;
     };
 }
 declare class FigurePlugin extends CorePlugin<FigureState> implements FigureState {
-    static getters: readonly ["getFigures", "getFigure"];
-    readonly figures: FigureState["figures"];
+    static getters: readonly ["getFigures", "getFigure", "getFigureSheetId"];
+    readonly figures: {
+        [sheet: string]: Record<UID, Figure | undefined> | undefined;
+    };
     allowDispatch(cmd: CoreCommand): CommandResult;
     handle(cmd: CoreCommand): void;
     private updateFigure;
@@ -3276,6 +3279,7 @@ declare class FigurePlugin extends CorePlugin<FigureState> implements FigureStat
     private checkFigureDuplicate;
     getFigures(sheetId: UID): Figure[];
     getFigure(sheetId: string, figureId: string): Figure | undefined;
+    getFigureSheetId(figureId: string): UID | undefined;
     import(data: WorkbookData): void;
     export(data: WorkbookData): void;
     exportForExcel(data: ExcelWorkbookData): void;
@@ -3396,7 +3400,7 @@ interface ImageState {
     readonly images: Record<UID, Record<UID, Image | undefined> | undefined>;
 }
 declare class ImagePlugin extends CorePlugin<ImageState> implements ImageState {
-    static getters: readonly ["getImage"];
+    static getters: readonly ["getImage", "getImagePath", "getImageSize"];
     readonly fileStore?: FileStore;
     readonly images: Record<UID, Record<UID, Image | undefined> | undefined>;
     /**
@@ -3404,13 +3408,15 @@ declare class ImagePlugin extends CorePlugin<ImageState> implements ImageState {
      */
     readonly syncedImages: Set<Image["path"]>;
     constructor(config: CorePluginConfig);
-    allowDispatch(cmd: CoreCommand): CommandResult.Success | CommandResult.DuplicatedImageId;
+    allowDispatch(cmd: CoreCommand): CommandResult.Success | CommandResult.InvalidFigureId;
     handle(cmd: CoreCommand): void;
     /**
      * Delete unused images from the file store
      */
     garbageCollectExternalResources(): void;
-    getImage(sheetId: UID, figureId: UID): Image;
+    getImage(figureId: UID): Image;
+    getImagePath(figureId: UID): string;
+    getImageSize(figureId: UID): FigureSize;
     private addFigure;
     import(data: WorkbookData): void;
     export(data: WorkbookData): void;
@@ -3705,12 +3711,10 @@ declare class EvaluationPlugin extends UIPlugin {
 
 declare class EvaluationChartPlugin extends UIPlugin {
     static getters: readonly ["getChartRuntime", "getBackgroundOfSingleCellChart"];
-    readonly charts: {
-        [sheetId: UID]: Record<UID, ChartRuntime | undefined> | undefined;
-    };
+    readonly charts: Record<UID, ChartRuntime | undefined>;
     private createRuntimeChart;
     handle(cmd: Command): void;
-    getChartRuntime(sheetId: UID, figureId: UID): ChartRuntime;
+    getChartRuntime(figureId: UID): ChartRuntime;
     /**
      * Get the background color of a chart based on the color of the first cell of the main range
      * of the chart. In order of priority, it will return :
@@ -4252,7 +4256,7 @@ declare class RendererPlugin extends UIPlugin {
 }
 
 interface RangeInputValue {
-    id: UID;
+    id: number;
     xc: string;
     color: string;
 }
@@ -4315,7 +4319,7 @@ declare class SelectionInputPlugin extends UIPlugin implements StreamCallbacks<S
      * Return the index of a range given its id
      * or `null` if the range is not found.
      */
-    getIndex(rangeId: string | null): number | null;
+    getIndex(rangeId: number | null): number | null;
 }
 
 /**
@@ -4889,15 +4893,14 @@ declare class SelectionInput extends Component<Props$B, SpreadsheetChildEnv> {
     getColor(range: SelectionRange): string;
     private triggerChange;
     onKeydown(ev: KeyboardEvent): void;
-    focus(rangeId: string): void;
+    focus(rangeId: number): void;
     addEmptyInput(): void;
-    removeInput(rangeId: string): void;
-    onInputChanged(rangeId: string, ev: InputEvent): void;
-    disable(): void;
+    removeInput(rangeId: number): void;
+    onInputChanged(rangeId: number, ev: InputEvent): void;
+    confirm(): void;
 }
 
 interface Props$A {
-    sheetId: UID;
     figureId: UID;
     definition: LineChartDefinition | BarChartDefinition | PieChartDefinition;
     updateChart: (definition: Partial<LineChartDefinition | BarChartDefinition | PieChartDefinition>) => DispatchResult;
@@ -4936,9 +4939,42 @@ declare class BarConfigPanel extends LineBarPieConfigPanel {
     onUpdateAggregated(ev: any): void;
 }
 
+interface PopoverProps {
+    /**
+     * Rectangle around which the popover is displayed.
+     * Coordinates are expressed as absolute DOM position.
+     */
+    anchorRect: Rect;
+    /** The popover can be positioned below the anchor Rectangle, or to the right of the rectangle */
+    positioning: PopoverPropsPosition;
+    maxWidth?: Pixel;
+    maxHeight?: Pixel;
+    /** Offset to apply to the vertical position of the popover.*/
+    verticalOffset: number;
+    onMouseWheel?: () => void;
+    onPopoverMoved?: () => void;
+    onPopoverHidden?: () => void;
+}
+declare class Popover extends Component<PopoverProps, SpreadsheetChildEnv> {
+    static template: string;
+    static defaultProps: {
+        positioning: string;
+        verticalOffset: number;
+        onMouseWheel: () => void;
+        onPopoverMoved: () => void;
+        onPopoverHidden: () => void;
+    };
+    private popoverRef;
+    private currentPosition;
+    private currentDisplayValue;
+    private spreadsheetRect;
+    private containerRect;
+    setup(): void;
+}
+
 interface ColorPickerProps {
+    anchorRect: Rect;
     maxHeight?: Pixel;
-    dropdownDirection?: "left" | "right" | "center";
     onColorPicked: (color: Color) => void;
     currentColor: Color;
 }
@@ -4947,9 +4983,13 @@ declare class ColorPicker extends Component<ColorPickerProps, SpreadsheetChildEn
     static defaultProps: {
         currentColor: string;
     };
+    static components: {
+        Popover: typeof Popover;
+    };
     COLORS: string[];
     private state;
     get colorPickerStyle(): string;
+    get popoverProps(): PopoverProps;
     onColorClick(color: Color): void;
     getCheckMarkColor(): Color;
     resetColor(): void;
@@ -4968,7 +5008,6 @@ interface Props$z {
     showColorPicker: boolean;
     onColorPicked: (color: string) => void;
     icon: string;
-    dropdownDirection?: "left" | "right" | "center";
     title?: string;
     disabled?: boolean;
     dropdownMaxHeight?: Pixel;
@@ -4979,7 +5018,11 @@ declare class ColorPickerWidget extends Component<Props$z, SpreadsheetChildEnv>
     static components: {
         ColorPicker: typeof ColorPicker;
     };
+    colorPickerButtonRef: {
+        el: HTMLElement | null;
+    };
     get iconStyle(): string;
+    get colorPickerAnchorRect(): Rect;
 }
 
 interface Props$y {
@@ -5002,7 +5045,6 @@ declare class LineBarPieDesignPanel extends Component<Props$y, SpreadsheetChildE
 }
 
 interface Props$x {
-    sheetId: UID;
     figureId: UID;
     definition: GaugeChartDefinition;
     updateChart: (definition: Partial<GaugeChartDefinition>) => DispatchResult;
@@ -5059,7 +5101,6 @@ declare class LineConfigPanel extends LineBarPieConfigPanel {
 }
 
 interface Props$v {
-    sheetId: UID;
     figureId: UID;
     definition: ScorecardChartDefinition;
     updateChart: (definition: Partial<ScorecardChartDefinition>) => DispatchResult;
@@ -5214,7 +5255,7 @@ declare class ChartJsComponent extends Component<Props$t, SpreadsheetChildEnv> {
     static template: string;
     private canvas;
     private chart?;
-    get background(): Color;
+    get background(): string;
     get canvasStyle(): string;
     get chartRuntime(): ChartJSRuntime;
     setup(): void;
@@ -5256,39 +5297,6 @@ declare class ScorecardChart extends Component<Props$s, SpreadsheetChildEnv> {
     private getWidestElement;
 }
 
-interface PopoverProps {
-    /**
-     * Rectangle around which the popover is displayed.
-     * Coordinates are expressed as absolute DOM position.
-     */
-    anchorRect: Rect;
-    /** The popover can be positioned below the anchor Rectangle, or to the right of the rectangle */
-    positioning: PopoverPropsPosition;
-    maxWidth?: Pixel;
-    maxHeight?: Pixel;
-    /** Offset to apply to the vertical position of the popover.*/
-    verticalOffset: number;
-    onMouseWheel?: () => void;
-    onPopoverMoved?: () => void;
-    onPopoverHidden?: () => void;
-}
-declare class Popover extends Component<PopoverProps, SpreadsheetChildEnv> {
-    static template: string;
-    static defaultProps: {
-        positioning: string;
-        verticalOffset: number;
-        onMouseWheel: () => void;
-        onPopoverMoved: () => void;
-        onPopoverHidden: () => void;
-    };
-    private popoverRef;
-    private currentPosition;
-    private currentDisplayValue;
-    private spreadsheetRect;
-    private containerRect;
-    setup(): void;
-}
-
 interface Props$r {
     position: DOMCoordinates;
     menuItems: MenuItem[];