Control How Users Interact With a Visual

You can control how users can interact with a visual. You can control their ability to:

  • Change metrics, rulers, colors, visual styles, or otherwise modify a visual
  • Group, filter, or sort visual data
  • Use radial menu options
  • Copy, export, or delete the visual
  • Create keysets from visual data
  • Export visual data
  • Integrate a visual into external applications
  • Change the defaults set for a visual in the data source configuration visual defaults.

Visual interactivity settings are useful in embedded use cases where the analytic on the parent application page needs to behave in a consistent manner with the rest of the application. These controls are managed on the interactivity sidebar for the visual.

You can control user interactivity using the interactivity sidebar of a visual from the Visual Gallery.

Individual visual interactivity settings can be overridden by dashboard interactivity settings. When a dashboard overrides the interactivity settings specified for an individual visual, the visual's interactivity settings are not changed, but they are ignored, and the visual interactivity settings specified by the dashboard are used.

To control user interactions with a visual:

  1. Select the visual in the Visual Gallery.

  2. Select the interactivity option () on the sidebar menu for the visual. The interactivity sidebar opens.

    By default, all interactivity settings are activated (on) for a visual. Each interaction is controlled by a switch. Slide the switches to the right to turn a setting on; slide them to the left to turn the setting off.

    In addition, you can use the Preview Interactivity Settings option to test the visual interactivity settings. When this switch is turned on, the visual behaves as it will when it is embedded. The Preview Interactivity Settings switch is a temporary switch: by default it is off each time you access the visual. It is not saved with the visual; so if you turn it on and save the visual, it will still be off the next time you edit the visual.

    Each visual interactivity setting is described in the following table.

    Visual Feature Group UI Setting JavaScript Setting Controls the ability to...
    Data Interactivity Metrics METRICS 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.
    Group GROUPING Change the Group field on the x-axis of the visual. This setting also controls whether a user can group tables.
    Filter FILTER Filter data using the Filter option from the visual drop-down menu and to the left of the visual title. (To fully remove filtering functionality for a visual, be sure to turn off the Filter switch in the Radial Menu settings on the interactivity sidebar too.)
    Sort SORT Sort and limit the data in a visual. The sort and limit () visual sidebar menu option is disabled when this switch is off and you cannot access the Sort & Limit sidebar.
    Radial Menu Zoom ZOOM_ACTION Zoom into a selected data point on a visual using the Zoom option on the radial menu.
    Filter FILTER_ACTION Filter data using the Filter option on the radial menu. (To fully remove filtering functionality for a visual, be sure to turn off the Filter switch in the Data Interactivity settings on the interactivity sidebar too.)
    Details DETAILS_ACTION Display additional information about a specific visual data element using the Details option on the radial menu.
    Trend TREND_ACTION View trends for a selected data point using the Trend option on the radial menu.
    Keyset KEYSET_ACTION Create a keyset from a selected data point using the Keyset option on the radial menu. (To fully remove keyset functionality for a visual, be sure to turn off the Create Keyset switch in the Visualization settings on the interactivity sidebar too.)
    Actions ACTIONS_ACTION Invoke an action using the Actions option on the radial menu. (To fully remove actions functionality for a visual, be sure to turn off the Actions switch in the Visualization settings on the interactivity sidebar too.)
    Link LINK_ACTION Link to another dashboard using the Link option on the radial menu.
    Visualization Settings SETTINGS Specify settings for the visual. The visual settings () visual sidebar menu option is disabled when this switch is off and you cannot access the visual settings sidebar.
    Rulers RULERS Add visual reference lines and customize the markers used on the metric axis. The ruler settings () sidebar menu option is disabled when this switch is off and you cannot access the ruler sidebar.
    Colors COLORS Change the color palette used by the visual. The color settings () visual sidebar menu option is disabled when this switch is off and you cannot access the color sidebar.
    Create Keyset KEYSET Create a keyset from the visual data using the Create Keyset option from the visual drop-down menu. (To fully remove keyset functionality for a visual, be sure to turn off the Keyset switch in the Radial Menu settings on the interactivity sidebar too.)
    Copy COPY Copy a visual using the Copy Visual option from the visual drop-down menu.
    Export EXPORT Export a visual using the Export option from the visual drop-down menu.
    Actions ACTIONS Invoke an action using the Actions option from the visual drop-down menu. (To fully remove actions functionality for a visual, be sure to turn off the Actions switch in the Radial Menu settings on the interactivity sidebar too.)
    Remove REMOVE Remove a visual using the Remove Visual option from the visual drop-down menu.
    Visual Style VISUAL_STYLE Change the style of a visual. The visual style settings () visual sidebar menu option is disabled when this switch is off and you cannot access the visual type sidebar.
    Select Time Bar Field TIMEBAR_FIELD Change the time field on the time bar.
    Maximize MAXIMIZE Maximize a visual for optimal viewing.
    Rename RENAME Rename a visual.
    Show Time Bar Panel TIMEBAR_PANEL Show the time bar for the visual.
  3. Slide the switches on or off for the interactivity settings you want to change.

  4. Optionally, preview the behavior with the interactivity settings applied. Slide the Preview Interactivity Settings switch on (to the right).

  5. Select to save the visual.