hs-admin-ui 15.1.6 → 15.1.8

package/dist/types/components/business/bcTable/utils/type.d.ts

@@ -1,463 +0,0 @@
-import { Ref, ComputedRef } from 'vue';
-import { VxeTableInstance } from 'vxe-table';
-import { IFormData, ICustomData, IAuthData } from '../../../../types';
-
-interface GET_SELECT {
-    data: ICustomData.Data[];
-    isSelected: boolean;
-    uniqId: string;
-}
-export interface TableIndex {
-    /** 当前表格聚焦行索引 */
-    rowIndex: number;
-    /** 当前表格聚焦列索引 */
-    columnIndex: number;
-    /** 当前聚焦表格配置id */
-    unidId: string;
-}
-/** 权限数据 */
-export interface AUTH_DATA_MAP {
-    /** 菜单版本 */
-    menu_version?: number;
-    /** 字典权限 */
-    dict_functions: Record<'code' | 'name' | 'json_data', string>[];
-    /** 数据权限 */
-    data_functions: Record<'code' | 'name' | 'json_data', string>[];
-    /** 字段权限 */
-    field_functions: {
-        table: IAuthData.IAuth;
-        form: IAuthData.IAuth;
-    };
-}
-export interface FORM_TABLE {
-    data: {
-        table: ICustomData.FormTable;
-        form: IFormData.Form;
-    };
-    auth: AUTH_DATA_MAP;
-}
-export interface BcBoxApi {
-    /** 刷新重置 */
-    refreshData: () => Promise<void>;
-    /** 获取报表表格基础配置数据 */
-    getReportBaseConfig?: () => void;
-    /** 获取权限数据 */
-    getAuthData: () => AUTH_DATA_MAP;
-    /** 设置下拉数据
-     * @param field 字段名
-     * @param list 下拉数据
-     */
-    setOptions: (field: string, list: ICustomData.Data[]) => void;
-    /** 获取下拉数据
-     * @param field 字段名,当传值为 '-1' 时返回所有下拉数据字段值
-     */
-    getOptions: <T extends string>(field: T) => T extends '-1' ? ICustomData.Data : ICustomData.Data[] | undefined;
-    /**
-     * 判断是否首次加载执行过， 默认false,未执行过
-     * 所有初始化不进行加载的逻辑都通过这个进行判断
-     */
-    isInitLoad: Ref<boolean>;
-    setInitLoad: Function;
-    showLoading: Function;
-    hideLoading: Function;
-    emitAttr: Function;
-    resetReady: (p: 'query' | 'table') => void;
-}
-export interface BcTableApi {
-    /** 查询方法 */
-    search: (table_id?: string, query?: ICustomData.Data) => Promise<void>;
-    /** 重置方法
-     * @param noSearch boolean时：是否只重置不查询数据， 默认是false重置后直接查询数据
-     * @param noSearch Function时：重置完查询数据后执行的回调函数，再进行查询操作
-     */
-    reset: (noSearch?: boolean | Function) => Promise<void>;
-    /** vxtable表格实例方法 */
-    getApi: (table_id?: string) => VxeTableInstance;
-    /** 获取当前实例的配置 id */
-    getConfigId: () => string;
-    /** 获取当前表格配置的id,
-     * @param index 索引位置， 默认为0, 当传值为 -1 时，返回所有表格id
-     */
-    getTab: <T extends number>(index?: T) => T extends -1 ? string[] : string;
-    /** 设置当前表格激活的标签页展示,
-     * @param index 索引位置， 默认为0,
-     */
-    setTab: (index?: number) => void;
-    /** 设置表格查询按钮显示隐藏
-     * @param field 按钮字段名
-     * @param isShow 是否隐藏,默认为true隐藏
-     */
-    hideBtn: (field: string | string[], isShow?: boolean) => void;
-    /** 设置表格查询按钮是否禁用
-     * @param field 按钮字段名
-     * @param isDisabled 是否禁用,默认为true禁用
-     */
-    setBtnDisabled: (field: string | string[], isDisabled?: boolean) => void;
-    /** 设置表格查询条件显示隐藏
-     * @param field 查询条件字段名
-     * @param isShow 是否隐藏,默认为true隐藏
-     */
-    hideQuery: (field: string | string[], isShow?: boolean) => void;
-    /** 设置表格查询条件是否禁用
-     * @param field 查询条件字段名
-     * @param isDisabled 是否禁用,默认为true禁用
-     */
-    setQueryDisabled: (field: string | string[], isDisabled?: boolean) => void;
-    /** 设置表格展示列显示隐藏
-     * @param field 列字段名
-     * @param isShow 是否隐藏,默认为true隐藏
-     */
-    hideColumn: (field: string | string[], isShow?: boolean) => void;
-    /** 表格配置数据
-     * @param table_id 表格id, 在开启模拟分页的情况下，取值 '-1' 时，获取所有表格数据
-     * @param omit 需要排除的字段集合
-     */
-    getData: <T extends string>(table_id?: T, omit?: string[]) => T extends '-1' ? Promise<ICustomData.Data[]> : ICustomData.Data[] | undefined;
-    /** 表格当前激活的tab页id(table_id) */
-    getActiveTab: () => string;
-    /** 表格当前激活的tab页序号 */
-    getTabIndex: () => number;
-    /** 清除表格数据 */
-    clearTableData: () => Promise<void>;
-    /** 表格配置数据 */
-    getDataInstance: () => ICustomData.FormTable | undefined;
-    /** 更新表格查询条件数据方法 */
-    updateSearchForm: (params: ICustomData.Data) => void;
-    /** 更新表格数据 */
-    updateTableData: (id: string, data: ICustomData.Data[]) => void;
-    /** 查询条件校验 */
-    searchValidate: () => Promise<void>;
-    /** 重新统计分页数据 */
-    reloadCountTableData: (table_id?: string, query?: ICustomData.Data) => void;
-    /** 查询参数获取
-     * @param hideGroupField 是否隐藏以custome_field开头字段, 默认true隐藏, 当设置 '-1' 时，返回非空值数据
-     */
-    getQueryData: (hideGroupField?: boolean | string) => ICustomData.Data | undefined;
-    /** 可显示查询参数获取
-     * @param clearEmpty 当设置 '-1' 时，返回非空值数据
-     */
-    getShowQueryData: (clearEmpty?: string) => ICustomData.Data;
-    /** 设置查询参数
-     * @param data 查询参数
-     * @param isCanche 是否缓存查询参数，默认false
-     */
-    setQueryData: (data: ICustomData.Data, isCanche?: boolean) => Promise<void>;
-    /** 获取查询配置项 */
-    getQueryConfig: (field: string) => ICustomData.FormItemConfigData;
-    /** 设置表格单元格聚焦
-     * @param rowIndex 行索引
-     * @param field 列索引 或 列字段名
-     */
-    setTableCellFocus: (rowIndex: number, field?: number | string) => void;
-    /** 设置查询条件聚焦
-     * @param index 索引位置， 默认为0
-     * @param delay 延迟时间， 默认为600ms
-     */
-    setQueryFocus: (index?: number, delay?: number) => void;
-    /** 重置预设的选中数据 */
-    resetCheckboxRow: (data?: ICustomData.Data[]) => Promise<void>;
-    /** 清除选中数据 */
-    clearCheckboxRow: () => Promise<void>;
-    /** 更新复选框选中数据
-     * @param data 选中数据
-     * @param field 更新字段
-     */
-    updateCheckboxRow: (data: ICustomData.Data, field: string) => void;
-    /** 设置预设选中数据
-     * @param data 选中数据
-     * @param isSelected 是否选中,当设置true时，选中数据为当前追加data;当设置false时，过滤出data中的数据
-     * @param uniqId 数据唯一值，用于数据去重，默认去重字段为 id,【此值存在时也可用于复选框的勾选状态回显】
-     */
-    setCheckboxRow: (data: ICustomData.Data[], isSelected?: boolean, uniqId?: string) => Promise<void>;
-    /** 获取是否有预设的选中数据
-     * @param activeTab 当前激活的标签页, '-1'可查询所有标签页选中数据
-     */
-    getCheckboxRow: (activeTab?: string) => GET_SELECT;
-    /**
-     * 删除的行数据
-     * @param row 字符串id或行数据
-     */
-    removeCheckboxRow: (row: string | ICustomData.Data) => void;
-    /** 获取表格配置项数据，保留了数据间的引用关系
-     * @param tableId 表格id
-     */
-    getTableConfig: (tableId?: string) => ICustomData.Table | undefined;
-    /** 获取表格配置的列配置项数据,这是深复制后的数据隔断了数据的引用关系，所以修改数据不会影响表格配置数据
-     * @param tableId 表格id
-     */
-    getColumnConfigs: (tableId?: string) => ICustomData.TableItem[];
-    /** 获取下拉数据 【在<bc-box />模式下使用】
-     * @param field 字段名
-     */
-    getOptions: (field: string) => ICustomData.Data[] | undefined;
-    /** 缓存当前点击的按钮键字段，用于计算属性动态设置加载状态，按钮的自定义加载loadingIcon由“Loading”=>"ele-Loading" */
-    btnKey: Ref<string>;
-    /** 用于处理指定按钮加载状态 */
-    setBtnKey: (key: string) => void;
-    proxyFormData: (query: ICustomData.Data) => ICustomData.Data;
-    refreshData: (data: ICustomData.FormTable | undefined) => void;
-    resetReady: (p: 'query' | 'table') => void;
-}
-/** 当前单元格索引位置 */
-export interface CellIndex {
-    rowIndex: Record<string, number>;
-    columnIndex: Record<string, any>;
-}
-/** 对外导出表格参数实例 */
-export interface TableParams {
-    tableApi: Ref<Record<string, VxeTableInstance>>;
-    activeTabs: Ref<string>;
-    /** vxe-table实例，含有表格所有实例方法 */
-    api: ComputedRef<VxeTableInstance>;
-}
-export interface FetchTableParams {
-    /** 当前表格id */
-    tableId?: string;
-    /** 查询参数 */
-    [key: string]: ICustomData.ANY;
-}
-/** 表格键盘事件 */
-export interface TableKeyEventParams {
-    $event: KeyboardEvent;
-    $table: VxeTableInstance;
-    $api: BcTableApi;
-    /** 查询条件类型还是表格类型 */
-    type: 'table' | 'query';
-}
-/** 表格当前行数据 */
-export interface TableCurrentRow {
-    row: ICustomData.Data;
-    rowIndex: number;
-    code: string;
-    key: string;
-    e: KeyboardEvent;
-}
-/** 对外导出表格参数实例（含数实例数据） */
-export interface TableInstance extends TableParams {
-    /** 查询方法 , 默认获取当前查询参数会进行当前分页数据下查询 */
-    search: (table_id?: string, query?: ICustomData.Data) => Promise<void>;
-    /** 查询方法, 默认不会获取当前查询参数，会重置为第一页进行查询 */
-    searchTo: (table_id?: string, query?: ICustomData.Data) => Promise<void>;
-    /** 重置方法
-     * @param noSearch boolean时：是否只重置不查询数据， 默认是false重置后直接查询数据
-     * @param noSearch Function时：重置完查询数据后执行的回调函数，再进行查询操作
-     */
-    reset: (noSearch?: boolean | Function) => Promise<void>;
-    /** vxtable表格实例方法 */
-    getApi: (table_id?: string) => VxeTableInstance;
-    /** 获取当前实例的配置 id */
-    getConfigId: () => string;
-    /** 获取当前表格配置的id,
-     * @param index 索引位置， 默认为0, 当传值为 -1 时，返回所有表格id
-     */
-    getTab: <T extends number>(index?: T) => T extends -1 ? string[] : string;
-    /** 设置当前表格激活的标签页展示,
-     * @param index 索引位置， 默认为0,
-     */
-    setTab: (index?: number) => void;
-    /** 表格当前激活的tab页id(table_id) */
-    getActiveTab: () => string;
-    /** 表格当前激活的tab页序号 */
-    getTabIndex: () => number;
-    /**
-     *  @deprecated 该功能已弃用,请使用getDataInstance方法
-     */
-    data: Ref<ICustomData.FormTable | undefined>;
-    /** 表格配置数据
-     *  @deprecated 该功能已弃用,请使用getDataInstance方法
-     */
-    dataInstance: Ref<ICustomData.FormTable | undefined>;
-    /** 表格配置数据 */
-    getDataInstance: () => ICustomData.FormTable | undefined;
-    /** 设置表格查询按钮显示隐藏
-     * @param field 按钮字段名
-     * @param isShow 是否隐藏,默认为true隐藏
-     */
-    hideBtn: (field: string | string[], isShow?: boolean) => void;
-    /** 设置表格查询按钮是否禁用
-     * @param field 按钮字段名
-     * @param isDisabled 是否禁用,默认为true禁用
-     */
-    setBtnDisabled: (field: string | string[], isDisabled?: boolean) => void;
-    /** 设置表格查询条件显示隐藏
-     * @param field 查询条件字段名
-     * @param isShow 是否隐藏,默认为true隐藏
-     */
-    hideQuery: (field: string | string[], isShow?: boolean) => void;
-    /** 设置表格查询条件是否禁用
-     * @param field 查询条件字段名
-     * @param isDisabled 是否禁用,默认为true禁用
-     */
-    setQueryDisabled: (field: string | string[], isDisabled?: boolean) => void;
-    /** 设置表格展示列显示隐藏
-     * @param field 列字段名
-     * @param isShow 是否隐藏,默认为true隐藏
-     */
-    hideColumn: (field: string | string[], isShow?: boolean) => void;
-    /** 表格配置数据
-     * @param table_id 表格id, 在开启模拟分页的情况下，取值 '-1' 时，获取所有表格数据
-     * @param omit 需要排除的字段集合 默认排除 ['customTotal', '_X_ROW_KEY', '_X_ROW_CHILD']
-     */
-    getData: <T extends string>(table_id?: T, omit?: string[]) => T extends '-1' ? Promise<ICustomData.Data[]> : ICustomData.Data[];
-    /** 表格配置数据
-     * @param data 表格数据
-     * @param uuid 表格id
-     */
-    setData: (data: ICustomData.Data[], table_id?: string) => Promise<void>;
-    /** 表格修改行数据
-     * @param data 表格数据，可谓单对象、数组对象
-     * @param uuid 行唯一识别id，用于数据查询索引，默认 'id'
-     */
-    setRow: (data: ICustomData.Data | ICustomData.Data[], uuid?: string) => Promise<void>;
-    /** 表格指定行之前插入数据
-     * @param data 表格数据，可谓单对象、数组对象
-     * @param records 指定插入行数据位置
-     * @param uuid 行唯一识别id，用于数据查询索引，默认 'id'
-     */
-    insertBefore: (data: ICustomData.Data | ICustomData.Data[], records: ICustomData.Data, uuid?: string) => Promise<void>;
-    /** 表格指定行之后插入数据
-     * @param data 表格数据，可谓单对象、数组对象
-     * @param records 指定插入行数据位置
-     * @param uuid 行唯一识别id，用于数据查询索引，默认 'id'
-     */
-    insertAfter: (data: ICustomData.Data | ICustomData.Data[], records: ICustomData.Data, uuid?: string) => Promise<void>;
-    /** 请求方法
-     * @param params 查询参数
-     * @param callback 回调处理返回数据
-     */
-    fetchTableData: (params: FetchTableParams, callback?: (data: ICustomData.Data[]) => ICustomData.Data[]) => Promise<ICustomData.Data[]>;
-    /** 在表格渲染数据前对接口返回数据的同步处理方法
-     * @param asyncFun 同步数据处理方法
-     * @param table_id 表格id，默认所有表格使用同一个方法，传值为指定表格id时，使用指定表格id的异步处理方法
-     */
-    setTableAsyncFun: (asyncFun: (data: ICustomData.Data[]) => ICustomData.Data[], table_id?: string) => void;
-    /** 在表格数据查询前的前置操作,
-     * 重要提示：在插入的异步函数中参数为当前查询参数，函数体中有返回值时接口查询使用当前查询参数，无返回值时使用默认查询参数
-     * @param asyncFun 异步查询前置操作（searchForm：查询参数，baseData当前表格配置项）
-     * @param table_id 表格id, 默认所有表格使用同一个方法，传值为指定表格id时，使用指定表格id的异步处理方法
-     */
-    setTableBeforeAsyncFun: (asyncFun: (searchForm?: ICustomData.Data, baseData?: ICustomData.TableBaseData) => Promise<ICustomData.Data | undefined>, table_id?: string) => void;
-    showLoading: Function;
-    hideLoading: Function;
-    /** 查询参数
-     * @deprecated 该功能已弃用,请使用getQueryData方法
-     */
-    formData?: ComputedRef<ICustomData.Data | undefined>;
-    /** 当前单元格索引位置 */
-    getCellIndex: () => CellIndex;
-    /** 查询参数
-     *  @param key 按钮键字段
-     */
-    getBtnConfig: (key: string) => ICustomData.BtnData | undefined;
-    /** 查询参数
-     *  @param hideGroupField 是否隐藏以custome_field开头字段, 默认true隐藏, 当设置 '-1' 时，返回非空值数据
-     */
-    getQueryData: (hideGroupField?: boolean | string) => ICustomData.Data | undefined;
-    /** 可显示查询参数获取
-     * @param clearEmpty 当设置 '-1' 时，返回非空值数据
-     */
-    getShowQueryData: (clearEmpty?: string) => ICustomData.Data;
-    /** 获取查询条件组件实例
-     *  @param field 查询组件字段
-     */
-    getQueryItemInstance: (field: string) => any;
-    /** 获取表格配置项数据，保留了数据间的引用关系
-     * @param tableId 表格id
-     */
-    getTableConfig: (tableId?: string) => ICustomData.Table | undefined;
-    /** 获取表格配置的列配置项数据,这是深复制后的数据隔断了数据的引用关系，所以修改数据不会影响表格配置数据
-     * @param tableId 表格id
-     */
-    getColumnConfigs: (tableId?: string) => ICustomData.TableItem[];
-    /** 设置查询参数
-     * @param data 查询参数
-     * @param isCanche 是否缓存查询参数，默认false
-     */
-    setQueryData: (data: ICustomData.Data, isCanche?: boolean) => Promise<void>;
-    /** 更新查询条件指定字段值
-     * @param field 更新指定字段
-     * @param data
-     */
-    updateQueryData: (field: string, data: ICustomData.ANY) => Promise<void>;
-    /** 获取查询配置项 */
-    getQueryConfig: (field: string) => ICustomData.FormItemConfigData;
-    /** 设置查询条件聚焦
-     * @param index 索引位置， 默认为0
-     * @param delay 延迟时间， 默认为600ms
-     */
-    setQueryFocus: (index?: number, delay?: number) => void;
-    /**
-     * 表格聚焦索引位置对象
-     * @param rowIndex 行索引
-     * @param columnIndex 列索引 或 列字段名
-     */
-    tableIndex: TableIndex;
-    /** 设置表格单元格聚焦
-     * @param rowIndex 行索引 当取值 -1 时，取消表格行选中
-     * @param field 列索引 或 列字段名
-     */
-    setTableCellFocus: (rowIndex: number, field?: number | string) => void;
-    /** 设置预设选中数据
-     * @param data 选中数据
-     * @param isSelected 是否选中,当设置true时，选中数据为当前追加data;当设置false时，过滤出data中的数据
-     * @param uniqId 数据唯一值，用于数据去重，默认去重字段为 id,【此值存在时也可用于复选框的勾选状态回显】
-     */
-    setCheckboxRow: (data: ICustomData.Data[], isSelected?: boolean, uniqId?: string) => Promise<void>;
-    /** 获取是否有预设的选中数据
-     * @param activeTab 当前激活的标签页, '-1'可查询所有标签页选中数据
-     */
-    getCheckboxRow: (activeTab?: string) => GET_SELECT;
-    /**
-     * 删除的行数据
-     * @param row 字符串id或行数据
-     */
-    removeCheckboxRow: (row: string | ICustomData.Data) => void;
-    /** 重置预设的选中数据 */
-    resetCheckboxRow: (data?: ICustomData.Data[]) => Promise<void>;
-    /** 清除选中数据 */
-    clearCheckboxRow: () => Promise<void>;
-    /** 更新复选框选中数据
-     * @param data 选中数据
-     * @param field 更新字段
-     */
-    updateCheckboxRow: (data: ICustomData.Data, field: string) => void;
-    /** 获取下拉数据 【在bc-box模式下使用】
-     * @param field 字段名
-     */
-    getOptions: (field: string) => ICustomData.Data[] | undefined;
-    /** 表格键盘事件 tab键 */
-    tableTab: (data: TableKeyEventParams) => Promise<void>;
-    /** 表格键盘事件 方向右键 */
-    tableArrowRight: (data: TableKeyEventParams) => Promise<void>;
-    /** 表格键盘事件 方向左键 */
-    tableArrowLeft: (data: TableKeyEventParams) => Promise<void>;
-    /** 表格键盘事件 方向下键 */
-    tableArrowDown: (data: TableKeyEventParams) => Promise<void>;
-    /** 表格键盘事件 方向上键 */
-    tableArrowUp: (data: TableKeyEventParams) => Promise<void>;
-    /** 表格复选框选中
-     * @param data 当前实例表格事件参数
-     * @param todo 函数，返回true则继续，返回false则不继续
-     */
-    tableCheckbox: (data: TableKeyEventParams, todo?: () => boolean) => Promise<void>;
-    /** 表格键盘查询事件  方向TAB键 */
-    queryTabFocus: (data: TableKeyEventParams) => void;
-    /** 表格键盘查询事件  方向右键 */
-    queryRightFocus: (data: TableKeyEventParams) => void;
-    /** 表格键盘查询事件  方向左键 */
-    queryLeftFocus: (data: TableKeyEventParams) => void;
-    /** 表格键盘查询事件  方向下键 */
-    queryDownFocus: (data: TableKeyEventParams) => void;
-    configData?: IAuthData.Auth;
-}
-/** 用户自定义字段 */
-export interface ColumnField {
-    fieldShow: boolean | number;
-    userFieldShow: boolean | number;
-    fieldProp: string;
-    fieldName: string;
-    columnWidth: string | number;
-    showName: string;
-    sort: number;
-}
-export {};