API IDEE Core v1.1.0 API

Class: WMS

IDEE/impl/layer/WMS~WMS

import WMS from 'IDEE/impl/layer/WMS';

WMS devuelve un mapa en formato imagen de un conjunto capas ráster o vectoriales. Permitiendo las personalización de las capas mediante estilos. Se trata de un mapa dínamico.

new WMS(options, vendorOptions)

impl/ol/js/layer/WMS.js, line 51

Constructor principal de la clase. Crea una capa WMS con parámetros especificados por el usuario.

Name Type Description

Name	Type	Description
`options`	Mx.parameters.LayerOptions	Parámetros opcionales para la capa. opacity: Opacidad de capa, por defecto 1. singleTile: Indica si la tesela es única o no. animated: Define si la capa está animada, el valor predeterminado es falso. format: Formato de la capa, por defecto image/png. styles: Estilos de la capa. sldBody: Parámetros "ol.source.ImageWMS" minZoom: Zoom mínimo aplicable a la capa. maxZoom: Zoom máximo aplicable a la capa. minScale: Escala mínima. maxScale: Escala máxima. minResolution: Resolución mínima. maxResolution: Resolución máxima. ratio: determina el tamaño de las solicitudes de las imágenes. 1 significa que tienen el tamaño de la ventana, 2 significa que tienen el doble del tamaño de la ventana, y así sucesivamente. Debe ser 1 o superior. Por defecto es 1. crossOrigin: Atributo crossOrigin para las imágenes cargadas. isWMSfull: establece si la capa es WMS_FULL. mergeLayers: Verdadero si se añaden todas las capas del servicio en una, falso en caso contrario. Por defecto, verdadero.
`vendorOptions`	Object	Opciones para la biblioteca base. Ejemplo vendorOptions: `import OLSourceTileWMS from 'ol/source/TileWMS'; { opacity: 0.1, source: new OLSourceTileWMS({ attributions: 'wms', ... }) tileLoadFunction: }`

options

Mx.parameters.LayerOptions

Parámetros opcionales para la capa.

opacity: Opacidad de capa, por defecto 1.
singleTile: Indica si la tesela es única o no.
animated: Define si la capa está animada, el valor predeterminado es falso.
format: Formato de la capa, por defecto image/png.
styles: Estilos de la capa.
sldBody: Parámetros "ol.source.ImageWMS"
minZoom: Zoom mínimo aplicable a la capa.
maxZoom: Zoom máximo aplicable a la capa.
minScale: Escala mínima.
maxScale: Escala máxima.
minResolution: Resolución mínima.
maxResolution: Resolución máxima.
ratio: determina el tamaño de las solicitudes de las imágenes. 1 significa que tienen el tamaño de la ventana, 2 significa que tienen el doble del tamaño de la ventana, y así sucesivamente. Debe ser 1 o superior. Por defecto es 1. crossOrigin: Atributo crossOrigin para las imágenes cargadas.
isWMSfull: establece si la capa es WMS_FULL.
mergeLayers: Verdadero si se añaden todas las capas del servicio en una, falso en caso contrario. Por defecto, verdadero.

vendorOptions

Object

Opciones para la biblioteca base. Ejemplo vendorOptions:


import OLSourceTileWMS from 'ol/source/TileWMS';
{
 opacity: 0.1,
 source: new OLSourceTileWMS({
   attributions: 'wms',
   ...
 })
 tileLoadFunction: 
}

Properties:

Name	Type	Description
`options`	Object	Opciones de la capa WMS.
`layers`	Array.<IDEE.layer.WMS>	Intancia de WMS con metadatos.
`tileLoadFunction`	function	Función de carga de tiles.
`mergeLayers`	Boolean	Verdadero si se añaden todas las capas del servicio en una, falso en caso contrario. Por defecto, verdadero.

Extends

IDEE.impl.layer.Layer

Members

module:IDEE/impl/layer/WMS~WMS.LEGEND_IMAGE{string} {null}

WMS LEGEND_IMAGE.

Imagen de la leyenda por defecto.

Methods

addAllLayers_() impl/ol/js/layer/WMS.js, line 423

Este método agrega todas las capas por separado definidas en el servidor.

⚠️ Advertencia: Este método no debe ser llamado por el usuario.

addCapabilitiesMetadata(capabilitiesLayer) impl/ol/js/layer/WMS.js, line 633

Este método agrega metadatos.

⚠️ Advertencia: Este método no debe ser llamado por el usuario.

Name	Type	Description
`capabilitiesLayer`	Object	Metadatos de la capa.

addSingleLayer_() impl/ol/js/layer/WMS.js, line 472

Este método agrega esta capa como capa única.

⚠️ Advertencia: Este método no debe ser llamado por el usuario.

addTo(map) impl/ol/js/layer/WMS.js, line 338

Este método agrega la capa al mapa.

Name	Type	Description
`map`	IDEE.impl.Map	Mapa de la implementación.

cql(){IDEE.layer.WMS.impl.cql} impl/ol/js/layer/WMS.js, line 974

Devuelve el valor de la propiedad "cql".

Returns:

Valor de la cql.

cql(newCql) impl/ol/js/layer/WMS.js, line 986

Sobrescribe el valor de la propiedad "cql".

Name	Type	Description
`newCql`	IDEE.WMS.cql	Nueva cql.

createOLSource_(resolutions, minResolution, maxResolution, extent){ol.source} impl/ol/js/layer/WMS.js, line 662

Este método crea la fuente ol para esta instancia.

⚠️ Advertencia: Este método no debe ser llamado por el usuario.

