balala-revogrid 1.0.0

package/dist/types/services/dimension.provider.d.ts

@@ -0,0 +1,71 @@
+import ViewportProvider from './viewport.provider';
+import { DimensionStoreCollection, Trimmed } from "../store/index";
+import type { DimensionCols, DimensionType, MultiDimensionType, ColumnRegular, DimensionSettingsState, ViewPortScrollEvent, ViewSettingSizeProp } from "../types/index";
+export type DimensionConfig = {
+    realSizeChanged(k: MultiDimensionType): void;
+};
+/**
+ * Dimension provider
+ * Stores dimension information and custom sizes
+ *
+ * @dependsOn ViewportProvider
+ */
+export default class DimensionProvider {
+    private viewports;
+    readonly stores: DimensionStoreCollection;
+    private gridTotalWidth;
+    constructor(viewports: ViewportProvider, config: DimensionConfig);
+    /**
+     * 设置表格总宽度（由 revo-grid 组件调用）
+     */
+    setGridTotalWidth(width: number): void;
+    /**
+     * Clear old sizes from dimension and viewports
+     * @param type - dimension type
+     * @param count - count of items
+     */
+    clearSize(t: MultiDimensionType, count: number): void;
+    /**
+     * Apply new custom sizes to dimension and view port
+     * @param type - dimension type
+     * @param sizes - new custom sizes
+     * @param keepOld - keep old sizes merge new with old
+     */
+    setCustomSizes(type: MultiDimensionType, sizes: ViewSettingSizeProp, keepOld?: boolean): void;
+    setItemCount(realCount: number, type: MultiDimensionType): void;
+    /**
+     * Apply trimmed items
+     * @param trimmed - trimmed items
+     * @param type
+     */
+    setTrimmed(trimmed: Trimmed, type: MultiDimensionType): void;
+    /**
+     * Sets dimension data and viewport coordinate
+     * @param itemCount
+     * @param type - dimension type
+     * @param noVirtual - disable virtual data
+     */
+    setData(itemCount: number, type: MultiDimensionType, noVirtual?: boolean): void;
+    /**
+     * Applies new columns to the dimension provider
+     * @param columns - new columns data
+     * @param disableVirtualX - disable virtual data for X axis
+     */
+    applyNewColumns(columns: Record<DimensionCols, ColumnRegular[]>, disableVirtualX: boolean, keepOld?: boolean, version?: number): void;
+    /**
+     * Gets the full size of the grid by summing up the sizes of all dimensions
+     * Goes through all dimensions columnTypes (x) and rowTypes (y) and sums up their sizes
+     */
+    getFullSize(): {
+        x: number;
+        y: number;
+    };
+    setViewPortCoordinate({ type, coordinate, force, }: {
+        coordinate?: number;
+        type: MultiDimensionType;
+        force?: boolean;
+    }): void;
+    getViewPortPos(e: ViewPortScrollEvent): number;
+    setSettings(data: Partial<DimensionSettingsState>, dimensionType: DimensionType): void;
+    updateSizesPositionByNewDataIndexes(type: MultiDimensionType, newItemsOrder: number[], prevItemsOrder?: number[]): void;
+}

package/dist/types/services/local.scroll.service.d.ts

@@ -0,0 +1,36 @@
+import type { DimensionType, ViewPortScrollEvent } from "../types/index";
+interface Config {
+    skipAnimationFrame?: boolean;
+    runScroll(e: ViewPortScrollEvent): void;
+    applyScroll(e: ViewPortScrollEvent): void;
+}
+type Params = {
+    contentSize: number;
+    virtualContentSize?: number;
+    clientSize: number;
+    virtualSize: number;
+    maxSize?: number;
+};
+/**
+ * Based on content size, client size and virtual size
+ * return full size
+ */
+export declare function getContentSize(contentSize: number, clientSize: number, virtualSize?: number): number;
+export default class LocalScrollService {
+    private cfg;
+    private preventArtificialScroll;
+    private previousScroll;
+    private params;
+    constructor(cfg: Config);
+    setParams(params: Params, dimension: DimensionType): void;
+    setScroll(e: ViewPortScrollEvent): Promise<void>;
+    /**
+     * On scroll event started
+     */
+    scroll(coordinate: number, dimension: DimensionType, force?: boolean, delta?: number, outside?: boolean): void;
+    private getParams;
+    private wrapCoordinate;
+    private cancelScroll;
+    private convert;
+}
+export {};

package/dist/types/services/local.scroll.timer.d.ts

