Skip to main content
Pentaho Documentation

Level

pentaho.visual.color.Level

The Level class is String based enumeration that represents a Level of Measurement, as understood by S. S. Steven and as applied to the visual representation capabilities of a color palette.

Currently, the following color palette levels of measurement are supported:

  • nominal - A qualitative measurement level. The lowest in the hierarchy of levels of measurement. A nominal color palette can represent data visually while preserving the distinction between different things and also, possibly, enabling easy association of different, but somehow similar, things. However, a nominal color palette represents data in a way that conveys no preferential order between the various things.

    See pentaho.visual.color.palettes.nominalPrimary for an example of a nominal color palette.

  • quantitative - Aggregates the interval and ratio levels of measurement, the highest in the hierarchy of levels of measurement. A quantitative color palette can represent data visually while preserving the order between different things. Additionally, it can represent the proportion between quantities (ratios), or, at least, the proportion between differences of quantities (intervals).

    See pentaho.visual.color.palettes.quantitativeGray5 for an example of a quantitative color palette.

  • divergent — A mixed type of color palette that can represent quantitative data while clearly dividing it in two "nominal" regions, separated by a reference value (typically zero).

    See pentaho.visual.color.palettes.divergentRyg5 for an example of a divergent color palette.

AMD Module

require(["pentaho/visual/color/level"], function(Level) { /* code goes here */ });

See also:  pentaho.visual.color.Palette#level , pentaho.visual.color.PaletteProperty.Type#levels , pentaho.visual.role.Level

Extends

Constructor

Name Description
new Level()

Classes

Name Summary
Type

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

Members

Name Description
$isValid : boolean

Determines if this value is a valid instance of its type.

$key : string

Gets the key of the simple value.

$type : pentaho.type.Value.Type

Gets the type of this instance.

configure

Configures this value with a given configuration.

formatted : string

Gets or sets the formatted value of the property.

value : string

Gets the underlying string primitive value of the value.

Methods

Name Description
_configure(config)
 
Protected

Configures this value with a given non-nully configuration.

_toJSONValue(keyArgs) : UJsonValue
 
Protected

Converts the value of the simple instance to a JSON-compatible representation.

assertValid()

Ensures that the value is valid, and throws the first validation error if it is not.

clone() : pentaho.type.Simple

Creates a clone of the simple value.

equals(other) : boolean

Determines if a given value, of the same type, represents the same entity.

equalsContent(other) : boolean

Determines if a given value, of the same type, represents the same entity with the same content.

toJSON() : UJsonValue

Creates a top-level JSON specification that describes this instance.

toSpec(keyArgs) : pentaho.type.spec.UInstance

Creates a specification that describes this value.

toSpecInContext(keyArgs) : any

Creates a specification that describes this instance.

toString() : String

Returns a string that represents the current simple value.

validate() : Array.<pentaho.type.ValidationError>

Determines if this value is a valid instance of its type.

valueOf() : *

Gets the underlying primitive value of the simple value.

Constructor Details

new Level()

Source: javascript/web/pentaho/visual/color/level.js, line 31

See also:  pentaho.visual.color.Palette#level , pentaho.visual.color.PaletteProperty.Type#levels , pentaho.visual.role.Level

Members Details

$isValid: boolean

Determines if this value is a valid instance of its type.

This attribute calls validate and returns a boolean value indicating if it returned no errors.

Source: javascript/web/pentaho/type/value.js, line 123

Inherited From: pentaho.type.Value#$isValid

$key: string

Gets the key of the simple value.

The key of a value identifies it among values of the same concrete type.

If two values have the same concrete type and their keys are equal, then it must also be the case that pentaho.type.Value.Type#areEqual returns true when given the two values. The opposite should be true as well. If two values of the same concrete type have distinct keys, then pentaho.type.Value.Type#areEqual should return false.

The default simple value implementation, returns the result of calling toString() on pentaho.type.Simple#value.

Source: javascript/web/pentaho/type/simple.js, line 198

Inherited From: pentaho.type.Simple#$key

$type: pentaho.type.Value.Type

Gets the type of this instance.

Source: javascript/web/pentaho/type/value.js, line 246

Overrides: pentaho.type.mixins.DiscreteDomain#$type

configure:

Configures this value with a given configuration.

If config is Nully, it is ignored.

If config is a plain object, its properties, v, f, value and formatted are set on this simple's corresponding properties. It is an error if the properties v or value contain a primitive value which is different from of this simple.

If config is another simple value, it can be of any simple type. However, its primitive value must be the same as that of this simple. If the formatted value of config is not Nully, it updates this simple's formatted value.

An error is thrown if config is of another type.

Source: javascript/web/pentaho/type/simple.js, line 224

Inherited From: pentaho.type.Simple#configure

formatted: string

Gets or sets the formatted value of the property.

Source: javascript/web/pentaho/type/simple.js, line 141

Inherited From: pentaho.type.Simple#formatted

value: string

Gets the underlying string primitive value of the value.

Source: javascript/web/pentaho/type/string.js, line 35

Inherited From: pentaho.type.String#value

Methods Details

_configure(config)
 
Protected

Configures this value with a given non-nully configuration.

The default implementation does nothing.

Source: javascript/web/pentaho/type/value.js, line 178

Inherited From: pentaho.type.Value#_configure

Parameters:
Name Default Value Summary
config : any

The configuration.

_toJSONValue(keyArgs) : UJsonValue
 
Protected

Converts the value of the simple instance to a JSON-compatible representation.

The default implementation returns value itself. Override to implement a custom JSON format for this simple value type.

Source: javascript/web/pentaho/type/simple.js, line 361

Inherited From: pentaho.type.Simple#_toJSONValue

Parameters:
Name Default Value Summary
keyArgs : Object

