IAttributeBody
Attribute is our nomenclature for ‘dimension’ as typically used in multi-dimensional BI modeling.
export interface IAttributeBody
Remarks
The attribute specifies on what dimension to slice/dice the measures.
In GoodData, each attribute can have multiple different display forms. Display forms essentially provide different representations for elements in the dimension.
Properties
Property | Modifiers | Type | Description |
|---|---|---|---|
string | (Optional) This is user-assigned alias of the attribute; it is opaque for the backend. When backend returns metadata about execution results, it WILL include this user-assigned alias in the metadata. | ||
Reference to display form to use for element representations. The display form can be referenced by either URL of the display form resource on backend OR by unique, backend-recognized, identifier of the display form. Note: specifying display forms by URI is discouraged and WILL be deprecated in the future. The specification of URL has several drawbacks:
| |||
User-assigned id of the attribute. The value is used to cross-reference model elements that are part of an execution. The constraint is that the local identifiers of all measures and attributes in an execution definition MUST be unique. | |||
boolean | (Optional) Indicates whether to show all values of given attribute even if the data bound to those values are not available |
Property details
IAttributeBody.aliasproperty
This is user-assigned alias of the attribute; it is opaque for the backend. When backend returns metadata about execution results, it WILL include this user-assigned alias in the metadata.
alias?: string;
IAttributeBody.displayFormproperty
Reference to display form to use for element representations.
The display form can be referenced by either URL of the display form resource on backend OR by unique, backend-recognized, identifier of the display form.
Note: specifying display forms by URI is discouraged and WILL be deprecated in the future. The specification of URL has several drawbacks:
- Display form URLs are tied to particular analytical workspace; this makes any application that uses URL-specified display forms workspace-specific. - Display form URLs are not supported by all GoodData backends == this makes any application that uses URL-specified display form backend-specific
displayForm: ObjRef;
IAttributeBody.localIdentifierproperty
User-assigned id of the attribute. The value is used to cross-reference model elements that are part of an execution.
The constraint is that the local identifiers of all measures and attributes in an execution definition MUST be unique.
localIdentifier: Identifier;
IAttributeBody.showAllValuesproperty
Indicates whether to show all values of given attribute even if the data bound to those values are not available
showAllValues?: boolean;