API IDEE Core

Class: WMS

IDEE/layer/WMS~WMS 


import WMS from 'IDEE/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(userParameters, options, vendorOptions)

facade/js/layer/WMS.js, line 38

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

Name Type Description
userParameters string | Mx.parameters.WMS

Parámetros para la construcción de la capa.

  • attribution: Atribución de la capa.
  • name: nombre de la capa en el servidor.
  • isBase: Indica si la capa es base.
  • transparent (deprecated): Falso si es una capa base, verdadero en caso contrario.
  • maxExtent: La medida en que restringe la visualización a una región específica.
  • legend: Nombre asociado en el árbol de contenidos, si usamos uno.
  • visibility: Verdadero si la capa es visible, falso si queremos que no lo sea. En este caso la capa sería detectado por los plugins de tablas de contenidos y aparecería como no visible.
  • displayInLayerSwitcher: Indica si la capa se muestra en el selector de capas.
  • url: url del servicio WFS.
  • queryable: Indica si la capa es consultable.
  • version: Versión WMS.
  • tiled: Verdadero si queremos dividir la capa en tiles, falso en caso contrario.
  • type: Tipo de la capa.
  • useCapabilities: Define si se utilizará el capabilities para generar la capa.
  • mergeLayers: Verdadero si se añaden todas las capas del servicio en una, falso en caso contrario. Por defecto, verdadero.
options Mx.parameters.LayerOptions

Estas opciones se mandarán a la implementación de 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.
vendorOptions Object

Opciones para la biblioteca base. Ejemplo vendorOptions:


import OLSourceTileWMS from 'ol/source/TileWMS';
{
 opacity: 0.1,
 source: new OLSourceTileWMS({
   attributions: 'wms',
   ...
 }),
 cql: 'id IN (3,5)',
}
Properties:
Name Type Description
idLayer String

Identificador de la capa.
legend String

Nombre asociado en el árbol de contenido, si usamos uno.
version String

Versión WMS.
tiled Boolean

Verdadero si queremos dividir la capa en mosaicos, falso en caso contrario.
transparent Boolean

(deprecated) 'Falso' si es una capa base, 'verdadero' en caso contrario.
capabilitiesMetadata Object

Capacidades de metadatos WMS.
minZoom Number

Limitar el zoom mínimo.
maxZoom Number

Limitar el zoom máximo.
options Object

Capa de opciones WMS.
useCapabilities Boolean

Define si se utilizará el capabilities para generar la capa.
isBase Boolean

Define si la capa es base.
cql String

Parámetro de filtrado.
wmcParent_ IDEE.layer.WMC

Capa WMC padre.

Extends

  • IDEE.Layer

Methods

_updateNoCache()

facade/js/layer/WMS.js, line 552

Actualica los parámetros de NoCahe, "IDEE.config.tileMappins".

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

calculateMaxExtent(){IDEE.WMS.maxExtent}

facade/js/layer/WMS.js, line 431

Este método calcula la extensión máxima de esta capa.

Versión asíncrona de getMaxExtent.

Returns:
Devuelve el maxExtent.

calculateMaxExtentWithCapabilities(){IDEE.WMS.maxExtent}

facade/js/layer/WMS.js, line 443

Este método calcula la extensión máxima de esta capa.

Versión asíncrona de getMaxExtent.

Returns:
Devuelve el maxExtent.

cql(){IDEE.layer.WMS.impl.cql}

facade/js/layer/WMS.js, line 235

Devuelve el valor de la propiedad "cql".

Returns:
Valor de la cql.

cql(newCql)

facade/js/layer/WMS.js, line 247

Sobrescribe el valor de la propiedad "cql".

Name Type Description
newCql IDEE.WMS.cql

Nueva cql.

equals(obj){Boolean}

facade/js/layer/WMS.js, line 602

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

Name Type Description
obj Object

Objeto a comparar.
Returns:
Valor verdadero es igual, falso no lo es.

getCapabilities(){IDEE.WMS.capabilities}

