IAttributeMetadataObject
Attribute metadata object
export interface IAttributeMetadataObject extends IMetadataObject
Extends: IMetadataObject
Properties
Property | Modifiers | Type | Description |
|---|---|---|---|
(ALPHA) (Optional) Semantic-layer conditional formatting authored on this attribute. | |||
(Optional) Dataset the attribute belongs to (if supplied by backend include) | |||
Display forms of the attribute | |||
(Optional) A reference to the attribute displayForm that represents implicit drill down step | |||
(Optional) A reference to the attribute displayForm that represents implicit drill to url from attribute value | |||
boolean | (Optional) Whether the attribute is locked for editing | ||
string | (Optional) Source column name in the underlying data source table. | ||
“attribute” |
Property details
IAttributeMetadataObject.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 attribute.
conditionalFormatting?: ISemanticConditionalFormatting;
IAttributeMetadataObject.dataSetproperty
Dataset the attribute belongs to (if supplied by backend include)
dataSet?: IDataSetMetadataObject;
IAttributeMetadataObject.displayFormsproperty
Display forms of the attribute
displayForms: IAttributeDisplayFormMetadataObject[];
IAttributeMetadataObject.drillDownStepproperty
A reference to the attribute displayForm that represents implicit drill down step
drillDownStep?: ObjRef;
Remarks
Drilling of this type will be available in any report/dashboard where this attribute will be present. This will be performed on attribute headers and attribute element headers. These will be defined in LDM.
IAttributeMetadataObject.drillToAttributeLinkproperty
A reference to the attribute displayForm that represents implicit drill to url from attribute value
drillToAttributeLink?: ObjRef;
Remarks
Drilling of this type will be available in any report/dashboard where this attribute will be present. This will be performed on attribute headers and attribute element headers. These will be defined in LDM.
IAttributeMetadataObject.isLockedproperty
Whether the attribute is locked for editing
isLocked?: boolean;
IAttributeMetadataObject.sourceColumnproperty
Source column name in the underlying data source table.
sourceColumn?: string;
IAttributeMetadataObject.typeproperty
type: "attribute";