IAttributeDisplayFormMetadataObject
Attribute display form metadata object
export interface IAttributeDisplayFormMetadataObject extends IMetadataObject
Extends: IMetadataObject
Properties
Property | Modifiers | Type | Description |
|---|---|---|---|
A reference to the attribute that displayForm represents | |||
(ALPHA) (Optional) Semantic-layer conditional formatting authored on this label; takes precedence over the owning attribute’s (backend-defined). | |||
AttributeDisplayFormType | string | (Optional) Subtype of the display form (e.g. GDC.geo.pin, or GDC.link, see constants above). | ||
(ALPHA) (Optional) Additional configuration for geo area display forms. | |||
boolean | (Optional) Default display form of attribute. | ||
boolean | (Optional) Primary display form of attribute. | ||
“displayForm” |
Property details
IAttributeDisplayFormMetadataObject.attributeproperty
A reference to the attribute that displayForm represents
attribute: ObjRef;
IAttributeDisplayFormMetadataObject.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 this label; takes precedence over the owning attribute’s (backend-defined).
conditionalFormatting?: ISemanticConditionalFormatting;
IAttributeDisplayFormMetadataObject.displayFormTypeproperty
Subtype of the display form (e.g. GDC.geo.pin, or GDC.link, see constants above).
displayFormType?: AttributeDisplayFormType | string;
IAttributeDisplayFormMetadataObject.geoAreaConfigpropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Additional configuration for geo area display forms.
geoAreaConfig?: IAttributeDisplayFormGeoAreaConfig;
IAttributeDisplayFormMetadataObject.isDefaultproperty
Default display form of attribute.
isDefault?: boolean;
IAttributeDisplayFormMetadataObject.isPrimaryproperty
Primary display form of attribute.
isPrimary?: boolean;
IAttributeDisplayFormMetadataObject.typeproperty
type: "displayForm";