ICatalogAttribute
Type representing catalog attribute
export interface ICatalogAttribute extends IGroupableCatalogItemBase
Extends: IGroupableCatalogItemBase
Properties
Property | Modifiers | Type | Description |
|---|---|---|---|
Attribute metadata object that catalog attribute represents | |||
(Optional) Attribute dataset | |||
Default display form of the attribute | |||
Display forms of the attribute | |||
Attribute’s display forms that contain geo pins (lat; lng) pairs. | |||
“attribute” | Catalog item type | ||
(ALPHA) (Optional) Referenced objects the current user may not read: the attribute hierarchies this attribute belongs to. |
Property details
ICatalogAttribute.attributeproperty
Attribute metadata object that catalog attribute represents
attribute: IAttributeMetadataObject;
ICatalogAttribute.dataSetproperty
Attribute dataset
dataSet?: IDataSetMetadataObject;
ICatalogAttribute.defaultDisplayFormproperty
Default display form of the attribute
defaultDisplayForm: IAttributeDisplayFormMetadataObject;
ICatalogAttribute.displayFormsproperty
Display forms of the attribute
displayForms: IAttributeDisplayFormMetadataObject[];
ICatalogAttribute.geoPinDisplayFormsproperty
Attribute’s display forms that contain geo pins (lat; lng) pairs.
geoPinDisplayForms: IAttributeDisplayFormMetadataObject[];
ICatalogAttribute.typeproperty
Catalog item type
type: "attribute";
ICatalogAttribute.unavailablepropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production.
Referenced objects the current user may not read: the attribute hierarchies this attribute belongs to.
unavailable?: IUnavailableReference[];
Remarks
Undefined when object permissions were not checked.