WebMapServiceCatalogItem

Creates a single item in the catalog from one or many WMS layers.

Note: To present all layers in an available WMS as individual items in the catalog use the WebMapServiceCatalogGroup.

Example usage

{
  "type": "wms",
  "name": "Mangrove Cover",
  "url": "https://ows.services.dea.ga.gov.au",
  "layers": "mangrove_cover_v2_0_2"
}

WebMapServiceCatalogItemTraits

Trait	Type	Default	Description
layers	string		The layer or layers to display (comma separated values).
styles	string		The styles to use with each of the Layer(s) (comma separated values). This maps one-to-one with Layer(s)
crs	string		CRS to use with WMS layers. We support Web Mercator (EPSG:3857, EPSG:900913) and WGS 84 (EPSG:4326, CRS:84, EPSG:4283)
dimensions	any		Dimension parameters used to request a particular layer along one or more dimensional axes (including elevation, excluding time). Do not include _dim prefx for parameter keys. These dimensions will be applied to all layers (if applicable)
availableStyles	WebMapServiceAvailableLayerStylesTraits[]		The available styles.
availableDimensions	WebMapServiceAvailableLayerDimensionsTraits[]		The available dimensions.
parameters	any		Additional parameters to pass WMS GetMap and GetFeatureInfo requests. Style parameters are stored as CSV in styles, dimension parameters are stored in dimensions.
maxRefreshIntervals	number	1000	The maximum number of discrete times that can be created by a single date range, when specified in the format time/time/periodicity. E.g. 2015-04-27T16:15:00/2015-04-27T18:45:00/PT15M has 11 times.
disableDimensionSelectors	boolean		When true, disables the dimension selectors in the workbench.
isGeoServer	boolean		True if this WMS is a GeoServer; otherwise, false.
isEsri	boolean		True if this WMS is from Esri; otherwise, false.
isThredds	boolean		True if this WMS is from a THREDDS server; otherwise, false.
isNcWMS	boolean		True if this WMS supports NcWMS.
supportsColorScaleRange	boolean		Gets or sets whether this WMS server has been identified as supporting the COLORSCALERANGE parameter.
supportsGetLegendGraphic	boolean		Gets or sets whether this WMS server supports GetLegendGraphic requests.
supportsGetTimeseries	boolean		Gets or sets whether this WMS server supports GetTimeseries requests. If true, then GetTimeseries will be used instead of GetFeatureInfo. This will also set default value of getFeatureInfoFormat to { format: "text/csv", type: "text" }
colorScaleMinimum	number	-50	The minimum of the color scale range. Because COLORSCALERANGE is a non-standard property supported by ncWMS servers, this property is ignored unless WebMapServiceCatalogItem's supportsColorScaleRange is true. WebMapServiceCatalogItem's colorScaleMaximum must be set as well.
colorScaleMaximum	number	50	The maximum of the color scale range. Because COLORSCALERANGE is a non-standard property supported by ncWMS servers, this property is ignored unless WebMapServiceCatalogItem's supportsColorScaleRange is true. WebMapServiceCatalogItem's colorScaleMinimum must be set as well.
useWmsVersion130	boolean	true	Use WMS version 1.3.0. True by default (unless url has "version=1.1.1" or "version=1.1.0"), if false, then WMS version 1.1.1 will be used.
getFeatureInfoFormat	GetFeatureInfoFormat		Format parameter to pass to GetFeatureInfo requests. Defaults to "application/json", "application/vnd.ogc.gml", "text/html" or "text/plain" - depending on GetCapabilities response
getFeatureInfoUrl	string		If defined, this URL will be used for GetFeatureInfo requests instead of url.
getFeatureInfoParameters	any		Additional parameters to pass WMS GetFeatureInfo requests. If parameters trait is also defined, this is applied on top. Dimension parameters are stored in dimensions.
AttributionTraits
attribution	string		The attribution to display with the data.
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 description is undefined.
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 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.
ChartTraits
chartType	string		Type determines how the data availibility will be plotted on chart. eg: momentLines, momentPoints
chartDisclaimer	string		A HTML string to show above the chart as a disclaimer
chartColor	string		The color to use when the data set is displayed on the chart. The value can be any html color string, eg: 'cyan' or '#00ffff' or 'rgba(0, 255, 255, 1)' for the color cyan.
chartGlyphStyle	string		The glyph style to use for points plotted on the chart. Allowed values include circle, cross, diamond, square, star, triangle, wye. Default is "circle".
DiffableTraits
availableDiffStyles	string[]		List of styles that can be used for computing difference image
isShowingDiff	boolean		True if currently showing diff image
firstDiffDate	string		The first date to use to compute the difference image
secondDiffDate	string		The second date to use to compute the difference image
diffStyleId	string		The ID of the style used to compute the difference image
DiscretelyTimeVaryingTraits
fromContinuous	string	nearest	Specifies how a continuous time (e.g. the timeline control) is mapped to a discrete time for this dataset. Valid values are: * nearest - the nearest available discrete time to the current continuous time is used. * next - the discrete time equal to or after the current continuous time is used. * previous - the discrete time equal to or before the current continuous time is used.
showInChartPanel	boolean		Whether to plot data availability on a chart.
disableDateTimeSelector	boolean		When true, disables the date time selector in the workbench
multiplierDefaultDeltaStep	number	2	The multiplierDefaultDeltaStep is used to set the default multiplier (see TimeVaryingTraits.multiplier trait) - it represents the average number of (real-time) seconds between (dataset) time steps. For example, a value of five would set the multiplier so that a new time step (of this dataset) would appear every five seconds (on average) if the timeline is playing. This trait will only take effect if multiplier is not explicitly set.
ExportWebCoverageServiceTraits
linkedWcsUrl	string		Gets or sets the URL of a WCS that enables clip-and-ship for this WMS item.
linkedWcsCoverage	string		Gets or sets the coverage name for linked WCS for clip-and-ship.
linkedWcsParameters	WebCoverageServiceParameterTraits		WCS Parameters included in GetCoverage requests (for clip-and-ship).
ExportableTraits
disableExport	boolean		Disable user export functionality
FeaturePickingTraits
allowFeaturePicking	boolean	true	Indicates whether features in this catalog item can be selected by clicking them on the map.
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.
ImageryProviderTraits
leafletUpdateInterval	number		Update a tile only once during this interval when the map is panned. Value should be specified in milliseconds.
tileErrorHandlingOptions	TileErrorHandlingTraits		Options for handling tile errors
clipToRectangle	boolean	true	Gets or sets a value indicating whether this dataset should be clipped to the {@link CatalogItem#rectangle}. If true, no part of the dataset will be displayed outside the rectangle. This property is true by default, leading to better performance and avoiding tile request errors that might occur when requesting tiles outside the server-specified rectangle. However, it may also cause features to be cut off in some cases, such as if a server reports an extent that does not take into account that the representation of features sometimes require a larger spatial extent than the features themselves. For example, if a point feature on the edge of the extent is drawn as a circle with a radius of 5 pixels, half of that circle will be cut off.
minimumLevel	number		The minimum level-of-detail supported by the imagery provider. Take care when specifying this that the number of tiles at the minimum level is small, such as four or less. A larger number is likely to result in rendering problems
maximumLevel	number		The maximum level-of-detail supported by the imagery provider, or undefined if there is no limit
tileWidth	number	256	Tile width in pixels. Default value is 256 pixels
tileHeight	number	256	Tile height in pixels. Default value is 256 pixels
LayerOrderingTraits
keepOnTop	boolean		Keeps the layer on top of all other imagery layers.
supportsReordering	boolean	true	Does this layer support reordering in the workbench.
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.
MappableTraits
rectangle	RectangleTraits		The bounding box rectangle that contains all the data in this catalog item.
idealZoom	IdealZoomTraits		Override default ideal zoom if the given values are valid.
disablePreview	boolean		Disables the preview on the Add Data panel. This is useful when the preview will be very slow to load.
disableZoomTo	boolean		Disables the zoom to (aka 'Ideal Zoom') button in the workbench.
zoomOnAddToWorkbench	boolean		Zoom to dataset when added to workbench. Doesn't work if disableZoomTo is true.
show	boolean	true	Show or hide a workbench item. When show is false, a mappable item is removed from the map and a chartable item is removed from the chart panel.
initialMessage	InitialMessageTraits		A message to show when the user adds the catalog item to the workbench. Useful for showing disclaimers.
featureInfoTemplate	FeatureInfoTemplateTraits		A template object for formatting content in feature info panel
showStringIfPropertyValueIsNull	string		If the value of a property is null or undefined, show the specified string as the value of the property. Otherwise, the property name will not be listed at all.
maximumShownFeatureInfos	number		The maximum number of "feature infos" that can be displayed in feature info panel.
MinMaxLevelTraits
maxScaleDenominator	number		The denominator of the smallest scale (largest denominator) for which tiles should be requested. For example, if this value is 10000, then tiles representing a scale smaller than 1:10000 (i.e. numerically larger denominator, when zooming out further) will not be requested. For large scales set hideLayerBeforeMaxScaleDenominator to true, otherwise you may experience performance issues (requesting too many tiles).
minScaleDenominator	number		The denominator of the largest scale (smallest denominator) for which tiles should be requested. For example, if this value is 1000, then tiles representing a scale larger than 1:1000 (i.e. numerically smaller denominator, when zooming in closer) will not be requested. Instead, tiles of the largest-available scale, as specified by this property, will be used and will simply get blurier as the user zooms in closer.
hideLayerAfterMinScaleDenominator	boolean		True to hide tiles when the Minimum Scale Denominator is exceeded. If false, we can zoom in arbitrarily close to the (increasingly blurry) layer.
scaleWorkbenchInfo	string		The message to show to the user when this dataset is not visible due to scale.
OpacityTraits
opacity	number	0.8	The opacity of the item.
disableOpacityControl	boolean		When true, the user will be unable to change the opacity of the item
SplitterTraits
splitDirection	number		The side of the splitter to display this imagery layer on. Defaults to both sides.
disableSplitter	boolean		If true, splitter funcitonality will be hidden for this model.
TimeFilterTraits
timeFilterPropertyName	string		The name of a property in a feature returned from this layer's feature query service that indicates the times at which this layer covers this position. For example, historical and near-real-time satellite imagery often comes as daily swaths, with a given area on the globe potentially only covered every number of days.
timeFilterCoordinates	TimeFilterCoordinates		The current position picked by the user for filtering
TimeVaryingTraits
timeLabel	string		Time label which is shown in workbench next to date/time selector (Will default to t("dateTime.selectorLabel") = "Time:").
currentTime	string	2024-04-16T06:53:07.706000000Z	The current time at which to show this dataset.
initialTimeSource	string	now	The initial time to use if Current Time is not specified. Valid values are * start - the dataset's start time * stop - the dataset's stop time * now - the current system time. If the system time is after Stop Time, Stop Time is used. If the system time is before Start Time, Start Time is used. * none - do not automatically set an initial time This value is ignored if Current Time is specified.
startTime	string		The earliest time for which this dataset is available. This will be the start of the range shown on the timeline control.
stopTime	string		The latest time for which this dataset is available. This will be the end of the range shown on the timeline control.
multiplier	number		The multiplier to use in progressing time for this dataset. For example, 5.0 means that five seconds of dataset time will pass for each one second of real time.
isPaused	boolean	true	True if time is currently paused for this dataset, or false if it is progressing.
dateFormat	string		A dateformat string (using the dateformat package) used to adjust the presentation of the date in various spots in the UI for a catalog item. For example, to just show the year set to 'yyyy'. Used in places like the the Workbench Item and Bottom Dock
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	0d	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).

