@juzhenfe/page-model 3.21.14 → 3.22.2

package/dist/{components → src/components}/table/constructor.d.ts

@@ -1,341 +1,349 @@
-import IManager from '../../utils/manager';
+import { default as IManager } from '../../utils/manager';
 import { ComponentPublicInstance } from 'vue';
-import PageModelManager from '../page-model/constructor';
+import { default as PageModelManager } from '../page-model/constructor';
 import { ElTable } from 'element-plus';
-export default class TableManager extends IManager {
-    size: PageModel.Size;
-    propsConfig?: PageModel.Table;
-    tableRef: typeof ElTable;
-    loadingData: boolean;
-    tableData: any[];
-    /**
-     * 渲染数据
-     */
-    renderTableData: any[];
-    /**
-     * 表格编辑开启状态对象
-     */
-    editableOpen: import("vue").Reactive<Map<string, boolean>>;
-    /**
-     * 表格保存源数据
-     */
-    editableData: Map<string, string>;
-    total: number;
-    pagination: PageModel.Pagination;
-    currentPage: number;
-    pageSize: number;
-    pageSizeUserSet: number;
-    tableProps: PageModel.TableProps;
-    tableEvents: PageModel.TableEvents;
-    selection: any[];
-    isDataUpdating: boolean;
-    currentPageSelection: any[];
-    sortOrders: string[];
-    sortParams: AnyObject;
-    constructor(config?: PageModel.Table);
-    /**
-     * 是否已经初始化列筛选参数
-     */
-    private isInitColumnParams;
-    /**
-     * 获取本地的表格的列筛选参数
-     */
-    initColumnParams(): boolean;
-    /**
-     * 是否已经初始化列筛选参数
-     */
-    private isInitColumnSortParams;
-    /**
-     * 获取本地的表格的列筛选参数
-     */
-    initColumnSortParams(): boolean;
-    /**
-     * 是否当前列字段工具可见
-     */
-    isColumnToolsVisible: boolean;
-    /**
-     * * 切换列字段工具的可见
-     */
-    updateColumnToolsVisible(visible: boolean): void;
-    get table(): PageModel.Table<AnyObject, TableManager>;
-    /**
-     * config配置的rowKey
-     * 用户自己配置的rowKey
-     */
-    get setedRowKey(): string;
-    /**
-     * 内置的rowKey
-     */
-    randomRowKey: string;
-    /**
-     * 使用的rowKey
-     * 可能是用户配置的id，也可能是生成的随机串
-     */
-    get rowKey(): string;
-    init(): void;
-    updateTableRef(tableRef: typeof ElTable): void;
-    updateLoading(loading: boolean): void;
-    /**
-     * 获取pageIndex的key
-     */
-    get pageIndexKey(): string;
-    /**
-     * 获取pageSize的key
-     */
-    get pageSizeKey(): string;
-    /**
-     * 获取表格的搜索参数
-     * @returns
-     */
-    getReqParams(): any;
-    /**
-     * 列筛选参数
-     */
-    columnParamsList: PageModel.TableColumnParamsItem[];
-    /**
-     * 返回对象，每列是否配置了筛选
-     * key是否配置参数
-     */
-    get columnParamsKey(): {};
-    /**
-     * 是否开启列筛选
-     */
-    get isColumnSearch(): boolean;
-    /**
-     * 获取每列的参数
-     */
-    getColumnParams(): any;
-    /**
-     * 列排序参数
-     */
-    columnSortParamsList: PageModel.TableColumnSortParamsItem[];
-    /**
-     * 是否开启排序功能
-     */
-    get isColumnSort(): boolean;
-    /**
-     * 获取每列的排序参数
-     */
-    getColumnSortParams(): any;
-    refreshPage(): void;
-    onConfigUpdated(): void;
-    updateByConfig(): void;
-    totalEls: any[];
-    updateTotalEls(): void;
-    /**
-     * 主动更新选中数据
-     * @param selection
-     */
-    updateSelection(selection: any[]): void;
-    clearSelection(): void;
-    /**
-     * 根据ElTable返回的数据进行表格选中更新
-     * @param selection
-     * @returns
-     */
-    _updateSelectionByElTable(selection: any[]): boolean;
-    updateProps(): void;
-    updateEvents(): void;
-    /**
-     * 获取有效的选中数据
-     * @param selections
-     * @returns
-     */
-    getValidSelections(selections: any[]): any[];
-    patchTableSelectable(): void;
-    patchTableRadio(): void;
-    /**
-     * 设置上下文菜单
-     */
-    patchTableContextMenu(): boolean;
-    patchTableSortable(): void;
-    /**
-     * 构建单元格的唯一key
-     * 列标记 - 行标记
-     * @param columnKey 列的key
-     * @param rowIndex 行数据 或者 行key
-     * @returns
-     */
-    composeTableCellKey(columnKey: string, rowKey: string): string;
-    /**
-     * 构建单元格的唯一key
-     * 列标记 - 行标记
-     * @param columnKey table列
-     * @param rowIndex 行数据
-     * @returns
-     */
-    composeTableCellKeyByData(column: any, row: any): string;
-    /**
-     * 当前聚焦的单元格
-     */
-    focusCellKey: string;
-    /**
-     * 当前聚焦的列
-     */
-    focusEl: PageModel.TableBaseItem;
-    /**
-     * 移除当前单元格聚焦
-     */
-    blurCell(): void;
-    /**
-     * document点击事件
-     */
-    documentClickHandler: (e: MouseEvent) => void;
-    /**
-     * 移除单元格外点击事件
-     */
-    removeCellOutClickEvent(): void;
-    /**
-     * 单元格外点击，清理选中
-     */
-    bindCellOutClickEvent(): void;
-    /**
-     * 当前单元格聚焦
-     */
-    focusCell(cell?: HTMLElement): void;
-    /**
-     * 设置表格可编辑
-     * @returns
-     */
-    patchTableEditable(): boolean;
-    /**
-     * 设置单元格可编辑
-     * @param mapKey
-     */
-    setCellEditing(cellKey: string): void;
-    /**
-     * 关闭单元格的编辑状态
-     * @param cellKey
-     */
-    closeCellEditing(cellKey: string): void;
-    /**
-     * 保存当前行的原数据
-     * @param key
-     * @param data
-     */
-    saveRowData(cellKey: string, data: any): void;
-    /**
-     * 清空当前行的原数据
-     */
-    clearRowData(cellKey: string): void;
-    /**
-     * 更新当前行的更新loading
-     */
-    setRowUpdateLoading(cellKey: string, loading: boolean): void;
-    /**
-     * 还原原来的数据
-     */
-    restoreCellValue(row: any, cellKey: string, restoreKey: string): void;
-    /**
-     * 重置编辑的情况
-     */
-    resetTableEdit(): void;
-    /**
-     * 更新分页器
-     */
-    updatePagination(): void;
-    /**
-     * 识别数据标识，如果没有携带标志，自动生成
-     */
-    setTableDataRowKey(data: any[]): any[];
-    /**
-     * 更新表格数据源
-     * @param data
-     */
-    updateData(data: any[]): void;
-    setTableSelection(): void;
-    /**
-     * 删除多选中的某项
-     * @param selectItem
-     */
-    delSelectionItem(selectItem: any): void;
-    updateTotal(total: number): void;
-    updateContext(context: ComponentPublicInstance): void;
-    register(manager: PageModelManager): void;
-    radioData: AnyObject | null;
-    setRadioData(radioData: AnyObject | null): void;
-    /**
-     * 强制同步单选的数据
-     */
-    _syncRadioData(): void;
-    loadExcelDependence(): Promise<any>;
-    getTableCellText(el: any, rowData: AnyObject): any;
-    /**
-     * 获取excelData的表头
-     */
-    getExcelDataHeader(columns: any[]): {
-        exportEls: any[];
-        excelData: any[][];
-        cols: any[];
-    };
-    /**
-     * exceldata插入数据
-     */
-    insertExcelData(excelData: any[][], exportEls: any[], insertData: any[]): void;
-    /**
-     * 将树形数据扁平化
-     * 合并到主数据中
-     */
-    patchChildrenData(data: any[], childrenKey: string): any;
-    /**
-     * 导出数据到excel
-     * @param opts
-     * @returns
-     */
-    exportDataToExcel(opts: PageModel.TableDataExportModel): Promise<boolean>;
-    /**
-     * 基于excel数据生成excel文件进行下载
-     */
-    exportDataToExcelByExcelData(filename: string, excelData: any[][], cols: any[], mergeOpt?: {
-        exportData: any[];
-        exportEls: any[];
-    }): boolean;
-    /**
-     * 当前表格元素
-     */
-    currentFilterTableEls: PageModel.TableBaseItem[];
-    /**
-     * 更新当前表格元素
-     */
-    updateCurrentFilterTableEls(els: PageModel.TableBaseItem[]): void;
-    /**
-     * 当前渲染的列元素
-     */
-    currentRenderTableEls: PageModel.TableBaseItem[];
-    /**
-     * 更新当前渲染的列元素
-     */
-    updateCurrentRenderTableEls(els: PageModel.TableBaseItem[]): void;
-    /**
-     * 当前列元素更新
-     */
-    onCurrentRenderTableElsChange(): void;
-    /**
-     * 当前隐藏的字段数量
-     */
-    get hiddeenFieldCount(): number;
-    /**
-     * 私人配置key
-     */
-    saveContentScope: string;
-    /**
-     * 私人配置
-     */
-    saveContent: any[];
-    /**
-     * 更新私人配置
-     */
-    updateSaveContent(content: any[], scope: string): void;
-    onUnmounted(): void;
-    scrollTop: number;
-    updateScrollTop(top: any): void;
-    scrollLeft: number;
-    updateScrollLeft(left: any): void;
-    /**
-     * 组件暴露的方法
-     */
-    exposeActions: {
-        [key: string]: (...rest: any[]) => unknown;
-    };
-    destroy(): void;
-}
+
+export default class TableManager extends IManager {
+    size: PageModel.Size;
+    propsConfig?: PageModel.Table;
+    tableRef: typeof ElTable;
+    loadingData: boolean;
+    tableData: any[];
+    /**
+     * 渲染数据
+     */
+    renderTableData: any[];
+    /**
+     * 表格编辑开启状态对象
+     */
+    editableOpen: import('vue').Reactive<Map<string, boolean>>;
+    /**
+     * 表格保存源数据
+     */
+    editableData: Map<string, string>;
+    total: number;
+    pagination: PageModel.Pagination;
+    currentPage: number;
+    pageSize: number;
+    pageSizeUserSet: number;
+    tableProps: PageModel.TableProps;
+    tableEvents: PageModel.TableEvents;
+    selection: any[];
+    isDataUpdating: boolean;
+    currentPageSelection: any[];
+    sortOrders: string[];
+    sortParams: AnyObject;
+    constructor(config?: PageModel.Table);
+    /**
+     * 是否已经初始化列筛选参数
+     */
+    private isInitColumnParams;
+    /**
+     * 获取本地的表格的列筛选参数
+     */
+    initColumnParams(): boolean;
+    /**
+     * 是否已经初始化列筛选参数
+     */
+    private isInitColumnSortParams;
+    /**
+     * 获取本地的表格的列筛选参数
+     */
+    initColumnSortParams(): boolean;
+    /**
+     * 是否当前列字段工具可见
+     */
+    isColumnToolsVisible: boolean;
+    /**
+     * * 切换列字段工具的可见
+     */
+    updateColumnToolsVisible(visible: boolean): void;
+    get table(): PageModel.Table<AnyObject, TableManager>;
+    /**
+     * 是否虚拟表格模式
+     */
+    get isVirtual(): boolean;
+    /**
+     * config配置的rowKey
+     * 用户自己配置的rowKey
+     */
+    get setedRowKey(): string;
+    /**
+     * 内置的rowKey
+     */
+    randomRowKey: string;
+    /**
+     * 使用的rowKey
+     * 可能是用户配置的id，也可能是生成的随机串
+     */
+    get rowKey(): string;
+    init(): void;
+    updateTableRef(tableRef: typeof ElTable): void;
+    updateLoading(loading: boolean): void;
+    /**
+     * 获取pageIndex的key
+     */
+    get pageIndexKey(): string;
+    /**
+     * 获取pageSize的key
+     */
+    get pageSizeKey(): string;
+    /**
+     * 获取表格的搜索参数
+     * @returns
+     */
+    getReqParams(): any;
+    /**
+     * 列筛选参数
+     */
+    columnParamsList: PageModel.TableColumnParamsItem[];
+    /**
+     * 返回对象，每列是否配置了筛选
+     * key是否配置参数
+     */
+    get columnParamsKey(): {};
+    /**
+     * 是否开启列筛选
+     */
+    get isColumnSearch(): boolean;
+    /**
+     * 获取每列的参数
+     */
+    getColumnParams(): any;
+    /**
+     * 列排序参数
+     */
+    columnSortParamsList: PageModel.TableColumnSortParamsItem[];
+    /**
+     * 是否开启排序功能
+     */
+    get isColumnSort(): boolean;
+    /**
+     * 获取每列的排序参数
+     */
+    getColumnSortParams(): any;
+    refreshPage(): void;
+    onConfigUpdated(): void;
+    updateByConfig(): void;
+    totalEls: any[];
+    updateTotalEls(): void;
+    /**
+     * 主动更新选中数据
+     * @param selection
+     */
+    updateSelection(selection: any[]): void;
+    clearSelection(): void;
+    /**
+     * 根据ElTable返回的数据进行表格选中更新
+     * @param selection
+     * @returns
+     */
+    _updateSelectionByElTable(selection: any[]): boolean;
+    updateProps(): void;
+    updateEvents(): void;
+    /**
+     * 获取有效的选中数据
+     * @param selections
+     * @returns
+     */
+    getValidSelections(selections: any[]): any[];
+    patchTableSelectable(): void;
+    patchTableRadio(): void;
+    /**
+     * 设置上下文菜单
+     */
+    patchTableContextMenu(): boolean;
+    patchTableSortable(): void;
+    /**
+     * 构建单元格的唯一key
+     * 列标记 - 行标记
+     * @param columnKey 列的key
+     * @param rowIndex 行数据 或者 行key
+     * @returns
+     */
+    composeTableCellKey(columnKey: string, rowKey: string): string;
+    /**
+     * 构建单元格的唯一key
+     * 列标记 - 行标记
+     * @param columnKey table列
+     * @param rowIndex 行数据
+     * @returns
+     */
+    composeTableCellKeyByData(column: any, row: any): string;
+    /**
+     * 当前聚焦的单元格
+     */
+    focusCellKey: string;
+    /**
+     * 当前聚焦的列
+     */
+    focusEl: PageModel.TableBaseItem;
+    /**
+     * 移除当前单元格聚焦
+     */
+    blurCell(): void;
+    /**
+     * document点击事件
+     */
+    documentClickHandler: (e: MouseEvent) => void;
+    /**
+     * 移除单元格外点击事件
+     */
+    removeCellOutClickEvent(): void;
+    /**
+     * 单元格外点击，清理选中
+     */
+    bindCellOutClickEvent(): void;
+    /**
+     * 当前单元格聚焦
+     */
+    focusCell(cell?: HTMLElement): void;
+    /**
+     * 设置表格可编辑
+     * @returns
+     */
+    patchTableEditable(): boolean;
+    /**
+     * 设置单元格可编辑
+     * @param mapKey
+     */
+    setCellEditing(cellKey: string): void;
+    /**
+     * 关闭单元格的编辑状态
+     * @param cellKey
+     */
+    closeCellEditing(cellKey: string): void;
+    /**
+     * 保存当前行的原数据
+     * @param key
+     * @param data
+     */
+    saveRowData(cellKey: string, data: any): void;
+    /**
+     * 清空当前行的原数据
+     */
+    clearRowData(cellKey: string): void;
+    /**
+     * 更新当前行的更新loading
+     */
+    setRowUpdateLoading(cellKey: string, loading: boolean): void;
+    /**
+     * 还原原来的数据
+     */
+    restoreCellValue(row: any, cellKey: string, restoreKey: string): void;
+    /**
+     * 重置编辑的情况
+     */
+    resetTableEdit(): void;
+    /**
+     * 更新分页器
+     */
+    updatePagination(): void;
+    /**
+     * 识别数据标识，如果没有携带标志，自动生成
+     */
+    setTableDataRowKey(data: any[]): any[];
+    /**
+     * 更新表格数据源
+     * @param data
+     */
+    updateData(data: any[]): void;
+    /**
+     * 设置表格的选中状态
+     */
+    setTableSelection(): void;
+    /**
+     * 删除多选中的某项
+     * @param selectItem
+     */
+    delSelectionItem(selectItem: any): void;
+    updateTotal(total: number): void;
+    updateContext(context: ComponentPublicInstance): void;
+    register(manager: PageModelManager): void;
+    radioData: AnyObject | null;
+    setRadioData(radioData: AnyObject | null): void;
+    /**
+     * 强制同步单选的数据
+     */
+    _syncRadioData(): void;
+    loadExcelDependence(): Promise<boolean | HTMLScriptElement>;
+    getTableCellText(el: any, rowData: AnyObject): any;
+    /**
+     * 获取excelData的表头
+     */
+    getExcelDataHeader(columns: any[]): {
+        exportEls: any[];
+        excelData: any[][];
+        cols: any[];
+    };
+    /**
+     * exceldata插入数据
+     */
+    insertExcelData(excelData: any[][], exportEls: any[], insertData: any[]): void;
+    /**
+     * 将树形数据扁平化
+     * 合并到主数据中
+     */
+    patchChildrenData(data: any[], childrenKey: string): any;
+    /**
+     * 导出数据到excel
+     * @param opts
+     * @returns
+     */
+    exportDataToExcel(opts: PageModel.TableDataExportModel): Promise<boolean>;
+    /**
+     * 基于excel数据生成excel文件进行下载
+     */
+    exportDataToExcelByExcelData(filename: string, excelData: any[][], cols: any[], mergeOpt?: {
+        exportData: any[];
+        exportEls: any[];
+    }): boolean;
+    /**
+     * 当前表格元素
+     */
+    currentFilterTableEls: PageModel.TableBaseItem[];
+    /**
+     * 更新当前表格元素
+     */
+    updateCurrentFilterTableEls(els: PageModel.TableBaseItem[]): void;
+    /**
+     * 当前渲染的列元素
+     */
+    currentRenderTableEls: PageModel.TableBaseItem[];
+    /**
+     * 更新当前渲染的列元素
+     */
+    updateCurrentRenderTableEls(els: PageModel.TableBaseItem[]): void;
+    /**
+     * 当前列元素更新
+     */
+    onCurrentRenderTableElsChange(): void;
+    /**
+     * 当前隐藏的字段数量
+     */
+    get hiddeenFieldCount(): number;
+    /**
+     * 私人配置key
+     */
+    saveContentScope: string;
+    /**
+     * 私人配置
+     */
+    saveContent: any[];
+    /**
+     * 更新私人配置
+     */
+    updateSaveContent(content: any[], scope: string): void;
+    onUnmounted(): void;
+    scrollTop: number;
+    updateScrollTop(top: any): void;
+    scrollLeft: number;
+    updateScrollLeft(left: any): void;
+    /**
+     * 组件暴露的方法
+     */
+    exposeActions: {
+        [key: string]: (...rest: any[]) => unknown;
+    };
+    destroy(): void;
+}