initAppElement
Parameters
appElementConfigAppElementClientConfiguration<A>RequiredConfiguration for an AppElementClient
renderAppElementRenderer<A>RequiredRegisters a callback that renders an app element based on the data it receives.
Parameters
appElementDataARequiredThe 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.
addOrUpdateElementfunctionThis type has been superseded, use addElement or registerOnElementChange instead.
If 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
appElementDataARequiredThe data to attach to the app element. Existing data will be overwritten.
placementPlacementOptionalThe position, dimensions, and rotation of the app element.
topnumberRequiredThe distance from the top edge of the container, in pixels.
- The pixels are relative to their container.
Minimum: -32768
Maximum: 32767
leftnumberRequiredThe distance from the left edge of the container, in pixels.
- The pixels are relative to their container.
Minimum: -32768
Maximum: 32767
widthnumberRequiredA width, in pixels.
- The pixels are relative to their container.
Minimum: 0
Maximum: 32767
heightnumberRequiredA height, in pixels.
- The pixels are relative to their container.
Minimum: 0
Maximum: 32767
rotationnumberOptionalA rotation, in degrees.
Minimum: -180
Maximum: 180
Returns
Promise<void>
addElementfunctionAdds a new app element to the design.
Parameters
optsAppElementOptions<A>RequiredThe data and placement of the app element.
dataARequiredThe data to attach to the app element.
placementPlacementOptionalThe position, dimensions, and rotation of the app element.
topnumberRequiredThe distance from the top edge of the container, in pixels.
- The pixels are relative to their container.
Minimum: -32768
Maximum: 32767
leftnumberRequiredThe distance from the left edge of the container, in pixels.
- The pixels are relative to their container.
Minimum: -32768
Maximum: 32767
widthnumberRequiredA width, in pixels.
- The pixels are relative to their container.
Minimum: 0
Maximum: 32767
heightnumberRequiredA height, in pixels.
- The pixels are relative to their container.
Minimum: 0
Maximum: 32767
rotationnumberOptionalA 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>RequiredThe callback to run when the app element changes.
Parameters
appElementobject | undefinedRequiredInformation about the app element that was changed.
dataARequiredThe app element data in its most recent state.
versionnumberRequiredThe version number of the app.
updatefunctionRequiredFunction to update the app element data.
Parameters
optsAppElementOptions<A>RequiredUsed to add or update an app element to the design. The update function is provided in the AppElementChangeHandler callback (registerOnElementChange).
dataARequiredThe data to attach to the app element.
placementPlacementOptionalThe position, dimensions, and rotation of the app element.
topnumberRequiredThe distance from the top edge of the container, in pixels.
- The pixels are relative to their container.
Minimum: -32768
Maximum: 32767
leftnumberRequiredThe distance from the left edge of the container, in pixels.
- The pixels are relative to their container.
Minimum: -32768
Maximum: 32767
widthnumberRequiredA width, in pixels.
- The pixels are relative to their container.
Minimum: 0
Maximum: 32767
heightnumberRequiredA height, in pixels.
- The pixels are relative to their container.
Minimum: 0
Maximum: 32767
rotationnumberOptionalA rotation, in degrees.
Minimum: -180
Maximum: 180
Returns
Promise<void>
Returns
void
Returns
void