WebMapServiceAvailableLayerStylesTraits

Trait	Type	Default	Description
layerName	string		The name of the layer for which styles are available.
styles	WebMapServiceAvailableStyleTraits[]		The styles available for this layer.

WebMapServiceAvailableStyleTraits

Trait	Type	Default	Description
name	string		The name of the style.
title	string		The title of the style.
abstract	string		The abstract describing the style.
legend	LegendTraits		The name of the style.

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 png|jpg|jpeg|gif|svg, then urlMimeType must be defined - otherwise a hyperlink will be shown.
imageScaling	number	1	Scaling of the legend. For example, a high DPI legend may have scaling = 0.5, so it will be scaled down 50%
urlMimeType	string		The MIME type of the URL legend image. For example "image/png"
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 legendBackgroundColor.

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 Legend URL is specified.
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.

WebMapServiceAvailableLayerDimensionsTraits

Trait	Type	Default	Description
layerName	string		The name of the layer for which dimensions are available.
dimensions	WebMapServiceAvailableDimensionTraits[]		The dimensions available for this layer.

WebMapServiceAvailableDimensionTraits

Trait	Type	Default	Description
name	string		The name of the dimension.
values	string[]		Possible dimension values.
units	string		The units of the dimension.
unitSymbol	string		The unitSymbol of the dimension.
default	string		The default value for the dimension.
multipleValues	boolean		Can the dimension support multiple values.
nearestValue	boolean		The nearest value of the dimension.