@@ -0,0 +1,32 @@
+import type { DimensionType } from "../types/index";
+/**
+ * Apply changes only if mousewheel event happened some time ago (scrollThrottling)
+ */
+export declare class LocalScrollTimer {
+    private scrollThrottling;
+    /**
+     * Last mw event time for trigger scroll function below
+     * If mousewheel function was ignored we still need to trigger render
+     */
+    private mouseWheelScrollTimestamp;
+    private lastKnownScrollCoordinate;
+    constructor(scrollThrottling?: number);
+    setCoordinate(e: {
+        dimension: DimensionType;
+        coordinate: number;
+    }): void;
+    /**
+     * Remember last mw event time
+     */
+    latestScrollUpdate(dimension: DimensionType): void;
+    isReady(type: DimensionType, coordinate: number): boolean;
+    private verifyChange;
+    /**
+     * Check if scroll is ready to accept new value
+     * this is an edge case for scroll events
+     * when we need to apply scroll after throttling
+     */
+    private lastScrollUpdateCallbacks;
+    private clearLastScrollUpdate;
+    throttleLastScrollUpdate(type: DimensionType, coordinate: number, lastScrollUpdate: () => void): void;
+}

package/dist/types/services/selection.store.connector.d.ts

@@ -0,0 +1,74 @@
+import { SelectionStore } from "../store/index";
+import type { MultiDimensionType, DimensionCols, DimensionRows, Cell, EditCellStore, RangeArea } from "../types/index";
+type StoreByDimension = Record<number, SelectionStore>;
+type FocusedStore = {
+    entity: SelectionStore;
+    cell: Cell;
+    position: Cell;
+};
+type StoresMapping<T> = {
+    [xOrY: number]: Partial<T>;
+};
+export declare class SelectionStoreConnector {
+    readonly stores: {
+        [y: number]: {
+            [x: number]: SelectionStore;
+        };
+    };
+    readonly columnStores: StoreByDimension;
+    readonly rowStores: {
+        [y: number]: SelectionStore;
+    };
+    /**
+     * Helpers for data conversion
+     */
+    readonly storesByType: Partial<Record<MultiDimensionType, number>>;
+    readonly storesXToType: StoresMapping<DimensionCols>;
+    readonly storesYToType: StoresMapping<DimensionRows>;
+    get focusedStore(): FocusedStore | null;
+    get edit(): EditCellStore | null | undefined;
+    get focused(): Cell | null | undefined;
+    get selectedRange(): RangeArea | null | undefined;
+    registerColumn(x: number, type: DimensionCols): SelectionStore;
+    registerRow(y: number, type: DimensionRows): SelectionStore;
+    /**
+     * Cross store proxy, based on multiple dimensions
+     */
+    register({ x, y }: Cell): SelectionStore;
+    private destroy;
+    setEditByCell<T extends Cell>(storePos: T, editCell: T): void;
+    /**
+     * Sets the next focus cell before the current one.
+     *
+     * @param focus - The cell to set as the next focus.
+     */
+    beforeNextFocusCell(focus: Cell): void;
+    focusByCell<T extends Cell>(storePos: T, start: T, end: T): void;
+    focus(store: SelectionStore, { focus, end }: {
+        focus: Cell;
+        end: Cell;
+    }): Cell | null;
+    /**
+     * Retrieves the current store pointer based on the active store.
+     * Clears focus from all stores except the active one.
+     */
+    getCurrentStorePointer(store: SelectionStore): Cell | undefined;
+    /**
+     * Retrieves the next store based on the focus cell and current store pointer.
+     * If the next store exists, returns an object with the next store and the item in the new store.
+     * If the next store does not exist, returns null.
+     */
+    getNextStore(focus: Cell, currentStorePointer: Cell, lastCell: Cell): {
+        store: SelectionStore | undefined;
+        item: Partial<Cell> | null;
+    };
+    clearAll(): void;
+    setEdit(val?: string | boolean): void;
+    /**
+     * Select all cells across all stores
+     */
+    selectAll(): void;
+    private getXStores;
+    private getYStores;
+}
+export {};

package/dist/types/services/viewport.provider.d.ts

@@ -0,0 +1,9 @@
+import { type ViewportStoreCollection } from "../store/index";
+import type { MultiDimensionType, ViewportState } from "../types/index";
+export default class ViewportProvider {
+    readonly stores: ViewportStoreCollection;
+    constructor();
+    setViewport(type: MultiDimensionType, data: Partial<ViewportState>, options?: {
+        preserveItems?: boolean;
+    }): void;
+}