@odoo/o-spreadsheet 18.2.0-alpha.2 → 18.2.0-alpha.4

package/dist/o-spreadsheet.d.ts

@@ -1186,6 +1186,7 @@ declare class Session extends EventBus<CollaborativeEvent> {
     private waitingUndoRedoAck;
     private isReplayingInitialRevisions;
     private processedRevisions;
+    private lastRevisionMessage;
     private uuidGenerator;
     private lastLocalOperation;
     /**
@@ -2111,10 +2112,16 @@ declare class InternalViewport {
     adjustViewportZone(): void;
     /**
      *
-     * @param zone
-     * @returns Computes the absolute coordinate of a given zone inside the viewport
+     * Computes the visible coordinates & dimensions of a given zone inside the viewport
+     *
+     */
+    getVisibleRect(zone: Zone): Rect | undefined;
+    /**
+     *
+     * @returns Computes the absolute coordinates & dimensions of a given zone inside the viewport
+     *
      */
-    getRect(zone: Zone): Rect | undefined;
+    getFullRect(zone: Zone): Rect | undefined;
     isVisible(col: HeaderIndex, row: HeaderIndex): boolean;
     private searchHeaderIndex;
     private setViewportOffsetX;
@@ -2183,7 +2190,7 @@ type SheetViewports = {
  *
  */
 declare class SheetViewPlugin extends UIPlugin {
-    static getters: readonly ["getColIndex", "getRowIndex", "getActiveMainViewport", "getSheetViewDimension", "getSheetViewDimensionWithHeaders", "getMainViewportRect", "isVisibleInViewport", "getEdgeScrollCol", "getEdgeScrollRow", "getVisibleFigures", "getVisibleRect", "getVisibleRectWithoutHeaders", "getVisibleCellPositions", "getColRowOffsetInViewport", "getMainViewportCoordinates", "getActiveSheetScrollInfo", "getActiveSheetDOMScrollInfo", "getSheetViewVisibleCols", "getSheetViewVisibleRows", "getFrozenSheetViewRatio", "isPositionVisible", "getColDimensionsInViewport", "getRowDimensionsInViewport"];
+    static getters: readonly ["getColIndex", "getRowIndex", "getActiveMainViewport", "getSheetViewDimension", "getSheetViewDimensionWithHeaders", "getMainViewportRect", "isVisibleInViewport", "getEdgeScrollCol", "getEdgeScrollRow", "getVisibleFigures", "getVisibleRect", "getVisibleRectWithoutHeaders", "getVisibleCellPositions", "getColRowOffsetInViewport", "getMainViewportCoordinates", "getActiveSheetScrollInfo", "getActiveSheetDOMScrollInfo", "getSheetViewVisibleCols", "getSheetViewVisibleRows", "getFrozenSheetViewRatio", "isPositionVisible", "getColDimensionsInViewport", "getRowDimensionsInViewport", "getAllActiveViewportsZones", "getRect"];
     readonly viewports: Record<UID, SheetViewports | undefined>;
     /**
      * The viewport dimensions are usually set by one of the components
@@ -2254,6 +2261,11 @@ declare class SheetViewPlugin extends UIPlugin {
      * Computes the coordinates and size to draw the zone without taking the grid offset into account
      */
     getVisibleRectWithoutHeaders(zone: Zone): Rect;
+    /**
+     * Computes the actual size and position (:Rect) of the zone on the canvas
+     * regardless of the viewport dimensions.
+     */
+    getRect(zone: Zone): Rect;
     /**
      * Returns the position of the MainViewport relatively to the start of the grid (without headers)
      * It corresponds to the summed dimensions of the visible cols/rows (in x/y respectively)
@@ -2270,6 +2282,7 @@ declare class SheetViewPlugin extends UIPlugin {
      * of the current viewport
      */
     getRowDimensionsInViewport(sheetId: UID, row: HeaderIndex): HeaderDimensions;
+    getAllActiveViewportsZones(): Zone[];
     private ensureMainViewportExist;
     private getSubViewports;
     private checkPositiveDimension;
@@ -2301,6 +2314,7 @@ declare class SheetViewPlugin extends UIPlugin {
         xRatio: number;
         yRatio: number;
     };
+    private recomposeRect;
 }
 
 declare enum ClipboardMIMEType {
@@ -3972,6 +3986,10 @@ interface SpreadsheetChildEnv extends NotificationStoreMethods {
     getStore: Get;
 }
 
+interface RangeStringOptions {
+    useBoundedReference?: boolean;
+    useFixedReference?: boolean;
+}
 declare class RangeAdapter implements CommandHandler<CoreCommand> {
     private getters;
     private providers;
@@ -4019,11 +4037,10 @@ declare class RangeAdapter implements CommandHandler<CoreCommand> {
      * @param range the range (received from getRangeFromXC or getRangeFromZone)
      * @param forSheetId the id of the sheet where the range string is supposed to be used.
      * @param options
+     * @param options.useBoundedReference if true, the range will be returned with bounded row and column
      * @param options.useFixedReference if true, the range will be returned with fixed row and column
      */
-    getRangeString(range: Range, forSheetId: UID, options?: {
-        useFixedReference: boolean;
-    }): string;
+    getRangeString(range: Range, forSheetId: UID, options?: RangeStringOptions): string;
     getRangeDataFromXc(sheetId: UID, xc: string): RangeData;
     getRangeDataFromZone(sheetId: UID, zone: Zone | UnboundedZone): RangeData;
     getRangeFromZone(sheetId: UID, zone: Zone | UnboundedZone): Range;
@@ -4259,7 +4276,7 @@ declare class CellPlugin extends CorePlugin<CoreState$1> implements CoreState$1
      * starting an async evaluation even if it has been moved or re-allocated
      */
     getCellById(cellId: UID): Cell | undefined;
-    getFormulaString(sheetId: UID, tokens: Token[], dependencies: Range[], useFixedReference?: boolean): string;
+    getFormulaString(sheetId: UID, tokens: Token[], dependencies: Range[], useBoundedReference?: boolean): string;
     getTranslatedCellFormula(sheetId: UID, offsetX: number, offsetY: number, tokens: Token[]): string;
     getFormulaMovedInSheet(originSheetId: UID, targetSheetId: UID, tokens: Token[]): string;
     getCellStyle(position: CellPosition): Style;
@@ -6807,8 +6824,8 @@ interface RangeInputValue {
 declare class SelectionInputStore extends SpreadsheetStore {
     private initialRanges;
     private readonly inputHasSingleRange;
-    private readonly colors;
-    mutators: readonly ["resetWithRanges", "focusById", "unfocus", "addEmptyRange", "removeRange", "changeRange", "reset", "confirm"];
+    colors: Color[];
+    mutators: readonly ["resetWithRanges", "focusById", "unfocus", "addEmptyRange", "removeRange", "changeRange", "reset", "confirm", "updateColors"];
     ranges: RangeInputValue[];
     focusedRangeIndex: number | null;
     private inputSheetId;
@@ -6826,6 +6843,7 @@ declare class SelectionInputStore extends SpreadsheetStore {
     changeRange(rangeId: number, value: string): void;
     addEmptyRange(): void;
     removeRange(rangeId: number): void;
+    updateColors(colors: Color[]): void;
     confirm(): void;
     reset(): void;
     get selectionInputValues(): string[];
@@ -6892,6 +6910,8 @@ interface Props$1a {
     isInvalid?: boolean;
     class?: string;
     onSelectionChanged?: (ranges: string[]) => void;
+    onSelectionReordered?: (indexes: number[]) => void;
+    onSelectionRemoved?: (index: number) => void;
     onSelectionConfirmed?: () => void;
     colors?: Color[];
 }
@@ -6936,6 +6956,14 @@ declare class SelectionInput extends Component<Props$1a, SpreadsheetChildEnv> {
             type: FunctionConstructor;
             optional: boolean;
         };
+        onSelectionReordered: {
+            type: FunctionConstructor;
+            optional: boolean;
+        };
+        onSelectionRemoved: {
+            type: FunctionConstructor;
+            optional: boolean;
+        };
         colors: {
             type: ArrayConstructor;
             optional: boolean;
@@ -6943,7 +6971,9 @@ declare class SelectionInput extends Component<Props$1a, SpreadsheetChildEnv> {
         };
     };
     private state;
+    private dragAndDrop;
     private focusedInput;
+    private selectionRef;
     private store;
     get ranges(): SelectionRange[];
     get canAddRange(): boolean;
@@ -6951,6 +6981,8 @@ declare class SelectionInput extends Component<Props$1a, SpreadsheetChildEnv> {
     get isConfirmable(): boolean;
     get isResettable(): boolean;
     setup(): void;
+    startDragAndDrop(rangeId: number, event: MouseEvent): void;
+    getRangeElementsRects(): DOMRect[];
     getColor(range: SelectionRange): string;
     private triggerChange;
     onKeydown(ev: KeyboardEvent): void;
@@ -6967,6 +6999,8 @@ interface Props$19 {
     ranges: CustomizedDataSet[];
     hasSingleRange?: boolean;
     onSelectionChanged: (ranges: string[]) => void;
+    onSelectionReordered?: (indexes: number[]) => void;
+    onSelectionRemoved?: (index: number) => void;
     onSelectionConfirmed: () => void;
 }
 declare class ChartDataSeries extends Component<Props$19, SpreadsheetChildEnv> {
@@ -6982,6 +7016,14 @@ declare class ChartDataSeries extends Component<Props$19, SpreadsheetChildEnv> {
             optional: boolean;
         };
         onSelectionChanged: FunctionConstructor;
+        onSelectionReordered: {
+            type: FunctionConstructor;
+            optional: boolean;
+        };
+        onSelectionRemoved: {
+            type: FunctionConstructor;
+            optional: boolean;
+        };
         onSelectionConfirmed: FunctionConstructor;
     };
     get ranges(): string[];
@@ -7088,7 +7130,7 @@ declare class GenericChartConfigPanel extends Component<Props$15, SpreadsheetChi
         canUpdateChart: FunctionConstructor;
     };
     protected state: ChartPanelState;
-    protected dataSeriesRanges: CustomizedDataSet[];
+    protected dataSets: CustomizedDataSet[];
     private labelRange;
     protected chartTerms: {
         [key: string]: any;
@@ -7113,6 +7155,8 @@ declare class GenericChartConfigPanel extends Component<Props$15, SpreadsheetChi
      * button "confirm" is clicked
      */
     onDataSeriesRangesChanged(ranges: string[]): void;
+    onDataSeriesReordered(indexes: number[]): void;
+    onDataSeriesRemoved(index: number): void;
     onDataSeriesConfirmed(): void;
     getDataSeriesRanges(): CustomizedDataSet[];
     /**
@@ -9595,7 +9639,7 @@ declare function useHighlights(highlightProvider: HighlightProvider): void;
 declare class MainChartPanelStore extends SpreadsheetStore {
     mutators: readonly ["activatePanel", "changeChartType"];
     panel: "configuration" | "design";
-    private creationContext;
+    private creationContexts;
     activatePanel(panel: "configuration" | "design"): void;
     changeChartType(figureId: UID, newDisplayType: string): void;
     private getChartDefinitionFromContextCreation;
@@ -11199,7 +11243,7 @@ declare class BorderEditor extends Component<BorderEditorProps, SpreadsheetChild
 }
 
 interface Props$3 {
-    toggleBorderEditor: () => void;
+    toggleBorderEditor: (ev: MouseEvent) => void;
     showBorderEditor: boolean;
     disabled?: boolean;
     dropdownMaxHeight?: Pixel;
@@ -11235,6 +11279,7 @@ declare class BorderEditorWidget extends Component<Props$3, SpreadsheetChildEnv>
         el: HTMLElement | null;
     };
     state: State$3;
+    setup(): void;
     get borderEditorAnchorRect(): Rect;
     onBorderPositionPicked(position: BorderPosition): void;
     onBorderColorPicked(color: Color): void;
@@ -12699,6 +12744,7 @@ declare const chartHelpers: {
     getComboChartDatasets(definition: GenericDefinition<ComboChartDefinition>, args: ChartRuntimeGenerationArgs): chart_js.ChartDataset<"line" | "bar">[];
     getRadarChartDatasets(definition: GenericDefinition<RadarChartDefinition>, args: ChartRuntimeGenerationArgs): chart_js.ChartDataset<"radar">[];
     getGeoChartDatasets(definition: GenericDefinition<GeoChartDefinition>, args: GeoChartRuntimeGenerationArgs): chart_js.ChartDataset[];
+    getChartColorsGenerator(definition: GenericDefinition<ChartWithDataSetDefinition>, dataSetsSize: number): ColorGenerator;
     getChartLayout(definition: GenericDefinition<ChartWithDataSetDefinition>): chart_js_dist_types_utils._DeepPartialObject<Partial<{
         autoPadding: boolean;
         padding: chart_js.Scriptable<chart_js_dist_types_geometric.Padding, chart_js.ScriptableContext<keyof chart_js.ChartTypeRegistry>>;