Web Map Service (WMS) (group)
Note
This page is automatically generated from the source code, and is a bit rough. If you have trouble, check the source code for this type or post a message to the forum.
A CatalogGroup representing a collection of layers from a Web Map Service (WMS) server.
Initialization File properties:
"type": "wms-getCapabilities"
_nameInCatalog
The name of the item to show in the catalog, if different from name. Default undefined.
This property is observed.
_sourceInfoItemNames
The names of items in the CatalogMember's info array that contain details of the source of this CatalogMember's data. This should be overridden by children of this class.
blacklist
A hash of names of blacklisted data layers. A layer that appears in this hash will not be shown to the user. In this hash, the keys should be the Title of the layers to blacklist, and the values should be "true".
cacheDuration
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).
customProperties
The dictionary of custom item properties.
dataCustodian
A description of the custodian of the data sources in this group. This property is an HTML string that must be sanitized before display to the user.
description
The description of the item.
flatten
A value indicating whether the list of layers queried from GetCapabilities should be flattened into a list with no hierarchy.
forceProxy
Gets or sets whether or not this member should be forced to use a proxy. This property is not observable.
hideSource
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).
id
An optional unique id for this member, that is stable across renames and moves. Use uniqueId to get the canonical unique id for this CatalogMember, which is present even if there is no id.
initialMessage
A message object that is presented to the user when an item or group is initially clicked The object is of the form {title:string, content:string, key: string, confirmation: boolean, confirmText: string, width: number, height: number}.
isHidden
A value indicating whether this item is hidden from the catalog. This property is observable.
isOpen
A value indicating whether the group is currently expanded and showing its children.
isPromoted
A value indicating whether this item is kept above other non-promoted items.
isUserSupplied
A value indicating whether this member was supplied by the user rather than loaded from one of the Terria's initSources. User-supplied members must be serialized completely when, for example, serializing enabled members for sharing.
isWaitingForDisclaimer
Whether this catalog member is waiting for a disclaimer to be accepted before showing itself.
itemProperties
A hash of properties that will be set on each child item. For example, { 'treat404AsError': false }
name
The name of the item.
nameInCatalog
The name of this catalog member in the catalog. By default this is just name, but can be overridden.
parameters
The additional parameters to pass to the WMS server when requesting images. All parameter names must be entered in lowercase in order to be consistent with references in TerrisJS code. If this property is undefiend, WebMapServiceCatalogItem.defaultParameters is used.
shortReport
A short report to show on the now viewing tab.
titleField
The field name to use as the primary title in the catalog view: each WMS layer's "title" (default), "name", or "abstract".
url
The URL of the WMS server.