WFS Features (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 individual features from a Web Feature Service (WFS) server. By contrast to a WebFeatureServiceCatalogGroup, which creates one WebFeatureServiceCatalogItem per feature type (eg, one item for rivers, one for lakes), this group creates one WebFeatureServiceCatalogItem per feature (eg, one item for each individual river).

Initialization File properties:

"type": "wfs-features-group"

_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.

forceProxy

Gets or sets whether or not this member should be forced to use a proxy. This property is not observable.

groupByProperty

The name of the property by which to group the catalog items in this group. If this property is undefined, all catalog items are added at the top level.

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.

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.

nameProperty

The name of the WFS attribute from which to derive the names of the catalog items in this group. This property must be set.

shortReport

A short report to show on the now viewing tab.

typeNames

The WFS feature type names.

url

The URL of the WFS server.

useFeatureID

Gets or sets whether to use WFS "feature ID" for retrieving features. On by default, disable to handle ID-less features on some servers. When disabled, nameProperty is used for matching features, and will give incorrect results if its values are not unique.