@odoo/o-spreadsheet 16.0.5 → 16.0.6

package/dist/o-spreadsheet.d.ts

@@ -324,10 +324,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 {
@@ -541,9 +541,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";
@@ -570,13 +570,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: {
@@ -1677,12 +1677,12 @@ interface CreateChartCommand extends SheetDependentCommand {
     type: "CREATE_CHART";
     id: UID;
     position?: {
-        x: number;
-        y: number;
+        x: Pixel;
+        y: Pixel;
     };
     size?: {
-        width: number;
-        height: number;
+        width: Pixel;
+        height: Pixel;
     };
     definition: ChartDefinition;
 }
@@ -1787,7 +1787,7 @@ interface StopSelectionCommand {
  */
 interface SetColorCommand {
     type: "SET_HIGHLIGHT_COLOR";
-    color: string;
+    color: Color;
 }
 interface EvaluateCellsCommand {
     type: "EVALUATE_CELLS";
@@ -2209,7 +2209,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;
@@ -2270,8 +2270,8 @@ interface Style {
     underline?: boolean;
     align?: Align;
     wrapping?: Wrapping;
-    fillColor?: string;
-    textColor?: string;
+    fillColor?: Color;
+    textColor?: Color;
     fontSize?: number;
 }
 interface UpdateCellData {
@@ -2350,7 +2350,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 */
@@ -3303,7 +3303,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;
 }
@@ -4097,7 +4097,7 @@ declare class GridSelectionPlugin extends UIPlugin {
 interface RangeInputValue {
     id: UID;
     xc: string;
-    color: string;
+    color: Color;
 }
 /**
  * Selection input Plugin
@@ -4196,7 +4196,7 @@ declare class SelectionInputsManagerPlugin extends UIPlugin {
 }
 
 interface ClientToDisplay extends Required<Client> {
-    color: string;
+    color: Color;
 }
 declare class SelectionMultiUserPlugin extends UIPlugin {
     static getters: readonly ["getClientsToDisplay"];
@@ -4227,8 +4227,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: {
@@ -4241,7 +4241,14 @@ declare class InternalViewport {
         x: Pixel;
         y: Pixel;
     });
-    getMaxSize(): ZoneDimension;
+    /** 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(): {
+        width: Pixel;
+        height: Pixel;
+    };
     /**
      * Return the index of a column given an offset x, based on the pane left
      * visible cell.
@@ -4386,8 +4393,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;
@@ -4819,7 +4825,7 @@ interface Props$y {
 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
@@ -4897,7 +4903,7 @@ interface ColorPickerProps {
 }
 declare class ColorPicker extends Component<ColorPickerProps, SpreadsheetChildEnv> {
     static template: string;
-    COLORS: string[];
+    COLORS: Color[];
     private state;
     get colorPickerStyle(): string;
     onColorClick(color: Color): void;
@@ -4910,6 +4916,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$w {
@@ -4926,7 +4933,7 @@ declare class LineBarPieDesignPanel extends Component<Props$w, 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;
 }
@@ -4962,7 +4969,9 @@ declare class GaugeChartDesignPanel extends Component<Props$u, SpreadsheetChildE
     };
     private state;
     get designErrorMessages(): string[];
-    updateBackgroundColor(color: string): void;
+    onClick(ev: MouseEvent): void;
+    setup(): void;
+    updateBackgroundColor(color: Color): void;
     updateTitle(ev: any): void;
     isRangeMinInvalid(): boolean;
     isRangeMaxInvalid(): boolean;
@@ -4970,7 +4979,7 @@ declare class GaugeChartDesignPanel extends Component<Props$u, 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;
@@ -5020,10 +5029,12 @@ declare class ScorecardChartDesignPanel extends Component<Props$s, SpreadsheetCh
         ColorPicker: typeof ColorPicker;
     };
     private state;
+    onClick(ev: MouseEvent): void;
+    setup(): void;
     updateTitle(ev: any): void;
     updateBaselineDescr(ev: any): void;
     openColorPicker(colorPickerId: ColorPickerId): void;
-    setColor(color: string, colorPickerId: ColorPickerId): void;
+    setColor(color: Color, colorPickerId: ColorPickerId): void;
 }
 
 interface ChartSidePanel {
@@ -5079,7 +5090,7 @@ interface MenuItem {
     children?: menuChildren;
     separator?: boolean;
     icon?: string;
-    textColor?: string;
+    textColor?: Color;
 }
 declare type FullMenuItem = Required<MenuItem>;
 declare type MenuItemsBuilder = (env: SpreadsheetChildEnv) => FullMenuItem[];
@@ -5147,8 +5158,8 @@ declare class ScorecardChart extends Component<Props$q, 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;
@@ -5169,6 +5180,22 @@ declare class ScorecardChart extends Component<Props$q, SpreadsheetChildEnv> {
     private getWidestElement;
 }
 
+declare const DATETIME_FORMAT: RegExp;
+declare enum ComponentsImportance {
+    Grid = 0,
+    Highlight = 5,
+    Figure = 10,
+    ScrollBar = 15,
+    GridPopover = 19,
+    GridComposer = 20,
+    Dropdown = 21,
+    ColorPicker = 25,
+    IconPicker = 25,
+    TopBarComposer = 30,
+    Popover = 35,
+    ChartAnchor = 1000
+}
+
 interface Props$p {
     /**
      * Coordinates are expressed relative to the "body" element.
@@ -5188,6 +5215,7 @@ interface Props$p {
      */
     flipVerticalOffset: Pixel;
     onMouseWheel: (ev: WheelEvent) => void;
+    zIndex: Number;
 }
 declare class Popover extends Component<Props$p, SpreadsheetChildEnv> {
     static template: string;
@@ -5197,6 +5225,7 @@ declare class Popover extends Component<Props$p, SpreadsheetChildEnv> {
         verticalOffset: number;
         marginTop: number;
         onMouseWheel: () => void;
+        zIndex: ComponentsImportance;
     };
     private spreadsheetPosition;
     get style(): string;
@@ -5322,7 +5351,7 @@ declare class Autofill extends Component<Props$m, SpreadsheetChildEnv> {
 interface ClientTagProps {
     active: boolean;
     name: string;
-    color: string;
+    color: Color;
     col: HeaderIndex;
     row: HeaderIndex;
     viewport: Viewport;
@@ -5423,7 +5452,7 @@ declare class FunctionDescriptionProvider extends Component<Props$k> {
 
 declare type HtmlContent = {
     value: string;
-    color?: string;
+    color?: Color;
     class?: string;
 };
 interface Props$j {
@@ -5735,6 +5764,7 @@ declare class GridPopover extends Component<Props$c, SpreadsheetChildEnv> {
     static components: {
         Popover: typeof Popover;
     };
+    zIndex: ComponentsImportance;
     get cellPopover(): PositionedCellPopover | ClosedCellPopover;
 }
 
@@ -5865,7 +5895,7 @@ declare class Border extends Component<Props$b, SpreadsheetChildEnv> {
 declare type Orientation = "nw" | "ne" | "sw" | "se";
 interface Props$a {
     zone: Zone;
-    color: string;
+    color: Color;
     orientation: Orientation;
     isResizing: boolean;
     onResizeHighlight: (isLeft: boolean, isRight: boolean) => void;
@@ -5880,7 +5910,7 @@ declare class Corner extends Component<Props$a, SpreadsheetChildEnv> {
 
 interface Props$9 {
     zone: Zone;
-    color: string;
+    color: Color;
 }
 interface HighlightState {
     shiftingMode: "isMoving" | "isResizing" | "none";
@@ -5935,8 +5965,8 @@ declare class HorizontalScrollBar extends Component<Props$7, SpreadsheetChildEnv
             left: number;
         };
     };
-    get offset(): number;
-    get width(): number;
+    get offset(): Pixel;
+    get width(): Pixel;
     get isDisplayed(): boolean;
     get position(): {
         left: string;
@@ -5962,8 +5992,8 @@ declare class VerticalScrollBar extends Component<Props$6, SpreadsheetChildEnv>
             top: number;
         };
     };
-    get offset(): number;
-    get height(): number;
+    get offset(): Pixel;
+    get height(): Pixel;
     get isDisplayed(): boolean;
     get position(): {
         top: string;
@@ -6099,7 +6129,7 @@ declare abstract class AbstractCell<T extends CellEvaluation = CellEvaluation> i
     isLink(): this is LinkCell$1;
     isEmpty(): boolean;
     get evaluated(): T;
-    get formattedValue(): string;
+    get formattedValue(): FormattedValue;
     get composerContent(): string;
     get defaultAlign(): "center" | "left" | "right";
     /**
@@ -6287,8 +6317,8 @@ declare class TopBar extends Component<Props, SpreadsheetChildEnv> {
     undoTool: boolean;
     redoTool: boolean;
     paintFormatTool: boolean;
-    fillColor: string;
-    textColor: string;
+    fillColor: Color;
+    textColor: Color;
     menus: FullMenuItem[];
     composerStyle: string;
     setup(): void;
@@ -6304,7 +6334,7 @@ declare class TopBar extends Component<Props, SpreadsheetChildEnv> {
     updateCellState(): void;
     getMenuName(menu: FullMenuItem): string;
     toggleMerge(): void;
-    setColor(target: string, color: string): void;
+    setColor(target: string, color: Color): void;
     setBorder(command: BorderCommand): void;
     setFormat(ev: MouseEvent): void;
     openCustomFormatSidePanel(custom: string): void;
@@ -6377,8 +6407,6 @@ declare class Spreadsheet extends Component<SpreadsheetProps, SpreadsheetChildEn
     get gridHeight(): Pixel;
 }
 
-declare const DATETIME_FORMAT: RegExp;
-
 /**
  * We export here all entities that needs to be accessed publicly by Odoo.
  *