The keyword arguments object. Please see the documentation of subclasses for information on additional, supported keyword arguments.

Returns:
Name Description
UJsonValue

A JSON-compatible representation of value.

assertValid()

Ensures that the value is valid, and throws the first validation error if it is not.

This method calls the validate method.

Source: javascript/web/pentaho/type/value.js, line 152

Inherited From: pentaho.type.Value#assertValid

Throws:
Name Description
pentaho.type.ValidationError

When the value is not valid, the first error returned by the validate method.

clone() : pentaho.type.Simple

Creates a clone of the simple value.

Source: javascript/web/pentaho/type/simple.js, line 89

Inherited From: pentaho.type.Simple#clone

Returns:
Name Description
pentaho.type.Simple

The simple value clone.

equals(other) : boolean

Determines if a given value, of the same type, represents the same entity.

The default implementation delegates the operation to the _isEqual method.

Source: javascript/web/pentaho/type/value.js, line 107

Inherited From: pentaho.type.Value#equals

Parameters:
Name Default Value Summary
other : any

A value to test for equality.

Returns:
Name Description
boolean

true if the given value is equal to this one; or, false, otherwise.

See also:  pentaho.type.Value#$key , pentaho.type.Value.Type#areEqual

equalsContent(other) : boolean

Determines if a given value, of the same type, represents the same entity with the same content.

The given value must be of the same concrete type (or the result is undefined).

If two values are equal, they must have an equal key, value, formatted value.

Source: javascript/web/pentaho/type/simple.js, line 213

Inherited From: pentaho.type.Simple#equalsContent

Parameters:
Name Default Value Summary
other : pentaho.type.Simple

A simple value to test for equality.

Returns:
Name Description
boolean

true if the given simple value is equal to this one; false, otherwise.

toJSON() : UJsonValue

Creates a top-level JSON specification that describes this instance.

Attributes which do not have a JSON-compatible specification are omitted. Specifically, for inline types, attributes with a function value are not supported.

This method simply calls pentaho.type.Instance#toSpec with argument keyArgs.isJson as true and exists for seamless integration with JavaScript's JSON.stringify method.

Source: javascript/web/pentaho/type/instance.js, line 210

Overrides: pentaho.type.mixins.DiscreteDomain#toJSON

Returns:
Name Description
UJsonValue

A JSON-compatible specification.

See also:  pentaho.type.Instance#toSpec

Implements:
toSpec(keyArgs) : pentaho.type.spec.UInstance

Creates a specification that describes this value.

If an ambient specification context, currently exists, it is used to manage the serialization process. Otherwise, one is created and set as current. Then, the actual work is delegated to pentaho.type.Instance#toSpecInContext.

Source: javascript/web/pentaho/type/value.js, line 184

Overrides: pentaho.type.mixins.DiscreteDomain#toSpec

Parameters:
Name Default Value Summary
keyArgs : Object
 
Optional

The keyword arguments object. Passed to every value and type serialized within this scope.

Please see the documentation of value subclasses for information on additional, supported keyword arguments.

Parameters:
Name Default Value Summary
isJson : boolean
 
Optional
false

Generates a JSON-compatible specification. Attributes which do not have a JSON-compatible specification are omitted.

declaredType : pentaho.type.Type
 
Optional

The base type of this value's storage location. If the value does not have this exact type, its inline type property must be included in the specification. Otherwise, it can be omitted. When unspecified, the inline type property is only included if forceType is true.

forceType : boolean
 
Optional
false

Forces inclusion of the inline type property, _, in the specification.

omitFormatted : boolean
 
Optional
false

Omits the formatted value on Simple values' specifications.

preferPropertyArray : boolean
 
Optional
false

Indicates that, if possible, array form is used for Complex values' specifications.

The array form of a complex value cannot be used when its type must be inlined.

includeDefaults : boolean
 
Optional
false

When true, all of the properties of Complex values are serialized. When false, the default, only properties whose value is different from their default value are serialized.

Only applies to complex values that are serialized in object form. In array form, all of the properties of complex values are serialized independently of their value.

omitProps : Object
 
Optional

An object whose own property names with a truthy value are the names of the properties of the current complex type to omit from the serialization.

Only applies when a complex is output in object form. In array form, all properties are output whatever their value.

This argument only applies to complex values and is not passed through to the values of their properties.

Returns:
Name Description
pentaho.type.spec.UInstance

A specification of this value.

toSpecInContext(keyArgs) : any

Creates a specification that describes this instance.

Source: javascript/web/pentaho/type/instance.js, line 190

Overrides: pentaho.type.mixins.DiscreteDomain#toSpecInContext

Parameters:
Name Default Value Summary
keyArgs : Object
 
Optional

The keyword arguments' object. Passed to every instance and type serialized within this scope.

Please see the documentation of subclasses for information on additional, supported keyword arguments.

Returns:
Name Description
any

A specification of this instance.

See also:  pentaho.type.Instance#toSpec

toString() : String

Returns a string that represents the current simple value.

Source: javascript/web/pentaho/type/simple.js, line 174

Inherited From: pentaho.type.Simple#toString

Returns:
Name Description
String

The string representation.

validate() : Array.<pentaho.type.ValidationError>

Determines if this value is a valid instance of its type.

The default implementation delegates to pentaho.type.Value.Type#_validate.

Source: javascript/web/pentaho/type/value.js, line 137

Inherited From: pentaho.type.Value#validate

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

A non-empty array of errors or null.

See also:  pentaho.type.Value#$isValid

valueOf() : *

Gets the underlying primitive value of the simple value.

Source: javascript/web/pentaho/type/simple.js, line 165

Inherited From: pentaho.type.Simple#valueOf

Returns:
Name Description
*

The underlying value.