Skip to main content
Hitachi Vantara Lumada and 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.

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.

isKey : boolean

Indicates if the attribute identifies rows, together with other key attributes.

The default value is false.

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

Extends