@odoo/o-spreadsheet 16.3.0-alpha.0 → 16.3.0-alpha.2

package/dist/o-spreadsheet.d.ts

@@ -2304,6 +2304,10 @@ interface Position$1 {
     col: HeaderIndex;
     row: HeaderIndex;
 }
+interface PixelPosition {
+    x: Pixel;
+    y: Pixel;
+}
 interface Merge extends Zone {
     id: number;
     topLeft: Position$1;
@@ -2868,6 +2872,7 @@ declare class RangeAdapter implements CommandHandler<CoreCommand> {
      * Get a Xc string that represent a part of a range
      */
     private getRangePartString;
+    private getInvalidRange;
 }
 
 interface CorePluginConfig {
@@ -3918,7 +3923,7 @@ declare 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"];
+    static getters: readonly ["getColIndex", "getRowIndex", "getActiveMainViewport", "getSheetViewDimension", "getSheetViewDimensionWithHeaders", "getMainViewportRect", "isVisibleInViewport", "getEdgeScrollCol", "getEdgeScrollRow", "getVisibleFigures", "getVisibleRect", "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
@@ -4018,6 +4023,7 @@ declare class SheetViewPlugin extends UIPlugin {
      */
     private shiftVertically;
     getVisibleFigures(): Figure[];
+    isPositionVisible(position: PixelPosition): boolean;
     getFrozenSheetViewRatio(sheetId: UID): {
         xRatio: number;
         yRatio: number;
@@ -5301,17 +5307,114 @@ declare class ScorecardChart extends Component<Props$s, SpreadsheetChildEnv> {
 }
 
 interface Props$r {
+    position: DOMCoordinates;
+    menuItems: MenuItem[];
+    depth: number;
+    maxHeight?: Pixel;
+    onClose: () => void;
+    onMenuClicked?: (ev: CustomEvent) => void;
+    menuId?: UID;
+}
+interface MenuState {
+    isOpen: boolean;
+    parentMenu?: MenuItem;
+    position: null | DOMCoordinates;
+    scrollOffset?: Pixel;
+    menuItems: MenuItem[];
+}
+declare class Menu extends Component<Props$r, SpreadsheetChildEnv> {
+    static template: string;
+    static components: {
+        Menu: typeof Menu;
+        Popover: typeof Popover;
+    };
+    static defaultProps: {
+        depth: number;
+    };
+    private subMenu;
+    private menuRef;
+    private position;
+    setup(): void;
+    get visibleMenuItems(): MenuItem[];
+    get subMenuPosition(): DOMCoordinates;
+    get menuHeight(): Pixel;
+    get popoverProps(): PopoverProps;
+    getColor(menu: MenuItem): string | undefined;
+    activateMenu(menu: MenuItem): Promise<void>;
+    private close;
+    /**
+     * Return the number of pixels between the top of the menu
+     * and the menu item at a given index.
+     */
+    private subMenuVerticalPosition;
+    private onExternalClick;
+    private getMenuItemsHeight;
+    getName(menu: MenuItem): string;
+    isRoot(menu: MenuItem): boolean;
+    isEnabled(menu: MenuItem): boolean;
+    onScroll(ev: any): void;
+    /**
+     * If the given menu is not disabled, open it's submenu at the
+     * correct position according to available surrounding space.
+     */
+    openSubMenu(menu: MenuItem, menuIndex: number): void;
+    isParentMenu(subMenu: MenuState, menuItem: MenuItem): boolean;
+    closeSubMenu(): void;
+    onClickMenu(menu: MenuItem, menuIndex: number): void;
+    onMouseOver(menu: MenuItem, position: Pixel): void;
+}
+
+declare type ResizeAnchor = "top left" | "top" | "top right" | "right" | "bottom right" | "bottom" | "bottom left" | "left";
+interface Props$q {
+    figure: Figure;
+    style: string;
+    onFigureDeleted: () => void;
+    onMouseDown: (ev: MouseEvent) => void;
+    onClickAnchor(dirX: ResizeDirection, dirY: ResizeDirection, ev: MouseEvent): void;
+}
+declare class FigureComponent extends Component<Props$q, SpreadsheetChildEnv> {
+    static template: string;
+    static components: {
+        Menu: typeof Menu;
+    };
+    static defaultProps: {
+        onFigureDeleted: () => void;
+        onMouseDown: () => void;
+        onClickAnchor: () => void;
+    };
+    private menuState;
+    private figureRef;
+    private menuButtonRef;
+    private menuButtonRect;
+    private borderWidth;
+    get isSelected(): boolean;
+    get figureRegistry(): Registry<FigureContent>;
+    private getBorderWidth;
+    get borderStyle(): string;
+    get wrapperStyle(): string;
+    getResizerPosition(resizer: ResizeAnchor): string;
+    setup(): void;
+    clickAnchor(dirX: ResizeDirection, dirY: ResizeDirection, ev: MouseEvent): void;
+    onMouseDown(ev: MouseEvent): void;
+    onKeyDown(ev: KeyboardEvent): void;
+    onContextMenu(ev: MouseEvent): void;
+    showMenu(): void;
+    private openContextMenu;
+}
+
+interface Props$p {
     figure: Figure;
     onFigureDeleted: () => void;
 }
-declare class ChartFigure extends Component<Props$r, SpreadsheetChildEnv> {
+declare class ChartFigure extends Component<Props$p, SpreadsheetChildEnv> {
     static template: string;
     static components: {};
+    onDoubleClick(): void;
     get chartType(): ChartType;
     get chartComponent(): new (...args: any) => Component;
 }
 
-interface Props$q {
+interface Props$o {
     isVisible: boolean;
     position: Position;
 }
@@ -5323,7 +5426,7 @@ interface State$3 {
     position: Position;
     handler: boolean;
 }
-declare class Autofill extends Component<Props$q, SpreadsheetChildEnv> {
+declare class Autofill extends Component<Props$o, SpreadsheetChildEnv> {
     static template: string;
     state: State$3;
     get style(): string;
@@ -5397,13 +5500,13 @@ declare class Ripple extends Component<RippleProps, SpreadsheetChildEnv> {
     getRippleEffectProps(id: number): RippleEffectProps;
 }
 
-interface Props$p {
+interface Props$n {
     sheetId: string;
     openContextMenu: (registry: MenuItemRegistry, ev: MouseEvent) => void;
     style?: string;
     onMouseDown: (ev: MouseEvent) => void;
 }
-declare class BottomBarSheet extends Component<Props$p, SpreadsheetChildEnv> {
+declare class BottomBarSheet extends Component<Props$n, SpreadsheetChildEnv> {
     static template: string;
     static components: {
         Ripple: typeof Ripple;
@@ -5437,11 +5540,11 @@ declare class BottomBarSheet extends Component<Props$p, SpreadsheetChildEnv> {
     get sheetName(): string;
 }
 
-interface Props$o {
+interface Props$m {
     openContextMenu: (x: number, y: number, registry: MenuItemRegistry) => void;
     closeContextMenu: () => void;
 }
-declare class BottomBarStatistic extends Component<Props$o, SpreadsheetChildEnv> {
+declare class BottomBarStatistic extends Component<Props$m, SpreadsheetChildEnv> {
     static template: string;
     static components: {
         Ripple: typeof Ripple;
@@ -5454,64 +5557,6 @@ declare class BottomBarStatistic extends Component<Props$o, SpreadsheetChildEnv>
     private getComposedFnName;
 }
 
-interface Props$n {
-    position: DOMCoordinates;
-    menuItems: MenuItem[];
-    depth: number;
-    maxHeight?: Pixel;
-    onClose: () => void;
-    onMenuClicked?: (ev: CustomEvent) => void;
-    menuId?: UID;
-}
-interface MenuState {
-    isOpen: boolean;
-    parentMenu?: MenuItem;
-    position: null | DOMCoordinates;
-    scrollOffset?: Pixel;
-    menuItems: MenuItem[];
-}
-declare class Menu extends Component<Props$n, SpreadsheetChildEnv> {
-    static template: string;
-    static components: {
-        Menu: typeof Menu;
-        Popover: typeof Popover;
-    };
-    static defaultProps: {
-        depth: number;
-    };
-    private subMenu;
-    private menuRef;
-    private position;
-    setup(): void;
-    get visibleMenuItems(): MenuItem[];
-    get subMenuPosition(): DOMCoordinates;
-    get menuHeight(): Pixel;
-    get popoverProps(): PopoverProps;
-    getColor(menu: MenuItem): string | undefined;
-    activateMenu(menu: MenuItem): Promise<void>;
-    private close;
-    /**
-     * Return the number of pixels between the top of the menu
-     * and the menu item at a given index.
-     */
-    private subMenuVerticalPosition;
-    private onExternalClick;
-    private getMenuItemsHeight;
-    getName(menu: MenuItem): string;
-    isRoot(menu: MenuItem): boolean;
-    isEnabled(menu: MenuItem): boolean;
-    onScroll(ev: any): void;
-    /**
-     * If the given menu is not disabled, open it's submenu at the
-     * correct position according to available surrounding space.
-     */
-    openSubMenu(menu: MenuItem, menuIndex: number): void;
-    isParentMenu(subMenu: MenuState, menuItem: MenuItem): boolean;
-    closeSubMenu(): void;
-    onClickMenu(menu: MenuItem, menuIndex: number): void;
-    onMouseOver(menu: MenuItem, position: Pixel): void;
-}
-
 interface BottomBarSheetItem {
     id: UID;
     name: string;
@@ -5521,13 +5566,13 @@ interface SheetState {
     isDnd: boolean;
     sheetDndPositions: Record<UID, number> | undefined;
 }
-interface Props$m {
+interface Props$l {
     onClick: () => void;
 }
 interface BottomBarMenuState extends MenuState {
     menuId: UID | undefined;
 }
-declare class BottomBar extends Component<Props$m, SpreadsheetChildEnv> {
+declare class BottomBar extends Component<Props$l, SpreadsheetChildEnv> {
     static template: string;
     static components: {
         Menu: typeof Menu;
@@ -5570,52 +5615,16 @@ declare class BottomBar extends Component<Props$m, SpreadsheetChildEnv> {
     get sheetListMaxScroll(): number;
 }
 
-declare type ResizeAnchor = "top left" | "top" | "top right" | "right" | "bottom right" | "bottom" | "bottom left" | "left";
-interface Props$l {
-    figure: Figure;
-    style: string;
-    onFigureDeleted: () => void;
-    onMouseDown: (ev: MouseEvent) => void;
-    onClickAnchor(dirX: ResizeDirection, dirY: ResizeDirection, ev: MouseEvent): void;
-}
-declare class FigureComponent extends Component<Props$l, SpreadsheetChildEnv> {
-    static template: string;
-    static components: {
-        Menu: typeof Menu;
-    };
-    static defaultProps: {
-        onFigureDeleted: () => void;
-        onMouseDown: () => void;
-        onClickAnchor: () => void;
-    };
-    private menuState;
-    private figureRef;
-    private menuButtonRef;
-    private menuButtonRect;
-    private borderWidth;
-    get isSelected(): boolean;
-    get figureRegistry(): Registry<FigureContent>;
-    private getBorderWidth;
-    get borderStyle(): string;
-    get wrapperStyle(): string;
-    getResizerPosition(resizer: ResizeAnchor): string;
-    setup(): void;
-    clickAnchor(dirX: ResizeDirection, dirY: ResizeDirection, ev: MouseEvent): void;
-    onMouseDown(ev: MouseEvent): void;
-    onKeyDown(ev: KeyboardEvent): void;
-    onContextMenu(ev: MouseEvent): void;
-    showMenu(): void;
-    private openContextMenu;
+declare type HFigureAxisType = "top" | "bottom" | "vCenter";
+declare type VFigureAxisType = "right" | "left" | "hCenter";
+interface SnapLine<T extends HFigureAxisType | VFigureAxisType> {
+    matchedFigIds: UID[];
+    snapOffset: number;
+    snappedAxisType: T;
+    position: Pixel;
 }
 
 declare type ContainerType = "topLeft" | "topRight" | "bottomLeft" | "bottomRight" | "dnd";
-interface DndState {
-    figId: string | undefined;
-    x: Pixel;
-    y: Pixel;
-    width: Pixel;
-    height: Pixel;
-}
 interface Props$k {
     onFigureDeleted: () => void;
 }
@@ -5625,6 +5634,16 @@ interface Container {
     style: string;
     inverseViewportStyle: string;
 }
+interface Snap<T extends HFigureAxisType | VFigureAxisType> {
+    line: SnapLine<T>;
+    lineStyle: string;
+    containerStyle: string;
+}
+interface DndState {
+    draggedFigure?: Figure;
+    horizontalSnap?: Snap<HFigureAxisType>;
+    verticalSnap?: Snap<VFigureAxisType>;
+}
 /**
  * Each figure ⭐ is positioned inside a container `div` placed and sized
  * according to the split pane the figure is part of, or a separate container for the figure
@@ -5695,14 +5714,26 @@ declare class FiguresContainer extends Component<Props$k, SpreadsheetChildEnv> {
     private getVisibleFigures;
     get containers(): Container[];
     private getContainerStyle;
+    private rectToCss;
+    private getContainerRect;
     private getInverseViewportPositionStyle;
     private getFigureContainer;
     startDraggingFigure(figure: Figure, ev: MouseEvent): void;
+    /**
+     * Initialize the resize of a figure with mouse movements
+     *
+     * @param dirX X direction of the resize. -1 : resize from the left border of the figure, 0 : no resize in X, 1 :
+     * resize from the right border of the figure
+     * @param dirY Y direction of the resize. -1 : resize from the top border of the figure, 0 : no resize in Y, 1 :
+     * resize from the bottom border of the figure
+     * @param ev Mouse Event
+     */
     startResize(figure: Figure, dirX: ResizeDirection, dirY: ResizeDirection, ev: MouseEvent): void;
+    private getOtherFigures;
     private getDndFigure;
     getFigureStyle(figure: Figure): string;
-    private internalToScreenCoordinates;
-    private screenCoordinatesToInternal;
+    private getSnap;
+    private getSnapLineStyle;
 }
 
 interface Props$j {
@@ -6689,6 +6720,7 @@ declare const components: {
     GaugeChartDesignPanel: typeof GaugeChartDesignPanel;
     ScorecardChartConfigPanel: typeof ScorecardChartConfigPanel;
     ScorecardChartDesignPanel: typeof ScorecardChartDesignPanel;
+    FigureComponent: typeof FigureComponent;
 };
 declare function addFunction(functionName: string, functionDescription: FunctionDescription): void;