API IDEE Core

Class: OSM

IDEE/impl/layer/OSM~OSM 


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

La API-IDEE permite visualizar la capa de Open Street Map.

new OSM(userParameters, options, vendorOptions)

impl/ol/js/layer/OSM.js, line 24

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

Name Type Description
userParameters string | Mx.parameters.OSM

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

  • attribution: Atribución de la capa.
  • isBase: Indica si la capa es base.
  • transparent (deprecated): Falso si es una capa base, verdadero en caso contrario.
  • visibility: Indica si la capa estará por defecto visible o no.
  • displayInLayerSwitcher: Indica si la capa se muestra en el selector de capas.
  • name: Nombre de la capa en la leyenda.
  • legend: Indica el nombre que queremos que aparezca en el árbol de contenidos, si lo hay.
  • type: Tipo de la capa.
  • url: Url genera la OSM.
  • minZoom: Zoom mínimo aplicable a la capa.
  • maxZoom: Zoom máximo aplicable a la capa.
  • maxExtent: La medida en que restringe la visualización a una región específica.
  • opacity: Opacidad de capa, por defecto 1.
options Mx.parameters.LayerOptions

Parámetros opcionales para la capa.

  • animated: Activa la animación para capas base o parámetros animados.
  • minScale: Escala mínima.
  • maxScale: Escala máxima.
vendorOptions Object

Opciones para la biblioteca base. Ejemplo vendorOptions:


import SourceOSM from 'ol/source/OSM';
{
 opacity: 0.1,
 source: new SourceOSM({
   attributions: 'osm',
   ...
 })
}
tileLoadFunction:

Extends

  • IDEE.impl.layer.Layer

Methods

addTo(map)

impl/ol/js/layer/OSM.js, line 160

Este método añade la capa al mapa.

Name Type Description
map IDEE.impl.Map

Mapa de la implementación.

destroy()

impl/ol/js/layer/OSM.js, line 352

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

equals(obj){Boolean}

impl/ol/js/layer/OSM.js, line 385

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.

getMaxResolution()

impl/ol/js/layer/OSM.js, line 340

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

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

getMinResolution()

impl/ol/js/layer/OSM.js, line 327

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

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

setFacadeObj(obj)

impl/ol/js/layer/OSM.js, line 292

Este método establece la clase de la fachada OSM. 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

Fachada de la capa.

setMaxExtent(maxExtent)

impl/ol/js/layer/OSM.js, line 316

Este método establece la extensión máxima para la capa Openlayers.

Name Type Description
maxExtent Mx.Extent

Extensión máxima.

setResolutions(resolutions)

impl/ol/js/layer/OSM.js, line 237

Este método establece las resoluciones para esta capa.

Name Type Description
resolutions Array.<Number>

Nuevas resoluciones a aplicar.

setTileLoadFunction(func)

impl/ol/js/layer/OSM.js, line 304

Este método establece tileLoadFunction

Name Type Description
func function

Función de carga de teselas.

setVisible(visibility)

impl/ol/js/layer/OSM.js, line 118

Este método establece la visibilidad de esta capa.

Name Type Description
visibility Boolean

Verdadero es visible, falso si no.

updateSource_(resolutions)

impl/ol/js/layer/OSM.js, line 250

Este método actualiza la capa de origen.

  • ⚠️ Advertencia: Este método no debe ser llamado por el usuario.
Name Type Description
resolutions Array

Nuevas resoluciones a aplicar.