Use a local data instance with a data visualization

For finer grained control of the data source than you have with preconfigured data sources, create a local data instance. Then bind the local data instance to the dataPassthrough property of the data visualization.

Before you begin

Important:

This is an advanced procedure. Consider carefully whether you need a local data instance or can use a standard data source.

Before proceeding, review Dynamically expose data in UI Builder pages (advanced feature).

Role required: ui_builder_admin, admin

Procedure

1. Open the technical dashboard or other UI Builder page in UI Builder.
2. In the Data and scripts drawer, under Data resources, select + Add data resource.
   
   
   
3. In the Select a data resource window, search for Data visualization.
   You get a selection of the data resources you can use.
   
   
4. Select a data resource that matches the type of data you want to show.
5. Read through the information pane and copy or take notes on the configuration details.
6. Select Add.
7. Complete the configuration options that you need for the type of visualization with which you plan to use this data instance.
   Create and configure a separate local data instance for every type of visualization that you want to use the same data. For example, if you plan to have a bar and a time series that show scores from the same indicator, create two local data instances: one each for bar and time series visualizations, but both on the same indicator.

   Tip:

   You can add the data visualization to the page and compare its configuration panel to the options for the local data instance.
8. Copy the @data data bind for this data source.
   
   
   
9. Add the desired data visualization component to the page.
10. In the configuration panel for that data visualization, in the Data sources section, turn on Define data manually.
11. For the Data field, select Bind data or use scripts.
    
    
    
12. In the Bind data to Data dialog, under Data types, select Data resource.
13. Double-click in the Add a data output to this area section and paste the data bind to your local data instance into the blue box.
14. Append .output.result at the end of the data bind.
    For example, the completed data bind to the local data instance data_visualization_api_for_table_data_source_1 is @data.data_visualization_api_for_table_data_source_1.output.result.
    
    
15. Select Apply.

Result

You have created a local data instance and bound it to a data visualization. You can now complete the configuration of your data visualization.

• Enable filters to apply to a local data instance
  To enable a viewer to switch between which field values or breakdown elements they see in a data visualization, add filter components to the UI Builder page. For those filters to apply to a local data instance, configure that instance accordingly.
• Enable data caching for a local data instance
  To help reduce the load time of data visualizations, and if real time or very fresh data is not necessary, enable data caching on the data source.
• Local data instances for multiple data visualizations
  A special Data Visualization API data resource is available to fetch data for multiple data visualizations simultaneously. This data resource reduces the number of API calls and thus can speed up data fetching.