@odoo/o-spreadsheet 17.1.5 → 17.1.8

package/dist/o-spreadsheet.d.ts

@@ -3533,6 +3533,7 @@ declare class FigurePlugin extends CorePlugin<FigureState> implements FigureStat
         [sheet: string]: Record<UID, Figure | undefined> | undefined;
     };
     allowDispatch(cmd: CoreCommand): CommandResult;
+    beforeHandle(cmd: CoreCommand): void;
     handle(cmd: CoreCommand): void;
     private onRowColDelete;
     private onRowDeletion;
@@ -3854,7 +3855,7 @@ interface SheetState {
     readonly cellPosition: Record<UID, CellPosition | undefined>;
 }
 declare class SheetPlugin extends CorePlugin<SheetState> implements SheetState {
-    static getters: readonly ["getSheetName", "tryGetSheetName", "getSheet", "tryGetSheet", "getSheetIdByName", "getSheetIds", "getVisibleSheetIds", "isSheetVisible", "getEvaluationSheets", "doesHeaderExist", "doesHeadersExist", "getCell", "getCellPosition", "getColsZone", "getRowCells", "getRowsZone", "getNumberCols", "getNumberRows", "getNumberHeaders", "getGridLinesVisibility", "getNextSheetName", "isEmpty", "getSheetSize", "getSheetZone", "getPaneDivisions", "checkZonesExistInSheet", "getCommandZones", "getUnboundedZone", "checkElementsIncludeAllNonFrozenHeaders"];
+    static getters: readonly ["getSheetName", "tryGetSheetName", "getSheet", "tryGetSheet", "getSheetIdByName", "getSheetIds", "getVisibleSheetIds", "isSheetVisible", "getEvaluationSheets", "doesHeaderExist", "doesHeadersExist", "getCell", "getCellPosition", "getColsZone", "getRowCells", "getRowsZone", "getNumberCols", "getNumberRows", "getNumberHeaders", "getGridLinesVisibility", "getNextSheetName", "getSheetSize", "getSheetZone", "getPaneDivisions", "checkZonesExistInSheet", "getCommandZones", "getUnboundedZone", "checkElementsIncludeAllNonFrozenHeaders"];
     readonly sheetIdsMapName: Record<string, UID | undefined>;
     readonly orderedSheetIds: UID[];
     readonly sheets: Record<UID, Sheet | undefined>;
@@ -3903,10 +3904,6 @@ declare class SheetPlugin extends CorePlugin<SheetState> implements SheetState {
      * This validation ensures that all rows or columns cannot be deleted when frozen panes exist.
      */
     checkElementsIncludeAllNonFrozenHeaders(sheetId: UID, dimension: Dimension, elements: HeaderIndex[]): boolean;
-    /**
-     * Check if a zone only contains empty cells
-     */
-    isEmpty(sheetId: UID, zone: Zone): boolean;
     getCommandZones(cmd: Command): Zone[];
     /**
      * Check if zones in the command are well formed and
@@ -4001,7 +3998,7 @@ declare class SheetPlugin extends CorePlugin<SheetState> implements SheetState {
 }
 
 declare class EvaluationPlugin extends UIPlugin {
-    static getters: readonly ["evaluateFormula", "getCorrespondingFormulaCell", "getRangeFormattedValues", "getRangeValues", "getRangeFormats", "getEvaluatedCell", "getEvaluatedCells", "getEvaluatedCellsInZone", "getSpreadPositionsOf", "getArrayFormulaSpreadingOn"];
+    static getters: readonly ["evaluateFormula", "getCorrespondingFormulaCell", "getRangeFormattedValues", "getRangeValues", "getRangeFormats", "getEvaluatedCell", "getEvaluatedCells", "getEvaluatedCellsInZone", "getSpreadPositionsOf", "getArrayFormulaSpreadingOn", "isEmpty"];
     private shouldRebuildDependenciesGraph;
     private evaluator;
     private positionsToUpdate;
@@ -4027,6 +4024,10 @@ declare class EvaluationPlugin extends UIPlugin {
     getEvaluatedCellsInZone(sheetId: UID, zone: Zone): EvaluatedCell[];
     getSpreadPositionsOf(position: CellPosition): CellPosition[];
     getArrayFormulaSpreadingOn(position: CellPosition): CellPosition | undefined;
+    /**
+     * Check if a zone only contains empty cells
+     */
+    isEmpty(sheetId: UID, zone: Zone): boolean;
     exportForExcel(data: ExcelWorkbookData): void;
     /**
      * Returns the corresponding formula cell of a given cell
@@ -4126,7 +4127,7 @@ type SheetValidationResult = {
     [col: HeaderIndex]: Array<Lazy<ValidationResult>>;
 };
 declare class EvaluationDataValidationPlugin extends UIPlugin {
-    static getters: readonly ["getDataValidationInvalidCriterionValueMessage", "getDataValidationCheckBoxCellPositions", "getDataValidationListCellsPositions", "getInvalidDataValidationMessage", "getValidationResultForCellValue", "isCellValidCheckbox", "isDataValidationInvalid"];
+    static getters: readonly ["getDataValidationInvalidCriterionValueMessage", "getInvalidDataValidationMessage", "getValidationResultForCellValue", "isCellValidCheckbox", "isDataValidationInvalid"];
     validationResults: Record<UID, SheetValidationResult>;
     handle(cmd: CoreViewCommand): void;
     isDataValidationInvalid(cellPosition: CellPosition): boolean;
@@ -4140,8 +4141,6 @@ declare class EvaluationDataValidationPlugin extends UIPlugin {
     isCellValidCheckbox(cellPosition: CellPosition): boolean;
     /** Get the validation result if the cell on the given position had the given value */
     getValidationResultForCellValue(cellValue: CellValue, cellPosition: CellPosition): ValidationResult;
-    getDataValidationCheckBoxCellPositions(): CellPosition[];
-    getDataValidationListCellsPositions(): CellPosition[];
     private getValidationResultForCell;
     private computeSheetValidationResults;
     private getRuleErrorForCellValue;
@@ -5029,7 +5028,7 @@ type SheetViewports = {
  *
  */
 declare class SheetViewPlugin extends UIPlugin {
-    static getters: readonly ["getColIndex", "getRowIndex", "getActiveMainViewport", "getSheetViewDimension", "getSheetViewDimensionWithHeaders", "getMainViewportRect", "isVisibleInViewport", "getEdgeScrollCol", "getEdgeScrollRow", "getVisibleFigures", "getVisibleRect", "getColRowOffsetInViewport", "getMainViewportCoordinates", "getActiveSheetScrollInfo", "getActiveSheetDOMScrollInfo", "getSheetViewVisibleCols", "getSheetViewVisibleRows", "getFrozenSheetViewRatio", "isPositionVisible"];
+    static getters: readonly ["getColIndex", "getRowIndex", "getActiveMainViewport", "getSheetViewDimension", "getSheetViewDimensionWithHeaders", "getMainViewportRect", "isVisibleInViewport", "getEdgeScrollCol", "getEdgeScrollRow", "getVisibleFigures", "getVisibleRect", "getVisibleRectWithoutHeaders", "getVisibleCellPositions", "getColRowOffsetInViewport", "getMainViewportCoordinates", "getActiveSheetScrollInfo", "getActiveSheetDOMScrollInfo", "getSheetViewVisibleCols", "getSheetViewVisibleRows", "getFrozenSheetViewRatio", "isPositionVisible"];
     readonly viewports: Record<UID, SheetViewports | undefined>;
     /**
      * The viewport dimensions are usually set by one of the components
@@ -5076,6 +5075,10 @@ declare class SheetViewPlugin extends UIPlugin {
     getActiveSheetDOMScrollInfo(): SheetDOMScrollInfo;
     getSheetViewVisibleCols(): HeaderIndex[];
     getSheetViewVisibleRows(): HeaderIndex[];
+    /**
+     * Get the positions of all the cells that are visible in the viewport, taking merges into account.
+     */
+    getVisibleCellPositions(): CellPosition[];
     /**
      * Return the main viewport maximum size relative to the client size.
      */
@@ -5092,6 +5095,10 @@ declare class SheetViewPlugin extends UIPlugin {
      * Computes the coordinates and size to draw the zone on the canvas
      */
     getVisibleRect(zone: Zone): Rect;
+    /**
+     * Computes the coordinates and size to draw the zone without taking the grid offset into account
+     */
+    getVisibleRectWithoutHeaders(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)