createSendUpdateAction

Function: createSendUpdateAction()

taipy-gui JS module API • Docs

---

taipy-gui JS module API / createSendUpdateAction

createSendUpdateAction(name, value, context, onChange?, propagate?, relName?): Action

Create a send update Action that will be used to update Context.

This action will update the variable name (if propagate is true) and trigger the invocation of the on_change Python function on the backend.

Parameters

• name: string = ""

The name of the variable holding the requested data as received as a property.

• value: unknown

The new value for the variable named name.

• context: undefined | string

The execution context.

• onChange?: string

The name of the on_change Python function to invoke on the backend (default is "on_change").

• propagate?: boolean = true

A flag indicating that the variable should be automatically updated on the backend.

• relName?: string

The name of the related variable (for example the lov when a lov value is updated).

Returns

Action

The action fed to the reducer.