API IDEE Core

Class: OSM

IDEE/layer/OSM~OSM 


import OSM from 'IDEE/layer/OSM';

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

new OSM(userParameters, options, vendorOptions)

facade/js/layer/OSM.js, line 29

Constructor principal de la clase.

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

Estas opciones se mandarán a la implementación de 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:
Properties:
Name Type Description
idLayer String

Identificador de la capa.
name String

Nombre de la capa, OSM.
legend String

Indica el nombre que queremos que aparezca en el árbol de contenidos, si lo hay.
transparent Boolean

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

Opciones OSM.
isBase Boolean

Define si la capa es base.

Extends

  • IDEE.Layer

Methods

equals(obj){Boolean}

facade/js/layer/OSM.js, line 154

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.

setTileLoadFunction(func)

facade/js/layer/OSM.js, line 141

Sobrescribe la función de carga de teselas.

Name Type Description
func function

Función de carga de teselas.