API IDEE Core

Class: LayerBase

IDEE/Layer~LayerBase 


import LayerBase from 'IDEE/Layer';

De esta clase heredadan todas las capas base.

new LayerBase(userParameters, impl)

facade/js/layer/Layer.js, line 34

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

Name Type Description
userParameters string | Mx.parameters.Layer

Parámetros proporcionados por el usuario.

  • attribution: Atribución de la capa.
  • name: Nombre de la capa.
  • 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.
  • minZoom. Zoom mínimo aplicable a la capa.
  • maxZoom. Zoom máximo aplicable a la capa.
  • url: url del servicio.
impl Object

Implementación.
Properties:
Name Type Description
idLayer string

Identificador de la capa.
type string

Tipo de la capa.
url string

URL del servicio.
name string

Nombre de la capa.
transparent Boolean

(deprecated) Falso si es una capa base, verdadero en caso contrario.
userMaxExtent Array.<Number>

MaxExtent proporcionado por el usuario, la medida en que restringe la visualización a una región específica.
legend string

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

Define si la capa es base.
section_ IDEE.layer.Section

Indica si la capa pertenece a una sección.

Extends

  • IDEE.Base

Methods

calculateMaxExtent(){IDEE.layer.maxExtent}

facade/js/layer/Layer.js, line 461

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

Returns:
Devuelve una promesa, con la extensión máxima de esta capa.

displayInLayerSwitcher(){IDEE.layer.impl.displayInLayerSwitcher}

facade/js/layer/Layer.js, line 371

Devuelve verdadero si la capa estará en el "DisplayInLayerSwitcher".

Returns:
Verdadero si esta en el "DisplayInLayerSwitcher", falso si no.

displayInLayerSwitcher(newDisplayInLayerSwitcher)

facade/js/layer/Layer.js, line 384

Sobrescribe la propiedad "displayInLayerSwitcher" de la capa.

Name Type Description
newDisplayInLayerSwitcher Boolean

Verdadero si esta en el "DisplayInLayerSwitcher", falso si no.

generateName_()

facade/js/layer/Layer.js, line 827

Este método genera automáticamente un nombre para esta capa.

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

getId(){String}

facade/js/layer/Layer.js, line 403

Este método devuelve el identificador de la capa.

Returns:
Devuelve el identificador de la capa.

getLegend(){IDEE.layer.impl.legend}

facade/js/layer/Layer.js, line 222

Devuelve la leyenda de la capa. Indica el nombre que queremos que aparezca en el árbol de contenidos, si lo hay.

Returns:
Leyenda.

getLegendURL(){IDEE.layer.impl.getLegendURL}

facade/js/layer/Layer.js, line 636

Devuelve la URL de la leyenda.

Returns:
URL de la leyenda.

getMaxExtent(){IDEE.layer.maxExtent}

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

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

Returns:
Devuelve la extensión máxima de esta capa.

getMaxScale(){Number}

facade/js/layer/Layer.js, line 718

Esta función devuelve el valor de la escala máxima para esta capa.

Returns:
Devuelve el valor de la escala máxima.

getMaxZoom(){Number}

facade/js/layer/Layer.js, line 763

Este método devuelve el zoom máximo aplicable a la capa.

Returns:
Nuevo zoom.

getMinScale(){Number}

facade/js/layer/Layer.js, line 696

Esta función devuelve el valor de la escala mínima para esta capa.

Returns:
Devuelve el valor de la escala mínima.

getMinZoom(){Number}

facade/js/layer/Layer.js, line 740

Este método devuelve el mínimo zoom aplicable a la capa.

Returns:
Zoom mínimo.

getOpacity(){Number}

facade/js/layer/Layer.js, line 786

Este método obtiene la opacidad de esta capa.

Returns:
Opacidad de la capa.

getSection(){IDEE.layer.Section}

facade/js/layer/Layer.js, line 529

Este método devuelve la sección de esta capa, si la tiene.

Returns:
Sección de la capa.

getZIndex(){Number}

facade/js/layer/Layer.js, line 662

Este método obtiene el índice z de esta capa.

Returns:
Devuelve el z-index.

inRange(){IDEE.layer.impl.inRange}

facade/js/layer/Layer.js, line 620

Este método indica si la capa está dentro del rango.

Returns:
Devuelve si la capa está dentro del rango.

isBase(){IDEE.layer.impl.transparent}

facade/js/layer/Layer.js, line 301

Devuelve el valor de la propiedad "isBase" de la capa.

Returns:
Valor de la propiedad "isBase".

isBase(newIsBase)

facade/js/layer/Layer.js, line 313

Sobrescribe el valor de la propiedad "isBase".

Name Type Description
newIsBase Boolean

Nuevo valor para la propiedad "isBase".

isQueryable(){Boolean}

facade/js/layer/Layer.js, line 571

Este método indica si la capa es consultable.

Returns:
Devuelve si la capa es consultable.

