Skip to main content
Pentaho Documentation

Type

pentaho.visual.color.PaletteProperty.Type

The type class of pentaho.visual.color.PaletteProperty.

Extends

  • pentaho.type.PaletteProperty.Type

Constructor

Name Description
new Type()
 
Static

Members

Name Description
levels : pentaho.type.List.<pentaho.visual.color.Level>

Gets or sets the array of possible measurement levels of color palettes that are set on this property.

Methods

Name Description
__collectOtherUsedPalettesIdsOn(owner) : Object.<string, boolean>

Gets a set of used palette identifiers on the given owner.

_fillSpecInContext()
validateOn(model) : Array.<pentaho.type.ValidationError>

Determines if this color palette property is valid on the given visualization model.

Constructor Details

new Type()
 
Static

Source: javascript/web/pentaho/visual/color/paletteProperty.js, line 36

Members Details

levels: pentaho.type.List.<pentaho.visual.color.Level>

Gets or sets the array of possible measurement levels of color palettes that are set on this property.

This attribute is Monotonic

The value of a monotonic attribute can change, but only in some, predetermined monotonic direction.

In this case, a measurement level can be removed from a color palette property, but one cannot be added.

This attribute is Inherited

When there is no local value, the effective value of the attribute is the inherited effective value.

The first set local value must respect the monotonicity property with the inherited value.

Other characteristics

When set to a Nully value, the set operation is ignored.

The root visual.color.PaletteProperty has a levels attribute which is the list of all possible color palette measurement levels.

The returned array or its elements should not be modified.

Source: javascript/web/pentaho/visual/color/paletteProperty.js, line 145

Methods Details

__collectOtherUsedPalettesIdsOn(owner) : Object.<string, boolean>

Gets a set of used palette identifiers on the given owner.

Source: javascript/web/pentaho/visual/color/paletteProperty.js, line 94

Parameters:
Name Default Value Summary
owner : pentaho.type.Complex

The owner complex.

Returns:
Name Description
Object.<string, boolean>

The set of used identifiers.

_fillSpecInContext()

Source: javascript/web/pentaho/visual/color/paletteProperty.js, line 222

validateOn(model) : Array.<pentaho.type.ValidationError>

Determines if this color palette property is valid on the given visualization model.

If generic property validation fails, those errors are returned.

Otherwise, validity is further determined as follows:

  1. The current palette value must have a level which is one of the property's allowed levels.

Source: javascript/web/pentaho/visual/color/paletteProperty.js, line 191

Parameters:
Name Default Value Summary
model : pentaho.visual.base.Model

The visualization model.

Returns:
Name Description
Array.<pentaho.type.ValidationError>

A non-empty array of ValidationError or null.