@odoo/o-spreadsheet 16.2.0-alpha.3 → 16.2.0-alpha.4

package/dist/{o_spreadsheet.d.ts → o-spreadsheet.d.ts}

@@ -350,11 +350,16 @@ interface SelectionProcessor {
 }
 declare type SelectionStreamProcessor = SelectionProcessor & StatefulStream<SelectionEvent, AnchorZone>;
 
-interface XLSXExportFile {
+declare type XLSXExportFile = XLSXExportImageFile | XLSXExportXMLFile;
+interface XLSXExportXMLFile {
     path: string;
     content: string;
     contentType?: string;
 }
+interface XLSXExportImageFile {
+    path: string;
+    imagePath: string;
+}
 interface XLSXExport {
     name: string;
     files: XLSXExportFile[];
@@ -613,6 +618,25 @@ interface IconSetRule {
 declare type ConditionalFormattingOperatorValues = "BeginsWith" | "Between" | "ContainsText" | "IsEmpty" | "IsNotEmpty" | "EndsWith" | "Equal" | "GreaterThan" | "GreaterThanOrEqual" | "LessThan" | "LessThanOrEqual" | "NotBetween" | "NotContains" | "NotEqual";
 declare type UpDown = "up" | "down";
 
+interface Figure {
+    id: UID;
+    x: Pixel;
+    y: Pixel;
+    width: Pixel;
+    height: Pixel;
+    tag: string;
+}
+interface FigureSize {
+    width: Pixel;
+    height: Pixel;
+}
+declare type ResizeDirection = -1 | 0 | 1;
+
+interface Image {
+    path: string;
+    size: FigureSize;
+}
+
 interface CellData {
     content?: string;
     style?: number;
@@ -686,6 +710,7 @@ interface ExcelSheetData extends Omit<SheetData, "figureTables"> {
         [key: string]: ExcelCellData | undefined;
     };
     charts: FigureData<ExcelChartDefinition>[];
+    images: FigureData<Image>[];
     filterTables: ExcelFilterTableData[];
 }
 interface FilterTableData {
@@ -835,25 +860,6 @@ interface TransportService<T = any> {
     leave: (id: UID) => void;
 }
 
-interface Figure {
-    id: UID;
-    x: Pixel;
-    y: Pixel;
-    width: Pixel;
-    height: Pixel;
-    tag: string;
-}
-interface FigureSize {
-    width: Pixel;
-    height: Pixel;
-}
-declare type ResizeDirection = -1 | 0 | 1;
-
-interface Image {
-    path: string;
-    size: FigureSize;
-}
-
 declare type FilePath = string;
 /**
  * FileStore manage the transfer of file with the server.
@@ -1351,12 +1357,6 @@ declare class EditionPlugin extends UIPlugin {
     private getTokensInSelection;
 }
 
-declare type Rect = {
-    x: Pixel;
-    y: Pixel;
-    width: Pixel;
-    height: Pixel;
-};
 /**
  * Coordinate in pixels
  */
@@ -1368,6 +1368,7 @@ interface DOMDimension {
     width: Pixel;
     height: Pixel;
 }
+declare type Rect = DOMCoordinates & DOMDimension;
 /**
  * The viewport is the visible area of a sheet.
  * Column and row headers are not included in the viewport.
@@ -2216,8 +2217,8 @@ interface UnboundedZone {
     hasHeader?: boolean;
 }
 interface ZoneDimension {
-    height: HeaderIndex;
-    width: HeaderIndex;
+    numberOfRows: HeaderIndex;
+    numberOfCols: HeaderIndex;
 }
 declare type Align = "left" | "right" | "center" | undefined;
 declare type VerticalAlign = "top" | "middle" | "bottom" | undefined;
@@ -3420,6 +3421,7 @@ declare class ImagePlugin extends CorePlugin<ImageState> implements ImageState {
     private addFigure;
     import(data: WorkbookData): void;
     export(data: WorkbookData): void;
+    exportForExcel(data: ExcelWorkbookData): void;
     private getAllImages;
 }
 
@@ -3818,7 +3820,7 @@ declare class InternalViewport {
         x: Pixel;
         y: Pixel;
     });
-    getMaxSize(): ZoneDimension;
+    getMaxSize(): DOMDimension;
     /**
      * Return the index of a column given an offset x, based on the pane left
      * visible cell.
@@ -3946,8 +3948,8 @@ declare class SheetViewPlugin extends UIPlugin {
      * It returns -1 if no row is found.
      */
     getRowIndex(y: Pixel): HeaderIndex;
-    getSheetViewDimensionWithHeaders(): ZoneDimension;
-    getSheetViewDimension(): ZoneDimension;
+    getSheetViewDimensionWithHeaders(): DOMDimension;
+    getSheetViewDimension(): DOMDimension;
     /** type as pane, not viewport but basically pane extends viewport */
     getActiveMainViewport(): Viewport;
     /**
@@ -5148,26 +5150,6 @@ interface ChartSidePanel {
     design: new (...args: any) => Component;
 }
 
-/**
- * This registry is intended to map a type of figure (tag) to a class of
- * component, that will be used in the UI to represent the figure.
- *
- * The most important type of figure will be the Chart
- */
-interface FigureContent {
-    Component: any;
-    SidePanelComponent?: string;
-    keepRatio?: boolean;
-    minFigSize?: number;
-    borderWidth?: number;
-}
-
-interface SidePanelContent {
-    title: string | ((env: SpreadsheetChildEnv) => string);
-    Body: any;
-    Footer?: any;
-}
-
 /**
  * An ActionMenuItem represent a menu item for the menus of the topbar.
  * and the context menu in the grid.
@@ -5235,6 +5217,27 @@ declare class MenuItemRegistry extends Registry<MenuItemSpec> {
     getMenuItems(): MenuItem[];
 }
 
+/**
+ * This registry is intended to map a type of figure (tag) to a class of
+ * component, that will be used in the UI to represent the figure.
+ *
+ * The most important type of figure will be the Chart
+ */
+interface FigureContent {
+    Component: any;
+    menuBuilder: (figureId: UID, onFigureDeleted: () => void, env: SpreadsheetChildEnv) => MenuItem[];
+    SidePanelComponent?: string;
+    keepRatio?: boolean;
+    minFigSize?: number;
+    borderWidth?: number;
+}
+
+interface SidePanelContent {
+    title: string | ((env: SpreadsheetChildEnv) => string);
+    Body: any;
+    Footer?: any;
+}
+
 /**
  * An AutofillRule is used to generate what to do when we need to autofill
  * a cell. (In a AutofillGenerator, see plugins/autofill.ts)
@@ -5277,7 +5280,7 @@ declare class ScorecardChart extends Component<Props$s, SpreadsheetChildEnv> {
     get baselineArrowDirection(): BaselineArrowDirection;
     get backgroundColor(): string;
     get primaryFontColor(): string;
-    get secondaryFontColor(): "#757575" | "#bbbbbb";
+    get secondaryFontColor(): "#525252" | "#C8C8C8";
     get figure(): Figure;
     get chartStyle(): string;
     get chartContentStyle(): string;
@@ -5298,86 +5301,17 @@ 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;
-}
-
-interface Props$q {
     figure: Figure;
     onFigureDeleted: () => void;
 }
-declare class ChartFigure extends Component<Props$q, SpreadsheetChildEnv> {
+declare class ChartFigure extends Component<Props$r, SpreadsheetChildEnv> {
     static template: string;
-    static components: {
-        Menu: typeof Menu;
-    };
-    private menuState;
-    private chartContainerRef;
-    private menuButtonRef;
-    private menuButtonRect;
-    private position;
-    private getMenuItemRegistry;
+    static components: {};
     get chartType(): ChartType;
-    onContextMenu(ev: MouseEvent): void;
-    showMenu(): void;
-    private openContextMenu;
     get chartComponent(): new (...args: any) => Component;
 }
 
-interface Props$p {
+interface Props$q {
     isVisible: boolean;
     position: Position;
 }
@@ -5389,7 +5323,7 @@ interface State$3 {
     position: Position;
     handler: boolean;
 }
-declare class Autofill extends Component<Props$p, SpreadsheetChildEnv> {
+declare class Autofill extends Component<Props$q, SpreadsheetChildEnv> {
     static template: string;
     state: State$3;
     get style(): string;
@@ -5463,13 +5397,13 @@ declare class Ripple extends Component<RippleProps, SpreadsheetChildEnv> {
     getRippleEffectProps(id: number): RippleEffectProps;
 }
 
-interface Props$o {
+interface Props$p {
     sheetId: string;
     openContextMenu: (registry: MenuItemRegistry, ev: MouseEvent) => void;
     style?: string;
     onMouseDown: (ev: MouseEvent) => void;
 }
-declare class BottomBarSheet extends Component<Props$o, SpreadsheetChildEnv> {
+declare class BottomBarSheet extends Component<Props$p, SpreadsheetChildEnv> {
     static template: string;
     static components: {
         Ripple: typeof Ripple;
@@ -5503,11 +5437,11 @@ declare class BottomBarSheet extends Component<Props$o, SpreadsheetChildEnv> {
     get sheetName(): string;
 }
 
-interface Props$n {
+interface Props$o {
     openContextMenu: (x: number, y: number, registry: MenuItemRegistry) => void;
     closeContextMenu: () => void;
 }
-declare class BottomBarStatistic extends Component<Props$n, SpreadsheetChildEnv> {
+declare class BottomBarStatistic extends Component<Props$o, SpreadsheetChildEnv> {
     static template: string;
     static components: {
         Ripple: typeof Ripple;
@@ -5520,6 +5454,64 @@ declare class BottomBarStatistic extends Component<Props$n, 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;
@@ -5588,14 +5580,19 @@ interface Props$l {
 }
 declare class FigureComponent extends Component<Props$l, SpreadsheetChildEnv> {
     static template: string;
-    static components: {};
+    static components: {
+        Menu: typeof Menu;
+    };
     static defaultProps: {
         onFigureDeleted: () => void;
         onMouseDown: () => void;
         onClickAnchor: () => void;
     };
-    private borderWidth;
+    private menuState;
     private figureRef;
+    private menuButtonRef;
+    private menuButtonRect;
+    private borderWidth;
     get isSelected(): boolean;
     get figureRegistry(): Registry<FigureContent>;
     private getBorderWidth;
@@ -5606,6 +5603,9 @@ declare class FigureComponent extends Component<Props$l, SpreadsheetChildEnv> {
     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 ContainerType = "topLeft" | "topRight" | "bottomLeft" | "bottomRight" | "dnd";
@@ -6250,7 +6250,7 @@ interface Props$5 {
     focus: ComposerFocusType;
     onComposerUnmounted: () => void;
     onComposerContentFocused: (selection: ComposerSelection) => void;
-    gridDims: ZoneDimension;
+    gridDims: DOMDimension;
 }
 /**
  * This component is a composer which positions itself on the grid at the anchor cell.