terriajs
Version:
Geospatial data visualization platform.
772 lines (636 loc) • 45.4 kB
HTML
<html lang="en">
<head>
<meta charset="utf-8">
<title>JSDoc: Source: Models/WebMapTileServiceCatalogItem.js</title>
<script src="scripts/prettify/prettify.js"> </script>
<script src="scripts/prettify/lang-css.js"> </script>
<!--[if lt IE 9]>
<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
<![endif]-->
<link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
<link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
</head>
<body>
<div id="main">
<h1 class="page-title">Source: Models/WebMapTileServiceCatalogItem.js</h1>
<section>
<article>
<pre class="prettyprint source linenums"><code>'use strict';
/*global require*/
var URI = require('urijs');
var clone = require('terriajs-cesium/Source/Core/clone');
var defaultValue = require('terriajs-cesium/Source/Core/defaultValue');
var defined = require('terriajs-cesium/Source/Core/defined');
var defineProperties = require('terriajs-cesium/Source/Core/defineProperties');
var freezeObject = require('terriajs-cesium/Source/Core/freezeObject');
var GeographicTilingScheme = require('terriajs-cesium/Source/Core/GeographicTilingScheme');
var GetFeatureInfoFormat = require('terriajs-cesium/Source/Scene/GetFeatureInfoFormat');
var knockout = require('terriajs-cesium/Source/ThirdParty/knockout');
var loadXML = require('../Core/loadXML');
var Rectangle = require('terriajs-cesium/Source/Core/Rectangle');
var WebMapTileServiceImageryProvider = require('terriajs-cesium/Source/Scene/WebMapTileServiceImageryProvider');
var WebMercatorTilingScheme = require('terriajs-cesium/Source/Core/WebMercatorTilingScheme');
var when = require('terriajs-cesium/Source/ThirdParty/when');
var containsAny = require('../Core/containsAny');
var Metadata = require('./Metadata');
var MetadataItem = require('./MetadataItem');
var ImageryLayerCatalogItem = require('./ImageryLayerCatalogItem');
var inherit = require('../Core/inherit');
var overrideProperty = require('../Core/overrideProperty');
var proxyCatalogItemUrl = require('./proxyCatalogItemUrl');
var xml2json = require('../ThirdParty/xml2json');
var LegendUrl = require('../Map/LegendUrl');
/**
* A {@link ImageryLayerCatalogItem} representing a layer from a Web Map Tile Service (WMTS) server.
*
* @alias WebMapTileServiceCatalogItem
* @constructor
* @extends ImageryLayerCatalogItem
*
* @param {Terria} terria The Terria instance.
*/
var WebMapTileServiceCatalogItem = function(terria) {
ImageryLayerCatalogItem.call(this, terria);
this._rawMetadata = undefined;
this._metadata = undefined;
this._dataUrl = undefined;
this._dataUrlType = undefined;
this._metadataUrl = undefined;
this._legendUrl = undefined;
this._rectangle = undefined;
this._rectangleFromMetadata = undefined;
this._intervalsFromMetadata = undefined;
/**
* Gets or sets the WMTS layer to use. This property is observable.
* @type {String}
*/
this.layer = '';
/**
* Gets or sets the WMTS style to use. This property is observable.
* @type {String}
*/
this.style = undefined;
/**
* Gets or sets the WMTS Tile Matrix Set ID to use. This property is observable.
* @type {String}
*/
this.tileMatrixSetID = undefined;
/**
* Gets or sets the labels for each level in the matrix set. This property is observable.
* @type {Array}
*/
this.tileMatrixSetLabels = undefined;
/**
* Gets or sets the tiling scheme to pass to the WMTS server when requesting images.
* If this property is undefiend, the default tiling scheme of the provider is used.
* @type {Object}
*/
this.tilingScheme = undefined;
/**
* Gets or sets the formats in which to try WMTS GetFeatureInfo requests. If this property is undefined, the `WebMapServiceImageryProvider` defaults
* are used. This property is observable.
* @type {GetFeatureInfoFormat[]}
*/
this.getFeatureInfoFormats = undefined;
/**
* Gets or sets a value indicating whether a time dimension, if it exists in GetCapabilities, should be used to populate
* the {@link ImageryLayerCatalogItem#intervals}. If the {@link ImageryLayerCatalogItem#intervals} property is set explicitly
* on this catalog item, the value of this property is ignored.
* @type {Boolean}
* @default true
*/
this.populateIntervalsFromTimeDimension = true;
/**
* Gets or sets 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.
* @type {Number}
*/
this.minScaleDenominator = undefined;
/**
* Gets or sets the format in which to request tile images. If not specified, 'image/png' is used. This property is observable.
* @type {String}
*/
this.format = undefined;
knockout.track(this, [
'_dataUrl', '_dataUrlType', '_metadataUrl', '_legendUrl', '_rectangle', '_rectangleFromMetadata', '_intervalsFromMetadata',
'layer', 'style', 'tileMatrixSetID', 'getFeatureInfoFormats',
'tilingScheme', 'populateIntervalsFromTimeDimension', 'minScaleDenominator', 'format']);
// dataUrl, metadataUrl, and legendUrl are derived from url if not explicitly specified.
overrideProperty(this, 'metadataUrl', {
get : function() {
if (defined(this._metadataUrl)) {
return this._metadataUrl;
}
return cleanUrl(this.url) + '?service=WMTS&request=GetCapabilities&version=1.0.0';
},
set : function(value) {
this._metadataUrl = value;
}
});
// The dataUrl must be explicitly specified. Don't try to use `url` as the the dataUrl, because it won't work for a WMTS URL.
overrideProperty(this, 'dataUrl', {
get : function() {
return this._dataUrl;
},
set : function(value) {
this._dataUrl = value;
}
});
overrideProperty(this, 'dataUrlType', {
get : function() {
if (defined(this._dataUrlType)) {
return this._dataUrlType;
} else {
return 'none';
}
},
set : function(value) {
this._dataUrlType = value;
}
});
};
inherit(ImageryLayerCatalogItem, WebMapTileServiceCatalogItem);
defineProperties(WebMapTileServiceCatalogItem.prototype, {
/**
* Gets the type of data item represented by this instance.
* @memberOf WebMapTileServiceCatalogItem.prototype
* @type {String}
*/
type : {
get : function() {
return 'wmts';
}
},
/**
* Gets a human-readable name for this type of data source, 'Web Map Tile Service (WMTS)'.
* @memberOf WebMapTileServiceCatalogItem.prototype
* @type {String}
*/
typeName : {
get : function() {
return 'Web Map Tile Service (WMTS)';
}
},
/**
* Gets a value indicating whether this {@link ImageryLayerCatalogItem} supports the {@link ImageryLayerCatalogItem#intervals}
* property for configuring time-dynamic imagery.
* @type {Boolean}
*/
supportsIntervals : {
get : function() {
return true;
}
},
/**
* Gets the metadata associated with this data source and the server that provided it, if applicable.
* @memberOf WebMapTileServiceCatalogItem.prototype
* @type {Metadata}
*/
metadata : {
get : function() {
if (!defined(this._metadata)) {
this._metadata = requestMetadata(this);
}
return this._metadata;
}
},
/**
* Gets the set of functions used to update individual properties in {@link CatalogMember#updateFromJson}.
* When a property name in the returned object literal matches the name of a property on this instance, the value
* will be called as a function and passed a reference to this instance, a reference to the source JSON object
* literal, and the name of the property.
* @memberOf WebMapTileServiceCatalogItem.prototype
* @type {Object}
*/
updaters : {
get : function() {
return WebMapTileServiceCatalogItem.defaultUpdaters;
}
},
/**
* Gets the set of functions used to serialize individual properties in {@link CatalogMember#serializeToJson}.
* When a property name on the model matches the name of a property in the serializers object literal,
* the value will be called as a function and passed a reference to the model, a reference to the destination
* JSON object literal, and the name of the property.
* @memberOf WebMapTileServiceCatalogItem.prototype
* @type {Object}
*/
serializers : {
get : function() {
return WebMapTileServiceCatalogItem.defaultSerializers;
}
}
});
WebMapTileServiceCatalogItem.defaultUpdaters = clone(ImageryLayerCatalogItem.defaultUpdaters);
WebMapTileServiceCatalogItem.defaultUpdaters.tilingScheme = function(wmtsItem, json, propertyName, options) {
if (json.tilingScheme === 'geographic') {
wmtsItem.tilingScheme = new GeographicTilingScheme();
} else if (json.tilingScheme === 'web-mercator') {
wmtsItem.tilingScheme = new WebMercatorTilingScheme();
} else {
wmtsItem.tilingScheme = json.tilingScheme;
}
};
WebMapTileServiceCatalogItem.defaultUpdaters.getFeatureInfoFormats = function(wmtsItem, json, propertyName, options) {
var formats = [];
for (var i = 0; i < json.getFeatureInfoFormats.length; ++i) {
var format = json.getFeatureInfoFormats[i];
formats.push(new GetFeatureInfoFormat(format.type, format.format));
}
wmtsItem.getFeatureInfoFormats = formats;
};
freezeObject(WebMapTileServiceCatalogItem.defaultUpdaters);
WebMapTileServiceCatalogItem.defaultSerializers = clone(ImageryLayerCatalogItem.defaultSerializers);
// Serialize the underlying properties instead of the public views of them.
WebMapTileServiceCatalogItem.defaultSerializers.dataUrl = function(wmtsItem, json, propertyName) {
json.dataUrl = wmtsItem._dataUrl;
};
WebMapTileServiceCatalogItem.defaultSerializers.dataUrlType = function(wmtsItem, json, propertyName) {
json.dataUrlType = wmtsItem._dataUrlType;
};
WebMapTileServiceCatalogItem.defaultSerializers.metadataUrl = function(wmtsItem, json, propertyName) {
json.metadataUrl = wmtsItem._metadataUrl;
};
WebMapTileServiceCatalogItem.defaultSerializers.legendUrl = function(wmtsItem, json, propertyName) {
json.legendUrl = wmtsItem._legendUrl;
};
WebMapTileServiceCatalogItem.defaultSerializers.tilingScheme = function(wmtsItem, json, propertyName) {
if (wmtsItem.tilingScheme instanceof GeographicTilingScheme) {
json.tilingScheme = 'geographic';
} else if (wmtsItem.tilingScheme instanceof WebMercatorTilingScheme) {
json.tilingScheme = 'web-mercator';
} else {
json.tilingScheme = wmtsItem.tilingScheme;
}
};
freezeObject(WebMapTileServiceCatalogItem.defaultSerializers);
/**
* The collection of strings that indicate an Abstract property should be ignored. If these strings occur anywhere
* in the Abstract, the Abstract will not be used. This makes it easy to filter out placeholder data like
* Geoserver's "A compliant implementation of WMTS..." stock abstract.
* @type {Array}
*/
WebMapTileServiceCatalogItem.abstractsToIgnore = [
'A compliant implementation of WMTS'
];
/**
* Updates this catalog item from a WMTS GetCapabilities document.
* @param {Object|XMLDocument} capabilities The capabilities document. This may be a JSON object or an XML document. If it
* is a JSON object, each layer is expected to have a `_parent` property with a reference to its
* parent layer.
* @param {Boolean} [overwrite=false] True to overwrite existing property values with data from the capabilities; false to
* preserve any existing values.
* @param {Object} [thisLayer] A reference to this layer within the JSON capabilities object. If this parameter is not
* specified or if `capabilities` is an XML document, the layer is found automatically based on this
* catalog item's `layers` property.
*/
WebMapTileServiceCatalogItem.prototype.updateFromCapabilities = function(capabilities, overwrite, thisLayer) {
if (defined(capabilities.documentElement)) {
capabilities = WebMapTileServiceCatalogItem.capabilitiesXmlToJson(capabilities);
thisLayer = undefined;
}
if (!defined(thisLayer)) {
thisLayer = findLayer(capabilities, this.layer);
if (!defined(thisLayer)) {
return;
}
}
this._rawMetadata = capabilities;
if (!containsAny(thisLayer.Abstract, WebMapTileServiceCatalogItem.abstractsToIgnore)) {
updateInfoSection(this, overwrite, 'Data Description', thisLayer.Abstract);
}
var service = defined(capabilities.Service) ? capabilities.Service : {};
// Show the service abstract if there is one, and if it isn't the Geoserver default "A compliant implementation..."
if (!containsAny(service.Abstract, WebMapTileServiceCatalogItem.abstractsToIgnore) && service.Abstract !== thisLayer.Abstract) {
updateInfoSection(this, overwrite, 'Service Description', service.Abstract);
}
// Show the Access Constraints if it isn't "none" (because that's the default, and usually a lie).
if (defined(service.AccessConstraints) && !/^none$/i.test(service.AccessConstraints)) {
updateInfoSection(this, overwrite, 'Access Constraints', service.AccessConstraints);
}
updateValue(this, overwrite, 'dataCustodian', getDataCustodian(capabilities));
updateValue(this, overwrite, 'minScaleDenominator', thisLayer.MinScaleDenominator);
updateValue(this, overwrite, 'getFeatureInfoFormats', getFeatureInfoFormats(thisLayer));
updateValue(this, overwrite, 'rectangle', getRectangleFromLayer(thisLayer));
// Find a suitable image format. Prefer PNG but fall back on JPEG is necessary
var formats = thisLayer.Format;
if (defined(formats)) {
if (!Array.isArray(formats)) {
formats = [formats];
}
var format;
if (formats.indexOf('image/png') >= 0) {
format = 'image/png';
} else if (formats.indexOf('image/jpeg') >= 0 || formats.indexOf('images/jpg') >= 0) {
format = 'image/jpeg';
}
updateValue(this, overwrite, 'format', format);
}
// Find a suitable tile matrix set.
var tileMatrixSetID = 'urn:ogc:def:wkss:OGC:1.0:GoogleMapsCompatible';
var tileMatrixSetLabels;
var tileMatrixSetLinks = thisLayer.TileMatrixSetLink;
if (!Array.isArray(tileMatrixSetLinks)) {
tileMatrixSetLinks = [tileMatrixSetLinks];
}
var i;
for (i = 0; i < tileMatrixSetLinks.length; ++i) {
var link = tileMatrixSetLinks[i];
var set = link.TileMatrixSet;
if (capabilities.usableTileMatrixSets[set]) {
tileMatrixSetID = set;
tileMatrixSetLabels = capabilities.usableTileMatrixSets[set];
break;
}
}
updateValue(this, overwrite, 'tileMatrixSetID', tileMatrixSetID);
updateValue(this, overwrite, 'tileMatrixSetLabels', tileMatrixSetLabels);
// Find the default style.
var styles = thisLayer.Style;
if (defined(styles)) {
if (!Array.isArray(styles)) {
styles = [styles];
}
var defaultStyle;
for (i = 0; i < styles.length; ++i) {
var style = styles[i];
if (style.isDefault) {
defaultStyle = style.Identifier;
var legendData = style.legendURL;
if (defined(legendData)) {
// WMTS can specify multiple legends, where different legends are applicable to different zooms.
// Since TerriaJS only supports showing a single legend currently, show the first one.
if (Array.isArray(legendData)) {
legendData = legendData[0];
}
this.legendUrl = new LegendUrl(legendData.href, legendData.format);
}
break;
}
}
if (!defined(defaultStyle)) {
defaultStyle = '';
}
updateValue(this, overwrite, 'style', defaultStyle);
}
};
WebMapTileServiceCatalogItem.prototype._load = function() {
if (!defined(this._rawMetadata)) {
var that = this;
return loadXML(proxyCatalogItemUrl(this, this.metadataUrl)).then(function(xml) {
that._rawMetadata = WebMapTileServiceCatalogItem.capabilitiesXmlToJson(xml);
that.updateFromCapabilities(that._rawMetadata, false);
return that._rawMetadata;
});
}
};
WebMapTileServiceCatalogItem.prototype._createImageryProvider = function() {
return new WebMapTileServiceImageryProvider({
url : cleanAndProxyUrl(this, this.url),
layer : this.layer,
tileMatrixSetID: this.tileMatrixSetID,
tileMatrixLabels: this.tileMatrixSetLabels,
style: this.style,
getFeatureInfoFormats : this.getFeatureInfoFormats,
tilingScheme : defined(this.tilingScheme) ? this.tilingScheme : new WebMercatorTilingScheme(),
format : defaultValue(this.format, 'image/png')
});
};
WebMapTileServiceCatalogItem.capabilitiesXmlToJson = function(xml) {
var json = xml2json(xml);
json.usableTileMatrixSets = {
'urn:ogc:def:wkss:OGC:1.0:GoogleMapsCompatible': true
};
var standardTilingScheme = new WebMercatorTilingScheme();
var matrixSets = json.Contents.TileMatrixSet;
for (var i = 0; i < matrixSets.length; ++i) {
var matrixSet = matrixSets[i];
// Usable tile matrix sets must use the Web Mercator projection.
if (matrixSet.SupportedCRS !== 'urn:ogc:def:crs:EPSG::900913' && matrixSet.SupportedCRS !== 'urn:ogc:def:crs:EPSG:6.18:3:3857' ) {
continue;
}
// Usable tile matrix sets must have a single 256x256 tile at the root.
var matrices = matrixSet.TileMatrix;
if (!defined(matrices) || matrices.length < 1) {
continue;
}
var levelZeroMatrix = matrices[0];
if ((levelZeroMatrix.TileWidth | 0) !== 256 || (levelZeroMatrix.TileHeight | 0) !== 256 || (levelZeroMatrix.MatrixWidth | 0) !== 1 || (levelZeroMatrix.MatrixHeight | 0) !== 1) {
continue;
}
var levelZeroScaleDenominator = 559082264.0287178; // from WMTS 1.0.0 spec section E.4.
if (Math.abs(levelZeroMatrix.ScaleDenominator - levelZeroScaleDenominator) > 1) {
continue;
}
if (!defined(levelZeroMatrix.TopLeftCorner)) {
continue;
}
var levelZeroTopLeftCorner = levelZeroMatrix.TopLeftCorner.split(' ');
var startX = levelZeroTopLeftCorner[0];
var startY = levelZeroTopLeftCorner[1];
if (Math.abs(startX - standardTilingScheme._rectangleSouthwestInMeters.x) > 1) {
continue;
}
if (Math.abs(startY - standardTilingScheme._rectangleNortheastInMeters.y) > 1) {
continue;
}
json.usableTileMatrixSets[matrixSet.Identifier] = true;
if (defined(matrixSet.TileMatrix) && matrixSet.TileMatrix.length > 0) {
json.usableTileMatrixSets[matrixSet.Identifier] = matrixSet.TileMatrix.map(function(item) { return item.Identifier; });
}
}
return json;
};
function cleanAndProxyUrl(catalogItem, url) {
return proxyCatalogItemUrl(catalogItem, cleanUrl(url));
}
function cleanUrl(url) {
// Strip off the search portion of the URL
var uri = new URI(url);
uri.search('');
return uri.toString();
}
function getRectangleFromLayer(layer) {
// Unfortunately, WMTS 1.0 doesn't require WGS84BoundingBox (or any bounding box) to be specified.
var bbox = layer.WGS84BoundingBox;
if (!defined(bbox)) {
return undefined;
}
var ll = bbox.LowerCorner;
var ur = bbox.UpperCorner;
if (!defined(ll) || !defined(ur)) {
return undefined;
}
var llParts = ll.split(' ');
var urParts = ur.split(' ');
if (llParts.length !== 2 || urParts.length !== 2) {
return undefined;
}
return Rectangle.fromDegrees(llParts[0], llParts[1], urParts[0], urParts[1]);
}
function getFeatureInfoFormats(layer) {
var supportsJsonGetFeatureInfo = false;
var supportsXmlGetFeatureInfo = false;
var supportsHtmlGetFeatureInfo = false;
var xmlContentType = 'text/xml';
var format = layer.InfoFormat;
if (defined(format)) {
if (format === 'application/json') {
supportsJsonGetFeatureInfo = true;
} else if (defined(format.indexOf) && format.indexOf('application/json') >= 0) {
supportsJsonGetFeatureInfo = true;
}
if (format === 'text/xml' || format === 'application/vnd.ogc.gml') {
supportsXmlGetFeatureInfo = true;
xmlContentType = format;
} else if (defined(format.indexOf) && format.indexOf('text/xml') >= 0) {
supportsXmlGetFeatureInfo = true;
xmlContentType = 'text/xml';
} else if (defined(format.indexOf) && format.indexOf('application/vnd.ogc.gml') >= 0) {
supportsXmlGetFeatureInfo = true;
xmlContentType = 'application/vnd.ogc.gml';
} else if (defined(format.indexOf) && format.indexOf('text/html') >= 0) {
supportsHtmlGetFeatureInfo = true;
}
}
var result = [];
if (supportsJsonGetFeatureInfo) {
result.push(new GetFeatureInfoFormat('json'));
}
if (supportsXmlGetFeatureInfo) {
result.push(new GetFeatureInfoFormat('xml', xmlContentType));
}
if (supportsHtmlGetFeatureInfo) {
result.push(new GetFeatureInfoFormat('html'));
}
return result;
}
function requestMetadata(wmtsItem) {
var result = new Metadata();
result.isLoading = true;
var metadata = wmtsItem._rawMetadata || loadXML(proxyCatalogItemUrl(wmtsItem, wmtsItem.metadataUrl)).then(WebMapTileServiceCatalogItem.capabilitiesXmlToJson);
result.promise = when(metadata, function(json) {
if (json.ServiceIdentification || json.ServiceProvider) {
populateMetadataGroup(result.serviceMetadata, {
Identification: json.ServiceIdentification,
Provider: json.ServiceProvider
});
} else {
result.serviceErrorMessage = 'Service information not found in GetCapabilities operation response.';
}
var layer = findLayer(json, wmtsItem.layer);
if (layer) {
populateMetadataGroup(result.dataSourceMetadata, layer);
} else {
result.dataSourceErrorMessage = 'Layer information not found in GetCapabilities operation response.';
}
wmtsItem.updateFromCapabilities(json, false, layer);
result.isLoading = false;
}).otherwise(function() {
result.dataSourceErrorMessage = 'An error occurred while invoking the GetCapabilities service.';
result.serviceErrorMessage = 'An error occurred while invoking the GetCapabilities service.';
result.isLoading = false;
});
return result;
}
function findLayer(json, name) {
if (!defined(json.Contents) || !defined(json.Contents.Layer)) {
return undefined;
}
var layers = json.Contents.Layer;
for (var i = 0; i < layers.length; ++i) {
var layer = layers[i];
if (layer.Identifier === name || layer.Title === name) {
return layer;
}
}
return undefined;
}
function populateMetadataGroup(metadataGroup, sourceMetadata) {
if (typeof sourceMetadata === 'string' || sourceMetadata instanceof String || sourceMetadata instanceof Array) {
return;
}
for (var name in sourceMetadata) {
if (sourceMetadata.hasOwnProperty(name) && name !== '_parent') {
var value = sourceMetadata[name];
var dest;
if (name === 'BoundingBox' && value instanceof Array) {
for (var i = 0; i < value.length; ++i) {
var subValue = value[i];
dest = new MetadataItem();
dest.name = name + ' (' + subValue.CRS + ')';
dest.value = subValue;
populateMetadataGroup(dest, subValue);
metadataGroup.items.push(dest);
}
} else {
dest = new MetadataItem();
dest.name = name;
dest.value = value;
populateMetadataGroup(dest, value);
metadataGroup.items.push(dest);
}
}
}
}
function updateInfoSection(item, overwrite, sectionName, sectionValue) {
if (!defined(sectionValue) || sectionValue.length === 0) {
return;
}
var section = item.findInfoSection(sectionName);
if (!defined(section)) {
item.info.push({
name: sectionName,
content: sectionValue
});
} else if (overwrite) {
section.content = sectionValue;
}
}
function updateValue(item, overwrite, propertyName, propertyValue) {
if (!defined(propertyValue)) {
return;
}
if (overwrite || !defined(item[propertyName])) {
item[propertyName] = propertyValue;
}
}
function getDataCustodian(json) {
if (defined(json.ServiceProvider) && defined(json.ServiceProvider.ProviderName)) {
var name = json.ServiceProvider.ProviderName;
var web;
var email;
if (defined(json.ServiceProvider.ProviderSite) && defined(json.ServiceProvider.ProviderSite['xlink:href'])) {
web = json.ServiceProvider.ProviderSite.href;
}
if (defined(json.ServiceProvider.ServiceContact) && defined(json.ServiceProvider.ServiceContact.Address) && defined(json.ServiceProvider.ServiceContact.Address.ElectronicMailAddress)) {
email = json.ServiceProvider.ServiceContact.Address.ElectronicMailAddress;
}
var text = defined(web) ? '[' + name + '](' + web + ')' : name;
if (defined(email)) {
text += '<br/>';
text += '[' + email + '](mailto:' + email + ')';
}
return text;
} else {
return undefined;
}
}
module.exports = WebMapTileServiceCatalogItem;
</code></pre>
</article>
</section>
</div>
<nav>
<h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="AbsCode.html">AbsCode</a></li><li><a href="AbsConcept.html">AbsConcept</a></li><li><a href="AbsDataset.html">AbsDataset</a></li><li><a href="AbsIttCatalogGroup.html">AbsIttCatalogGroup</a></li><li><a href="AbsIttCatalogItem.html">AbsIttCatalogItem</a></li><li><a href="AddressGeocoder.html">AddressGeocoder</a></li><li><a href="ArcGisCatalogGroup.html">ArcGisCatalogGroup</a></li><li><a href="ArcGisFeatureServerCatalogGroup.html">ArcGisFeatureServerCatalogGroup</a></li><li><a href="ArcGisFeatureServerCatalogItem.html">ArcGisFeatureServerCatalogItem</a></li><li><a href="ArcGisMapServerCatalogGroup.html">ArcGisMapServerCatalogGroup</a></li><li><a href="ArcGisMapServerCatalogItem.html">ArcGisMapServerCatalogItem</a></li><li><a href="AugmentedVirtuality.html">AugmentedVirtuality</a></li><li><a href="BingMapsCatalogItem.html">BingMapsCatalogItem</a></li><li><a href="BooleanParameter.html">BooleanParameter</a></li><li><a href="BulkAddressGeocoderResult.html">BulkAddressGeocoderResult</a></li><li><a href="CameraView.html">CameraView</a></li><li><a href="Catalog.html">Catalog</a></li><li><a href="CatalogFunction.html">CatalogFunction</a></li><li><a href="CatalogGroup.html">CatalogGroup</a></li><li><a href="CatalogItem.html">CatalogItem</a></li><li><a href="CatalogMember.html">CatalogMember</a></li><li><a href="Cesium.html">Cesium</a></li><li><a href="Cesium3DTilesCatalogItem.html">Cesium3DTilesCatalogItem</a></li><li><a href="CesiumDragPoints.html">CesiumDragPoints</a></li><li><a href="CesiumTerrainCatalogItem.html">CesiumTerrainCatalogItem</a></li><li><a href="CkanCatalogGroup.html">CkanCatalogGroup</a></li><li><a href="CkanCatalogItem.html">CkanCatalogItem</a></li><li><a href="Clock.html">Clock</a></li><li><a href="CompositeCatalogItem.html">CompositeCatalogItem</a></li><li><a href="Concept.html">Concept</a></li><li><a href="CorsProxy.html">CorsProxy</a></li><li><a href="CsvCatalogItem.html">CsvCatalogItem</a></li><li><a href="CswCatalogGroup.html">CswCatalogGroup</a></li><li><a href="CustomComponentType.html">CustomComponentType</a></li><li><a href="CzmlCatalogItem.html">CzmlCatalogItem</a></li><li><a href="DataSourceCatalogItem.html">DataSourceCatalogItem</a></li><li><a href="DateTimeParameter.html">DateTimeParameter</a></li><li><a href="DisplayVariablesConcept.html">DisplayVariablesConcept</a></li><li><a href="EnumerationParameter.html">EnumerationParameter</a></li><li><a href="Feature.html">Feature</a></li><li><a href="FunctionParameter.html">FunctionParameter</a></li><li><a href="GeoJsonCatalogItem.html">GeoJsonCatalogItem</a></li><li><a href="GlobeOrMap.html">GlobeOrMap</a></li><li><a href="GnafAddressGeocoder.html">GnafAddressGeocoder</a></li><li><a href="GnafApi.html">GnafApi</a></li><li><a href="GnafSearchProviderViewModel.html">GnafSearchProviderViewModel</a></li><li><a href="GpxCatalogItem.html">GpxCatalogItem</a></li><li><a href="HelpScreen.html">HelpScreen</a></li><li><a href="HelpSequence.html">HelpSequence</a></li><li><a href="HelpSequences.html">HelpSequences</a></li><li><a href="HelpViewState.html">HelpViewState</a></li><li><a href="ImageryLayerCatalogItem____.html">ImageryLayerCatalogItem</a></li><li><a href="IonImageryCatalogItem.html">IonImageryCatalogItem</a></li><li><a href="KmlCatalogItem.html">KmlCatalogItem</a></li><li><a href="Leaflet.html">Leaflet</a></li><li><a href="LeafletDataSourceDisplay.html">LeafletDataSourceDisplay</a></li><li><a href="LeafletDragPoints.html">LeafletDragPoints</a></li><li><a href="LeafletGeomVisualizer.html">LeafletGeomVisualizer</a></li><li><a href="LegendHelper.html">LegendHelper</a></li><li><a href="LegendUrl.html">LegendUrl</a></li><li><a href="LineParameter.html">LineParameter</a></li><li><a href="MagdaCatalogItem.html">MagdaCatalogItem</a></li><li><a href="MapboxMapCatalogItem.html">MapboxMapCatalogItem</a></li><li><a href="MapInteractionMode.html">MapInteractionMode</a></li><li><a href="Metadata.html">Metadata</a></li><li><a href="MetadataItem.html">MetadataItem</a></li><li><a href="module.html#.exports">exports</a></li><li><a href="OgrCatalogItem.html">OgrCatalogItem</a></li><li><a href="OpenStreetMapCatalogItem.html">OpenStreetMapCatalogItem</a></li><li><a href="PlacesLikeMeCatalogfunction.html">PlacesLikeMeCatalogfunction</a></li><li><a href="PointParameter.html">PointParameter</a></li><li><a href="Polling.html">Polling</a></li><li><a href="PolygonParameter.html">PolygonParameter</a></li><li><a href="RectangleParameter.html">RectangleParameter</a></li><li><a href="RegionDataParameter.html">RegionDataParameter</a></li><li><a href="RegionMapping.html">RegionMapping</a></li><li><a href="RegionParameter.html">RegionParameter</a></li><li><a href="RegionProvider.html">RegionProvider</a></li><li><a href="RegionProviderList.html">RegionProviderList</a></li><li><a href="RegionTypeParameter.html">RegionTypeParameter</a></li><li><a href="ResultPendingCatalogItem.html">ResultPendingCatalogItem</a></li><li><a href="SdmxJsonCatalogItem.html">SdmxJsonCatalogItem</a></li><li><a href="SensorObservationServiceCatalogItem.html">SensorObservationServiceCatalogItem</a></li><li><a href="SocrataCatalogGroup.html">SocrataCatalogGroup</a></li><li><a href="SpatialDetailingCatalogFunction.html">SpatialDetailingCatalogFunction</a></li><li><a href="StringParameter.html">StringParameter</a></li><li><a href="SummaryConcept.html">SummaryConcept</a></li><li><a href="TableCatalogItem.html">TableCatalogItem</a></li><li><a href="TableColumn.html">TableColumn</a></li><li><a href="TableColumnStyle.html">TableColumnStyle</a></li><li><a href="TableDataSource.html">TableDataSource</a></li><li><a href="TableStructure.html">TableStructure</a></li><li><a href="TableStyle.html">TableStyle</a></li><li><a href="TerrainCatalogItem.html">TerrainCatalogItem</a></li><li><a href="Terria.html">Terria</a></li><li><a href="TerriaError.html">TerriaError</a></li><li><a href="TerriaJsonCatalogFunction.html">TerriaJsonCatalogFunction</a></li><li><a href="TimeSeriesStack.html">TimeSeriesStack</a></li><li><a href="UrlTemplateCatalogItem.html">UrlTemplateCatalogItem</a></li><li><a href="UrthecastCatalogGroup.html">UrthecastCatalogGroup</a></li><li><a href="UrthecastServerCatalogItem.html">UrthecastServerCatalogItem</a></li><li><a href="UserDrawing.html">UserDrawing</a></li><li><a href="VariableConcept.html">VariableConcept</a></li><li><a href="ViewerModes..html">ViewerModes.</a></li><li><a href="WebFeatureServiceCatalogGroup.html">WebFeatureServiceCatalogGroup</a></li><li><a href="WebFeatureServiceCatalogItem.html">WebFeatureServiceCatalogItem</a></li><li><a href="WebMapServiceCatalogGroup.html">WebMapServiceCatalogGroup</a></li><li><a href="WebMapServiceCatalogItem.html">WebMapServiceCatalogItem</a></li><li><a href="WebMapTileServiceCatalogGroup.html">WebMapTileServiceCatalogGroup</a></li><li><a href="WebMapTileServiceCatalogItem.html">WebMapTileServiceCatalogItem</a></li><li><a href="WebProcessingServiceCatalogFunction.html">WebProcessingServiceCatalogFunction</a></li><li><a href="WebProcessingServiceCatalogGroup.html">WebProcessingServiceCatalogGroup</a></li><li><a href="WebProcessingServiceCatalogItem.html">WebProcessingServiceCatalogItem</a></li><li><a href="WfsFeaturesCatalogGroup.html">WfsFeaturesCatalogGroup</a></li><li><a href="WhyAmISpecialCatalogFunction.html">WhyAmISpecialCatalogFunction</a></li></ul><h3>Global</h3><ul><li><a href="global.html#_bumpyTerrainProvider">_bumpyTerrainProvider</a></li><li><a href="global.html#_terrain">_terrain</a></li><li><a href="global.html#activeTimeColumnNameIdOrIndex">activeTimeColumnNameIdOrIndex</a></li><li><a href="global.html#addBoundingBox">addBoundingBox</a></li><li><a href="global.html#addMarker">addMarker</a></li><li><a href="global.html#addUserCatalogMember">addUserCatalogMember</a></li><li><a href="global.html#allFeaturesAvailablePromise">allFeaturesAvailablePromise</a></li><li><a href="global.html#allShareKeys">allShareKeys</a></li><li><a href="global.html#arrayProduct">arrayProduct</a></li><li><a href="global.html#barHeightMax">barHeightMax</a></li><li><a href="global.html#barHeightMin">barHeightMin</a></li><li><a href="global.html#barLeft">barLeft</a></li><li><a href="global.html#barTop">barTop</a></li><li><a href="global.html#buildEmptyAccumulator">buildEmptyAccumulator</a></li><li><a href="global.html#buildRequestData">buildRequestData</a></li><li><a href="global.html#buildShareLink">buildShareLink</a></li><li><a href="global.html#buildShortShareLink">buildShortShareLink</a></li><li><a href="global.html#calculateFinishDatesFromStartDates">calculateFinishDatesFromStartDates</a></li><li><a href="global.html#canShorten">canShorten</a></li><li><a href="global.html#categoryName">categoryName</a></li><li><a href="global.html#ChartData">ChartData</a></li><li><a href="global.html#color">color</a></li><li><a href="global.html#ColorMap">ColorMap</a></li><li><a href="global.html#combineData">combineData</a></li><li><a href="global.html#combineFilters">combineFilters</a></li><li><a href="global.html#combineRepeated">combineRepeated</a></li><li><a href="global.html#combineValueArrays">combineValueArrays</a></li><li><a href="global.html#computeRingWindingOrder">computeRingWindingOrder</a></li><li><a href="global.html#computeScreenSpacePosition">computeScreenSpacePosition</a></li><li><a href="global.html#config">config</a></li><li><a href="global.html#containsAny">containsAny</a></li><li><a href="global.html#convertLuceneHit">convertLuceneHit</a></li><li><a href="global.html#convertToDates">convertToDates</a></li><li><a href="global.html#correctEntityHeight">correctEntityHeight</a></li><li><a href="global.html#createCatalogItemFromFileOrUrl">createCatalogItemFromFileOrUrl</a></li><li><a href="global.html#createCatalogItemFromUrl">createCatalogItemFromUrl</a></li><li><a href="global.html#createCatalogMemberFromType">createCatalogMemberFromType</a></li><li><a href="global.html#createLeafletCredit">createLeafletCredit</a></li><li><a href="global.html#createParameterFromType">createParameterFromType</a></li><li><a href="global.html#createRegexDeserializer">createRegexDeserializer</a></li><li><a href="global.html#createRegexSerializer">createRegexSerializer</a></li><li><a href="global.html#cssClass">cssClass</a></li><li><a href="global.html#CustomComponents">CustomComponents</a></li><li><a href="global.html#deIndexWithDescendants">deIndexWithDescendants</a></li><li><a href="global.html#Description">Description</a></li><li><a href="global.html#direction">direction</a></li><li><a href="global.html#disposeSubscription">disposeSubscription</a></li><li><a href="global.html#EarthGravityModel1996">EarthGravityModel1996</a></li><li><a href="global.html#error">error</a></li><li><a href="global.html#extendLoad">extendLoad</a></li><li><a href="global.html#extent">extent</a></li><li><a href="global.html#featureClicked">featureClicked</a></li><li><a href="global.html#featureDataToGeoJson">featureDataToGeoJson</a></li><li><a href="global.html#featureMousedown">featureMousedown</a></li><li><a href="global.html#features">features</a></li><li><a href="global.html#findKeyForGroupElement">findKeyForGroupElement</a></li><li><a href="global.html#flattenCatalog">flattenCatalog</a></li><li><a href="global.html#formatDate">formatDate</a></li><li><a href="global.html#formatDateTime">formatDateTime</a></li><li><a href="global.html#formatNumberForLocale">formatNumberForLocale</a></li><li><a href="global.html#formatPropertyValue">formatPropertyValue</a></li><li><a href="global.html#formatTime">formatTime</a></li><li><a href="global.html#getAncestors">getAncestors</a></li><li><a href="global.html#getColumnOptions">getColumnOptions</a></li><li><a href="global.html#getColumnWithNameIdOrIndex">getColumnWithNameIdOrIndex</a></li><li><a href="global.html#getDataUriFormat">getDataUriFormat</a></li><li><a href="global.html#getGroupChildren">getGroupChildren</a></li><li><a href="global.html#getShareData">getShareData</a></li><li><a href="global.html#getTemporalFiltersContext">getTemporalFiltersContext</a></li><li><a href="global.html#getUniqueValues">getUniqueValues</a></li><li><a href="global.html#gmlToGeoJson">gmlToGeoJson</a></li><li><a href="global.html#gradientColorMap">gradientColorMap</a></li><li><a href="global.html#hasAddress">hasAddress</a></li><li><a href="global.html#hasChildren">hasChildren</a></li><li><a href="global.html#hasLatitudeAndLongitude">hasLatitudeAndLongitude</a></li><li><a href="global.html#hostInDomains">hostInDomains</a></li><li><a href="global.html#id">id</a></li><li><a href="global.html#infoWithoutSources">infoWithoutSources</a></li><li><a href="global.html#isBrowserCompatible">isBrowserCompatible</a></li><li><a href="global.html#isCommonMobilePlatform">isCommonMobilePlatform</a></li><li><a href="global.html#isLoading">isLoading</a></li><li><a href="global.html#isVisible">isVisible</a></li><li><a href="global.html#itemHeight">itemHeight</a></li><li><a href="global.html#itemHeightMin">itemHeightMin</a></li><li><a href="global.html#items">items</a></li><li><a href="global.html#itemSpacing">itemSpacing</a></li><li><a href="global.html#itemWidth">itemWidth</a></li><li><a href="global.html#Legend">Legend</a></li><li><a href="global.html#legendUrl">legendUrl</a></li><li><a href="global.html#map">map</a></li><li><a href="global.html#markdownToHtml">markdownToHtml</a></li><li><a href="global.html#markerVisible">markerVisible</a></li><li><a href="global.html#name">name</a></li><li><a href="global.html#NowViewing">NowViewing</a></li><li><a href="global.html#overrideProperty">overrideProperty</a></li><li><a href="global.html#pad">pad</a></li><li><a href="global.html#parseCustomHtmlToReact">parseCustomHtmlToReact</a></li><li><a href="global.html#parseCustomMarkdownToReact">parseCustomMarkdownToReact</a></li><li><a href="global.html#PickedFeatures">PickedFeatures</a></li><li><a href="global.html#pickPosition">pickPosition</a></li><li><a href="global.html#point">point</a></li><li><a href="global.html#points">points</a></li><li><a href="global.html#position">position</a></li><li><a href="global.html#prettifyCoordinates">prettifyCoordinates</a></li><li><a href="global.html#prettifyProjection">prettifyProjection</a></li><li><a href="global.html#printWindow">printWindow</a></li><li><a href="global.html#processAddress">processAddress</a></li><li><a href="global.html#Proj4Definitions">Proj4Definitions</a></li><li><a href="global.html#propertyGetTimeValues">propertyGetTimeValues</a></li><li><a href="global.html#readJson">readJson</a></li><li><a href="global.html#rectangle">rectangle</a></li><li><a href="global.html#rectangleToLatLngBounds">rectangleToLatLngBounds</a></li><li><a href="global.html#RegionDataValue">RegionDataValue</a></li><li><a href="global.html#regionDetails">regionDetails</a></li><li><a href="global.html#registerCustomComponentTypes">registerCustomComponentTypes</a></li><li><a href="global.html#rememberRejections">rememberRejections</a></li><li><a href="global.html#removeMarker">removeMarker</a></li><li><a href="global.html#replaceUnderscores">replaceUnderscores</a></li><li><a href="global.html#sanitiseAddressNumber">sanitiseAddressNumber</a></li><li><a href="global.html#selectBaseMap">selectBaseMap</a></li><li><a href="global.html#serializeToJson">serializeToJson</a></li><li><a href="global.html#ServerConfig">ServerConfig</a></li><li><a href="global.html#setClockCurrentTime">setClockCurrentTime</a></li><li><a href="global.html#shareKeyIndex">shareKeyIndex</a></li><li><a href="global.html#shouldBeUpdated">shouldBeUpdated</a></li><li><a href="global.html#showSelection">showSelection</a></li><li><a href="global.html#sortByFirst">sortByFirst</a></li><li><a href="global.html#sortedIndices">sortedIndices</a></li><li><a href="global.html#splitIntoBatches">splitIntoBatches</a></li><li><a href="global.html#supportsIntervals">supportsIntervals</a></li><li><a href="global.html#supportsWebGL">supportsWebGL</a></li><li><a href="global.html#TerriaViewer">TerriaViewer</a></li><li><a href="global.html#Title">Title</a></li><li><a href="global.html#toArrayOfRows">toArrayOfRows</a></li><li><a href="global.html#Tooltip">Tooltip</a></li><li><a href="global.html#triggerResize">triggerResize</a></li><li><a href="global.html#unionRectangleArray">unionRectangleArray</a></li><li><a href="global.html#unionRectangles">unionRectangles</a></li><li><a href="global.html#units">units</a></li><li><a href="global.html#up">up</a></li><li><a href="global.html#updateApplicationOnHashChange">updateApplicationOnHashChange</a></li><li><a href="global.html#updateFromJson">updateFromJson</a></li><li><a href="global.html#updateRectangleFromRegion">updateRectangleFromRegion</a></li><li><a href="global.html#variableNameLeft">variableNameLeft</a></li><li><a href="global.html#variableNameTop">variableNameTop</a></li><li><a href="global.html#ViewerMode">ViewerMode</a></li><li><a href="global.html#width">width</a></li><li><a href="global.html#yAxisMax">yAxisMax</a></li><li><a href="global.html#yAxisMin">yAxisMin</a></li></ul>
</nav>
<br class="clear">
<footer>
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Fri Sep 21 2018 12:26:19 GMT+1000 (AUS Eastern Standard Time)
</footer>
<script> prettyPrint(); </script>
<script src="scripts/linenumber.js"> </script>
</body>
</html>