Skip to content

CatalogIndexReference

"type": "catalog-index-reference"

CatalogIndexReferenceTraits

Trait Type Default Description
memberKnownContainerUniqueIds string[]

These are used to load models which this model depends on (eg parent groups).

shareKeys string[]

Share keys can be used to resolve older model IDs to this model.

nameInCatalog string

The name of the item to be displayed in the catalog. This will only be defined if it differs from name.

CatalogMemberReferenceTraits
name string

The name to use for this catalog member before the reference is loaded.

description string

The description to use for this catalog member before the reference is loaded. Markdown and HTML may be used.

dataCustodian string

Gets or sets a description of the custodian of this data item.

isGroup boolean

Is the target of this reference expected to be a catalog group?

isFunction boolean

Is the target of this reference expected to be a catalog function?

isMappable boolean

Is the target of this reference expected to have map items?

isChartable boolean

Is the target of this reference expected to have chart items?

ReferenceTraits
isOpenInWorkbench boolean true

Whether the item in the workbench open or collapsed.