Skip to main content
Pentaho Documentation

Property

pentaho.visual.role. Property

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

A visual role is described by:

  1. modes
  2. isVisualKey.

AMD Module

require(["pentaho/visual/role/Property"], function(Property) { /* code goes here */ });

Extends

Constructor

Name Description
new Property()

This class was not designed to be constructed directly.

Members

Name Description
$type : pentaho.type.Type

Gets the type of this instance.

Methods

Name Description
toJSON() : JsonValue

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

toSpec(keyArgs) : any

Creates a top-level specification that describes this instance.

toSpecInContext(keyArgs) : any
Abstract

Creates a specification that describes this instance.

Constructor Details

new Property()

This class was not designed to be constructed directly.

Source: javascript/web/pentaho/visual/role/Property.js, line 45

Members Details

$type: pentaho.type.Type

Gets the type of this instance.

Source: javascript/web/pentaho/type/Instance.js, line 115

Overrides: pentaho.visual.role.AbstractProperty#$type

See also: pentaho.type.Instance.type , pentaho.type.Type#instance

Methods Details

toJSON() : JsonValue

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 197

Inherited From: pentaho.type.Instance#toJSON

Returns:
Name Description
JsonValue

A JSON-compatible specification.

See also: pentaho.type.Instance#toSpec

toSpec(keyArgs) : any

Creates a top-level specification that describes this instance.

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/Instance.js, line 159

Inherited From: pentaho.type.Instance#toSpec

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.

Parameters:
Name Default Value Summary
isJson : boolean
Optional
false

Generates a JSON-compatible specification. Attributes that 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

In the specification, forces inclusion of the inline type property: _.

Returns:
Name Description
any

A specification of this instance.

toSpecInContext(keyArgs) : any
Abstract

Creates a specification that describes this instance.

Source: javascript/web/pentaho/type/Instance.js, line 177

Inherited From: pentaho.type.Instance#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