Interactivity Properties
You can add interactivity override settings to your embed script to provide granular control over what your users can do with an embedded Composer component. Properties can be passed with parameters in the interactivityOverrides
object of the createComponent
method when embedding Composer components.
The interactivityProfileName
property must be specified before the interactivity overrides (interactivityOverrides
object) can work. See Embedded Dashboard Properties and Objects.
The interactivityOverrides
object includes two properties, settings
and visualSettings
.
The parameters of the
settings
property affect the current embedded dashboard interactivity. See Dashboard Interactivity Parameters (settings Property).The parameters of the
visualSettings
object property affect the current embedded visual interactivity. See Visual Interactivity Properties (visualSettings Property).
The following example depicts the use and placement of dashboard and visual interactivity parameters.
<script> src="<server>:8443/composer/embed/embed.js", { "type": "dashboard", "dashboardId": "<dashboard-ID>", "theme": "modern", "interactivityProfileName": "interactive", "interactivityOverrides": { "settings":{ "CHANGE_LAYOUT": true }, "visualSettings":{ "FILTER": false }, } } </script>
Custom user attributes can be used as variables in these property value settings. For example, the following property setting is valid and will insert the value of the var2
custom user attribute in the property setting. If a var2
custom user attribute is not found for a user, a value of true
is assumed.
While it is possible to save a dashboard profile using custom user attributes, you cannot pass the dashboard profile with custom user attributes in the JavaScript.
"CHANGE_LAYOUT": "${User.var2|true}"
Dashboard Interactivity Parameters (settings
Property)
Use the settings
property to specify interactivity parameters for the dashboard. The default for all dashboard interactivity parameters is true
.
Parameter | Description |
---|---|
"ADD_TO_FAVORITES": false | When set to Type: boolean |
"ADD_VISUALS": false | When set to Type: boolean |
"CHANGE_LAYOUT": true | When set to Type: boolean |
"DASHBOARD_INTERACTIONS": true | When set to true , users can link fields between disparate data sources to create cross-source links. When set to false , they cannot create cross-source links and the ![]() |
"DASHBOARD_LINKS": true | When set to Type: boolean |
"DELETE": true | When set to Type: boolean |
"EXPORT_CONFIGURATION": true | When set to Type: boolean |
"EXPORT_PNG_PDF": true | When set to Type: boolean |
"FILTER": true | When set to Type: boolean |
"REFRESH": true | When set to Type: boolean |
"RENAME": true | When set to Type: boolean |
"SAVE": true | When set to Type: boolean |
Visual Interactivity Properties (visualSettings
Property)
Use the visualSettings
property to specify visual interactivity parameters for the embedded visuals. If the overrideVisualInteractivity
property is set to true
within these settings, the visual interactivity parameters will override any interactivity properties specified for the individual visuals.
The defaults for these parameters are determined by the interactivity profile.
If the interactivity profile is
readonly
, then theoverrideVisualInteractivity
property istrue
and allvisualSettings
parameters arefalse
. If the interactivity profile isinteractive
, then theoverrideVisualInteractivity
property is set tofalse
, allvisualSettings
parameters are empty, and the visual interactivity settings for the individual visuals are used.When a custom interactivity profile is saved for a dashboard and
overrideVisualInteractivity
is set tofalse
, then allvisualSettings
parameters are empty and the visual interactivity settings for the individual visuals are used. IfoverrideVisualInteractivity
is set totrue
, then thevisualSettings
for the dashboard are used.
Parameter | Description |
---|---|
"ACTIONS": false | When set to Type: boolean |
"ACTIONS_ACTION": false | When set to Type: boolean |
"COLORS": false | When set to When set to Type: boolean |
"COPY": false | When set to true , users can copy a visual using the Copy Visual option from the visual drop-down menu. When set to false , they cannot copy visuals.Type: boolean |
"DETAILS_ACTION": false | When set to true , users can display additional information about a specific visual data element using the Details option on the radial menu. When set to false , users cannot display additional information about a specific visual data element using the radial menu.Type: boolean |
"EXPORT": false | When set to true , users can export a visual using the Export option from the visual drop-down menu. When set to false , they cannot export visuals.Type: boolean |
"FILTER": false | When set to true , users can filter visual data using the Filter option from the visual drop-down menu and to the left of the visual title. When set to false , they cannot filter visual data.Type: boolean |
"FILTER_ACTION": false | When set to Type: boolean |
"GROUPING": false | When set to true , users can change the Group field on the x-axis of the visual. When set to false , they cannot change the Group field.Type: boolean |
"KEYSET": false | When set to Type: boolean |
"KEYSET_ACTION": false | When set to |
"LINK_ACTION": false | When set to true , users can link to another dashboard using the Link option on the radial menu. When set to false , users cannot link to another dashboard using the Link option on the radial menu.Type: boolean |
"METRICS": false | When set to true , users can change metric fields (other than a metric that might be in the Group field) on the axes for the visual. This setting also controls whether a user can control the aggregation method (SUM, AVG, MIN, MAX, etc.) used for metrics in a table. When set to false , users cannot change metric fields or control the aggregation method used for metrics on a visual.Type: boolean |
"overrideVisualInteractivity": false | When set to When set to Type: boolean |
"REMOVE": false | When set to true , users can remove a visual using the Remove Visual option from the visual drop-down menu. When set to false , users cannot remove visuals.Type: boolean |
"RULERS": false | When set to When set to Type: boolean |
"SETTINGS": false | When set to When set to Type: boolean |
"SORT": false | When set to When set to Type: boolean |
"TIMEBAR_FIELD": false | When set to Type: boolean |
"TREND_ACTION": false | When set to Type: boolean |
"VISUAL_STYLE": false | When set to When set to Type: boolean |
"ZOOM_ACTION": false | When set to Type: boolean |
Comments
0 comments
Please sign in to leave a comment.