Supported Embedded Visual Authoring Properties and Objects
The following properties can be passed as parameters to the createComponent
method when embedding Composer visual authoring components.
Property/Object | Default | Description |
---|---|---|
"breadcrumbs.href":"<address>" | none | The link address of the breadcrumb title. A valid link address should be specified in quotes ( Type: string |
"breadcrumbs.onClick" | none | The click action handler for the breadcrumb title. Type: function |
"breadcrumbs.target":"_blank" | none | The link target parameter. Use Type: string |
"breadcrumbs.title":"<title>" | none | The first item breadcrumbs title. A valid title should be specified in quotes ( Type: string |
"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.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 |
"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.