@odoo/o-spreadsheet 16.2.1 → 16.2.3

package/dist/o-spreadsheet.d.ts

@@ -294,10 +294,10 @@ declare function toZone(xc: string): Zone;
  */
 declare function findCellInNewZone(oldZone: Zone, currentZone: Zone): Position$1;
 declare function positionToZone(position: Position$1): {
-    left: number;
-    right: number;
-    top: number;
-    bottom: number;
+    left: HeaderIndex;
+    right: HeaderIndex;
+    top: HeaderIndex;
+    bottom: HeaderIndex;
 };
 
 interface SelectionEventPayload {
@@ -406,9 +406,9 @@ interface SectionRule {
     readonly upperInflectionPoint: SectionThreshold;
 }
 interface ColorSet {
-    readonly lowerColor: string;
-    readonly middleColor: string;
-    readonly upperColor: string;
+    readonly lowerColor: Color;
+    readonly middleColor: Color;
+    readonly upperColor: Color;
 }
 interface SectionThreshold {
     readonly type: "number" | "percentage";
@@ -435,13 +435,13 @@ interface GaugeChartOptions extends ChartOptions {
         radiusPercentage: number;
         widthPercentage: number;
         lengthPercentage: number;
-        color: string;
+        color: Color;
     };
     valueLabel?: {
         formatter: (() => string) | null;
         display: boolean;
-        color: string;
-        backgroundColor: string;
+        color: Color;
+        backgroundColor: Color;
         borderRadius: number;
         fontSize: number;
         padding: {
@@ -1622,8 +1622,8 @@ interface CreateChartCommand extends SheetDependentCommand {
     type: "CREATE_CHART";
     id: UID;
     position?: {
-        x: number;
-        y: number;
+        x: Pixel;
+        y: Pixel;
     };
     size?: FigureSize;
     definition: ChartDefinition;
@@ -1637,8 +1637,8 @@ interface CreateImageOverCommand extends SheetDependentCommand {
     type: "CREATE_IMAGE";
     figureId: UID;
     position: {
-        x: number;
-        y: number;
+        x: Pixel;
+        y: Pixel;
     };
     size: FigureSize;
     definition: Image;
@@ -1742,7 +1742,7 @@ interface StopSelectionCommand {
  */
 interface SetColorCommand {
     type: "SET_HIGHLIGHT_COLOR";
-    color: string;
+    color: Color;
 }
 interface EvaluateCellsCommand {
     type: "EVALUATE_CELLS";
@@ -2167,7 +2167,7 @@ declare type CoreCommandTypes = CoreCommand["type"];
  * Intellisense from resolving it.
  * See https://github.com/microsoft/TypeScript/issues/31940#issuecomment-841712377
  */
-declare type Alias = {};
+declare type Alias = {} & {};
 declare type HeaderIndex = number & Alias;
 declare type Pixel = number & Alias;
 declare type UID = string & Alias;
@@ -2231,8 +2231,8 @@ interface Style {
     align?: Align;
     wrapping?: Wrapping;
     verticalAlign?: VerticalAlign;
-    fillColor?: string;
-    textColor?: string;
+    fillColor?: Color;
+    textColor?: Color;
     fontSize?: number;
 }
 interface UpdateCellData {
@@ -2311,7 +2311,7 @@ interface Merge extends Zone {
 interface Highlight$1 {
     zone: Zone;
     sheetId: UID;
-    color: string | null;
+    color: Color | null;
 }
 interface PaneDivision {
     /** Represents the number of frozen columns */
@@ -3301,7 +3301,7 @@ declare class Filter {
     readonly id: UID;
     readonly zoneWithHeaders: Zone;
     constructor(id: UID, zone: Zone);
-    get col(): number;
+    get col(): HeaderIndex;
     /** Filtered zone, ie. zone of the filter without the header */
     get filteredZone(): Zone | undefined;
 }
@@ -3807,8 +3807,8 @@ declare class InternalViewport {
     offsetScrollbarY: Pixel;
     canScrollVertically: boolean;
     canScrollHorizontally: boolean;
-    width: Pixel;
-    height: Pixel;
+    viewportWidth: Pixel;
+    viewportHeight: Pixel;
     offsetCorrectionX: Pixel;
     offsetCorrectionY: Pixel;
     constructor(getters: Getters, sheetId: UID, boundaries: Zone, sizeInGrid: {
@@ -3821,6 +3821,10 @@ declare class InternalViewport {
         x: Pixel;
         y: Pixel;
     });
+    /** Returns the maximum size (in Pixels) of the viewport relative to its allocated client size
+     * When the viewport grid size is smaller than its client width (resp. height), it will return
+     * the client width (resp. height).
+     */
     getMaxSize(): DOMDimension;
     /**
      * Return the index of a column given an offset x, based on the pane left
@@ -3840,8 +3844,8 @@ declare class InternalViewport {
      * until it contains the cell completely.
      */
     adjustPosition(position?: Position$1): void;
-    adjustPositionX(col: HeaderIndex): void;
-    adjustPositionY(row: HeaderIndex): void;
+    adjustPositionX(targetCol: HeaderIndex): void;
+    adjustPositionY(targetRow: HeaderIndex): void;
     setViewportOffset(offsetX: Pixel, offsetY: Pixel): void;
     adjustViewportZone(): void;
     /**
@@ -3966,8 +3970,7 @@ declare class SheetViewPlugin extends UIPlugin {
     getSheetViewVisibleCols(): HeaderIndex[];
     getSheetViewVisibleRows(): HeaderIndex[];
     /**
-     * Return the main viewport maximum size. That is the zone dimension
-     * with some bottom and right padding.
+     * Return the main viewport maximum size relative to the client size.
      */
     getMainViewportRect(): Rect;
     private getMaximumSheetOffset;
@@ -4261,7 +4264,7 @@ declare class RendererPlugin extends UIPlugin {
 interface RangeInputValue {
     id: number;
     xc: string;
-    color: string;
+    color: Color;
 }
 /**
  * Selection input Plugin
@@ -4357,7 +4360,7 @@ declare class SelectionInputsManagerPlugin extends UIPlugin {
 }
 
 interface ClientToDisplay extends Required<Client> {
-    color: string;
+    color: Color;
 }
 declare class SelectionMultiUserPlugin extends UIPlugin {
     static getters: readonly ["getClientsToDisplay"];
@@ -4868,7 +4871,7 @@ interface Props$B {
 interface SelectionRange extends Omit<RangeInputValue, "color"> {
     isFocused: boolean;
     isValidRange: boolean;
-    color?: string;
+    color?: Color;
 }
 /**
  * This component can be used when the user needs to input some
@@ -4942,6 +4945,21 @@ declare class BarConfigPanel extends LineBarPieConfigPanel {
     onUpdateAggregated(ev: any): void;
 }
 
+declare const DATETIME_FORMAT: RegExp;
+declare enum ComponentsImportance {
+    Grid = 0,
+    Highlight = 5,
+    Figure = 10,
+    ScrollBar = 15,
+    GridPopover = 19,
+    GridComposer = 20,
+    Dropdown = 21,
+    IconPicker = 25,
+    TopBarComposer = 30,
+    Popover = 35,
+    ChartAnchor = 1000
+}
+
 interface PopoverProps {
     /**
      * Rectangle around which the popover is displayed.
@@ -4957,6 +4975,8 @@ interface PopoverProps {
     onMouseWheel?: () => void;
     onPopoverMoved?: () => void;
     onPopoverHidden?: () => void;
+    /** Setting popover to allow dynamic zIndex */
+    zIndex?: Number;
 }
 declare class Popover extends Component<PopoverProps, SpreadsheetChildEnv> {
     static template: string;
@@ -4966,6 +4986,7 @@ declare class Popover extends Component<PopoverProps, SpreadsheetChildEnv> {
         onMouseWheel: () => void;
         onPopoverMoved: () => void;
         onPopoverHidden: () => void;
+        zIndex: ComponentsImportance;
     };
     private popoverRef;
     private currentPosition;
@@ -4973,6 +4994,7 @@ declare class Popover extends Component<PopoverProps, SpreadsheetChildEnv> {
     private spreadsheetRect;
     private containerRect;
     setup(): void;
+    get popoverStyle(): string;
 }
 
 interface ColorPickerProps {
@@ -4989,7 +5011,7 @@ declare class ColorPicker extends Component<ColorPickerProps, SpreadsheetChildEn
     static components: {
         Popover: typeof Popover;
     };
-    COLORS: string[];
+    COLORS: Color[];
     private state;
     get colorPickerStyle(): string;
     get popoverProps(): PopoverProps;
@@ -5003,6 +5025,7 @@ declare class ColorPicker extends Component<ColorPickerProps, SpreadsheetChildEn
     showMagnifier(_ev: MouseEvent): void;
     moveMagnifier(ev: MouseEvent): void;
     get magnifyingGlassStyle(): string;
+    isSameColor(color1: Color, color2: Color): boolean;
 }
 
 interface Props$z {
@@ -5042,7 +5065,7 @@ declare class LineBarPieDesignPanel extends Component<Props$y, SpreadsheetChildE
     onClick(ev: MouseEvent): void;
     setup(): void;
     toggleColorPicker(): void;
-    updateBackgroundColor(color: string): void;
+    updateBackgroundColor(color: Color): void;
     updateTitle(ev: any): void;
     updateSelect(attr: string, ev: any): void;
 }
@@ -5079,7 +5102,7 @@ declare class GaugeChartDesignPanel extends Component<Props$w, SpreadsheetChildE
     private state;
     setup(): void;
     get designErrorMessages(): string[];
-    updateBackgroundColor(color: string): void;
+    updateBackgroundColor(color: Color): void;
     updateTitle(ev: any): void;
     isRangeMinInvalid(): boolean;
     isRangeMaxInvalid(): boolean;
@@ -5087,7 +5110,7 @@ declare class GaugeChartDesignPanel extends Component<Props$w, SpreadsheetChildE
     get isUpperInflectionPointInvalid(): boolean;
     updateInflectionPointValue(attr: string, ev: any): void;
     updateInflectionPointType(attr: string, ev: any): void;
-    updateSectionColor(target: string, color: string): void;
+    updateSectionColor(target: string, color: Color): void;
     updateRangeMin(ev: any): void;
     updateRangeMax(ev: any): void;
     toggleMenu(menu: GaugeMenu): void;
@@ -5142,7 +5165,7 @@ declare class ScorecardChartDesignPanel extends Component<Props$u, SpreadsheetCh
     updateTitle(ev: any): void;
     updateBaselineDescr(ev: any): void;
     toggleColorPicker(colorPickerId: ColorPickerId): void;
-    setColor(color: string, colorPickerId: ColorPickerId): void;
+    setColor(color: Color, colorPickerId: ColorPickerId): void;
     private closeMenus;
 }
 
@@ -5182,7 +5205,7 @@ interface MenuItemSpec {
     children?: MenuChildren;
     separator?: boolean;
     icon?: string;
-    textColor?: string;
+    textColor?: Color;
 }
 interface MenuItem {
     id: string;
@@ -5279,8 +5302,8 @@ declare class ScorecardChart extends Component<Props$s, SpreadsheetChildEnv> {
     get baseline(): string;
     get baselineDescr(): string;
     get baselineArrowDirection(): BaselineArrowDirection;
-    get backgroundColor(): string;
-    get primaryFontColor(): string;
+    get backgroundColor(): Color;
+    get primaryFontColor(): Color;
     get secondaryFontColor(): "#525252" | "#C8C8C8";
     get figure(): Figure;
     get chartStyle(): string;
@@ -5434,7 +5457,7 @@ declare class Autofill extends Component<Props$o, SpreadsheetChildEnv> {
 interface ClientTagProps {
     active: boolean;
     name: string;
-    color: string;
+    color: Color;
     col: HeaderIndex;
     row: HeaderIndex;
 }
@@ -5609,6 +5632,39 @@ declare class BottomBar extends Component<Props$l, SpreadsheetChildEnv> {
     get sheetListMaxScroll(): number;
 }
 
+interface Props$k {
+    position: DOMCoordinates;
+    isActive: boolean;
+    onClick: () => void;
+}
+declare class FilterIcon extends Component<Props$k, SpreadsheetEnv> {
+    static style: string;
+    static template: string;
+    get style(): string;
+}
+
+interface Props$j {
+    gridPosition: DOMCoordinates;
+}
+declare class FilterIconsOverlay extends Component<Props$j, SpreadsheetChildEnv> {
+    static style: string;
+    static template: string;
+    static components: {
+        FilterIcon: typeof FilterIcon;
+    };
+    static defaultProps: {
+        gridPosition: {
+            x: number;
+            y: number;
+        };
+    };
+    getVisibleFilterHeaders(): Position$1[];
+    getFilterHeaderPosition(position: Position$1): DOMCoordinates;
+    isFilterActive(position: Position$1): boolean;
+    toggleFilterMenu(position: Position$1): void;
+    private isPositionVisible;
+}
+
 declare type ContainerType = "topLeft" | "topRight" | "bottomLeft" | "bottomRight" | "dnd";
 interface DndState {
     figId: string | undefined;
@@ -5617,7 +5673,7 @@ interface DndState {
     width: Pixel;
     height: Pixel;
 }
-interface Props$k {
+interface Props$i {
     onFigureDeleted: () => void;
 }
 interface Container {
@@ -5686,7 +5742,7 @@ interface Container {
  * that occurred during the drag & drop, and to position the figure on the correct pane.
  *
  */
-declare class FiguresContainer extends Component<Props$k, SpreadsheetChildEnv> {
+declare class FiguresContainer extends Component<Props$i, SpreadsheetChildEnv> {
     static template: string;
     static components: {
         FigureComponent: typeof FigureComponent;
@@ -5706,7 +5762,7 @@ declare class FiguresContainer extends Component<Props$k, SpreadsheetChildEnv> {
     private screenCoordinatesToInternal;
 }
 
-interface Props$j {
+interface Props$h {
     onCellHovered: (position: Partial<Position$1>) => void;
     onCellDoubleClicked: (col: HeaderIndex, row: HeaderIndex) => void;
     onCellClicked: (col: HeaderIndex, row: HeaderIndex, modifiers: {
@@ -5719,7 +5775,7 @@ interface Props$j {
     gridOverlayDimensions: string;
     onFigureDeleted: () => void;
 }
-declare class GridOverlay extends Component<Props$j, SpreadsheetChildEnv> {
+declare class GridOverlay extends Component<Props$h, SpreadsheetChildEnv> {
     static template: string;
     static components: {
         FiguresContainer: typeof FiguresContainer;
@@ -5741,23 +5797,24 @@ declare class GridOverlay extends Component<Props$j, SpreadsheetChildEnv> {
     private getCartesianCoordinates;
 }
 
-interface Props$i {
+interface Props$g {
     hoveredCell: Partial<Position$1>;
     gridRect: Rect;
     onClosePopover: () => void;
     onMouseWheel: (ev: WheelEvent) => void;
 }
-declare class GridPopover extends Component<Props$i, SpreadsheetChildEnv> {
+declare class GridPopover extends Component<Props$g, SpreadsheetChildEnv> {
     static template: string;
     static components: {
         Popover: typeof Popover;
     };
+    zIndex: ComponentsImportance;
     get cellPopover(): PositionedCellPopover | ClosedCellPopover;
 }
 
 declare type ScrollDirection = "horizontal" | "vertical";
 
-interface Props$h {
+interface Props$f {
     width: Pixel;
     height: Pixel;
     direction: ScrollDirection;
@@ -5765,7 +5822,7 @@ interface Props$h {
     offset: Pixel;
     onScroll: (offset: Pixel) => void;
 }
-declare class ScrollBar extends Component<Props$h> {
+declare class ScrollBar extends Component<Props$f> {
     static template: string;
     static defaultProps: {
         width: number;
@@ -5779,10 +5836,10 @@ declare class ScrollBar extends Component<Props$h> {
     onScroll(ev: any): void;
 }
 
-interface Props$g {
+interface Props$e {
     leftOffset: number;
 }
-declare class HorizontalScrollBar extends Component<Props$g, SpreadsheetChildEnv> {
+declare class HorizontalScrollBar extends Component<Props$e, SpreadsheetChildEnv> {
     static components: {
         ScrollBar: typeof ScrollBar;
     };
@@ -5790,8 +5847,8 @@ declare class HorizontalScrollBar extends Component<Props$g, SpreadsheetChildEnv
     static defaultProps: {
         leftOffset: number;
     };
-    get offset(): number;
-    get width(): number;
+    get offset(): Pixel;
+    get width(): Pixel;
     get isDisplayed(): boolean;
     get position(): {
         left: string;
@@ -5802,10 +5859,10 @@ declare class HorizontalScrollBar extends Component<Props$g, SpreadsheetChildEnv
     onScroll(offset: any): void;
 }
 
-interface Props$f {
+interface Props$d {
     topOffset: number;
 }
-declare class VerticalScrollBar extends Component<Props$f, SpreadsheetChildEnv> {
+declare class VerticalScrollBar extends Component<Props$d, SpreadsheetChildEnv> {
     static components: {
         ScrollBar: typeof ScrollBar;
     };
@@ -5813,8 +5870,8 @@ declare class VerticalScrollBar extends Component<Props$f, SpreadsheetChildEnv>
     static defaultProps: {
         topOffset: number;
     };
-    get offset(): number;
-    get height(): number;
+    get offset(): Pixel;
+    get height(): Pixel;
     get isDisplayed(): boolean;
     get position(): {
         top: string;
@@ -5825,39 +5882,6 @@ declare class VerticalScrollBar extends Component<Props$f, SpreadsheetChildEnv>
     onScroll(offset: any): void;
 }
 
-interface Props$e {
-    position: DOMCoordinates;
-    isActive: boolean;
-    onClick: () => void;
-}
-declare class FilterIcon extends Component<Props$e, SpreadsheetEnv> {
-    static style: string;
-    static template: string;
-    get style(): string;
-}
-
-interface Props$d {
-    gridPosition: DOMCoordinates;
-}
-declare class FilterIconsOverlay extends Component<Props$d, SpreadsheetChildEnv> {
-    static style: string;
-    static template: string;
-    static components: {
-        FilterIcon: typeof FilterIcon;
-    };
-    static defaultProps: {
-        gridPosition: {
-            x: number;
-            y: number;
-        };
-    };
-    getVisibleFilterHeaders(): Position$1[];
-    getFilterHeaderPosition(position: Position$1): DOMCoordinates;
-    isFilterActive(position: Position$1): boolean;
-    toggleFilterMenu(position: Position$1): void;
-    private isPositionVisible;
-}
-
 interface Props$c {
 }
 interface ClickableCell {
@@ -5982,7 +6006,7 @@ declare class FunctionDescriptionProvider extends Component<Props$9> {
 
 declare type HtmlContent = {
     value: string;
-    color?: string;
+    color?: Color;
     class?: string;
 };
 interface AutocompleteValue {
@@ -6159,8 +6183,8 @@ declare class TopBar extends Component<Props$6, SpreadsheetChildEnv> {
     undoTool: boolean;
     redoTool: boolean;
     paintFormatTool: boolean;
-    fillColor: string;
-    textColor: string;
+    fillColor: Color;
+    textColor: Color;
     menus: MenuItem[];
     setup(): void;
     get topbarComponents(): TopbarComponent[];
@@ -6179,7 +6203,7 @@ declare class TopBar extends Component<Props$6, SpreadsheetChildEnv> {
     updateCellState(): void;
     getMenuName(menu: MenuItem): string;
     toggleMerge(): void;
-    setColor(target: string, color: string): void;
+    setColor(target: string, color: Color): void;
     setBorder(command: BorderCommand): void;
     setFormat(format: Format, custom: boolean): void;
     openCustomFormatSidePanel(custom: string): void;
@@ -6402,7 +6426,7 @@ declare class Border extends Component<Props$4, SpreadsheetChildEnv> {
 declare type Orientation = "nw" | "ne" | "sw" | "se";
 interface Props$3 {
     zone: Zone;
-    color: string;
+    color: Color;
     orientation: Orientation;
     isResizing: boolean;
     onResizeHighlight: (isLeft: boolean, isRight: boolean) => void;
@@ -6417,7 +6441,7 @@ declare class Corner extends Component<Props$3, SpreadsheetChildEnv> {
 
 interface Props$2 {
     zone: Zone;
-    color: string;
+    color: Color;
 }
 interface HighlightState {
     shiftingMode: "isMoving" | "isResizing" | "none";
@@ -6567,8 +6591,6 @@ declare function createEmptySheet(sheetId: UID, name: string): SheetData;
 declare function createEmptyWorkbookData(sheetName?: string): WorkbookData;
 declare function createEmptyExcelSheet(sheetId: UID, name: string): ExcelSheetData;
 
-declare const DATETIME_FORMAT: RegExp;
-
 /**
  * We export here all entities that needs to be accessed publicly by Odoo.
  *