GetFeatureInfoFormat

Trait	Type	Default	Description
type	string		The type of response to expect from a GetFeatureInfo request. Valid values are 'json', 'xml', 'html', 'text' or 'csv'. If type is 'csv', then featureInfoContext will contain timeSeries object (see "Customizing the Feature Info Template" in documentation)
format	string		The info format to request from the WMS server. This is usually a MIME type such as 'application/json' or text/xml'. If this parameter is not specified, the provider will request 'json' using 'application/json', 'xml' using 'text/xml', 'html' using 'text/html', and 'text' using 'text/plain'.

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)

WebCoverageServiceParameterTraits

Trait	Type	Default	Description
outputCrs	string		Output CRS (in EPSG format - eg "EPSG:4326").
outputFormat	string	image/geotiff	File format of output (defaults to GeoTIFF).
subsets	KeyValueTraits[]		Array of key-value pairs for subsets to be included in query parameters. For example {key: "Time", value: "2020"} will add query parameter subset=Time("2020")
duplicateSubsetValues	KeyValueTraits[]		If multiple values have been detected for a particular subset ID (key), then we can only use the first one as WCS only supports one value per subset. Each element in this array represents the actual value used for a subset which has multiple values.
additionalParameters	KeyValueTraits[]		Each key-value will be added to URL like so - someurl.com?key=value.

