@odoo/o-spreadsheet 19.5.0-alpha.2 → 19.5.0-alpha.20

package/dist/types/plugins/ui_stateful/sheetview.d.ts

@@ -1,123 +0,0 @@
-import { ViewportCollection } from "../../helpers/viewport_collection";
-import { Command, CommandResult, LocalCommand } from "../../types/commands";
-import { AnchorOffset, Figure, FigureUI } from "../../types/figure";
-import { CellPosition, Dimension, HeaderDimensions, HeaderIndex, Pixel, PixelPosition, UID, Zone } from "../../types/misc";
-import { DOMCoordinates, DOMDimension, EdgeScrollInfo, Rect, SheetDOMScrollInfo, Viewport } from "../../types/rendering";
-import { UIPlugin } from "../ui_plugin";
-/**
- * Viewport plugin.
- *
- * This plugin manages all things related to all viewport states.
- *
- */
-export declare class SheetViewPlugin extends UIPlugin {
-    static getters: readonly ["getColIndex", "getRowIndex", "getActiveMainViewport", "getSheetViewDimension", "getSheetViewDimensionWithHeaders", "getMainViewportRect", "isVisibleInViewport", "getEdgeScrollCol", "getEdgeScrollRow", "getVisibleFigures", "getVisibleRect", "getVisibleRectWithoutHeaders", "getVisibleRectWithZoom", "getVisibleCellPositions", "getColRowOffsetInViewport", "getMainViewportCoordinates", "getActiveSheetScrollInfo", "getSheetViewVisibleCols", "getSheetViewVisibleRows", "getFrozenSheetViewRatio", "isPixelPositionVisible", "getColDimensionsInViewport", "getRowDimensionsInViewport", "getRect", "getFigureUI", "getPositionAnchorOffset", "getGridOffset", "getViewportZoomLevel", "getScrollBarWidth", "getMaximumSheetOffset", "getViewportCollection"];
-    private viewports;
-    private sheetsWithDirtyViewports;
-    private shouldRepositionViewports;
-    allowDispatch(cmd: LocalCommand): CommandResult | CommandResult[];
-    private handleEvent;
-    handle(cmd: Command): void;
-    finalize(): void;
-    private setViewports;
-    private syncPaneDivision;
-    /**
-     * Return the index of a column given an offset x, based on the viewport left
-     * visible cell.
-     * It returns -1 if no column is found.
-     */
-    getColIndex(x: Pixel): HeaderIndex;
-    /**
-     * Return the index of a row given an offset y, based on the viewport top
-     * visible cell.
-     * It returns -1 if no row is found.
-     */
-    getRowIndex(y: Pixel): HeaderIndex;
-    getSheetViewDimensionWithHeaders(): DOMDimension;
-    getSheetViewDimension(): DOMDimension;
-    getGridOffset(): DOMCoordinates;
-    /** type as pane, not viewport but basically pane extends viewport */
-    getActiveMainViewport(): Viewport;
-    /**
-     * Return the DOM scroll info of the active sheet, ie. the offset between the viewport left/top side and
-     * the grid left/top side, corresponding to the scroll of the scrollbars and not snapped to the grid.
-     */
-    getActiveSheetScrollInfo(): SheetDOMScrollInfo;
-    getSheetViewVisibleCols(): HeaderIndex[];
-    getSheetViewVisibleRows(): HeaderIndex[];
-    /**
-     * Get the positions of all the cells that are visible in the viewport, taking merges into account.
-     */
-    getVisibleCellPositions(): CellPosition[];
-    /**
-     * Return the main viewport maximum size relative to the client size.
-     */
-    getMainViewportRect(): Rect;
-    getMaximumSheetOffset(): {
-        maxOffsetX: Pixel;
-        maxOffsetY: Pixel;
-    };
-    getColRowOffsetInViewport(dimension: Dimension, referenceHeaderIndex: HeaderIndex, targetHeaderIndex: HeaderIndex): Pixel;
-    /**
-     * Check if a given position is visible in the viewport.
-     */
-    isVisibleInViewport(cellPosition: CellPosition): boolean;
-    getScrollBarWidth(): Pixel;
-    getEdgeScrollCol(x: number, previousX: number, startingX: number): EdgeScrollInfo;
-    getEdgeScrollRow(y: number, previousY: number, startingY: number): EdgeScrollInfo;
-    /**
-     * Computes the coordinates and size to draw the zone on the canvas
-     */
-    getVisibleRect(zone: Zone): Rect;
-    /**
-     * Computes the coordinates and size to draw the zone on the canvas after it has been zoomed
-     */
-    getVisibleRectWithZoom(zone: Zone): Rect;
-    /**
-     * Computes the coordinates and size to draw the zone without taking the grid offset into account
-     */
-    getVisibleRectWithoutHeaders(zone: Zone): Rect;
-    /**
-     * Computes the actual size and position (:Rect) of the zone on the canvas
-     * regardless of the viewport dimensions.
-     */
-    getRect(zone: Zone): Rect;
-    /**
-     * Computes the actual size and position (:Rect) of the zone on the canvas
-     * regardless of the viewport dimensions.
-     */
-    getRectWithoutHeaders(zone: Zone): Rect;
-    /**
-     * Returns the position of the MainViewport relatively to the start of the grid (without headers)
-     * It corresponds to the summed dimensions of the visible cols/rows (in x/y respectively)
-     * situated before the pane divisions.
-     */
-    getMainViewportCoordinates(): DOMCoordinates;
-    /**
-     * Returns the size, start and end coordinates of a column relative to the left
-     * column of the current viewport
-     */
-    getColDimensionsInViewport(sheetId: UID, col: HeaderIndex): HeaderDimensions;
-    /**
-     * Returns the size, start and end coordinates of a row relative to the top row
-     * of the current viewport
-     */
-    getRowDimensionsInViewport(sheetId: UID, row: HeaderIndex): HeaderDimensions;
-    getViewportZoomLevel(): number;
-    /**
-     * Shift the viewport vertically and move the selection anchor
-     * such that it remains at the same place relative to the
-     * viewport top.
-     */
-    private shiftVertically;
-    getVisibleFigures(): FigureUI[];
-    getFigureUI(sheetId: UID, figure: Figure): FigureUI;
-    getPositionAnchorOffset(position: PixelPosition): AnchorOffset;
-    isPixelPositionVisible(position: PixelPosition): boolean;
-    getFrozenSheetViewRatio(sheetId: UID): {
-        xRatio: number;
-        yRatio: number;
-    };
-    getViewportCollection(): ViewportCollection;
-    private getPaneDivisions;
-}

