Parameters
appElementConfigAppElementClientConfiguration<A>Configuration for an AppElementClient
Properties of appElementConfig
renderAppElementRenderer<A>Registers a callback that renders an app element based on the data it receives.
Parameters
appElementDataAThe data the callback must use to render the app element.
Returns
An array of one or more elements to render as output of an app element.
AppElementRendererOutput
Returns
A client that provides methods for creating and managing the lifecycle of an app element.
addOrUpdateElementfunctionIf an app element is selected, the element's data is overwritten and the element is re-rendered. Otherwise, the provided data is used to create a new app element.
Parameters
appElementDataAThe data to attach to the app element. Existing data will be overwritten.
placementPlacementThe position, dimensions, and rotation of the app element.
Properties of placement
topnumberThe distance from the top edge of the container, in pixels.
- The pixels are relative to their container.
- Minimum: -32768
- Maximum: 32767
leftnumberThe distance from the left edge of the container, in pixels.
- The pixels are relative to their container.
- Minimum: -32768
- Maximum: 32767
widthnumberA width, in pixels.
- The pixels are relative to their container.
- Minimum: 0
- Maximum: 32767
heightnumberA height, in pixels.
- The pixels are relative to their container.
- Minimum: 0
- Maximum: 32767
rotationnumberA rotation, in degrees.
- Minimum: -180
- Maximum: 180
Returns
Promise<void>
registerOnElementChangefunctionA callback that runs when:
- the app element is created
- the app element's data is updated
- the user selects an existing app element
Parameters
handlerAppElementChangeHandler<A>The callback to run when the app element changes.
Parameters
appElementobject | undefinedInformation about the app element that was changed.
Properties of appElement
dataAThe app element data in its most recent state.
versionnumberThe version number of the app.
Returns
void
Returns
void