Skip to main content
Pentaho Documentation

role

pentaho.visual. role

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

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

Child Namespaces

Name Summary
adaptation

The adaptation namespace contains classes for describing visual role adaptation strategies between external and internal visual models.

scene

The scene namespace contains classes for describing visual scenes.

spec

The visual.role.spec namespace contains specification classes for describing visual role mappings.

util

The util namespace contains functions for common tasks around dealing with visual roles.

Classes

Name Summary
AbstractMapping

The AbstractMapping class is the base class for associations between a visual role and data fields of a visualization's current data set.

AbstractMappingType

The type class of pentaho.visual.role.AbstractMapping.

AbstractProperty

The AbstractProperty class is the base class of properties that represent a visual role of a visualization and defines its capabilities.

AbstractPropertyType

The type class of pentaho.visual.role.AbstractProperty.

Mapping

The Mapping class holds the association between a specific visual role and the data fields of a model's current data set, as seen internally to the visualization, by the view.

MappingField

The MappingField class represents a field in a visual role mapping.

MappingType

The type class of pentaho.visual.role.Mapping.

Mode

The Mode class describes a specific operating mode of a visual role in terms of the data type of its value and of the type of scale, continuous or categorical, used to encode it.

ModeType

The type class of pentaho.visual.role.Mode.

Property

The Property class represents a visual role of a visualization and defines its capabilities.

PropertyType

The type class of pentaho.visual.role.Property.

Interfaces

Name Summary
IAddUsage

The IAddUsage interface exposes information about the result of a hypothetical, valid add operation, of a field to a visual role.

IFieldsConstraints

The IFieldsConstraints interface exposes metadata information about the fields of visual roles' mappings.

IFieldsMetadata

The IFieldsMetadata interface exposes metadata information about the fields of visual roles' mappings.