API IDEE Core

Class: GenericVector

IDEE/layer/GenericVector~GenericVector 


import GenericVector from 'IDEE/layer/GenericVector';

GenericVector permite añadir cualquier tipo de capa vector.

new GenericVector(userParameters, options, vendorOptions)

facade/js/layer/GenericVector.js, line 36

Constructor principal de la clase.

Name Type Description
userParameters string | Mx.parameters.WMS

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

  • name: nombre de la capa.
  • legend: Nombre asociado en el árbol de contenidos, si usamos uno.
  • transparent (deprecated): Falso si es una capa base, verdadero en caso contrario.
  • extract: Opcional, activa la consulta por click en el objeto geográfico, por defecto verdadero.
  • infoEventType: Define si consultar la capa con un clic o con "hover".
  • maxExtent: La medida en que restringe la visualización a una región específica.
  • isBase: Indica si la capa es base.
  • ids: Opcional - identificadores por los que queremos filtrar los objetos geográficos.
  • cql: Opcional - Sentencia CQL para filtrar los objetos geográficos. El método setCQL(cadena_cql) refresca la capa aplicando el nuevo predicado CQL que reciba.
  • template: (opcional) Plantilla que se mostrará al consultar un objeto geográfico.
options Mx.parameters.LayerOptions

Estas opciones se mandarán a la implementación de la capa.

  • visibility: Indica la visibilidad de la capa.
  • format: Formato de la capa, por defecto image/png.
  • styles: Estilos de la capa.
  • minZoom: Zoom mínimo aplicable a la capa.
  • maxZoom: Zoom máximo aplicable a la capa.
  • queryable: Indica si la capa es consultable.
  • minScale: Escala mínima.
  • maxScale: Escala máxima.
  • minResolution: Resolución mínima.
  • maxResolution: Resolución máxima.
  • 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.
vendorOptions Object

Opciones para la biblioteca base. Ejemplo vendorOptions:


import Vector from 'ol/source/Vector';
{
 source: new Vector({
   ...
 })
}
Properties:
Name Type Description
idLayer String

Identificador de la capa.
name String

Nombre de la capa, identificador.
extract Boolean

Activa la consulta al hacer clic sobre un objeto geográfico, por defecto verdadero.
ids Array

Identificadores por los que queremos filtrar los objetos geográficos.
cql String

Sentencia CQL para filtrar los objetos geográficos.
options Object

Opciones GenericVector.
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

addFeatures(features, update)

facade/js/layer/GenericVector.js, line 412

Este método incluye objetos geográficos a la capa.

Name Type Description
features Array.<IDEE.feature>

Objetos geográficos que se incluirán a la capa.
update Boolean

Verdadero se vuelve a cargar la capa, falso no la vuelve a cargar.

calculateMaxExtent(){IDEE.layer.maxExtent}

facade/js/layer/GenericVector.js, line 185

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.

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

facade/js/layer/GenericVector.js, line 305

Devuelve el CQL de la capa.

Returns:
Devuelve el CQL.

cql(newCQL)

facade/js/layer/GenericVector.js, line 315

Sobrescribe el cql de la capa.

Name Type Description
newCQL String

Nuevo CQL.

equals(obj){Boolean}

facade/js/layer/GenericVector.js, line 387

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.

extract(){IDEE.LayerType.KML}

facade/js/layer/GenericVector.js, line 245

Devuelve el valor de la propiedad "extract". La propiedad "extract" tiene la siguiente función: Activa la consulta al hacer clic en la característica, por defecto verdadero.

Returns:
Valor de la propiedad "extract".

extract(newExtract)

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

Sobrescribe el valor de la propiedad "extract". La propiedad "extract" tiene la siguiente función: Activa la consulta al hacer clic en la característica, por defecto verdadero.

Name Type Description
newExtract Boolean

Nuevo valor para sobreescribir la propiedad "extract".

getMaxExtent(isSource){Array}

facade/js/layer/GenericVector.js, line 170

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

Name Type Default Description
isSource Boolean true

Extent de la biblioteca base o no, por defecto verdadero.
Returns:
Devuelve la extensión máxima de esta capa.

getStyle(){IDEE.layer.Vector.style}

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

Este método devuelve el estilo de la capa.

ids(){IDEE.layer.WFS.impl.ids}

facade/js/layer/GenericVector.js, line 345

Devuelve los ids de la capa.

Returns:
Devuelve los ids.

ids(newIds)

facade/js/layer/GenericVector.js, line 355

Sobrescribe los ids de la capa.

Name Type Description
newIds Array

Nuevos ids.

setCQL(newCQLparam)

facade/js/layer/GenericVector.js, line 325

Este método Sobrescribe el filtro CQL.

Name Type Description
newCQLparam String

Nuevo filtro CQL.

setMaxExtent(maxExtent)

facade/js/layer/GenericVector.js, line 197

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

Name Type Description
maxExtent Array | Object

Nuevo valor para el "MaxExtent".

url(){String}

facade/js/layer/GenericVector.js, line 219

Devuelve la url del servicio.

Returns:
URL del servicio.

url(newUrl)

facade/js/layer/GenericVector.js, line 231

Modifica la url del servicio.

Name Type Description
newUrl String

Nueva URL.

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

facade/js/layer/GenericVector.js, line 279

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

Returns:
Versión del servicio.

version(newVersion)

facade/js/layer/GenericVector.js, line 291

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

Name Type Description
newVersion String

Nueva versión del servicio.