@newview/ui 1.1.53 → 1.1.55

package/types/GridJava.d.ts

@@ -0,0 +1,837 @@
+import { BaseInstance } from "@newview/base-vue";
+
+import { ApiResult, BaseApi, QueryWrapper } from "@newview/infrastructure";
+import { VNode } from "vue";
+import { VxeColumnProps, VxeTableDefines, VxeTableInstance, VxeTableListeners, VxeTablePropTypes } from "vxe-table";
+import { SearchComOption } from "./SearchCom";
+import { ToolbarOption } from "./Toolbar";
+
+export const GloablValueTypeJava = {
+  /**
+   * 客户端 日期时间
+   */
+  $datetime: "$datetime",
+  /**
+   * 客户端 日期
+   */
+  $date: "$date",
+  /**
+   * 客户端 时间
+   */
+  $time: "$time",
+  /**
+   * 唯一标识
+   */
+  $guid: "$guid",
+  /**
+   * 登录用户Id
+   */
+  $LoginUserId: "@LoginUserId",
+  /**
+   * 登录用户真实名称
+   */
+  $LoginUserTrueName: "@LoginUserName",
+  /**
+   * 登录用户账号
+   */
+  $LoginUserAccount: "@LoginAccount",
+  /**
+   * 服务器 日期
+   */
+  $CurrentDate: "@CurrentDate"
+};
+
+/**
+ * Gird Option
+ */
+export interface GridOptionsJava {
+    /**
+     * api接口对应类
+     */
+    api?: BaseApi;
+
+    /**
+     * 基本属性
+     */
+    setting?: GridSettingJava;
+
+    /**
+     * 事件
+     */
+    event?: GridEventJava;
+
+    /**
+     * 搜索条件配置参数
+     */
+    searchOptions?: SearchComOption[];
+
+    /**
+     * 工具栏按钮
+     */
+    toolbars?: ToolbarOption[];
+
+    /**
+     * 右侧按钮
+     */
+    rightToolbars?: ToolbarOption[];
+
+    /**
+     * 列参数
+     */
+    columns?: GridColumnJava[];
+}
+
+/**
+ * 按钮
+ */
+export interface GridButtonJava {
+    /**
+     * 名称，唯一标识
+     */
+    name: string;
+    /**
+     * 文本
+     */
+    text?: string;
+    /**
+     * 图标
+     */
+    icon?: string;
+    /**
+     * 点击方法
+     */
+    onclick?: (row: any, btn: GridButtonJava) => void;
+    /**
+     * 按钮类型
+     */
+    type?: "default" | "primary" | "dashed" | "text" | "info" | "success" | "warning" | "error";
+    /**
+     * 样式
+     */
+    class?: string,
+    /**
+     * 是否显示
+     */
+    isShow?: boolean | ((row: any) => boolean);
+    /**
+     * 是否禁用
+     */
+    isEnable?: boolean | ((row: any) => boolean);
+}
+
+/**
+ * 日期选择参数
+ */
+export interface GridDatePickerPropJava {
+    format?: string,
+    type?: "date" | "daterange" | "datetime" | "datetimerange" | "year" | "month"
+}
+
+/**
+ * 时间选择参数
+ */
+export interface GridTimePickerPropJava {
+    type?: "time" | "timerange",
+    format?: string
+}
+
+/**
+ * InputNumber 参数
+ */
+export interface GridInputNumberPropJava {
+    /**
+     * 最大值 默认值: Infinity
+     */
+    max?: number,
+    /**
+     * 最小值 默认值: -Infinity
+     */
+    min?: number,
+    /**
+     * 每次改变的步伐，可以是小数 默认值: 1
+     */
+    step?: number
+}
+
+/**
+ * TreeSelect data参数
+ */
+export interface GridTreeSelectOptionPropJava {
+    title: any,
+    value: any,
+    expand?: boolean,
+    selected?: boolean,
+    checked?: boolean,
+    children?: GridTreeSelectOptionPropJava[]
+}
+
+/**
+ * Option
+ */
+export interface GridSelectOptionPropJava {
+    value: any,
+    text: any
+}
+
+/**
+ * 下拉框配置
+ */
+export interface GridSelectPropJava {
+    /**
+     * Option
+     */
+    data?: GridSelectOptionPropJava[],
+    multiple?: boolean,
+    clearable?: boolean,
+    transfer?: boolean
+}
+
+/**
+ * 树形下拉配置
+ */
+export interface GridTreeSelectPropJava {
+    data?: GridTreeSelectOptionPropJava[],
+    multiple?: boolean,
+    transfer?: boolean
+}
+
+/**
+ * 自动完成组件参数
+ */
+export interface GridAutoCompletePropJava {
+    data?: string[],
+    filterMethod?: Function
+}
+
+/**
+ * Ch列参数
+ */
+export interface GridChPropJava {
+    /**
+     * 多选框的尺寸，可选值为 large、small、default 或者不设置
+     */
+    size?: string,
+    /**
+     * String | Number | Boolean,
+     */
+    trueValue?: string | number | boolean,
+    /**
+     * 没有选中时的值，当使用类似 1 和 0 来判断是否选中时会很有用
+     */
+    falseValue?: string | number | boolean,
+    /**
+     * Ch显示值
+     */
+    label?: string
+}
+
+
+/**
+ * swconfig列参数
+ */
+export interface GridSwPropJava {
+    /**
+     * 多选框的尺寸，可选值为 large、small、default 或者不设置
+     */
+    size?: string,
+    /**
+     * String | Number | Boolean,
+     */
+    trueValue?: string | number | boolean,
+    /**
+     * 没有选中时的值，当使用类似 1 和 0 来判断是否选中时会很有用
+     */
+    falseValue?: string | number | boolean,
+    /**
+      * 开关打开时的颜色
+      */
+    trueColor?: string
+    /**
+     * 开关关闭时的颜色
+     */
+    falseColor?: string
+}
+
+
+/**
+ * Option
+ */
+export interface FilterSelectOptionPropJava {
+    value: any,
+    label?: any,
+    text?: any,
+    checked?: boolean
+}
+/**
+ * 表头筛选配置
+ */
+export interface GridFilterPropJava {
+    /**
+     * 筛选类型
+     */
+    type: "select" | "input" | "date" | "month" | "year" | "time" | "datetime" | "daterange" | "numberrange";
+    /**
+     * 下拉列表数据
+     */
+    options?: FilterSelectOptionPropJava[]
+    /**
+     * 下拉选项是否多选
+     */
+    multiple?: boolean
+
+}
+
+/**
+ * 基本配置
+ */
+export interface GridSettingJava {
+    /**
+     * 按钮权限控制参数
+     */
+    operates?: string;
+    /**
+     * 表格类型('view'只读，'edit'行内编辑)
+     */
+    mode?: "view" | "edit";
+    /**
+     * 是否分页
+     */
+    isPagination?: boolean;
+    /**
+     * 是否为Tree
+     */
+    isTree?: boolean;
+    /**
+   * 空数据提示语
+   */
+    emptyText?: string;
+    /**
+     * 是否显示孩子节点
+     */
+    isShowChildren?: boolean;
+    /**
+     * 行Key
+     */
+    rowKey?: string;
+    /**
+     * 每页大小
+     */
+    pageSize?: number;
+    /**
+     * 删除提示语Key
+     */
+    delMsgKey?: string;
+    /**
+     * 开始时编辑
+     */
+    startEdit?: boolean;
+    /**
+     * 查询配置
+     */
+    searchConfig?: SearchConfigJava;
+    /**
+     * 按钮配置
+     */
+    toolbarConfig?: ToolbarConfigJava;
+    /**
+     * 编辑配置
+     */
+    editConfig?: VxeTablePropTypes.EditConfig;
+    /**
+     * 行配置
+     */
+    rowConfig?: VxeTablePropTypes.RowConfig;
+    /**
+     * 树配置
+     */
+    treeConfig?: VxeTablePropTypes.TreeConfig;
+    /**
+     * 右键菜单配置
+     */
+    menuConfig?: VxeTablePropTypes.MenuConfig;
+    /**
+     * 分页组件配置
+     */
+    pageConfig?: PageConfigJava;
+    /**
+     * 是否显示边框
+     */
+    border?: boolean;
+    /**
+     * 显示标题
+     */
+    showHeader?: boolean;
+    /**
+     * 给行附加 className
+     */
+    rowClassName?: VxeTablePropTypes.RowClassName;
+    /**
+     * 给单元格附加 className
+     */
+    cellClassName?: VxeTablePropTypes.CellClassName;
+    /**
+     * 双切换展开树
+     */
+    dblClickToggleTreeExpand?: boolean;
+    /**
+     * 校验规则配置项
+     */
+    editRules?: { [field: string]: VxeTableDefines.ValidatorRule[] }
+    /**
+     * 表头筛选配置
+     */
+    filterConfig?: VxeTablePropTypes.FilterConfig;
+    /**
+     * 复选框配置项
+     */
+    checkboxConfig?: VxeTablePropTypes.CheckboxConfig;
+    /**
+     * 是否显示斑马纹
+     */
+    stripe?: boolean;
+}
+
+/**
+ * Toolbar 配置
+ */
+export interface ToolbarConfigJava {
+    /**
+     * 是否为按钮组
+     */
+    isButtonGroup?: boolean;
+    /**
+     * 最多显示格式
+     */
+    maxShow?: number;
+}
+
+/**
+ * 查询配置
+ */
+export interface SearchConfigJava {
+    /**
+     * 按钮 Col Span
+     */
+    btnSpan?: number;
+    /**
+     * 标签宽度
+     */
+    labelWidth?: number;
+    /**
+     * 默认显示查询
+     */
+    defaultShowSearch?: boolean;
+}
+
+
+/**
+ * 分页组件配置
+ */
+export interface PageConfigJava {
+    /**
+     * 简洁版
+     */
+    simple?: boolean
+}
+
+/**
+ * 事件
+ */
+export interface GridEventJava extends VxeTableListeners {
+
+    /**
+     * 保存前事件
+     */
+    event_saveBefore?: (datas: any[]) => boolean;
+
+    /**
+     * 保存后事件
+     */
+    event_saveAfter?: (datas: any[], result: any) => void;
+
+    /**
+     * 删除前事件
+     */
+    event_deleteBefore?: (id: number, row: any) => boolean;
+
+    /**
+     * 删除后事件
+     */
+    event_deleteAfter?: (id: number, apiResult: ApiResult, row: any) => void;
+
+    /**
+     * 查询事件
+     */
+    event_search?: (data: any) => void;
+
+    /**
+     * 行添加前事件, 可以修改要插入Row的数据
+     */
+    event_addRowBefore?: (row: any, parentRow: any) => any;
+
+    /**
+     * 编辑行之前事件
+     */
+    event_editRowBefore?: (row: any, parentRow: any) => any;
+
+    /**
+     * 数据加载完成事件
+     * @param datas 
+     * @returns 
+     */
+    event_loaded?: (datas: any[]) => void;
+
+    /**
+     * 表头筛选项发生改变事件
+     * @param param 
+     * @returns 
+     */
+    event_filterChange?: (param, param2) => void;
+    /**
+      * 合并行或列
+      * @param param0 
+      * @returns 
+      */
+
+    event_rowspanMethod?: ({ row, _rowIndex, column, visibleData }) => void
+      /**
+     * 页码改变前事件
+     * @returns 
+     */
+      event_pageChangeBefore?: () => boolean;
+}
+
+/**
+ * 列配置
+ */
+export interface GridColumnJava extends VxeColumnProps {
+    // 扩展属性
+
+    /**
+     * 表头分组
+     */
+    children?: Array<GridColumnJava>;
+
+    /**
+     * 列类型
+     */
+    colType?: "ch" | "ed" | "password" | "auto" | "num" | "select" | "date" | "time" | "ro" | "seq" | "radio" | "checkbox" | "expand" | "treeSelect" | "switch" | "color";
+
+    /**
+     * 行按钮
+     */
+    rowButtons?: GridButtonJava[];
+
+    /**
+     * 渲染函数
+     */
+    format?: (h: any, params: { row: any, column: any }) => VNode | any;
+
+    /**
+     * 列头渲染函数
+     */
+    titleFormat?: (h: any, column: any) => VNode | any;
+
+    /**
+     * 值改变事件
+     */
+    change?: Function;
+
+    /**
+     * 失去焦点
+     */
+    blur?: Function;
+
+    /**
+     * 日期类型参数
+     */
+    datePicker?: GridDatePickerPropJava;
+
+    /**
+     * 时间类型参数
+     */
+    timePicker?: GridTimePickerPropJava;
+
+    /**
+     * 数字输入框参数
+     */
+    inputNumber?: GridInputNumberPropJava;
+
+    /**
+     * 下拉框参数
+     */
+    select?: GridSelectPropJava;
+
+    /**
+     * 自动完成组件参数
+     */
+    autoComplete?: GridAutoCompletePropJava;
+
+    /**
+     * 默认值
+     */
+    defaultValue?: any;
+
+    /**
+     * 树形下拉框参数
+     */
+    treeSelect?: GridTreeSelectPropJava;
+
+    /**
+     * ch列参数
+     */
+    ch?: GridChPropJava;
+
+    /**
+     * sw列参数
+     */
+    switchConfig?: GridSwPropJava;
+
+    /**
+     * 禁用
+     */
+    isEnable?: Function
+
+    /**
+     * 表头筛选配置
+     */
+    filter?: GridFilterPropJava
+
+    /**
+     * 该列内容是否作为删除提示
+     */
+    isDelKey?:Boolean
+}
+
+/**
+ * 数据加载参数
+ */
+export interface LoadDataOptionsJava {
+    filter?: string;
+    page?: number;
+    pageSize?: number;
+    sort?: string;
+    /**
+     * 是否分页
+     */
+    isPagination?: boolean;
+    queryWrapper?: QueryWrapper;
+    success: (datas: any) => void;
+}
+
+export declare class GridInstanceJava extends BaseInstance {
+    gloablValues: Array<any>;
+
+    /**
+     * 设置数据
+     * @param datas 
+     */
+    setDatas(datas: any[]): void;
+
+    /**
+     * 获取最新数据
+     * @returns 
+     */
+    getNewDatas(): any[];
+
+    /**
+     * 获取数据
+     * @returns 
+     */
+    getDatas(): any[];
+
+    /**
+     * 获取复选框选中的数据
+     * @returns 
+     */
+    getCheckboxDatas(): any[];
+
+    /**
+     * 获取当前记录行
+     * @returns 
+     */
+    getCurrentRecord(): any;
+
+    /**
+     * 获取需要保存的数据
+     * @returns 
+     */
+    getSaveDatas(): any[];
+
+    /**
+     * 获取XTable
+     */
+    getXTable(): VxeTableInstance;
+
+    /**
+     * 设置当前页
+     * @param pageIndex 
+     */
+    setPageIndex(pageIndex: number): void;
+
+    /**
+     * 获取页
+     */
+    getPageIndex(): number;
+
+    /**
+     * 重新计算页
+     * @param deleteNumber 
+     */
+    reCalcPageIndex(deleteNumber: number): void;
+
+    /**
+     * 设置每页尺寸
+     * @param pageSize 
+     */
+    setPageSize(pageSize: number): void;
+
+    /**
+     * 移除行
+     * @param row 
+     */
+    removeRow(row: any): void;
+
+    /**
+     * 新增行
+     * @param row 
+     */
+    addRow(row: any): Promise<void>;
+
+    /**
+     * 修改行
+     */
+    updateRow(rowId, data: any): Promise<void>;
+
+    /**
+     * 组织查询参数
+     * @returns 
+     */
+    getLoadDataOptions(): void;
+
+    /**
+     * 加载数据
+     * @param _readFunction 
+     */
+    loadData(_readFunction: (options: LoadDataOptionsJava) => Promise<void>): Promise<void>;
+
+    /**
+     * 加载数据
+     * @param _queryWrapper 
+     */
+    loadDataByQuery(_queryWrapper: QueryWrapper): void;
+
+    /**
+     * 刷新数据
+     */
+    refreshData(): Promise<void>;
+
+    /**
+     * 设置当前行
+     * @param row 
+     */
+    setCurrentRow(row: any): void;
+
+    /**
+     * 清除当前选中行
+     */
+    clearCurrentRow(): void;
+
+    /**
+     * 设置当前行为编辑状态
+     */
+    setEditRow(row: any): void;
+
+
+    /**
+     * 设置全局值
+     * @param key 
+     * @param value 
+     * @param isOnlyAddSetValue 
+     */
+    setGloablValue(key: string, value: any, isOnlyAddSetValue?: boolean): void;
+
+    /**
+     * 填充全局值到Row
+     * @param row row数据
+     */
+    intoGloablValue(row: any): void;
+
+    /**
+     * 获取添加的数据
+     * @param row 
+     * @returns 
+     */
+    getAddData(row: any): any;
+
+    /**
+     * 执行刷新
+     */
+    doRefresh(): void;
+
+    /**
+     * 执行删除
+     * @param row 
+     */
+    doDelete(row: any): void;
+
+    /**
+     * 清除行Radio选中状态
+     */
+    doClearRadioRow(): void;
+
+    /**
+     * 清除行checkbox选中状态
+     */
+    doClearCheckboxRow(): void;
+
+    /**
+     * 校验数据
+     */
+    validate(): Promise<boolean>;
+
+    /**
+     * 设置表头筛选条件
+     * @param field 
+     * @param options 
+     */
+    setFilter(field, options): void
+
+    /**
+     * 根据表头筛选数据获取拼接好的查询条件
+     * @param filterParam 
+     */
+    getHeaderFilter(filterParam): void
+
+    /**
+     * 加载表头筛选数据
+     * @param _queryWrapper 
+     */
+    loadDataByHeaderFilter(_queryWrapper: QueryWrapper): void;
+}
+/**
+ * 正在执行方法中遮罩配置
+ */
+export interface doMethodLoadingTypeJava {
+    /**
+     * 是否显示正在执行遮罩
+     */
+    show?: boolean;
+    /**
+     * 正在执行遮罩文本内容
+     */
+    text?: string
+}
+
+import type { DefineComponent } from 'vue';
+
+export declare const Grid: DefineComponent<{
+    /**
+     * Gird 配置项
+     */
+    option?: GridOptionsJava;
+    /**
+     * 正在执行方法中遮罩配置
+     */
+    doMethodLoading?: doMethodLoadingTypeJava;
+}>