API IDEE Core

Class: KML

IDEE/layer/KML~KML 


import KML from 'IDEE/layer/KML';

KML (Keyhole Markup Language).

new KML(userParameters, options, vendorOptions)

facade/js/layer/KML.js, line 31

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

Name Type Description
userParameters string | Mx.parameters.KML

Parámetros especificados por el usuario.

  • url: Url del fichero o servicio -> https://www.ign.es/web/resources/delegaciones/delegacionesIGN.kml
  • name: Nombre de la capa que aparecerá en la leyenda -> Delegaciones IGN
  • extract: Opcional, activa la consulta por click en el objeto geográfico, por defecto verdadero.
  • type: Tipo de la capa.
  • maxExtent: La medida en que restringe la visualización a una región específica.
  • legend: Indica el nombre que queremos que aparezca en el árbol de contenidos, si lo hay.
  • label: Define si se muestra la etiqueta o no. Por defecto mostrará la etiqueta.
  • layers: Permite filtrar el fichero KML por nombre de carpetas.
  • removeFolderChildren: Permite no mostrar las carpetas descendientes de las carpetas filtradas. Por defecto: true.
  • isBase: Indica si la capa es base.
  • transparent (deprecated): Falso si es una capa base, verdadero en caso contrario.
  • template: (opcional) Plantilla que se mostrará al consultar un objeto geográfico.
options Mx.parameters.LayerOptions

Parámetros que se pasarán a la implementación.

  • visibility: Define si la capa es visible o no.
  • style: Define el estilo de la capa.
  • minZoom. Zoom mínimo aplicable a la capa.
  • maxZoom. Zoom máximo aplicable a la capa.
  • minScale: Escala mínima.
  • maxScale: Escala máxima.
  • displayInLayerSwitcher. Indica si la capa se muestra en el selector de capas.
  • opacity. Opacidad de capa, por defecto 1.
  • scaleLabel. Escala de la etiqueta.
  • extractStyles: Extraer estilos del KML.Por defecto es verdadero.
  • predefinedStyles: Estilos predefinidos para la capa.
  • height: Define la altura del objeto geográfico. Puede ser un número o una propiedad. Si se define la altura será constante para todos los puntos del objeto geográfico. Solo disponible para Cesium.
  • clampToGround: Define si el objeto geográfico se debe ajustar al suelo. Si las coordenadas son 3D, por defecto es falso, en caso contrario es verdadero. Solo disponible para Cesium.
vendorOptions Object

Opciones para la biblioteca base. Ejemplo vendorOptions:


import OLSourceVector from 'ol/source/Vector';
{
 opacity: 0.1,
 source: new OLSourceVector({
   attributions: 'kml',
   ...
 })
}
Properties:
Name Type Description
idLayer String

Identificador de la capa.
extract Boolean

Opcional. Activa la consulta haciendo clic en el objeto geográfico, por defecto verdadero.
options Object

Parámetros de la capa.
label String

Etiqueta de la capa.
transparent Boolean

(deprecated) Falso si es una capa base, verdadero en caso contrario.
isBase Boolean

Define si la capa es base.
template String

Plantilla que se mostrará al consultar un objeto geográfico.

Extends

  • IDEE.layer.Vector

Methods

equals(obj){Boolean}

facade/js/layer/KML.js, line 208

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.

options(){IDEE.layer.KML.impl.options}

facade/js/layer/KML.js, line 171

Devuelve las opciones que se mandan a la implementación.

Returns:
Opciones de la capa KML.

options(newOptions)

facade/js/layer/KML.js, line 183

Sobrescribe las opciones de la capa KML.

Name Type Description
newOptions Object

Nuevas opciones.

setURL(newURL)

facade/js/layer/KML.js, line 195

Sobreescribe la URL de la capa.

Name Type Description
newURL String

Nueva URL de la capa.