Name	Type	Description
`resolutions`	Array.<Number>	Resolución
`minResolution`	Number	Resolución máxima.
`maxResolution`	Number	Resolución mínima.
`extent`	Array	Extensión.

Returns:

Fuente de Openlayers.

destroy() impl/ol/js/layer/WMS.js, line 1109

Este método destruye esta capa, limpiando el HTML y anulando el registro de todos los eventos.

equals(obj){Boolean} impl/ol/js/layer/WMS.js, line 1188

Este método comprueba si un objeto es igual a esta capa.

Name	Type	Description
`obj`	Object	Objeto a comparar.

Returns:

Verdadero es igual, falso si no.

getCapabilities(){capabilities} impl/ol/js/layer/WMS.js, line 879

Devuelve los metadatos, asincrono.

Returns:

Metadatos.

getExtent(){Array.<Number>} impl/ol/js/layer/WMS.js, line 738

Este método obtiene la extensión.

Returns:

Extensión, asincrono.

getExtentFromCapabilities(capabilities){Array.<Number>} impl/ol/js/layer/WMS.js, line 1081

Devuelve la extensión de los metadatos.

Name	Type	Description
`capabilities`	capabilities	Metadatos WMS.

Returns:

WMS Extensión.

getLayers(){IDEE.layer.WMS.impl} impl/ol/js/layer/WMS.js, line 867

Devuelve las capas WMS.

Returns:

Capa WMS.

getLegendURL(){String} impl/ol/js/layer/WMS.js, line 950

Devuelve la URL de la leyenda.

Returns:

URL de la leyenda.

getMaxResolution(){Number} impl/ol/js/layer/WMS.js, line 780

Este método obtiene la resolución máxima para este WMS.

Returns:

Resolución Máxima.

getMinResolution(){Number} impl/ol/js/layer/WMS.js, line 766

Este método obtiene la resolución mínima.

Returns:

Resolución mínima.

getNumZoomLevels(){Number} impl/ol/js/layer/WMS.js, line 855

Este método obtiene el número de niveles de zoom disponibles para la capa WMS.

Returns:

Número de niveles de zoom.

getSldVersion(){string|Array} impl/ol/js/layer/WMS.js, line 1036

Devuelve la versión del SLD.

Returns:

Versión del SLD.

getStyles(){string|Array} impl/ol/js/layer/WMS.js, line 1002

Devuelve el estilo de la capa.

Returns:

Estilo de la capa.

isQueryable(){Boolean} impl/ol/js/layer/WMS.js, line 326

Este método indica si la capa es consultable.

Returns:

Verdadero es consultable, falso si no.

recreateLayer() impl/ol/js/layer/WMS.js, line 1129

Este método elimina y crea la capa de Openlayers.

refresh() impl/ol/js/layer/WMS.js, line 1065

Este método actualiza el estado de este capa.

refreshLegendUrlByCapabilities_(capabilites) impl/ol/js/layer/WMS.js, line 580

Refresca la leyenda de la capa.

⚠️ Advertencia: Este método no debe ser llamado por el usuario.

Name	Type	Description
`capabilites`	Array.<Number>	Capabilities a usar

setFacadeObj(obj) impl/ol/js/layer/WMS.js, line 1097

Este método establece la clase de fachada WMS. La fachada se refiere a un patrón estructural como una capa de abstracción con un patrón de diseño.

Name	Type	Description
`obj`	object	WMS de la fachada.

setLegendURL(legendUrl) impl/ol/js/layer/WMS.js, line 962

Sobrescribe la leyenda.

Name	Type	Description
`legendUrl`	String	URL de la leyenda.

setMaxExtent(maxExtent) impl/ol/js/layer/WMS.js, line 812

Sobrescribe la extensión máxima de la capa.

Name	Type	Description
`maxExtent`	maxExtent	Extensión máxima.

setName(newName, isWMSFull) impl/ol/js/layer/WMS.js, line 1170

Sobreescribe el nombre de la capa.

Name	Type	Description
`newName`	String	Nuevo nombre de la capa.
`isWMSFull`	Boolean	Verdadero, si la capa es WMS_FULL, falso si no.

setResolutions(resolutions) impl/ol/js/layer/WMS.js, line 403

Este método establece las resoluciones para esta capa.

Name	Type	Description
`resolutions`	Array.<Number>	Nuevas resoluciones a aplicar.

setSldVersion(newSldVersion) impl/ol/js/layer/WMS.js, line 1048

Esta función aplica la versión del SLD a la capa

Name	Type	Description
`newSldVersion`	string \| Array	Nueva versión del SLD a aplicar.

setStyles(newStyles) impl/ol/js/layer/WMS.js, line 1014

Esta función aplica estilos a la capa

Name	Type	Description
`newStyles`	string \| Array	Nuevo estilo a aplicar.

setTileLoadFunction(fn) impl/ol/js/layer/WMS.js, line 842

Establece la función de carga de tiles.

Name	Type	Description
`fn`	function	Nueva función de carga de tiles.

setURL(newURL) impl/ol/js/layer/WMS.js, line 1154

Sobreescribe la URL de la capa.

Name	Type	Description
`newURL`	String	Nueva URL de la capa.

setVisible(visibility) impl/ol/js/layer/WMS.js, line 293

Este método establece la visibilidad de esta capa.

Name	Type	Description
`visibility`	Boolean	Verdadero es visible, falso si no.

updateMinMaxResolution(projection) impl/ol/js/layer/WMS.js, line 792

Actualiza la resolución mínima y máxima de la capa.

Name	Type	Description
`projection`	ol.Projection	Proyección del mapa.