vxe-table/types/grid.d.ts

import { VNode } from 'vue'
import { Table, TableRenderParams } from './table'
import { ColumnOptions } from './column'
import { FormOptions } from './form'
import { ToolbarOptions } from './toolbar'
import { PagerOptions } from './pager'

/**
 * 高级表格
 */
export declare class Grid extends Table {
  /**
   * 列配置
   */
  columns?: GridColumnOptions[];
  /**
   * 分页配置项
   */
  pagerConfig?: boolean | GridPagerConfig;
  /**
   * 数据代理配置项
   */
  proxyConfig?: GridProxyConfig;
  /**
   * 工具栏配置
   */
  toolbar?: boolean | GridToolbarOptions;
  /**
   * 表单配置项
   */
  formConfig?: boolean | GridFormOptions;

  /**
   * 给数据代理提交指令
   * @param code 指令编码
   */
  commitProxy(code: string): Promise<any>;
  /**
   * 获取已标记删除的数据
   */
  getPendingRecords(): any[];
  /**
   * 切换表格最大化/还原
   */
  zoom(): Promise<boolean>;
  /**
   * 判断是否最大化显示
   */
  isMaximized(): boolean;
  /**
   * 获取数据代理信息
   */
  getProxyInfo(): {
    data: any;
    filter: any;
    form: any;
    sort: any;
    pager: any;
    pendingRecords: any[];
  };
}

export interface GridProxyQueryPageParams {
  pageSize: number;
  currentPage: number;
}

export interface GridProxyQuerySortParams {
  order: string;
  property: string;
}

export interface GridProxyQueryFiltersParams {
  property: string;
  values: any[];
}

export interface GridProxyConfig {
  autoLoad?: boolean;
  message?: boolean;
  seq?: boolean;
  sort?: boolean;
  filter?: boolean;
  form?: boolean;
  props?: {
    list?: string;
    result?: string;
    total?: string;
  };
  ajax?: {
    query?(params: { page: GridProxyQueryPageParams, sort: GridProxyQuerySortParams, filters: GridProxyQueryFiltersParams[], form: any }, ...args: any[]): Promise<any>;
    delete?(params: { body: { removeRecords: any[] } }, ...args: any[]): Promise<any>;
    save?(params: { body: { insertRecords: any[], updateRecords: any[], removeRecords: any[], pendingRecords: any[] } }, ...args: any[]): Promise<any>;
  }
}

export interface GridPagerConfig extends PagerOptions {}

export interface GridColumnOptions extends ColumnOptions {
  children?: GridColumnOptions[];
}

export interface GridToolbarOptions extends ToolbarOptions {
  zoom?: boolean | {
    escRestore?: boolean;
    iconIn?: string;
    iconOut?: string;
  };
  slots?: {
    buttons?(): VNode[] | string[];
    tools?(): VNode[] | string[];
  }
}

export interface GridFormOptions extends FormOptions {}

export class GridRenderParams extends TableRenderParams {
  /**
   * 高级表格实例对象
   */
  $grid: Grid;
}