交互事件

交互事件可在表单设计器中编写事件处理代码。

事件名称 说明 回调参数
onCreated 组件创建后触发 —
onMounted 组件挂载后触发 —
onClick 按钮被点击触发 —
onInput 输入框值改变时触发 value：当前输入值
onChange 组件数据（v-model）改变时触发 (value, oldValue, subFormData, rowId)：
value，当前数据值
oldValue，变化之前的数据值

如果字段位于子表单内，还会返回下述两个回调参数：
subFormData，组件所在子表单数据
rowId，组件所在子表单的行Id（非行索引）
onFocus 获得焦点时触发 event：事件
onBlur 失效焦点时触发 event：事件
onValidate 组件数据校验时触发 (rule, value, callback)：
rule，组件校验规则
value，组件数据值
callback，校验回调函数
onBeforeUpload 图片或文件组件开始上传时触发 file：上传文件
onUploadSuccess 图片或文件组件上传成功后触发 (result, file, fileList)：
result，上传处理结果
file，当前上传文件
fileList，上传文件列表
onUploadError 图片或文件组件上传失败后触发 (error, file, fileList)：
error，错误信息
file，当前上传文件
fileList，上传文件列表
onFileRemove 删除图片或文件时触发 (file, fileList)：
file，被删除文件
fileList，文件列表
onRemoteQuery 下拉选项组件（Select）远程搜索时触发 keyword：搜索词

API方法

方法名 说明 参数
getFormRef 获取VFormRender组件 —
getWidgetRef 获取容器或字段组件 (widgetName, showError):
widgetName，组件名称
showError=true/false，如组件不存在是否显示错误
setValue 设置组件数据值 newValue，组件数据值
getValue 获取组件数据值 —
resetField 重置组件为默认值，并清除组件校验状态 —
setReadonly 设置组件是否只读，仅input、textarea、time、time-range、date、date-range等部分组件支持 true/false
setDisabled 设置组件是否禁用 true/false
setAppendButtonVisible 设置组件附加按钮是否可见，仅支持input true/false
setAppendButtonDisabled 设置组件附加按钮是否禁用，仅支持input true/false
setHidden 设置组件是否隐藏 true/false
setRequired 设置组件是否必填 true/false
setLabel 设置组件标签文字（label） newLabel，新标签文字
focus 让组件获得输入焦点 —
loadOptions 加载选择项，仅支持radio/checkbox/select/cascader组件 options，选项数组，格式为：
[
{label: ‘选项1’, value: ‘1’},
{label: ‘选项2’, value: ‘2’},
{label: ‘选项3’, value: ‘3’}
]
getOptions 返回radio/checkbox/select/cascader组件的选择项数组 —
disableOption 禁用指定选择项，仅支持radio/checkbox/select/cascader组件 optionValue，被禁用的选项值
enableOption 启用指定选择项，仅支持radio/checkbox/select/cascader组件 optionValue，被启用的选项值
setUploadHeader 设置文件或图片组件请求头（Header） (name, value)：请求头键值对
setUploadData 设置文件或图片组件上传参数 (name, value)：参数键值对
setToolbar 设置富文本组件默认工具栏按钮 customToolbar，工具按钮数组，详细参见Vue2Editor文档
setWidgetOption 设置组件属性 (optionName, optionValue)：
optionName，组件属性名
optionValue，属性值
getFieldEditor 获取组件内嵌的Element UI表单组件 —