Skip to main content

Pentaho+ documentation is moving!

The new product documentation portal is here. Check it out now at


Hitachi Vantara Lumada and Pentaho Documentation


pentaho.type.spec. IFunction

The spec.IFunction interface describes a function value in object form.

Source: doc-js/pentaho/type/spec/IFunction.jsdoc, line 17



Name Description
_ :  pentaho.type.spec.TypeReference

An inline type reference of the value's type.

f :  string

An alias for formatted.

formatted :  string

The formatted value.

v :  function | string

An alias for value.

value :  function | string

The underlying function value.

Members Details

_:  pentaho.type.spec.TypeReference

An inline type reference of the value's type.

Source: doc-js/pentaho/type/spec/IInstance.jsdoc, line 27

Inherited From: pentaho.type.spec.IInstance#_

f:  string

An alias for formatted.

Source: doc-js/pentaho/type/spec/ISimple.jsdoc, line 78

Inherited From: pentaho.type.spec.ISimple#f

formatted:  string

The formatted value.

When unspecified, or specified as a Nully or empty value, it is taken to be null.

Property f is an alias for this one.

Only one of f or formatted can be specified.

Source: doc-js/pentaho/type/spec/ISimple.jsdoc, line 56

Inherited From: pentaho.type.spec.ISimple#formatted

v:  function | string

An alias for value.

Source: doc-js/pentaho/type/spec/IFunction.jsdoc, line 53

Overrides: pentaho.type.spec.ISimple#v

value:  function | string

The underlying function value.

Property v is an alias for this one.

One and only one of v or value must be specified, non-Nully.

The value can be given as either a native JavaScript function or a string in the form of a function declaration (as would be returned by its toString method).

When serialized as JSON, the result of calling its toString() method is used.

Attention: Native functions are serialized as if they were a null value (e.g. String, or resulting from Function#bind.

Also, note that any functions that capture variables from their surrounding scopes (other than the global scope) cannot be properly de-serialized back. Only stateless functions can be properly serialized and de-serialized.

Source: doc-js/pentaho/type/spec/IFunction.jsdoc, line 26

Overrides: pentaho.type.spec.ISimple#value