Embedded Visual Authoring Properties and Objects
Properties can be passed as parameters to the createComponent
method when embedding Composer visual authoring components.
Here is a sample:
// NOTE: This example assumes that the EmbedManager has already been initialized const visualBuilder = await embedManager.createComponent('visual-builder', { visualId: <id>, // ID of existing visual source: { "visualId": "<id>", // ID of visual template, used for creating a new visual, do not pass it with visualId }, // If neither visualId is passed (visualId or source.visualId) an empty visual builder will be opened) "theme": "composer", "header": { "visible": true, "showTitle": true, "showActions": false, // hides the visual actions bar "title": "Static custom title" }, <optional breadcrumb properties> });
The following table describes all of the available properties.
Property/Object | Default | Description |
---|---|---|
<optional breadcrumb properties> | Optional breadcrumb properties are described in Optional Embedded Visual Authoring Breadcrumb Properties.
| |
"header.showActions": false | true | Indicates whether the visual header actions should be shown for the embedded visual. Valid values are Type: boolean |
"header.showTitle": false | true | Indicates whether the visual header title should be shown for the embedded visual. Valid values are Type: boolean |
"header.title": <text> | none | Specifies a static title for the visual. Type: string |
"header.visible": false | true | Indicates whether the visual header should be visible for the embedded visual. Valid values are Type: boolean |
"interactivityOverrides" | none | Specifies interactivity override settings for visual authoring. The interactivity settings specified in this object will override any interactivity settings specified for the individual visuals. For a list of visual interactivity settings you can specify, see Control How Users Interact With a Visual. Type: object |
"source.visualId":"<id>" | null | The source ID of a visual template, used for creating a new visual in visual authoring. This represents a predefined visual template. A valid source ID should be specified in quotes ( Type: string |
"theme":"dark" | composer | The theme for the embedded visual. Valid values are Type: string |
"visualId":"<id>" | null | The visual ID for an existing visual for visual authoring. A valid visual ID should be specified in quotes ( Type: string |
Comments
0 comments
Please sign in to leave a comment.