geopf-extensions-openlayers
Version:
French Geoportal Extensions for OpenLayers libraries
51 lines • 2 kB
TypeScript
export default SourceWMS;
/**
* @classdesc
* Geoportal tile WMS source creation (inherit from ol.source.TileWMS)
*
* @alias ol.source.GeoportalWMS
* @module GeoportalWMS
*/
declare class SourceWMS extends TileWMSSource {
/**
* @constructor
* @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 {Array} [options.legends] - Legends objects associated to the layer
* @param {Array} [options.metadata] - Metadata objects associated to the layer
* @param {String} [options.title] - title of the layer
* @param {String} [options.description] - description of the layer
* @param {String} [options.quicklookUrl] - quicklookUrl of the layer
* @param {Object} [options.olParams] - other options for ol.source.TileWMS function (see {@link http://openlayers.org/en/latest/apidoc/ol.source.TileWMS.html ol.source.TileWMS})
* @example
* var sourceWMS = new ol.source.GeoportalWMS({
* layer : "ORTHOIMAGERY.ORTHOPHOTOS"
* });
*
*/
constructor(options: {
layer: string;
configuration?: any;
ssl?: boolean | undefined;
apiKey?: string | undefined;
legends?: any[] | undefined;
metadata?: any[] | undefined;
title?: string | undefined;
description?: string | undefined;
quicklookUrl?: string | undefined;
olParams?: any;
});
_originators: any;
_legends: any;
_metadata: any;
_title: any;
_description: any;
_quicklookUrl: any;
name: string;
service: string;
}
import TileWMSSource from "ol/source/TileWMS";
//# sourceMappingURL=SourceWMS.d.ts.map