Vol.Pro开发文档

参数属性配置

此文档是生成页面的方法及属性配置，常用功能在【前端开发】文档上

[vue3代码]写在生成的[表.vue]文件中,[vue2代码]写在[表.jsx]文件methods方法中；二选一实现

使用方式,下面两种方式二选一实现，如：

1. 在生成的[表.jsx]文件中使用:
    onInit(){
        this.columnIndex=true//设置表格显示行号
    }

2.在生成的[表.vue]文件中使用:
    let gridRef;
    const onInit=($vm)=>{
        gridRef=$vm;
        gridRef.columnIndex=true//设置表格显示行号
    }
上面方式二选一都可以实现功能

属性	说明	类型	默认
自定义扩展页面获取父组件(获取生成页面对象,仅在生成jsx文件中扩展组件有效)	`1、通过this.$emit('parentCall', $parent => { //调用查询 $parent.search() })可以访问父组件ViewGird中的任何属性、方法` 2、具体也可以参考[前端开发文档->自定义弹出框 ]
获取自定义扩展页面(仅在生成jsx文件中扩展组件有效)	this.$refs.gridHeader/gridBody/gridFooter
columnIndex	是否显示行号	bool	false
ck	是否显示 checkbox	bool	true
buttons	查询界面按钮`具体使用见【前端开发】文档上按钮操作的示例`	array	[]
boxButtons	弹出框按钮`具体使用见【前端开发】文档上按钮操作的示例`	array	[]
editFormFields	编辑字段,查看[组件示例->volform表单组件]配置	json
editFormOptions	编辑配置,查看[组件示例->volform表单组件]配置	array	[]
searchFormFields	查询字段同上编辑字段	json
searchFormOptions	查询配置同上编辑配置	array	[]
single	查询界面的table checkbox是否单选	bool	false
load	查询页面打开时是否加载表数据	bool	true
height	表高度(查询界面的表高度)`可以在onInited中重新设置值`	number	0
tableMaxHeight	查询页面 table 的最大高度	number	0
boxModel	新建、编辑框弹出框状态	bool	false
textInline	table 内容超出后是否不换行	boolean	true
currentAction	当新建或编辑时，记录当前的状态：如当前操作是新建	string	Add
currentRow	当前编辑或查看数据的行	object	{}
pagination	主表与排序配置`{` `"sizes": [30, 60, 90], //默认分页条大小` `"size": 30, // 默认分页大小(每页大小)` `"sortName": '', // 排序字段` `"order": 'desc' // 排序方式desc或者asc` `}`
boxOptions	包含弹出框相关配置项`{ title: '',\\弹出出框标题` `saveClose: true,\\保存后是否关闭` `labelWidth: 100,\\弹出框编编辑表单左边文本标签的宽度` `height: 0,\\弹出框高度，需要在onInited中使用` `width: 0, \\弹出框宽度，需要在onInited中使用` `draggable: false\\弹出框是可以拖动}`
queryFields	查询按钮前面显示多个查询字段(默认只显示一个查询字段)`具体使用见【前端开发方】->【设置多个快捷查询字段】`	Array	[]
showTableAudit	是否显示表格审批按钮	bool	true
rowKey	树形结构的主键字段，如果设置值默认会开启树形 table；注意 rowKey 字段的值必须是唯一（2021.05.02）	string
labelWidth	高级查询的标签宽度	number	90
reserveSelection	分页或者刷新表格数据后是否保留复选框选择状态，2024.09.10	boolean	false
sortable	表格是否可以拖拽排序2024.10.06	boolean	false
showCustom	是否显示自定义配置列按钮 2022.05.27	bool	true
maxBtnLength	界面按钮最多显示的个数，超过的数量都显示在更多中	number	8
dicKeys	当前界面所有的下拉框字典编号及数据源	array	[]
url	查询界面调用的url接口，`如果需要修改，请在onInited中重新设置值`	string	''
hasDetail	是否显示明细表	bool	false
continueAdd	2021.04.11 新建时是否可以连续新建操作	bool	false
continueAddName	2021.04.11 按钮名称	string	保存后继续添加
continueAddName	2021.04.11 按钮名称	string	保存后继续添加
downloadFileName	2022.09.26增加自定义导出文件名	null	null
select2Count	下拉框超出2000数量显示select2组件	number	1500
beginEdit	主表表格点击行编辑时方法	Function	(row, column, index) => { return true }
endEditBefore	主表表格行结束编辑时方法	Function	(row, column, index) => { return true }
detailHeight	明细表的高度	number	300
hiddenFields	隐藏字段	Array	[]
text	按钮前面显示的文本(可以是html标签)	string	''
subDetails	三级明细表	Array	[]
lazy	树形表格是否默认延迟加载,`具体配置见【前端开发】->【table树形结构】`	boolean	true
defaultExpandAll	树形表格是否展开所有	boolean	false
expandRowKeys	默认展开的节点	Array	[]
rowParentField	树形表格父级id	string	''
paginationHide	是否隐藏分页	boolean	false
importDesc	导入excel弹出框的描述	string	''
multiple	包含多明细表相关配置项	{ horizontal: false, leftWidth: 0, rightWidth: 0 }	{ horizontal: false, leftWidth: 0, rightWidth: 0 }
dragPosition	表格可拖动位置，顶部拖动top,底部bottom	string	''
labelPosition	编辑表单标签文字显示位置:left / top（默认是top，或者在main.js全局配置）	string	''
submitChangeRows	只提交变更的明细表数据	boolean	true
detailOptions	弹出框明细表配置(这只是主从表，不是一对多),`具体使用见下面【明细表detailOptions参数】`

detailOptions明细表参数

使用方式，如：

1. 在生成的[表.jsx]文件中使用:
  onInited(){
    this.detailOptions.height=300//设置明细表高度
  }

2.在生成的[表.vue]文件中使用:
   const onInited=()=>{
       gridProxy.detailOptions.height=300//设置明细表高度
   }

上面方式二选一都可以实现功能

属性	说明	类型	默认
columnIndex	明细是否显示行号	boolean	false
ck	明细是否显示 checkbox	boolean	true
sortable	表格是否可以拖拽排序 2024.10.06	boolean	false
pagination	明细表分页与排序配置`{` `"sizes": [30, 60, 90], //默认分页条大小` `"size": 30, // 默认分页大小(每页大小)` `"sortName": '', // 排序字段` `"order": 'desc' // 排序方式desc或者asc` `}`
height	默认从表高度	number	0
single	明细表是否单选	boolean	false
paginationHide	明细表隐藏分页	boolean	false
dragPosition	明细表格可拖动位置，顶部拖动 top, 底部 bottom	string	''
buttons	弹出框从表表格操作按钮	Array	[]
cnName	从表名称	string	''
key	从表主键名	string	''
data	数据源	Array	[]
columns	从表列信息查看[组件示例->voltable表格组件]配置	Array	[]
load	默认是否加载明细表数据	boolean	false
delKeys	当编辑时删除当前明细的行主键值	Array	[]
url	从表加载数据的 url	string	''
textInline	明细表行内容显示在一行上，如果需要换行显示，请设置为 false	boolean	true
beginEdit	明细表点击行编辑时方法	Function	(row, column, index) => { return true }
endEditBefore	明细表行结束编辑时方法	Function	(row, column, index) => { return true }

参数属性配置

使用方式,下面两种方式二选一实现，如：

detailOptions明细表参数

使用方式，如：

ON THIS PAGE