package/dist/types/types/core_getters.d.ts

@@ -1,75 +0,0 @@
-import { BordersPlugin } from "../plugins/core/borders";
-import { CarouselPlugin } from "../plugins/core/carousel";
-import { CellPlugin } from "../plugins/core/cell";
-import { ChartPlugin } from "../plugins/core/chart";
-import { ConditionalFormatPlugin } from "../plugins/core/conditional_format";
-import { DataValidationPlugin } from "../plugins/core/data_validation";
-import { DefaultPlugin } from "../plugins/core/default";
-import { FigurePlugin } from "../plugins/core/figures";
-import { HeaderGroupingPlugin } from "../plugins/core/header_grouping";
-import { HeaderSizePlugin } from "../plugins/core/header_size";
-import { HeaderVisibilityPlugin } from "../plugins/core/header_visibility";
-import { ImagePlugin } from "../plugins/core/image";
-import { MergePlugin } from "../plugins/core/merge";
-import { NamedRangesPlugin } from "../plugins/core/named_range";
-import { PivotCorePlugin } from "../plugins/core/pivot";
-import { RangeAdapterPlugin } from "../plugins/core/range";
-import { SettingsPlugin } from "../plugins/core/settings";
-import { SheetPlugin } from "../plugins/core/sheet";
-import { TablePlugin } from "../plugins/core/tables";
-/**
- * Union of all getter names of a plugin.
- *
- * e.g. With the following plugin
- * ```ts
- * class MyPlugin {
- *   static getters = [
- *     "getCell",
- *     "getCellValue",
- *   ] as const;
- *   getCell() { ... }
- *   getCellValue() { ... }
- * }
- * ```
- * `type Names = GetterNames<typeof MyPlugin>` is equivalent to
- * `type Names = "getCell" | "getCellValue"`
- *
- * Some technical comments:
- *
- * - Since the getter names are in a static array, the type of the plugin must
- *   be given, not the class itself.
- *
- * - we need to index the getters array with every index:
- *   `Plugin["getters"][0] | Plugin["getters"][1] | Plugin["getters"][2] | ...`
- *   which is equivalent to `Plugin["getters"][0 | 1 | 2 | ...]`.
- *   This can be generalized because the union of all indices `0 | 1 | 2 | 3 | ...`
- *   is actually the type `number`.
- */
-type GetterNames<Plugin extends {
-    getters: readonly string[];
-}> = Plugin["getters"][number];
-/**
- * Extract getter methods from a plugin, based on its `getters` static array.
- * @example
- * class MyPlugin {
- *   static getters = [
- *     "getCell",
- *     "getCellValue",
- *   ] as const;
- *   getCell() { ... }
- *   getCellValue() { ... }
- * }
- * type MyPluginGetters = PluginGetters<typeof MyPlugin>;
- * // MyPluginGetters is equivalent to:
- * // {
- * //   getCell: () => ...,
- * //   getCellValue: () => ...,
- * // }
- */
-export type PluginGetters<Plugin extends {
-    new (...args: unknown[]): any;
-    getters: readonly string[];
-}> = Pick<InstanceType<Plugin>, GetterNames<Plugin>>;
-type RangeAdapterGetters = Pick<RangeAdapterPlugin, GetterNames<typeof RangeAdapterPlugin>>;
-export type CoreGetters = PluginGetters<typeof SheetPlugin> & PluginGetters<typeof HeaderSizePlugin> & PluginGetters<typeof HeaderVisibilityPlugin> & PluginGetters<typeof CellPlugin> & PluginGetters<typeof DefaultPlugin> & PluginGetters<typeof MergePlugin> & PluginGetters<typeof BordersPlugin> & PluginGetters<typeof ChartPlugin> & PluginGetters<typeof ImagePlugin> & PluginGetters<typeof CarouselPlugin> & PluginGetters<typeof FigurePlugin> & RangeAdapterGetters & PluginGetters<typeof ConditionalFormatPlugin> & PluginGetters<typeof TablePlugin> & PluginGetters<typeof SettingsPlugin> & PluginGetters<typeof HeaderGroupingPlugin> & PluginGetters<typeof DataValidationPlugin> & PluginGetters<typeof NamedRangesPlugin> & PluginGetters<typeof PivotCorePlugin>;
-export {};