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. |
|
hideDefaultDescription |
boolean |
If true, then no generic default description will be displayed if |
|
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 |
|
disableAboutData |
boolean |
Disables the 'About Data' button in the workbench. |
|
shareable |
boolean |
true |
True (default) if this catalog member may be included in share links. False to exclude it from share links. |
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 |
|
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, |