geopf-extensions-openlayers
Version:
French Geoportal Extensions for OpenLayers libraries
30 lines • 1.34 kB
TypeScript
export default LayerWMS;
/**
* @classdesc
* Geoportal LayerWMS source creation (inherit from ol.layer.Tile)
*
* @constructor
* @extends {ol.layer.Tile}
* @alias ol.layer.GeoportalWMS
* @type {ol.layer.GeoportalWMS}
* @param {Object} options - options for function call.
* @param {String} options.layer - Layer name (e.g. "ORTHOIMAGERY.ORTHOPHOTOS")
* @param {Object} [options.configuration] - configuration (cf. example)
* @param {Boolean} [options.ssl] - if set true, enforce protocol https (only for nodejs)
* @param {String} [options.apiKey] - Access key to Geoportal platform
* @param {Object} [options.olParams] - other options for ol.layer.Tile function (see {@link http://openlayers.org/en/latest/apidoc/ol.layer.Tile.html ol.layer.Tile})
* @param {Object} [options.olParams.sourceParams] - other options for ol.source.TileWMS function (see {@link http://openlayers.org/en/latest/apidoc/ol.source.TileWMS.html ol.source.TileWMS})
* @example
* var layerWMS = new ol.layer.GeoportalWMS({
* layer : "ORTHOIMAGERY.ORTHOPHOTOS"
* });
*
* layerWMS.getLegends();
* layerWMS.getMetadata();
* layerWMS.getTitle();
* layerWMS.getDescription();
* layerWMS.getQuicklookUrl();
* layerWMS.getOriginators();
*/
declare var LayerWMS: ol.layer.GeoportalWMS;
//# sourceMappingURL=LayerWMS.d.ts.map