facade/js/layer/WMS.js, line 476

Este método recupera una Promesa que será resuelto cuando se recupera la solicitud GetCapabilities por el servicio y analizado. Las capacidades se almacenan en caché para evitar solicitudes múltiples.

Returns:
Devuelve el capabilities.

getMaxExtent(callbackFn){IDEE.WMS.maxExtent}

facade/js/layer/WMS.js, line 372

Este método calcula la extensión máxima de esta capa.

Name Type Description
callbackFn function
Returns:
Devuelve la extensión máxima.

getNoCacheName(){IDEE.config.tileMappgins.names}

facade/js/layer/WMS.js, line 501

Devuelve el nombre del "tileMappins" (nombres del contexto, de la configuración).

Returns:
Devuelve "noCacheName".

getNoCacheUrl(){IDEE.config.tileMappgins.urls}

facade/js/layer/WMS.js, line 490

Devuelve las URL de "tileMappins" (url del contexto, de la configuración).

Returns:
Devuelve "noCacheURL".

getSldVersion(){string|Array}

facade/js/layer/WMS.js, line 348

Devuelve la versión del SLD.

Returns:
Versión del SLD.

getStyles(){string|Array}

facade/js/layer/WMS.js, line 324

Devuelve el estilo de la capa.

Returns:
Estilo de la capa.

getWMCParent(){IDEE.layer.WMC}

facade/js/layer/WMS.js, line 527

Este método obtiene su capa WMC padre.

Returns:
Capa WMC que contiene a esta capa.

options(){IDEE.layer.WMTS.options}

facade/js/layer/WMS.js, line 288

Devuelve las opciones de la capa.

Returns:
Devuelve las opciones de la implementación.

options(newOptions)

facade/js/layer/WMS.js, line 300

Sobrescribe las opciones de la capa.

Name Type Description
newOptions Object

Nuevas opciones.

setName(newName)

facade/js/layer/WMS.js, line 580

Sobreescribe el nombre de la capa.

Name Type Description
newName String

Nuevo nombre de la capa.

setSldVersion(newSldVersion)

facade/js/layer/WMS.js, line 360

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)

facade/js/layer/WMS.js, line 336

Esta función aplica estilos a la capa

Name Type Description
newStyles string | Array

Nuevo estilo a aplicar.

setTileLoadFunction(fn)

facade/js/layer/WMS.js, line 312

Establece la función de carga de tiles.

Name Type Description
fn function

Nueva función de carga de tiles.

setURL(newURL)

facade/js/layer/WMS.js, line 568

Sobreescribe la URL de la capa.

Name Type Description
newURL String

Nueva URL de la capa.

setWMCParent(wmcParent)

facade/js/layer/WMS.js, line 514

Este método establece su capa WMC padre.

Name Type Description
wmcParent IDEE.layer.WMC

Capa WMC que incluye a esta capa.

tiled(){IDEE.layer.WMS.impl.tiled}

facade/js/layer/WMS.js, line 203

Devuelve el valor de la propiedad "tiled".

Returns:
Valor de la tesela.

tiled(newTiled)

facade/js/layer/WMS.js, line 215

Sobrescribe el valor de la propiedad "tiled".

Name Type Description
newTiled IDEE.WMS.tiled

Nueva tesela.

updateMinMaxResolution(projection){IDEE.WMS.impl.updateMinMaxResolution}

facade/js/layer/WMS.js, line 541

Actualización de capas WMS de resolución mínima y máxima.

Name Type Description
projection String | Mx.Projection

Proyección del mapa.
Returns:
Devuelve la resolucción máxima y mínima.

version(){IDEE.layer.WMS.impl.version}

facade/js/layer/WMS.js, line 259

Devuelve la versión del servicio, por defecto es 1.3.0.

Returns:
Versión del servicio.

version(newVersion)

facade/js/layer/WMS.js, line 271

Sobrescribe la versión del servicio, por defecto es 1.3.0.

Name Type Description
newVersion String

Nueva versión del servicio.