| node | HTML Element | 表单根 DOM 元素。 |
| on | (eventType, callback) => void | 监听表单事件 |
| off | (eventType, callback) => void | 取消监听表单事件 |
| getData | () => object | 获取表单所有数据 |
| setData | (newData) => void | 将表单所有数据替换为 newData |
| getDataWithPreprocessor | () => object | 获取表单经过处理过后可以提交给后端的数据 |
| getContext | () => object | 获取上下本信息,如 userProfile 等 |
| getValue | (id) => any | 获取单个字段的值 |
| setValue | (id, newValue ) => void | 设置单个字段的值 |
| getInitialValues | () => object | 获取表单初始所有数据 |
| setInitialValue | (id, initialValue, notReplaceValue) => any | 设置单个字段的值,默认会将改字段的当前值一起替换,notReplaceValue 设置为 true 可以只设置初始值不替换当前值 |
| getErrors | () => object | 获取表单所有错误信息 |
| setErrors | (errors) => void | 设置表单错误信息 |
| setError | (id, error) => void | 设置某个字段的错误信息 |
| getFieldApis | () => object | 获取所有可用的字段 API |
| getFieldApi | (id) => object | 获取单个字段的 API,每个组件暴露的 API 都有一定不同,例如 EditableTable,具体参考组件每个的 API 文档 |
| validateForm | () => Promise | 立即验证当前表单数据是否合法,返回值 Promise then 里是 errors |
| isDataValid | () => boolean | 当前表单数据是否合法 |
| isDirty | () => boolean | 当前表单数据是否有被修改过 |
| registerMethod | (name, func) => void | 注册函数,Button 的 调用表单函数(formMethod) action 可以调用到 |
| getMethods | () => object | 获取所有注册的函数 |
| setFieldComponentProps | (id, componentProps) => void | 通过 JS 动态设置组件的 componentProps, 可以解决在 json 模式下不能写 callback,而很多组件的属性都是 callback 的形式的问题。 |
| submit | ({ saveOnly, handler }) => Promise | 提交表单 |
| refresh | () => void | 刷新表单 |
| cancel | () => void | 取消并返回上一页 |
| reset | ({ initialValues }) => void | 重制表单数据 |
| getProps | () => object | 获取表单的所有属性 |
| render | () => void | 重新渲染表单。和 refresh 方法不同,render 只会重新渲染整个表单,不会触发表单和子组件的重新请求数据 |