@odoo/o-spreadsheet 16.1.6 → 16.1.7

package/dist/o-spreadsheet.d.ts

@@ -290,10 +290,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 {
@@ -521,9 +521,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";
@@ -550,13 +550,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: {
@@ -1741,8 +1741,8 @@ interface CreateChartCommand extends SheetDependentCommand {
     type: "CREATE_CHART";
     id: UID;
     position?: {
-        x: number;
-        y: number;
+        x: Pixel;
+        y: Pixel;
     };
     size?: FigureSize;
     definition: ChartDefinition;
@@ -1756,8 +1756,8 @@ interface CreateImageOverCommand extends SheetDependentCommand {
     type: "CREATE_IMAGE";
     figureId: UID;
     position: {
-        x: number;
-        y: number;
+        x: Pixel;
+        y: Pixel;
     };
     size: FigureSize;
     definition: Image;
@@ -1861,7 +1861,7 @@ interface StopSelectionCommand {
  */
 interface SetColorCommand {
     type: "SET_HIGHLIGHT_COLOR";
-    color: string;
+    color: Color;
 }
 interface EvaluateCellsCommand {
     type: "EVALUATE_CELLS";
@@ -2286,7 +2286,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;
@@ -2350,8 +2350,8 @@ interface Style {
     align?: Align;
     wrapping?: Wrapping;
     verticalAlign?: VerticalAlign;
-    fillColor?: string;
-    textColor?: string;
+    fillColor?: Color;
+    textColor?: Color;
     fontSize?: number;
 }
 interface UpdateCellData {
@@ -2430,7 +2430,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 */
@@ -3411,7 +3411,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;
 }
@@ -3913,8 +3913,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: {
@@ -3927,7 +3927,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.
@@ -4072,8 +4079,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;
@@ -4367,7 +4373,7 @@ declare class RendererPlugin extends UIPlugin {
 interface RangeInputValue {
     id: UID;
     xc: string;
-    color: string;
+    color: Color;
 }
 /**
  * Selection input Plugin
@@ -4465,7 +4471,7 @@ declare class SelectionInputsManagerPlugin extends UIPlugin {
 }
 
 interface ClientToDisplay extends Required<Client> {
-    color: string;
+    color: Color;
 }
 declare class SelectionMultiUserPlugin extends UIPlugin {
     static getters: readonly ["getClientsToDisplay"];
@@ -4971,7 +4977,7 @@ interface Props$x {
 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
@@ -5055,7 +5061,7 @@ declare class ColorPicker extends Component<ColorPickerProps, SpreadsheetChildEn
     static defaultProps: {
         currentColor: string;
     };
-    COLORS: string[];
+    COLORS: Color[];
     private state;
     get colorPickerStyle(): string;
     onColorClick(color: Color): void;
@@ -5068,6 +5074,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$v {
@@ -5084,7 +5091,7 @@ declare class LineBarPieDesignPanel extends Component<Props$v, 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;
 }
@@ -5120,7 +5127,9 @@ declare class GaugeChartDesignPanel extends Component<Props$t, 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;
@@ -5128,7 +5137,7 @@ declare class GaugeChartDesignPanel extends Component<Props$t, 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;
@@ -5179,10 +5188,12 @@ declare class ScorecardChartDesignPanel extends Component<Props$r, 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 {
@@ -5241,7 +5252,7 @@ interface MenuItem {
     children?: menuChildren;
     separator?: boolean;
     icon?: string;
-    textColor?: string;
+    textColor?: Color;
 }
 declare type FullMenuItem = Required<MenuItem>;
 declare type MenuItemsBuilder = (env: SpreadsheetChildEnv) => FullMenuItem[];
@@ -5309,8 +5320,8 @@ declare class ScorecardChart extends Component<Props$p, 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;
@@ -5331,6 +5342,22 @@ declare class ScorecardChart extends Component<Props$p, 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 PopoverProps {
     /**
      * Rectangle around which the popover is displayed.
@@ -5346,6 +5373,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;
@@ -5355,6 +5384,7 @@ declare class Popover extends Component<PopoverProps, SpreadsheetChildEnv> {
         onMouseWheel: () => void;
         onPopoverMoved: () => void;
         onPopoverHidden: () => void;
+        zIndex: ComponentsImportance;
     };
     private popoverRef;
     private currentPosition;
@@ -5362,6 +5392,7 @@ declare class Popover extends Component<PopoverProps, SpreadsheetChildEnv> {
     private spreadsheetRect;
     private containerRect;
     setup(): void;
+    get popoverStyle(): string;
 }
 
 interface Props$o {
@@ -5468,7 +5499,7 @@ declare class Autofill extends Component<Props$m, SpreadsheetChildEnv> {
 interface ClientTagProps {
     active: boolean;
     name: string;
-    color: string;
+    color: Color;
     col: HeaderIndex;
     row: HeaderIndex;
 }
@@ -5544,7 +5575,7 @@ declare class FunctionDescriptionProvider extends Component<Props$k> {
 
 declare type HtmlContent = {
     value: string;
-    color?: string;
+    color?: Color;
     class?: string;
 };
 interface AutocompleteValue {
@@ -5856,6 +5887,7 @@ declare class GridPopover extends Component<Props$c, SpreadsheetChildEnv> {
     static components: {
         Popover: typeof Popover;
     };
+    zIndex: ComponentsImportance;
     get cellPopover(): PositionedCellPopover | ClosedCellPopover;
 }
 
@@ -5986,7 +6018,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;
@@ -6001,7 +6033,7 @@ declare class Corner extends Component<Props$a, SpreadsheetChildEnv> {
 
 interface Props$9 {
     zone: Zone;
-    color: string;
+    color: Color;
 }
 interface HighlightState {
     shiftingMode: "isMoving" | "isResizing" | "none";
@@ -6052,8 +6084,8 @@ declare class HorizontalScrollBar extends Component<Props$7, SpreadsheetChildEnv
     static defaultProps: {
         leftOffset: number;
     };
-    get offset(): number;
-    get width(): number;
+    get offset(): Pixel;
+    get width(): Pixel;
     get isDisplayed(): boolean;
     get position(): {
         left: string;
@@ -6075,8 +6107,8 @@ declare class VerticalScrollBar extends Component<Props$6, SpreadsheetChildEnv>
     static defaultProps: {
         topOffset: number;
     };
-    get offset(): number;
-    get height(): number;
+    get offset(): Pixel;
+    get height(): Pixel;
     get isDisplayed(): boolean;
     get position(): {
         top: string;
@@ -6227,8 +6259,8 @@ declare class TopBar extends Component<Props$2, SpreadsheetChildEnv> {
     undoTool: boolean;
     redoTool: boolean;
     paintFormatTool: boolean;
-    fillColor: string;
-    textColor: string;
+    fillColor: Color;
+    textColor: Color;
     menus: FullMenuItem[];
     composerStyle: string;
     setup(): void;
@@ -6246,7 +6278,7 @@ declare class TopBar extends Component<Props$2, 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(format: Format, custom: boolean): void;
     openCustomFormatSidePanel(custom: string): void;
@@ -6457,8 +6489,6 @@ declare function createEmptyExcelSheet(sheetId: UID, name: string): ExcelSheetDa
 
 declare function getMenuChildren(node: FullMenuItem, env: SpreadsheetChildEnv): FullMenuItem[];
 
-declare const DATETIME_FORMAT: RegExp;
-
 /**
  * We export here all entities that needs to be accessed publicly by Odoo.
  *