Skip to main content
Hitachi Vantara Lumada and Pentaho Documentation

Visualization API


The visual namespace contains the types that constitute the Pentaho Visualization API.


The Visualization API provides a unified way to visualize data across the Hitachi Vantara suite (e.g. Analyzer, PDI, CDF).

Essentially, it is a set of abstractions that enables safe, isolated operation between applications, visualizations and business logic.

A visualization is constituted by:

  • One Model, which identifies the visualization and defines it in terms of its data requirements, such as the visual degrees of freedom it has (e.g. X position, color and size) and any major options that affect its rendering.

  • One View (at least), which implements the actual rendering using chosen technologies (e.g. HTML, SVG, D3), and handle user interaction, dispatching actions and, for example, showing tooltips. The standard data actions are Select and Execute.

The Visualization API is built on top of other Platform JavaScript APIs:

  • The Data API ensures seamless integration with data sources in the Pentaho platform, as well as with other client-side component frameworks.

  • The Type API provides to visualizations out-of-the-box features such as class inheritance, metadata support, configuration, validation and serialization.

  • The Core APIs provide to visualizations features such as localization, theming and service registration and consumption.

A set of stock visualizations is included, covering the most common chart types. Based on the CCC charting library, they're customizable and extensible to fit your organization's desired look and feel.

Source: doc-js/pentaho/visual/_namespace.jsdoc, line 17

Child Namespaces

Name Summary

The action namespace contains the standard action types used by visualizations.


The base namespace contains the types used to define the base visualization.


The color namespace contains color-related classes and utilities.


The role namespace contains classes for describing visual roles — an important type of property of visualization models.


The visual.spec namespace contains specification interfaces and type definitions.