IMeasureDescriptorItem
Measure descriptor object.
export interface IMeasureDescriptorItem
Properties
Property | Modifiers | Type | Description |
|---|---|---|---|
(ALPHA) (Optional) Semantic-layer conditional formatting authored on the underlying metric or fact object. | |||
string | Measure format. | ||
string | (Optional) For persistent metrics or facts, this returns identifier of the object. Is empty for ad-hoc measures. | ||
string | |||
string | Measure name. | ||
(Optional) Opaque reference of the metric or fact object. | |||
string | (Optional) For persistent metrics or facts, this returns URI of the object. Is empty for ad-hoc measures. |
Property details
IMeasureDescriptorItem.conditionalFormattingpropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Semantic-layer conditional formatting authored on the underlying metric or fact object.
conditionalFormatting?: ISemanticConditionalFormatting;
IMeasureDescriptorItem.formatproperty
Measure format.
format: string;
Remarks
Backend must fill the name according to the following rules:
- If measure definition contained ‘format’, then the format from the definition MUST be used - Else if backend has a format for the measure in its records, then it MUST include that format - Otherwise the format must be defaulted
IMeasureDescriptorItem.identifierproperty
For persistent metrics or facts, this returns identifier of the object. Is empty for ad-hoc measures.
identifier?: string;
IMeasureDescriptorItem.localIdentifierproperty
localIdentifier: string;
IMeasureDescriptorItem.nameproperty
Measure name.
name: string;
Remarks
Backend must fill the name according to the following rules:
- If measure definition contained ’title’, then name MUST equal to ’title’, - Else if measure definition contained ‘alias’, then name MUST equal to ‘alias’, - Else if the backend has a name of the measure in its records, then it MUST include that name - Otherwise the name must default to value of localIdentifier
IMeasureDescriptorItem.refproperty
Opaque reference of the metric or fact object.
ref?: ObjRef;
IMeasureDescriptorItem.uriproperty
For persistent metrics or facts, this returns URI of the object. Is empty for ad-hoc measures.
uri?: string;