JS API

API

formApi

Name	Type	Description
node	HTML Element	Form root DOM element.
on	(eventType, callback) => void	Listen to the form event
off	(eventType, callback) => void	Unlisten to the form event
getData	() => object	Get all data for the form
setData	(newData) => void	Replace all data in the form with newData
getDataWithPreprocessor	() => object	Get the data that the form has been processed and can be submitted to the backend
getContext	() => object	Obtain the upper and lower information, such as userProfile, etc.
getValue	(id) => any	Get the value of a single field
setValue	(id, newValue) => void	Set the value of a single field
getInitialValues	() => object	Get all the data at the beginning of the form
setInitialValue	(id, initialValue, notReplaceValue) => any	Set the value of a single field, by default, the current value of the changed field will be replaced together, and 'notReplaceValue' can be set to 'true' to only set the initial value without replacing the current value
getErrors	() => object	Get all error messages for the form
setErrors	(errors) => void	Set Form Error Message
setError	(id, error) => void	Set the error message
getFieldApis	() => object	Get all available fields API
getFieldApi	(id) => object	To get the API of a single field, the API exposed by each component is different, for example, EditableTable, please refer to the API documentation for each component
validateForm	() => Promise	Immediately verify that the current form data is valid, and the return value of Promise then is errors
isDataValid	() => boolean	Whether the current form data is valid
isDirty	() => boolean	Whether the current form data has been modified
registerMethod	(name, func) => void	Register the function, and the Button's 'call formMethod' action can be called to
getMethods	() => object	Get all registered functions
setFieldComponentProps	(id, componentProps) => void	By dynamically setting the componentProps of a component by JS, you can solve the problem that callbacks cannot be written in json mode, and the properties of many components are in the form of callbacks.
submit	({ saveOnly, handler }) => Promise	Submit Form
refresh	() => void	Refresh the form
cancel	() => void	Cancel and go back to the previous page
reset	({ initialValues }) => void	Remake form data
getProps	() => object	Get all the properties of the form

formApi.on eventType

Name	callback	Description
firstRendered	(formApi) => void	Call this function when the form is rendered for the first time
ready	(formApi) => void	When the form API and all asynchronous component APIs are available
unmount	() => void	Called when the form is unloaded
fieldValueChange	(id, newValue) => void	When a field value changes, the parameter is a single form data
change	(Object) => void	When the form data changes, the parameters are all form data
validationFail	(Object) => void	When form verification fails, the parameters are all error messages in the form
schemaChanged	(Object) => void	Call this function when the form schema changes
submitted	(Object) => void	Call this function after the form submits data successfully

restApi

Name	Type
get	(url, config) => Promise
getStatic	(url, config) => Promise
post	(url, data, config) => Promise
put	(url, data, config) => Promise
delete	(url, config) => Promise

messageApi

https://ant.design/components/message#api