IDimensionalityItem
Beta API. Mostly stable, but details may change in a minor release, outside SemVer.
Represents a dimensionality item with an identifier and human-readable title.
export interface IDimensionalityItem
Properties
Property | Modifiers | Type | Description |
|---|---|---|---|
{ identifier: ObjRef; title: string; } | (BETA) (Optional) Optional dataset information for grouping catalog items. Present for catalog items, undefined for bucket items. | ||
(BETA) The identifier of the dimensionality item (attribute or date reference). | |||
(BETA) (Optional) Optional object reference for the item (typically the attribute/date display form reference). This is useful when the item | |||
string | (BETA) Human-readable title for display purposes. | ||
(BETA) Type of the item for icon rendering. Defaults to “attribute” if not specified. |
Property details
IDimensionalityItem.datasetpropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer.
Optional dataset information for grouping catalog items. Present for catalog items, undefined for bucket items.
dataset?: {
identifier: ObjRef;
title: string;
};
IDimensionalityItem.identifierpropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer.
The identifier of the dimensionality item (attribute or date reference).
identifier: ObjRefInScope;
IDimensionalityItem.refpropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer.
Optional object reference for the item (typically the attribute/date display form reference).
This is useful when the item identifier is a LocalIdRef (bucket item), but we still want to compare/deduplicate it against catalog candidates that are referenced by ObjRef.
ref?: ObjRef;
IDimensionalityItem.titlepropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer.
Human-readable title for display purposes.
title: string;
IDimensionalityItem.typepropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer.
Type of the item for icon rendering. Defaults to “attribute” if not specified.
type: DimensionalityItemType;