@scvzerng/element-ui-ag-grid-vue2 0.0.8

package/dist/types/GridDataCache.d.ts

@@ -0,0 +1,52 @@
+import { GridApi } from 'ag-grid-community';
+import { RowIdMapper } from './index';
+import { ActualRow } from './model/row/ActualRow';
+import { GridRow } from './model/row/GridRow';
+import { EditableRow } from './model/row/EditableRow';
+/**
+ * 表格数据源
+ */
+export declare class GridDataCache<T> {
+    /**
+     * 原始数据行
+     * @private
+     */
+    private rows;
+    /**
+     * 第几页
+     */
+    pageNum: number;
+    /**
+     * 每页数量
+     */
+    pageSize: number;
+    /**
+     * 数据是否已经全部加载完毕
+     */
+    isFinished: boolean;
+    /**
+     * 草稿数据 用于存储进入编辑模式时尚未提交的数据
+     * 比如编辑中的变更数据和新插入的临时数据
+     * @private
+     */
+    private readonly idMapper;
+    gridApi: GridApi<GridRow<T>>;
+    constructor(idMapper: RowIdMapper<T>);
+    createRow(data: T): ActualRow<T>;
+    setRows(rows: (ActualRow<T> | EditableRow<T>)[]): this;
+    replace(row: ActualRow<T> | EditableRow<T>): void;
+    remove(row: (ActualRow<T> | EditableRow<T>)[]): void;
+    getRows(): (ActualRow<T> | EditableRow<T>)[];
+    appendRows(rows: ActualRow<T>[]): void;
+    /**
+     * 插入数据
+     * @param rows
+     * @param index
+     */
+    insertRows(rows: (ActualRow<T> | EditableRow<T>)[], index?: number): void;
+    /**
+     * 删除数据
+     * @param rows
+     */
+    deleteRows(rows: GridRow<T>[] | string[]): void;
+}

package/dist/types/GridDataSource.d.ts

@@ -0,0 +1,39 @@
+import type { GridApi, IDatasource, IGetRowsParams, SortDirection, SortModelItem } from 'ag-grid-community';
+import type { GridDataCache } from './GridDataCache';
+import { ProjectionRow } from './model/row/ProjectionRow';
+export type DataGetter<T> = T[] | ((params: PageFetchParams) => Promise<T[]>) | ((params: PageFetchParams) => T[]);
+export type PageFetchParams = {
+    pageNum: number;
+    pageSize: number;
+} & FetchParams;
+export type FetchParams = {
+    startRow: number;
+    endRow: number;
+    sorts: SortModelItem[];
+    params: any;
+};
+export type SortModel = {
+    field: string;
+    direction: SortDirection;
+};
+export declare class GridDataSource<T> implements IDatasource {
+    /**
+     * 是否正在加载中
+     * @private
+     */
+    private loading;
+    private readonly dataGetter;
+    private cache;
+    private _api?;
+    private loadingDelay;
+    constructor(dataGetter: DataGetter<T>, cache: GridDataCache<T>);
+    set api(value: GridApi<ProjectionRow<T>>);
+    get api(): GridApi<ProjectionRow<T>>;
+    destroy(): void;
+    loadData(): void;
+    private getSorts;
+    getRows(params: IGetRowsParams & {
+        pageNum: number;
+        pageSize: number;
+    }): void;
+}

package/dist/types/GridEmptyDataOverlay.vue.d.ts

@@ -0,0 +1,2 @@
+declare const _default: import("vue").DefineComponent<{}, {}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, Readonly<import("vue").ExtractPropTypes<{}>>, {}>;
+export default _default;

package/dist/types/GridLoadingOverlay.vue.d.ts

@@ -0,0 +1,2 @@
+declare const _default: import("vue").DefineComponent<{}, {}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, Readonly<import("vue").ExtractPropTypes<{}>>, {}>;
+export default _default;

package/dist/types/PageGetRowsParams.d.ts

@@ -0,0 +1,32 @@
+import type { GridDataCache } from './GridDataCache';
+import type { IGetRowsParams, SortModelItem } from 'ag-grid-community';
+export declare class ServerGetRowsParamsRequest<T> implements IGetRowsParams {
+    context: any;
+    /**
+     * 结束行
+     */
+    endRow: number;
+    /**
+     * 过滤条件
+     */
+    filterModel: any;
+    /**
+     * 排序条件
+     */
+    sortModel: SortModelItem[];
+    /**
+     * 起始行
+     */
+    startRow: number;
+    /**
+     * 数据源
+     */
+    dataCache: GridDataCache<T>;
+    pageNum: number;
+    pageSize: number;
+    constructor(pageNum: number, pageSize: number, dataCache: GridDataCache<T>, sortModel?: SortModelItem[]);
+    static from<T>(pageNum: number, pageSize: number | undefined, dataCache: GridDataCache<T>): ServerGetRowsParamsRequest<T>;
+    static nextPage<T>(dataCache: GridDataCache<T>): ServerGetRowsParamsRequest<T>;
+    failCallback(): void;
+    successCallback(rowsThisBlock: T[]): void;
+}

package/dist/types/ag-grid/options/ag-grid-menu-options.d.ts

@@ -0,0 +1,9 @@
+import type { GridOptions } from 'ag-grid-community';
+import { RestrictedAgGridOptions } from './ag-grid-options';
+export type AgGridMenuOptions = Pick<GridOptions, 'onCellContextMenu' | 'suppressContextMenu' | 'getContextMenuItems' | 'onColumnHeaderContextMenu' | 'onContextMenuVisibleChanged' | 'preventDefaultOnContextMenu' | 'allowContextMenuWithControlKey'>;
+/**
+ * 适配器函数，用于将GridOptions转换为AgGridMenuOptions
+ * @param options 原始网格选项配置
+ * @returns 返回适配后的AgGrid菜单选项配置
+ */
+export declare const adapterGridMenuOptions: <T>(options: RestrictedAgGridOptions<T>) => AgGridMenuOptions;

package/dist/types/ag-grid/options/ag-grid-options-clean.d.ts

@@ -0,0 +1,2 @@
+import { GridOptions } from 'ag-grid-community';
+export declare const CLEAN_AG_GRID_OPTIONS: GridOptions;

package/dist/types/ag-grid/options/ag-grid-options.d.ts

@@ -0,0 +1,11 @@
+import type { GridOptions, GetContextMenuItemsParams } from 'ag-grid-community';
+import { ContextMenuItem } from '../../index';
+import { RowSelectionOptions } from 'ag-grid-community/dist/types/src/entities/gridOptions';
+/**
+ * 受限的ag-grid-options 用于暴露对外的ag-grid 选项 因为使用的社区版 需要把部分企业版的选项去掉
+ * 同时对于部分自定义模块替换商业模块的功能支持不是很足和实现不一致也需要覆盖和修改其类型
+ */
+export type RestrictedAgGridOptions<TData> = Pick<GridOptions, 'onSelectionChanged' | 'getRowStyle' | 'getRowClass' | 'rowClass' | 'rowStyle' | 'rowClassRules' | 'onCellMouseOver' | 'onRowSelected' | 'onCellMouseOut'> & {
+    getContextMenuItems?: (e: GetContextMenuItemsParams) => ContextMenuItem<TData>[];
+    rowSelection?: RowSelectionOptions<TData>;
+};