AttributeBuilder

Home > @gooddata/sdk-model > AttributeBuilder

AttributeBuilder class

Builder for attributes.

Do not instantiate this class directly. Instead use newAttribute() or modifyAttribute().

Signature:

export declare class AttributeBuilder 

Remarks

The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the AttributeBuilder class.

Properties

Property	Modifiers	Type	Description
alias		(alias?: string | undefined) => this	Sets alias - alternative title - for the attribute.
build		() => IAttribute	Creates the IAttribute instance.
defaultLocalId		() => this	Indicates that the attribute's localId should be generated using the default local-id generator logic.
displayForm		(ref: ObjRef) => this	Sets display form reference.
localId		(localId?: Identifier | undefined) => this	Sets local identifier (localId) for the attribute. LocalId can be used to reference the attribute within the execution definition.Normally, builder will generate localId based on contents of the attribute definition - taking all properties into account: in typical scenarios you don't have to call this function at all. The only exception where you have to provide custom local id is if your execution must contain the exact same attribute twice.For convenience, this method also accepts 'undefined', which indicates that the default local id generation logic should be used.
noAlias		() => this	Resets alias - alternative title - set for the attribute.
showAllValues		(showAllValues?: boolean | undefined) => this	Sets show all values property.