Sensor Observation Service (SOS) (item)

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 CatalogItem representing data obtained from a Sensor Observation Service (SOS) 2.0 server. The SOS specifications are available at http://www.opengeospatial.org/standards/sos . This requires a json configuration file which specifies the procedures and observableProperties to show. If more than one procedure or observableProperty is provided, the user can choose between the options. Note because of this need for configuration, there is no SOS catalog "group" (yet).

The offerings parameter is not used, and no spatial filters are provided. The default soap XML request body can be overridden to handle custom requirements.

Initialization File properties:

"type": "sos"

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

colors

The array of color strings used for chart lines. TODO: make this customizable, eg. use colormap / colorPalette.

customProperties

The dictionary of custom item properties.

data

The data, represented as a binary Blob, a string, or a Promise for one of those things. If this property is set, CatalogItem's url is ignored.

dataCustodian

A description of the custodian of this data item. This property is an HTML string that must be sanitized before display to the user.

dataSourceUrl

The URL from which the TableCatalogItem's data was obtained. This is informational; it is not used. This propery is observable.

dataUrl

The URL from which this data item's raw data can be retrieved, or undefined if raw data for this data item is not available.

dataUrlType

The type of the CatalogItem's dataUrl, or undefined if raw data for this data source is not available. Valid values are: * direct - A direct link to the data. * wfs - A Web Feature Service (WFS) base URL. If CatalogItem's dataUrl is not specified, the base URL will be this data item's URL. * wfs-complete - A complete, ready-to-use link to download features from a WFS server. * none - There is no data link.

dateFormat

Options for formatting current time and timeline tic labels. Options are: currentTime // Current time in time slider will be shown in this format. For example "mmmm yyyy" for Jan 2016. timelineTic // Timeline tics will have this label. For example "yyyy" will cause each tic to be labelled with the year.

description

The description of the item.

endDate

An end date in ISO8601 format. All requests filter to this end date. Set to undefined to use the current date.

featureInfoTemplate

A template to display message in a info box. May be a string or an object with template, name and/or partials properties.

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.

idColumns

The column identifiers (names or indices), so we can identify individual features within a table with a time column, or across multiple polled lat/lon files. Eg. ['lat', 'lon'] for immobile features, or ['identifier'] if a unique identifier is provided (where these are column names in the table; column numbers work as well). For region-mapped files, the region identifier is used instead. For non-spatial files, the x-column is used instead.

info

The array of section titles and contents for display in the layer info panel. In future this may replace 'description' above - this list should not contain sections named 'description' or 'Description' if the 'description' property is also set as both will be displayed. The object is of the form {name:string, content:string}. Content will be rendered as Markdown with HTML.

infoSectionOrder

The array of section titles definining the display order of info sections. If this property is not defined, DataPreviewSections's DEFAULT_SECTION_ORDER is used.

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

initialObservablePropertyIndex

The index of the initially selected observable property. Defaults to 0.

initialProcedureIndex

The index of the initially selected procedure. Defaults to 0.

isEnabled

A value indicating whether this data item is enabled. An enabled data item appears in the "Now Viewing" pane, but is not necessarily shown on the map.

isHidden

A value indicating whether this item is hidden from the catalog. This property is observable.

isLegendVisible

A value indicating whether the legend for this data item is currently visible.

isLoading

A value indicating whether this data source is currently loading.

isMappable

A value indicating whether this data source is mappable and should therefore include a Zoom To button.

isPromoted

A value indicating whether this item is kept above other non-promoted items.

isSampled

A value indicating whether the rows correspond to "sampled" data. This only makes a difference if there is a time column and idColumns. In this case, if isSampled is true, then feature position, color and size are interpolated to produce smooth animation of the features over time. If isSampled is false, then times are treated as the start of periods, so that feature positions, color and size are kept constant from one time until the next, then change suddenly. Color and size are never interpolated when they are drawn from a text column.

isShown

A value indicating whether this data item is currently shown on the map. In order to be shown, the item must also be enabled.

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.

keepOnTop

Keeps the layer on top of all other imagery layers.

legendUrl

The URL of the legend to show when this catalog item is enabled. If there is more than one legend URL, this property returns the first one.

legendUrls

The URLs of the legends to show when this catalog item is enabled.

maximumShownFeatureInfos

The maximum number of features whose information can be shown at one time in the Feature Info Panel, from this item. Defaults to terria.configParameters.defaultMaximumShownFeatureInfos

metadataUrl

The URL from which this data item's metadata description can be retrieved, or undefined if metadata is not available for this data item. The format of the metadata depends on the type of data item. For example, Web Map Service (WMS) data items provide their metadata via their GetCapabilities document.

name

The name of the item.

nowViewingMessage

A message to show when this item is enabled for the first time in order to call attention to the Now Viewing panel.

observableProperties

The sensor observation service observableProperties that the user can choose from for this catalog item. An array of objects with keys 'identifier', 'title' and (optionally) 'defaultDuration' and 'units', eg. [{ identifier: 'http://bom.gov.au/waterdata/services/parameters/Storage Level', title: 'Storage Level', units: 'metres' }] The identifier is used for communication with the server, and the title is used for display to the user. If there is only one object, the user is not presented with a choice.

observablePropertiesName

The name seen by the user for the list of observable properties. Defaults to "Property", but eg. for BoM, "Observation type" would be better.

opacity

The opacity (alpha) of the data item, where 0.0 is fully transparent and 1.0 is fully opaque.

procedures

The sensor observation service procedures that the user can choose from for this catalog item. An array of objects with keys 'identifier', 'title' and (optionally) 'defaultDuration' and 'units', eg. [{ identifier: 'http://bom.gov.au/waterdata/services/tstypes/Pat7_C_B_1_YearlyMean', title: 'Annual Mean', defaultDuration: '20y' // Final character must be s, h, d or y for seconds, hours, days or years. }] The identifier is used for communication with the server, and the title is used for display to the user. If there is only one object, the user is not presented with a choice.

proceduresName

The name seen by the user for the list of procedures. Defaults to "Procedure", but eg. for BoM, "Frequency" would be better.

rectangle

The geographic rectangle (extent or bounding box) containing this data item.

requestTemplate

The template XML string to POST to the SOS server to query for GetObservation. If this property is undefined, SensorObservationServiceCatalogItem.defaultRequestTemplate is used. This is used as a Mustache template. See SensorObservationServiceRequestTemplate.xml for the default. Be careful with newlines inside tags: Mustache can add an extra space in the front of them, which causes the request to fail on the SOS server. Eg. http://www.opengis.net/... will render as http://www.opengis.net/... The space before the "http" will cause the request to fail.

shareKeys

An array of all possible keys that can be used to match to this catalog member when specified in a share link - used for maintaining backwards compatibility when adding or changing CatalogMember's id.

shortReport

A short report to show on the now viewing tab.

showWarnings

Should any warnings like failures in region mapping be displayed to the user?

showsInfo

A value indicating whether this data source should show an info icon.

startDate

A start date in ISO8601 format. All requests filter to this start date. Set to undefined for no temporal filter.

tryToLoadObservationData

A flag. If true, the catalog item will load all features, then, if number of features < requestSizeLimit * requestNumberLimit, it will load all the observation data for those features, and show that. If false, or there are too many features, the observation data is only loaded when the feature is clicked on (via a chart in the feature info panel). Defaults to true.

url

The URL of this data.

zoomOnEnable

A value indicating whether the map will automatically zoom to this catalog item when it is enabled.