Skip to main content
Pentaho Documentation

IAttribute

IAttribute

The spec.IAttribute interface describes the structure of an attribute specification.

Properties:
Name Default Value Description
name : string

The name of the attribute.

Cannot be an empty string, "".

label : string

The label of the attribute.

If null is specified, it is instead taken to be undefined. The default value is undefined.

format : pentaho.data.spec.IFormatProvider

The format of the attribute.

The default value is null.

type : pentaho.data.AtomicTypeName

The name of the type of the attribute.

Specified values are recognized independently of their case. The default value is pentaho.data.AtomicTypeName.STRING.

isDiscrete : boolean

Indicates if the attribute is considered discrete.

When the attribute's type is one of pentaho.data.AtomicTypeName.STRING or pentaho.data.AtomicTypeName.BOOLEAN this property is ignored and the attribute is necessarily discrete.

Otherwise, when the attribute's type is one of pentaho.data.AtomicTypeName.NUMBER or pentaho.data.AtomicTypeName.DATE this property's default value is false, but can be specified otherwise.

members : Array.<pentaho.data.spec.IMember>

An array of member specifications.

This property is relevant only for discrete attributes.

isPercent : boolean

Indicates if the attribute represents a numeric value that is a percentage of something.

This property is relevant only for attributes of type pentaho.data.AtomicTypeName.NUMBER.

The default value is false.

Source: doc-js/pentaho/data/spec/IAttribute.jsdoc, line 17

Extends