KeyValueTraits

Trait	Type	Default	Description
key	string		Key string.
value	string		Value string.

TileErrorHandlingTraits

Trait	Type	Default	Description
thresholdBeforeDisablingItem	number		The number of tile failures before disabling the item.
treat403AsError	boolean		Indicates whether a 403 response code when requesting a tile should be treated as an error. If false, 403s are assumed to just be missing tiles and need not be reported to the user.
treat404AsError	boolean		Indicates whether a 404 response code when requesting a tile should be treated as an error. If false, 404s are assumed to just be missing tiles and need not be reported to the user.
ignoreUnknownTileErrors	boolean		A flag indicating whether non-specific (no HTTP status code) tile errors should be ignored. This is a last resort, for dealing with odd cases such as data sources that return non-images (eg XML) with a 200 status code. No error messages will be shown to the user.

RectangleTraits

Trait	Type	Default	Description
west	number		The westernmost longitude in degrees.
south	number		The southernmost longitude in degrees.
east	number		The easternmost longitude in degrees.
north	number		The northernmost longitude in degrees.
CameraTraits
position	VectorTraits		Position of the camera in the Earth-centered Fixed frame in meters.
direction	VectorTraits		The look direction of the camera in the Earth-centered Fixed frame.
up	VectorTraits		The up vector direction of the camera in the Earth-centered Fixed frame.

VectorTraits

Trait	Type	Default	Description
x	number		X component of vector in the Earth-centered Fixed frame.
y	number		Y component of vector in the Earth-centered Fixed frame.
z	number		Z component of vector in the Earth-centered Fixed frame.

IdealZoomTraits

Trait	Type	Default	Description
lookAt	LookAtTraits		Parameters for camera to look at a target.
camera	CameraTraits		Use camera position, direction and up if fully defined. Otherwise use rectangle if fully defined.

LookAtTraits

Trait	Type	Default	Description
targetLongitude	number		Target longitude on the WGS84 ellipsoid in degrees
targetLatitude	number		Target latitude on the WGS84 ellipsoid in degrees
targetHeight	number	100	Target height in meters. Treat it as camera height. A positive value is above the WGS84 ellipsoid. Default to 100 meters.
heading	number		Heading in degrees. Treat it as camera bearing. North is 0. A positive value rotates clockwise, negative anti-clockwise. Default to 0.
pitch	number	45	Pitch in degrees. Treat it as camera pitch. A positive value is to look down, negative up. Default to 45.
range	number	500	The range in meters. It is the distance between the target position and camera position projected onto the local plane. Not negative and default to 500.

CameraTraits

Trait	Type	Default	Description
position	VectorTraits		Position of the camera in the Earth-centered Fixed frame in meters.
direction	VectorTraits		The look direction of the camera in the Earth-centered Fixed frame.
up	VectorTraits		The up vector direction of the camera in the Earth-centered Fixed frame.
RectangleTraits
west	number		The westernmost longitude in degrees.
south	number		The southernmost longitude in degrees.
east	number		The easternmost longitude in degrees.
north	number		The northernmost longitude in degrees.

InitialMessageTraits

Trait	Type	Default	Description
title	string		The title of the message.
content	string		The content of the message.
key	string		Identifier. If multiple messages with the same key are triggered, only the first will be displayed.
confirmation	boolean		Whether the message requires confirmation.
confirmText	string		If confirmation is true, the text to put on the confirmation button.
width	number		Width of the message.
height	number		Height of the message.

FeatureInfoTemplateTraits

Trait	Type	Default	Description
name	string		A mustache template string for formatting name
template	string		A Mustache template string for formatting description
showFeatureInfoDownloadWithTemplate	boolean		Show feature info download if a template has been provided. If no template is provided, then download will always show.
partials	any		An object, mapping partial names to a template string. Defines the partials used in Template.
formats	any		An object, mapping field names to formatting options.

TimeFilterCoordinates

Trait	Type	Default	Description
tile	TileCoordinates		x, y, level coordinates of the picked tile. Refer: https://cesium.com/docs/cesiumjs-ref-doc/ImageryProvider.html?classFilter=imageryprovider#pickFeatures
LatLonHeightTraits
latitude	number		Latitude in degrees
longitude	number		Longitude in degrees
height	number		Height above ellipsoid in metres

TileCoordinates

Trait	Type	Default	Description
x	number		X coordinate of the tile
y	number		Y coordinate of the tile
level	number		Zoom level of the tile