Skip to main content
Hitachi Vantara Lumada and Pentaho Documentation

base

pentaho.visual. base

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

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

Child Namespaces

Name Summary
spec

The visual.base.spec namespace contains specification interfaces for the base visual types.

Classes

Name Summary
AbstractModel

The AbstractModel class is the abstract base class of visualization models.

AbstractModelType

The type class of pentaho.visual.base.AbstractModel.

Application

The base class of visual applications.

ApplicationType

The base type class of visual application types.

Model

The Model class is the base class of internal models of visualizations.

ModelType

The base class of visual model types.

View

This is the base class for views of visualizations.

ViewType

The base class of view types.

Members

Name Description
KeyTypes : string

The KeyTypes enum is the class of names of visual key types.

Members Details

KeyTypes: string

The KeyTypes enum is the class of names of visual key types.

The type of visual key determines how a visualization identifies the rendered visual elements.

Properties:
Name Default Value Description
dataOrdinal : string dataOrdinal

In visualizations having this type of visual key, visual elements are identified by the ordinal of the corresponding data row, possibly with the add of the values of some of the fields (used, for example, for splitting data between multiple small charts).

Typically, a Flat Table or a Scatter chart has this type of visual key.

dataKey : string dataKey

In visualizations having this type of visual key, visual elements are identified by the values of the key columns of the corresponding data row.

Typically, a Bar chart or Line chart has this type of visual key.

When a visualization has this type of visual key, the key fields of the provided data must be exactly the fields mapped to key visual roles (isVisualKey).

Source: javascript/web/pentaho/visual/base/KeyTypes.js, line 30