IAttributeDescriptorBody
Attribute descriptor header.
export interface IAttributeDescriptorBody
Properties
Property | Modifiers | Type | Description |
|---|---|---|---|
(ALPHA) (Optional) Semantic-layer conditional formatting authored on the underlying label, fact, or date dataset. | |||
{ locale: string; pattern: string; timezone?: string; } | (Optional) Describes format information in case of date attribute. | ||
Describes attributes to which the display form belongs. | |||
(ALPHA) (Optional) Geo area configuration bound to this attribute display form. | |||
string | (Optional) Specifies granularity in case of date attribute. | ||
string | Display form identifier | ||
(Optional) Label type (eg. image, hyperlink, etc…) | |||
string | Local identifier of the display form - this references back to the IAttribute which was on the input to the execution. | ||
string | Human readable name of the attribute. | ||
string | (Optional) Number format to apply to the attribute’s element values. | ||
Primary label of the attribute from formOf | |||
Opaque reference of the display form object. | |||
(Optional) | |||
string | (Optional) Display form type | ||
string | URI of the display form object |
Property details
IAttributeDescriptorBody.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 label, fact, or date dataset.
conditionalFormatting?: ISemanticConditionalFormatting;
IAttributeDescriptorBody.formatproperty
Describes format information in case of date attribute.
format?: {
locale: string;
pattern: string;
timezone?: string;
};
IAttributeDescriptorBody.formOfproperty
Describes attributes to which the display form belongs.
formOf: IAttributeHeaderFormOf;
IAttributeDescriptorBody.geoAreaConfigpropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Geo area configuration bound to this attribute display form.
geoAreaConfig?: IAttributeDisplayFormGeoAreaConfig;
IAttributeDescriptorBody.granularityproperty
Specifies granularity in case of date attribute.
granularity?: string;
IAttributeDescriptorBody.identifierproperty
Display form identifier
identifier: string;
IAttributeDescriptorBody.labelTypeproperty
Label type (eg. image, hyperlink, etc…)
labelType?: AttributeDisplayFormType;
IAttributeDescriptorBody.localIdentifierproperty
Local identifier of the display form - this references back to the IAttribute which was on the input to the execution.
localIdentifier: string;
IAttributeDescriptorBody.nameproperty
Human readable name of the attribute.
name: string;
IAttributeDescriptorBody.numberFormatproperty
Number format to apply to the attribute’s element values.
numberFormat?: string;
Remarks
Uses the same format specification as measure formats. Present for numeric computed attributes; element values of a header without it are displayed as they come from the backend. Consumers must display the formatted value only and keep the raw element name for drilling, sorting and grouping, the same way date attributes’ formattedName is treated.
IAttributeDescriptorBody.primaryLabelproperty
Primary label of the attribute from formOf
primaryLabel: ObjRef;
IAttributeDescriptorBody.refproperty
Opaque reference of the display form object.
ref: ObjRef;
IAttributeDescriptorBody.totalItemsproperty
totalItems?: ITotalDescriptor[];
IAttributeDescriptorBody.typeproperty
Display form type
type?: string;
IAttributeDescriptorBody.uriproperty
URI of the display form object
uri: string;