Interactivity Profile Overrides
The interactivityProfileName
property must be specified before the interactivity overrides (interactivityOverrides
object) can work. See Embedded Dashboard Properties and Objects.
The interactivityOverrides
object includes several property settings: visualSettings
, InteractivityValue
and editorUserSettings
.
-
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 Parameters (visualSettings Property). -
The parameters of the
InteractivityValue
property define the source inventory dashboard. See Sources Inventory Interactivity Parameters (InteractivityValue Property) . -
The parameters of the
editorUserSettings
property define the editor configuration dashboard. See Editor Configuration (editorUserSettings 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
When set to Type: boolean
If all menu item parameters are |
"CHANGE_LAYOUT": true
|
When set to Type: boolean |
"COMMENTS": true
|
When set to Type: boolean |
"CREATE_FILTER_SNIPPETS": false
|
When set to Type: boolean
If all menu item parameters are |
CREATE_SNIPPETS
|
Deprecated. Use |
"CREATE_TEXT_SNIPPETS": false
|
When set to Type: boolean
If all menu item parameters are |
"CREATE_VISUALS": false
|
When set to
When set to Type: boolean
If all menu item parameters are |
"DASHBOARD_ALERTS": false
|
When set to true , users with appropriate privileges can create and edit dashboard alerts using the dashboard icon . When set to false ,the dashboard icon is hidden and users cannot create or edit dashboard alerts. |
"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 icon is not available in the UI. |
"DASHBOARD_LINKS": true
|
When set to Type: boolean |
"DELETE": true
|
When set to Type: boolean |
EXPORT
|
Deprecated. Use EXPORT_CSV , EXPORT_PNG_PDF and EXPORT_XLSX . |
"EXPORT_CONFIGURATION": true
|
When set to Type: boolean |
"EXPORT_CSV": true
|
When set to Type: boolean |
"EXPORT_PNG_PDF": true
|
When set to Type: boolean |
"EXPORT_XLSX": 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_AS": true
|
When set to Type: boolean |
"SAVE": true
|
When set to Type: boolean |
"SCHEDULE_REPORTS": true
|
When set to Type: boolean |
"SHARE_DASHBOARD": true
|
When set to Type: boolean |
"SHARE_FILTER_SETS": true
|
When set to Type: boolean |
"WIDGETS": true
|
When set to Type: boolean |
Visual Interactivity Parameters (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.
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 |
"CONDITIONAL_FORMATTING": 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 context menu. When set to false , users cannot display additional information about a specific visual data element using the context menu.Type: boolean |
EXPORT
|
Deprecated. Use EXPORT_CSV , EXPORT_PNG_PDF and EXPORT_XLSX . |
"EXPORT_CSV": false
|
When set to Type: boolean |
"EXPORT_PNG_PDF": false
|
When set to Type: boolean |
"EXPORT_XLSX": false
|
When set to 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 name on a visual, or display name if viewed in a dashboard. When set to false , they cannot filter visual data. Type: boolean |
"FILTER_ACTION": false
|
When set to Type: boolean |
"FORMAT": false
|
When set to true , users can Format specific data in a visual. When set to false , they cannot format visual data.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 |
"INFO": false
|
When set to true , users can see visual details in the Info sidebar menu. When set to false , they cannot see those details.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 context menu. When set to false , users cannot link to another dashboard using the Link option on the context menu.Type: boolean |
"MAXIMIZE": false
|
When set to true , users can maximize a visual for optimal viewing. When set to false , they cannot maximize a visual.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 |
"RENAME": false
|
When set to true , users can change the display name of a visual. When set to false , they cannot change the display name of visual.Type: boolean |
"RULERS": false
|
When set to When set to Type: boolean |
"SAVE_AS": false
|
When set to Type: boolean |
"SAVE": false
|
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 |
"TIMEBAR_PANEL": 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 |
Sources Inventory Interactivity Parameters (InteractivityValue
Property)
Use the InteractivityValue
property to specify interactivity parameters for the sources inventory.
Parameter | Description |
---|---|
"ADD_NEW": true
|
When set to Type: boolean |
"FILTER": true
|
When set to Type: boolean |
"DELETE": true
|
When set to When set to Type: boolean |
"DESCRIPTION": true
|
When set to When set to Type: boolean |
"EXPORT": true
|
When set to When set to Type: boolean |
"PERMISSIONS": false
|
When set to true , users can manage user and group permissions for data sources. When set to false , they cannot manage permissions for data sources, and the related icons are not visible in the UI.Type: boolean |
"FAVORITES": true
|
When set to Type: boolean |
"ROW_SECURITY": false
|
When set to true , users can define row security for data sources. When set to false , they cannot define row security for data sources, and the related icons are not visible in the UI.Type: boolean |
"COLUMN_SECURITY": false
|
When set to true , users can define column security for data sources. When set to false , they cannot define column security for data sources, and the related icons are not visible in the UI.Type: boolean |
"CLEAR_CACHE": true
|
When set to Type: boolean |
"AVAILABLE_VISUAL_TYPES": true
|
When set to true , users invoke the Available Visual Types work area to enable and disable available visual types for a source. When set to false , they cannot affect available visual types, or see related icons are not visible in the UI.Type: boolean |
Editor Configuration (editorUserSettings
Property)
Use the editorUserSettings
property to configure the interactivity parameters for the dashboard.
{ "type": "dashboard", editorUserSettings: { isViewMode: true, canSwitchMode: false, allowInteractivityConfiguration: false, } }
Parameter | Description |
---|---|
isViewMode
|
When set to Type: boolean Default: |
canSwitchMode
|
When set to Type: boolean Default: |
allowInteractivityConfiguration
|
When set to Type: boolean Default: |