Skip to main content
Hitachi Vantara Lumada and Pentaho Documentation

IMappingAttribute

pentaho.visual.role.spec.IMappingAttribute

The spec.IMappingAttribute interface describes the object form of a visual role mapping attribute instance.

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

See also:  pentaho.visual.role.spec.IMapping , pentaho.visual.role.spec.UMappingAttribute

Extends

Examples

{
 name: "sales",
 aggregation: "sum"
}
{
 name: "product",
 isReverseOrder: true
}

Members

Name Description
_ : pentaho.type.spec.UTypeReference

An inline type reference of the value's type.

aggregation : string

The aggregation that is performed on the data property.

isReverseOrder : boolean

Indicates if the data property contributes to the default order of an ordinal visual role mapping by using the reverse natural order of the data property.

name : string

The name of the data property.

Members Details

_: pentaho.type.spec.UTypeReference

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#_

aggregation: string

The aggregation that is performed on the data property.

The value must be one of the supported Aggregation values.

The aggregation must be compatible with the data type of the data property.

Source: doc-js/pentaho/visual/role/spec/IMappingAttribute.jsdoc, line 52

See also:  pentaho.visual.role.MappingAttribute#aggregation

isReverseOrder: boolean

Indicates if the data property contributes to the default order of an ordinal visual role mapping by using the reverse natural order of the data property.

Source: doc-js/pentaho/visual/role/spec/IMappingAttribute.jsdoc, line 64

Default Value: false

See also:  pentaho.visual.role.MappingAttribute#isReverseOrder

name: string

The name of the data property.

This property is required.

Source: doc-js/pentaho/visual/role/spec/IMappingAttribute.jsdoc, line 42

See also:  pentaho.visual.role.MappingAttribute#name