CswCatalogGroup
"type": "csw-group"
CswCatalogGroupTraits
Trait | Type | Default | Description |
---|---|---|---|
flatten |
boolean |
True to flatten the layers into a single list; false to use the layer hierarchy. |
|
domainSpecification |
DomainSpecTraits |
Domain Specification |
|
includeWms |
boolean |
true |
True to allow WMS resources to be added to the catalog; otherwise, false. |
includeKml |
boolean |
true |
True to allow KML resources to be added to the catalog; otherwise, false. |
includeCsv |
boolean |
true |
True to allow CSV resources to be added to the catalog; otherwise, false. |
includeEsriMapServer |
boolean |
true |
True to allow ESRI Map resources to be added to the catalog; otherwise, false. |
includeGeoJson |
boolean |
true |
True to allow GeoJSON resources to be added to the catalog; otherwise, false |
wmsResourceFormat |
string |
\bwms\b |
Gets or sets a regular expression that, when it matches the protocol attribute of a URI element of a record, indicates that the URI is a WMS resource. |
kmlResourceFormat |
string |
\bkml\b |
Gets or sets a regular expression that, when it matches the protocol attribute of a URI element of a record, indicates that the resource is a KML resource. |
csvResourceFormat |
string |
\bcsv-geo- |
Gets or sets a regular expression that, when it matches the protocol attribute of a URI element of a record, indicates that the URI is a CSV resource. |
esriMapServerResourceFormat |
string |
\besri rest\b |
Gets or sets a regular expression that, when it matches the protocol attribute of a URI element of a record, indicates that the URI is a Esri MapServer resource. |
geoJsonResourceFormat |
string |
\bgeojson\b |
Gets or sets a regular expression that, when it matches the protocol attribute of a URI element of a record, indicates that the URI is a GeoJSON resource. |
getRecordsTemplate |
string |
Gets or sets the template XML string to POST to the CSW server to query for catalog items. If this property is undefined, |
|
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 |
|
isExperiencingIssues |
boolean |
Whether the catalog item is experiencing issues which may cause its data to be unavailable |
|
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. |
|
GetCapabilitiesTraits | |||
getCapabilitiesUrl |
string |
The URL at which to access to the OGC GetCapabilities service. |
|
getCapabilitiesCacheDuration |
string |
1d |
The amount of time to cache GetCapabilities responses. |
GroupTraits | |||
excludeMembers |
string[] |
An array of strings of excluded group and item names (or ids). A group or item name (or id) that appears in this list will not be shown to the user. This is case-insensitive and will also apply to all child/nested groups |
|
isOpen |
boolean |
True if this group is open and its contents are visible; otherwise, false. |
|
mergeGroupsByName |
boolean |
Merge member groups by name. |
|
sortMembersBy |
string |
Sort members by the given property/trait. For example |
|
members |
ModelReference |
The members of this group. |
|
displayGroup |
boolean |
Allow adding all members to the workbench with one click. Show Add All / Remove All button |
|
ItemPropertiesTraits | |||
itemProperties |
any |
Sets traits on group member items (note - will not set traits to sub-groups). This applies to all nested group members (eg members in sub-groups). Also see Item properties will be set in the following order (highest to lowest priority) |
|
itemPropertiesByType |
ItemPropertiesByTypeTraits[] |
Sets traits on group member items by model Item properties will be set in the following order (highest to lowest priority) |
|
itemPropertiesByIds |
ItemPropertiesByIdTraits[] |
Sets traits on group member items by model Item properties will be set in the following order (highest to lowest priority) |
|
LegendOwnerTraits | |||
legends |
LegendTraits[] |
The legends to display on the workbench. |
|
legendBackgroundColor |
string |
Apply background color to all legends. This can be useful if legends are transparent and clash with Terria colours |
|
hideLegendInWorkbench |
boolean |
Whether the legend is hidden in the workbench for this catalog member. |
|
UrlTraits | |||
url |
string |
The base URL of the file or service. |
|
forceProxy |
boolean |
Force the default proxy to be used for all network requests. |
|
cacheDuration |
string |
The cache duration to use for proxied URLs for this catalog member. If undefined, proxied URLs are effectively cachable forever. The duration is expressed as a Varnish-like duration string, such as '1d' (one day) or '10000s' (ten thousand seconds). |
DomainSpecTraits
Trait | Type | Default | Description |
---|---|---|---|
domainPropertyName |
string |
Domain Property Name. |
|
hierarchySeparator |
string |
Hierarchy Separator. |
|
queryPropertyName |
string |
Query Property Name. |
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, |
ItemPropertiesByTypeTraits
Trait | Type | Default | Description |
---|---|---|---|
type |
string |
The type of model to apply |
|
itemProperties |
any |
Sets traits on group member items of specified |
ItemPropertiesByIdTraits
Trait | Type | Default | Description |
---|---|---|---|
ids |
string[] |
The IDs of models to apply |
|
itemProperties |
any |
Sets traits on group member items of specified |
LegendTraits
Trait | Type | Default | Description |
---|---|---|---|
title |
string |
A title to be displayed above the legend. |
|
url |
string |
The URL of the legend image. If the URL suffix isn't one of the following |
|
imageScaling |
number |
1 |
Scaling of the legend. For example, a high DPI legend may have scaling = |
urlMimeType |
string |
The MIME type of the |
|
items |
LegendItemTraits[] |
||
backgroundColor |
string |
Apply background color to entire legend. This can be useful if legend is transparent and clashes with Terria colours. This will override |
LegendItemTraits
Trait | Type | Default | Description |
---|---|---|---|
title |
string |
The title to display next to this legend item. |
|
multipleTitles |
string |
Multiple titles to display next to this legend item. |
|
maxMultipleTitlesShowed |
string |
10 |
Maximum number of multiple titles to display next to this legend item. (Default is 10) |
titleAbove |
string |
The title to display above this legend item, i.e. marking the top of a box on the legend. |
|
titleBelow |
string |
The title to display below this legend item, i.e. marking the bottom of a box on the legend. |
|
color |
string |
The CSS color to display for this item. This property is ignored if |
|
outlineColor |
string |
The CSS color with which to outline this item. |
|
outlineWidth |
number |
The width of outline in pixels |
|
multipleColors |
string[] |
Multiple colors to show with this item in a grid arrangement. |
|
imageUrl |
string |
The URL of an image to display with this item. |
|
marker |
string |
Maki marker ID to display with this item (eg "circle"). |
|
rotation |
number |
The degrees to rotate legend item. |
|
addSpacingAbove |
boolean |
True to add a bit of extra spacing above this item in order to separate it visually from the rest of the legend. |
|
imageHeight |
number |
20 |
The height of the legend image. |
imageWidth |
number |
20 |
The width of the legend image. |