Skip to content

StubCatalogItem

"type": "stub"

StubCatalogItemTraits

Trait Type Default Description
isExperiencingIssues boolean true

Whether the catalog item is experiencing issues which may cause its data to be unavailable

CatalogMemberTraits
name string

The name of the catalog item.

description string

The description of the catalog item. Markdown and HTML may be used.

nameInCatalog string

The name of the item to be displayed in the catalog, if it is different from the one to display in the workbench.

info InfoSectionTraits[]

Human-readable information about this dataset.

infoSectionOrder string[]

An array of section titles defining the display order of info sections. If this property is not defined, {@link DataPreviewSections}'s DEFAULT_SECTION_ORDER is used

isOpenInWorkbench boolean true

Whether the item in the workbench open or collapsed.

shortReport string

A short report to show on the now viewing tab.

shortReportSections ShortReportTraits[]

A list of collapsible sections of the short report

hideSource boolean

Indicates that the source of this data should be hidden from the UI (obviously this isn't super-secure as you can just look at the network requests).

metadataUrls MetadataUrlTraits[]

Metadata URLs to show in data catalog.

dataUrls DataUrlTraits[]

Data URLs to show in data catalog.

dataCustodian string

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

modelDimensions EnumDimensionTraits[]

This provides ability to set model JSON through SelectableDimensions (a dropdown). When an option is selected, the value property will be used to call updateModelFromJson(). All string properties support Mustache templates (with the catalog member as context)

disableAboutData boolean

Disables the 'About Data' button in the workbench.

InfoSectionTraits

Trait Type Default Description
name string

The name of the section.

content string

The content of the section, in Markdown and HTML format. Set this property to null to remove this section entirely.

contentAsObject any

The content of the section which is a JSON object. Set this property to null to remove this section entirely.

show boolean true

Indicates if this info section showing (not collapsed).

ShortReportTraits

Trait Type Default Description
name string

The name of the section.

content string

The content of the section.

show boolean true

Indicates if this short report section showing.

MetadataUrlTraits

Trait Type Default Description
url string

The metadata URL of the file or service.

title string

Title used for metadata URL button.

DataUrlTraits

Trait Type Default Description
type string

Type of data URL. This value will be used to provide context or instruction on how to use the data URL. For example wcs will provide a link to WCS docs. Current supported values are: - wfs = A Web Feature Service (WFS) base URL - wcs = A Web Coverage Service (WCS) base URL - wfs-complete = A complete, ready-to-use link to download features from a WCS server - wcs-complete = A complete, ready-to-use link to download features from a WFS server - direct = Direct URL to dataset (this is the default if no type is specified) - none = Hide data URL

MetadataUrlTraits
url string

The metadata URL of the file or service.

title string

Title used for metadata URL button.

EnumDimensionTraits

Trait Type Default Description
id string

Dimension ID

name string

Dimension name (human-readable)

options DimensionOptionTraits[]

Dimension options

selectedId string

Selected Option's ID

allowUndefined boolean

Allow dimension to be undefined

disable boolean

Hides dimension

DimensionOptionTraits

Trait Type Default Description
id string

Option ID

name string

Option name (human-readable)

value any

Value (if this is undefined, id will be used)