mirror of
https://gitee.com/xuliangzhan_admin/vxe-table.git
synced 2026-01-21 05:27:57 +08:00
376 lines
10 KiB
JavaScript
376 lines
10 KiB
JavaScript
const apis = [
|
||
{
|
||
name: 'Props',
|
||
descKey: 'app.api.title.props',
|
||
type: '',
|
||
enum: '',
|
||
defVal: '',
|
||
list: [
|
||
{
|
||
name: 'toolbar',
|
||
descKey: 'app.api.grid.desc.toolbar',
|
||
type: 'Object',
|
||
enum: '',
|
||
defVal: '',
|
||
list: [
|
||
{
|
||
name: 'size',
|
||
desc: '尺寸',
|
||
type: 'String',
|
||
enum: 'medium,small,mini',
|
||
defVal: '',
|
||
list: []
|
||
},
|
||
{
|
||
name: 'buttons',
|
||
desc: '按钮列表',
|
||
type: 'Array',
|
||
enum: '',
|
||
defVal: '',
|
||
list: [
|
||
{
|
||
name: 'code',
|
||
desc: '按钮编码',
|
||
type: 'String',
|
||
enum: '',
|
||
defVal: '',
|
||
list: [
|
||
{
|
||
name: 'reload',
|
||
desc: '刷新数据，会重置分页；触发 ajax.query 方法',
|
||
type: '',
|
||
enum: '',
|
||
defVal: '',
|
||
list: []
|
||
},
|
||
{
|
||
name: 'query',
|
||
desc: '刷新数据；触发 ajax.query 方法',
|
||
type: '',
|
||
enum: '',
|
||
defVal: '',
|
||
list: []
|
||
},
|
||
{
|
||
name: 'insert',
|
||
desc: '新增数据',
|
||
type: '',
|
||
enum: '',
|
||
defVal: '',
|
||
list: []
|
||
},
|
||
{
|
||
name: 'insert_actived',
|
||
desc: '新增数据并且默认激活第一个可编辑的单元格',
|
||
type: '',
|
||
enum: '',
|
||
defVal: '',
|
||
list: []
|
||
},
|
||
{
|
||
name: 'mark_cancel',
|
||
desc: '将选中的数据标记或取消删除',
|
||
type: '',
|
||
enum: '',
|
||
defVal: '',
|
||
list: []
|
||
},
|
||
{
|
||
name: 'delete_selection',
|
||
desc: '删除选中行；触发 ajax.delete 方法',
|
||
type: '',
|
||
enum: '',
|
||
defVal: '',
|
||
list: []
|
||
},
|
||
{
|
||
name: 'remove_selection',
|
||
desc: '移除选中行',
|
||
type: '',
|
||
enum: '',
|
||
defVal: '',
|
||
list: []
|
||
},
|
||
{
|
||
name: 'save',
|
||
desc: '保存数据；；触发 ajax.save 方法',
|
||
type: '',
|
||
enum: '',
|
||
defVal: '',
|
||
list: []
|
||
},
|
||
{
|
||
name: 'export',
|
||
desc: '导出数据',
|
||
type: '',
|
||
enum: '',
|
||
defVal: '',
|
||
list: []
|
||
}
|
||
]
|
||
},
|
||
{
|
||
name: 'name',
|
||
desc: '显示名称',
|
||
type: 'String',
|
||
enum: '',
|
||
defVal: '',
|
||
list: []
|
||
}
|
||
]
|
||
},
|
||
{
|
||
name: 'setting',
|
||
desc: '显示列个性化设置按钮',
|
||
type: 'Boolean,Object',
|
||
enum: '',
|
||
defVal: '',
|
||
list: [
|
||
{
|
||
name: 'trigger',
|
||
desc: '触发方式',
|
||
type: 'String',
|
||
enum: 'manual,click,hover',
|
||
defVal: 'click',
|
||
list: []
|
||
},
|
||
{
|
||
name: 'immediate',
|
||
desc: '列勾选之后是否实时同步',
|
||
type: 'Boolean',
|
||
enum: '',
|
||
defVal: 'false',
|
||
list: []
|
||
}
|
||
]
|
||
}
|
||
]
|
||
},
|
||
{
|
||
name: 'pager-config',
|
||
descKey: 'app.api.grid.desc.pagerConfig',
|
||
type: 'Object',
|
||
enum: '',
|
||
defVal: '',
|
||
list: [
|
||
{
|
||
name: 'current-page',
|
||
desc: '当前页',
|
||
type: 'Number',
|
||
enum: '',
|
||
defVal: '1',
|
||
list: []
|
||
},
|
||
{
|
||
name: 'page-size',
|
||
desc: '每页大小',
|
||
type: 'Number',
|
||
enum: '',
|
||
defVal: '10',
|
||
list: []
|
||
},
|
||
{
|
||
name: 'total',
|
||
desc: '总条数',
|
||
type: 'Number',
|
||
enum: '',
|
||
defVal: '0',
|
||
list: []
|
||
},
|
||
{
|
||
name: 'pager-count',
|
||
desc: '显示页码按钮的数量',
|
||
type: 'Number',
|
||
enum: '',
|
||
defVal: '7',
|
||
list: []
|
||
},
|
||
{
|
||
name: 'page-sizes',
|
||
desc: '每页大小选项列表',
|
||
type: 'Array',
|
||
enum: '',
|
||
defVal: '[10,15,20,50,100]',
|
||
list: []
|
||
},
|
||
{
|
||
name: 'background',
|
||
desc: '带背景颜色',
|
||
type: 'Boolean',
|
||
enum: '',
|
||
defVal: 'false',
|
||
list: []
|
||
}
|
||
]
|
||
},
|
||
{
|
||
name: 'proxy-config',
|
||
descKey: 'app.api.grid.desc.proxyConfig',
|
||
type: 'Object',
|
||
enum: '',
|
||
defVal: '',
|
||
list: [
|
||
{
|
||
name: 'autoLoad',
|
||
desc: '是否自动加载查询数据',
|
||
type: 'Boolean',
|
||
enum: '',
|
||
defVal: 'true',
|
||
list: []
|
||
},
|
||
{
|
||
name: 'message',
|
||
desc: '是否显示消息提示',
|
||
type: 'Boolean',
|
||
enum: '',
|
||
defVal: 'true',
|
||
list: []
|
||
},
|
||
{
|
||
name: 'index',
|
||
desc: '存在 type=index 列时有效，是否代理动态序号（根据分页动态变化）',
|
||
type: 'Boolean',
|
||
enum: '',
|
||
defVal: 'false',
|
||
list: []
|
||
},
|
||
{
|
||
name: 'sort',
|
||
desc: '是否代理排序',
|
||
type: 'Boolean',
|
||
enum: '',
|
||
defVal: 'false',
|
||
list: []
|
||
},
|
||
{
|
||
name: 'filter',
|
||
desc: '是否代理筛选',
|
||
type: 'Boolean',
|
||
enum: '',
|
||
defVal: 'false',
|
||
list: []
|
||
},
|
||
{
|
||
name: 'props',
|
||
desc: '获取的属性配置',
|
||
type: 'Object',
|
||
enum: '',
|
||
defVal: '',
|
||
list: [
|
||
{
|
||
name: 'data',
|
||
desc: '响应结果中获取数据列表的属性',
|
||
type: 'String',
|
||
enum: '',
|
||
defVal: '如果 pager-config 配置了，则默认 result，否则为空',
|
||
list: []
|
||
},
|
||
{
|
||
name: 'page',
|
||
desc: '只对 pager-config 配置了有效，响应结果中获取分页的属性',
|
||
type: 'String',
|
||
enum: '',
|
||
defVal: 'page.total',
|
||
list: []
|
||
}
|
||
]
|
||
},
|
||
{
|
||
name: 'ajax',
|
||
desc: '代理配置（任何使用 Promise API 的任何库都可以对接数据代理）',
|
||
type: 'Object',
|
||
enum: '',
|
||
defVal: '',
|
||
list: [
|
||
{
|
||
name: 'query',
|
||
desc: '查询方法 Function({ page, sort, filter })，默认处理的数据结构 {page: {total: 0}, result: []}；如果使用了服务端排序，sort 属性可以获取相关信息；如果使用了服务端过滤，filter 属性可以获取相关信息',
|
||
type: 'Promise',
|
||
enum: '',
|
||
defVal: '',
|
||
list: []
|
||
},
|
||
{
|
||
name: 'delete',
|
||
desc: '删除方法 Function({ body })，提交的参数 { removeRecords }',
|
||
type: 'Promise',
|
||
enum: '',
|
||
defVal: '',
|
||
list: []
|
||
},
|
||
{
|
||
name: 'save',
|
||
desc: '保存方法 Function({ body })，提交的参数 { insertRecords, updateRecords, removeRecords, pendingRecords}',
|
||
type: 'Promise',
|
||
enum: '',
|
||
defVal: '',
|
||
list: []
|
||
}
|
||
]
|
||
}
|
||
]
|
||
}
|
||
]
|
||
},
|
||
{
|
||
name: 'Slots',
|
||
descKey: 'app.api.title.slots',
|
||
type: '',
|
||
enum: '',
|
||
defVal: '',
|
||
list: []
|
||
},
|
||
{
|
||
name: 'Events',
|
||
descKey: 'app.api.title.events',
|
||
type: '',
|
||
enum: '',
|
||
defVal: '',
|
||
list: [
|
||
{
|
||
name: 'current-page-change',
|
||
desc: '只对 pager-config 配置时有效，当前页发生改变时会触发该事件',
|
||
type: '',
|
||
enum: '',
|
||
defVal: '',
|
||
list: []
|
||
},
|
||
{
|
||
name: 'page-size-change',
|
||
desc: '只对 pager-config 配置时有效，每页大小发生改变时会触发该事件',
|
||
type: '',
|
||
enum: '',
|
||
defVal: '',
|
||
list: []
|
||
},
|
||
{
|
||
name: 'toolbar-button-click',
|
||
desc: '只对 toolbar 配置时有效，当工具栏的按钮被点击时会后触发该事件',
|
||
type: '',
|
||
enum: '',
|
||
defVal: '{menu,type,row,rowIndex,column,columnIndex,cell},event',
|
||
list: []
|
||
}
|
||
]
|
||
},
|
||
{
|
||
name: 'Methods',
|
||
descKey: 'app.api.title.methods',
|
||
type: '',
|
||
enum: '',
|
||
defVal: '',
|
||
list: [
|
||
{
|
||
name: 'commitProxy(code)',
|
||
desc: '给代理提交指令',
|
||
type: '',
|
||
enum: 'reload,query,delete,save',
|
||
defVal: '',
|
||
list: []
|
||
}
|
||
]
|
||
}
|
||
]
|
||
|
||
export default apis
|