User Guide Getting Started Help Center Documentation Community Training
Looker
  
English
Français
Deutsch
日本語
Admin Settings - Visualizations

Looker includes a robust list of native visualization types, letting you chart your data in a variety of ways. If you need a type of chart that is not included in Looker’s native visualization types, you can add custom JavaScript visualizations.

Custom visualizations are a community supported effort. Looker’s support team does not troubleshoot issues relating to custom visualizations or your custom visualization code. For tracking and closing out bugs, please use GitHub issues in the custom visualization’s repository, or visit Looker’s Community Forums for how-to articles, conversations, and tips regarding custom visualizations.

Use the Visualizations page in Looker’s Admin panel to install and administer custom JavaScript visualizations. To see the Visualizations page, you must enable the Sandboxed Custom Visualizations Labs feature. To ensure full functionality of downloaded visualizations, admins for customer-hosted deploys should make sure to install the Chromium renderer.

You can find a list of Looker’s Viz Blocks in Looker’s Blocks Directory. Looker also maintains a library of custom visualizations for public use on GitHub. You can find instructions for using Looker’s Visualization API to create your own visualization types here.

Viewing a List of Custom Visualizations

The Visualizations page in Looker’s Admin panel lists all of the custom visualizations that have been added to your Looker instance:

The list includes the following columns:

Adding a New Custom Visualization Manifest

To use a custom visualization with Looker, you must configure a visualization manifest that points Looker to your JavaScript code repository.

To configure a new visualization manifest, click the Add Visualization button in the upper left corner of the page.

Looker displays the New Visualization page:

  1. In the ID field, enter the unique ID of the visualization defined in the visualization JavaScript.

  2. In the Label field, enter the name of the visualization that will be displayed in the Looker visualization menu. For example, this is how Looker displays a custom visualization labeled “Sankey”:

  3. In the Main field, enter the URI of the visualization’s main JavaScript file.

  4. If the site hosting your custom visualization code uses a subresource integrity (SRI) hash for verification purposes, enter the SRI hash in the SRI Hash field. This field can be found under Advanced options.

  5. In the Dependencies field, enter the URIs of any other files that the visualization JavaScript is dependent upon, and click Add. You can enter multiple URIs separated by commas, or you can add multiple URIs one at a time. The Dependencies field can be found under Advanced options.

  6. Click Save.

Once added, you will see the visualization in the visualization menu in an Explore, and can use the new visualization type just like any of Looker’s existing visualization types.

Editing a Custom Visualization Manifest

To edit an existing visualization manifest, click the Edit button to the right of the visualization. Looker displays the same page that you use to add a visualization manifest (described above), but with the relevant information already filled in. Make any desired changes, then click Save.

Deleting a Custom Visualization Manifest

To delete a visualization manifest, click the Delete button to the right of the visualization and then click OK in the confirmation box. This removes the visualization from Looker, but will not affect anything in the visualization’s external code repository.

Deleting a visualization manifest disables any Looks or dashboards that use that visualization type. You can correct that by adding back the deleted visualization manifest with the same visualization ID.

Migrating Custom Visualizations

Any custom visualizations stored in the ~/looker/plugins/visualizations directory on your Looker instance must be migrated to the new custom visualization format.

You will see a Migrate Existing Visualizations button in the top left corner of the Edit Visualization page if all of the following are true:

Click the Migrate Existing Visualizations button to have Looker update your existing configurations to the format required for Looker 5.14.

The migration process adds several JavaScript files as dependencies in the new visualization manifests. If your custom visualization requires additional dependencies, edit the visualization manifest to add the dependent file URIs.

After migrating your configurations and adding any additional dependencies, your prior visualization types appear in the visualization list.

Top