initAppElement
Parameters
appElementConfigAppElementClientConfiguration<A>Configuration for an AppElementClient
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.
A primitive data type that can be used in app element data.
All primitive data types are supported except for symbols and bigints.
An object primitive data type that can be used in app element data.
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
appElementDataAThe data to attach to the app element. Existing data will be overwritten.
A primitive data type that can be used in app element data.
All primitive data types are supported except for symbols and bigints.
An object primitive data type that can be used in app element data.
placementPlacementThe position, dimensions, and rotation of the app element.
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>
addElementfunctionAdds a new app element to the design.
Parameters
optsAppElementOptions<A>The data and placement of the app element.
dataAThe data to attach to the app element.
A primitive data type that can be used in app element data.
All primitive data types are supported except for symbols and bigints.
An object primitive data type that can be used in app element data.
placementPlacementThe position, dimensions, and rotation of the app element.
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.
dataAThe app element data in its most recent state.
A primitive data type that can be used in app element data.
All primitive data types are supported except for symbols and bigints.
An object primitive data type that can be used in app element data.
versionnumberThe version number of the app.
updatefunctionFunction to update the app element data.
Parameters
optsAppElementOptions<A>Used to add or update an app element to the design. The update function is provided in the AppElementChangeHandler callback (registerOnElementChange).
dataAThe data to attach to the app element.
A primitive data type that can be used in app element data.
All primitive data types are supported except for symbols and bigints.
An object primitive data type that can be used in app element data.
placementPlacementThe position, dimensions, and rotation of the app element.
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>
Returns
void
Returns
void