createRequestDataUpdateAction

Function: createRequestDataUpdateAction()

taipy-gui JS module API • Docs

---

taipy-gui JS module API / createRequestDataUpdateAction

createRequestDataUpdateAction(name, id, context, columns, pageKey, payload, allData, library?): Action

Create a request data update Action that will be used to update the Context.

This action will provoke the invocation of the get_data() method of the backend library. That invocation generates an update of the elements holding the data named name on the front-end.

Parameters

• name: undefined | string

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

• id: undefined | string

The identifier of the visual element.

• context: undefined | string

The execution context.

• columns: string[]

The list of the columns needed by the element that emitted this action.

• pageKey: string

The unique identifier of the data that will be received from this action.

• payload: Record\<string, unknown>

The payload (specific to the type of component ie table, chart...).

• allData: boolean = false

The flag indicating if all the data is requested.

• library?: string

The name of the extension library.

Returns

Action

The action fed to the reducer.