isVisible(){Boolean}

facade/js/layer/Layer.js, line 554

Este método indica si la capa es visible.

Returns:
Devuelve si la capa es visible o no.

legend(){IDEE.layer.GeoTIFF.impl.legend}

facade/js/layer/Layer.js, line 193

Devuelve la leyenda de la capa. La Leyenda indica el nombre que queremos que aparezca en el árbol de contenidos, si lo hay.

Returns:
Leyenda de la capa.

legend(newLegend)

facade/js/layer/Layer.js, line 206

Sobrescribe la leyenda de la capa. La Leyenda indica el nombre que queremos que aparezca en el árbol de contenidos, si lo hay.

Name Type Description
newLegend String

Nueva leyenda.

name(){IDEE.layer.impl.name}

facade/js/layer/Layer.js, line 272

Nombre de la capa.

name(newName)

facade/js/layer/Layer.js, line 284

Sobrescribe el nombre de la capa.

Name Type Description
newName String

Nuevo nombre de la capa.

refresh()

facade/js/layer/Layer.js, line 812

Este método actualiza el estado de este capa.

resetMaxExtent()

facade/js/layer/Layer.js, line 497

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

setId(newID)

facade/js/layer/Layer.js, line 414

Este método establece el identificador de la capa.

Name Type Description
newID String

Nuevo identificador para la capa.

setLegend(newLegend)

facade/js/layer/Layer.js, line 234

Sobrescribe la leyenda de la capa. Indica el nombre que queremos que aparezca en el árbol de contenidos, si lo hay.

Name Type Description
newLegend String

Nueva leyenda.

setLegendURL(legendUrlParam)

facade/js/layer/Layer.js, line 647

Sobrescribe la url de la leyenda.

Name Type Description
legendUrlParam String

Nueva URL.

setMap(map)

facade/js/layer/Layer.js, line 517

La instancia del mapa de la fachada.

Name Type Description
map IDEE.map

Instancia del mapa creado con la fachada.

setMaxExtent(maxExtent)

facade/js/layer/Layer.js, line 473

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

Name Type Description
maxExtent String

Nuevo valor para el "MaxExtent".

setMaxScale(maxScale)

facade/js/layer/Layer.js, line 729

Esta función establece el valor de la escala máxima para esta capa.

Name Type Description
maxScale Number

Nueva escala máxima.

setMaxZoom(zoom)

facade/js/layer/Layer.js, line 774

Este método Sobrescribe el zoom máximo aplicable a la capa.

Name Type Description
zoom Number

Nuevo zoom.

setMinScale(minScale)

facade/js/layer/Layer.js, line 707

Esta función establece el valor de la escala mínima para esta capa.

Name Type Description
minScale Number

Nueva escala mínima.

setMinZoom(zoom)

facade/js/layer/Layer.js, line 751

Este método Sobrescribe el mínimo zoom aplicable a la capa.

Name Type Description
zoom Number

Nuevo zoom mínimo.

setOpacity(opacity)

facade/js/layer/Layer.js, line 797

Sobrescribe la opacidad de la capa.

Name Type Description
opacity Number

Opacidad de la capa.

setSection_(section)

facade/js/layer/Layer.js, line 542

Este método añade la capa dentro de una sección. Una capa solo puede estar dentro de una sección a la vez.

  • ⚠️ Advertencia: Este método no debe ser llamado por el usuario.
Name Type Description
section IDEE.layer.Section

Sección a la que se añadirá la capa.

setVisible(visibilityParam)

facade/js/layer/Layer.js, line 588

Este método Sobrescribe la propiedad "visibility" de la capa.

Name Type Description
visibilityParam Boolean

Verdadero visible, falso no visible.

setZIndex(zIndex)

facade/js/layer/Layer.js, line 673

Este método establece el z-index para esta capa.

Name Type Description
zIndex Number

Nuevo z-index.

transparent(){IDEE.layer.impl.transparent}

facade/js/layer/Layer.js, line 337

Devuelve el valor de la propiedad "transparent" de la capa.

Deprecated
  • Yes
Returns:
Valor de la propiedad "transparent".

transparent(newTransparent)

facade/js/layer/Layer.js, line 350

Sobrescribe el valor de la propiedad "transparent".

Name Type Description
newTransparent Boolean

Nuevo valor para la propiedad "transparent".
Deprecated
  • Yes

type(){String}

facade/js/layer/Layer.js, line 163

Devuelve el tipo de layer.

Returns:
Tipo.

type(newType)

facade/js/layer/Layer.js, line 175

Sobrescribe el tipo de capa.

Name Type Description
newType String

Nuevo tipo.

url(){IDEE.layer.impl.url}

facade/js/layer/Layer.js, line 248

Devuelve la url del servicio.

Returns:
URL del servicio.

url(newUrl)

facade/js/layer/Layer.js, line 260

Modifica la url del servicio.

Name Type Description
newUrl String

Nueva URL.