Embedded Dashboard Properties and Objects
Properties can be passed as parameters to the createComponent
method when embedding Composer dashboards.
Here is a sample:
embedManager.createComponent('dashboard', { "dashboardId": "<dashboard-ID>", "<property>": "<propertyValue>" } );
The following table describes all of the available properties.
Property/Object | Default | Description |
---|---|---|
"application.banner": true | false | Indicates whether the Composer top-level navigation banner should be shown with the embedded dashboard. Valid values are Type: boolean This property is deprecated and will be removed in a future release. |
"application.logo": true | false | Indicates whether the Composer logo should be shown with the embedded dashboard. Valid values are Type: boolean This property is deprecated and will be removed in a future release. |
"componentInstanceId":"<id>" | none | The instance ID for the dashboard is generated when the dashboard is created. Type: string |
"dashboardId":"<id>" | none | The dashboard ID. If no dashboard ID is specified, an empty dashboard is embedded. Type: string |
"editor.placement":"docRight" | modals | Indicates where the dashboard editor appears. Valid editor placements are Type: string |
"header.showActions": false | true | Indicates whether dashboard actions should be visible for the embedded dashboard. Valid values are Type: boolean |
"header.showTitle": false | true | Indicates whether the dashboard title should be shown for the embedded dashboard. Valid values are Type: Boolean |
"header.title":"<newtitle>" | none | Allows you to overwrite the title of the embedded dashboard. The embedded dashboard title is read only; it cannot be changed while the dashboard is embedded. Type: string |
"header.visible": false | true | Indicates whether the dashboard header should be shown for the embedded dashboard. Valid values are true or false . |
"interactivityOverrides" | none | Specifies specific dashboard and visual interactivity settings for an embedded dashboard. The visual interactivity settings specified in this object will override any interactivity settings specified for the individual visuals. These settings will also override the dashboard interactivity profile linked to the dashboard (the one saved with the dashboard) and the dashboard interactivity profile passed by the Type: object |
"interactivityProfileName":"interactive" | interactive | Determines the way in which your users will be able to work with the embedded dashboard. Valid values are When the mode is
Type: string |
"mode":"interactive" | interactive | When a dashboard interactivity profile is specified (using the Type: string |
"theme":"dark" | composer | The theme for the embedded dashboard. Valid values are Type: string |
"type":"dashboard" | The type of embedded Composer component. |
Comments
0 comments
Please sign in to leave a comment.