Skip to main content

Pentaho+ documentation has moved!

The new product documentation portal is here. Check it out now at


Hitachi Vantara Lumada and Pentaho Documentation

Visualization API

Parent article

The Visualization API 3.0 provides a unified way to visualize data across the Pentaho suite, including Analyzer, PDI, and CDF. This API allows for safe and isolated operation between applications, visualizations, and business logic including those of third parties.

The Visualization API 3.0 is built on top of the following Pentaho Platform JavaScript APIs:

  • Data API

    provides seamless integration with data sources in the Pentaho platform, as well as with other client-side component frameworks.

  • Type API

    Provides out-of-the-box features such as class inheritance, metadata support, validation, and serialization.

  • Core APIs

    Provide underlying core features such as localization, theming and services registration, and consumption.

A set of stock visualizations is included to cover the most common chart types. Based on the CCC charting library, these stock visualizations are customizable and extensible to fit your organization’s desired look and feel.

If you want to know more about how Visualization API 3.0 has changed from Visualization API 2.0, see Moving to Visualization API 3.0.

The following steps highlight how to use Visualization API 3.0 for the Pentaho platform through a sample visualization:

  1. Create a visualization
  2. Deploy the visualization
  3. Configure the visualization

Create a visualization

You create a visualization by defining the following classes:

  • Model class

    identifies the visualization and defines it in terms of its data requirements, such as the visual degrees of freedom it has (x position, color, and size for example) and any major options that affect its rendering.

  • IView class

    implements the actual rendering using chosen technologies, such as HTML, SVG, D3, and handles user interaction by dispatching actions including selection, drilling-down, and showing a tooltip.

The following walk-through tutorial guides you through the creation of a custom visualization for the Pentaho platform:

  1. Develop a visualization in a sandbox
  2. Create the Pentaho web package

Deploy the visualization

After creating your visualization, deploy it to a Pentaho product, such as the Pentaho Server or PDI.

Learn more

Configure the visualization

Your deployed visualization can be configured by third parties using configuration rules in external configuration files. These configurations are merged with default configurations included with the visualization.

Learn more