API IDEE Core

Class: Vector

IDEE/layer/Vector~Vector 


import Vector from 'IDEE/layer/Vector';

Esta clase es la base de todas las capas de tipo vectorial, de esta clase heredan todas las capas vectoriales del API-IDEE.

new Vector(parameters, options, implParam, vendorOptions)

facade/js/layer/Vector.js, line 40

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

Name Type Description
parameters Mx.parameters.Layer

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

  • name: Nombre de la capa en la leyenda.
  • 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.
  • 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.
  • extract: Opcional, activa la consulta por clic en el objeto geográfico, por defecto verdadero.
options Mx.parameters.LayerOptions

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

  • 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.
  • visibility. Define si la capa es visible o no. Verdadero por defecto.
  • displayInLayerSwitcher. Indica si la capa se muestra en el selector de capas.
  • opacity. Opacidad de capa, por defecto 1.
  • 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.
implParam Object

Valores de la implementación por defecto.
vendorOptions Object

Opciones para la biblioteca base. Ejemplo vendorOptions:


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

Identificador de la capa.
minZoom Number

Zoom mínimo.
maxZoom Number

Zoom máximo.
transparent Boolean

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

Define si la capa es base.
predefinedStyles Array

Estilos prefefinidos.
template String

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

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

Extends

  • IDEE.Layer
  • IDEE.layer

Members

module:IDEE/layer/Vector~Vector.DEFAULT_OPTIONS_STYLE{Object}

Estilos predeterminados.

module:IDEE/layer/Vector~Vector.DEFAULT_PARAMS{Object}

Parámetros predeterminados.

Methods

addFeatures(features, update, force)

facade/js/layer/Vector.js, line 214

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.
force Boolean

Si es verdadero, fuerza no esperar al evento LOAD de la capa aunque no esté cargada o no sea válida.

applyStyle_(styleParam, applyToFeature)

facade/js/layer/Vector.js, line 462

La forma en que se aplica el estilo a la capa.

Name Type Description
styleParam Object

Estilo que se aplicará a la capa.
applyToFeature Boolean

Indica si se aplicará el estilo a los objetos geográficos.

calculateMaxExtent(){IDEE.layer.Vector.impl.getFeaturesExtentPromise}

facade/js/layer/Vector.js, line 585

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

Returns:
Devuelve la extensión de los objetos geográficos.

clear()

facade/js/layer/Vector.js, line 294

Este método elimina todos los objetos geográficos.

clearStyle()

facade/js/layer/Vector.js, line 511

Elimina el estilo de la capa y de los objetos geográficos.

equals(obj){Boolean}

facade/js/layer/Vector.js, line 410

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(){Boolean}

facade/js/layer/Vector.js, line 346

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/Vector.js, line 360

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 | String

Nuevo valor para sobreescribir la propiedad "extract".

getFeatureById(id){Null|IDEE.feature}

facade/js/layer/Vector.js, line 261

Devuelve el objeto geográfico con el id pasado por parámetros.

Name Type Description
id String | Number

Id objeto geográfico.
Returns:
objeto geográfico: devuelve el objeto geográfico con esa identificación si se encuentra, en caso de que no se encuentre o no indique el id devuelve nulo.

getFeatures(applyFilter){Array.<IDEE.Feature>}

facade/js/layer/Vector.js, line 244

Este método devuelve todos los objetos geográficos o discrimina por el filtro.

Name Type Description
applyFilter Boolean

Indica si se ejecuta filtro.
Returns:
Devuelve todos los objetos geográficos o discriminando por el filtro.

getFeaturesExtent(applyFilter){Array.<number>}

facade/js/layer/Vector.js, line 330

Este método devuelve la extensión de todos los objetos geográficos o discrimina por el filtro.

Name Type Description
applyFilter Boolean

Indica si se ejecuta filtro.
Returns:
Alcance de las objetos geográficos.

getFilter(){IDEE.Filter}

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

Este método devuelve el valor de la propiedad filter, esta propiedad se utiliza para filtrar los objeto geográfico.

Returns:
Devuelve el filtro.

getGeometryType(layer){String}

facade/js/layer/Vector.js, line 546

Obtiene el tipo de geometría de la capa. Tipo de geometría: POINT (Punto), MPOINT (Multiples puntos), LINE (línea), MLINE (Multiples línes), POLYGON (Polígono), or MPOLYGON (Multiples polígonos).

Name Type Description
layer IDEE.layer.Vector

Capa vectorial.
Returns:
Tipo de geometría de la capa.

getLegendURL(){IDEE.layer.Vector.legendUrl}

facade/js/layer/Vector.js, line 523

Devuelve el legendURL.

Returns:
Devuelve el legendURL.

getMaxExtent(){IDEE.layer.Vector.impl.getFeaturesExtent}

facade/js/layer/Vector.js, line 565

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

Returns:
Devuelve la extensión de los objeto geográfico.

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

facade/js/layer/Vector.js, line 500

Este método devuelve el estilo de la capa.

redraw()

facade/js/layer/Vector.js, line 318

Este método redibuja la capa.

refresh()

facade/js/layer/Vector.js, line 306

Este método recarga la capa.

removeFeatures(features)

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

Elimina el objeto geográfico indicado por parámetro.

Name Type Description
features Array.<IDEE.feature>

El objeto geográfico que se eliminará.

removeFilter()

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

Este método elimina el valor de la propiedad "filter", lo pone a nulo.

setFilter(filter)

facade/js/layer/Vector.js, line 605

Sobrescribe el filtro de la capa.

Name Type Description
filter IDEE.Filter

Filtro para configurar.

setStyle(style, applyToFeature, defaultStyle)

facade/js/layer/Vector.js, line 433

Este método establece el estilo en capa.

Name Type Default Description
style IDEE.Style

Estilo que se aplicará a la capa.
applyToFeature Boolean false

Si el valor es verdadero se aplicará a los objetos geográficos, falso no. Por defecto, falso.
defaultStyle IDEE.layer.Vector.DEFAULT_OPTIONS_STYLE

Estilo por defecto, se define en Vector.js.

template(){String}

facade/js/layer/Vector.js, line 382

Devuelve el valor de la propiedad "template". La propiedad "template" tiene la siguiente función: Especifica una plantilla que se mostrará al consultar un objeto geográfico.

Returns:
Valor de la propiedad "template".

template(newTemplate)

facade/js/layer/Vector.js, line 396

Sobrescribe el valor de la propiedad "template". La propiedad "template" tiene la siguiente función: Especifica una plantilla que se mostrará al consultar un objeto geográfico.

Name Type Description
newTemplate String

Nuevo valor para sobreescribir la propiedad "template".

toGeoJSON(){Object}

facade/js/layer/Vector.js, line 635

Este método obtiene la representación GeoJSON de la capa.

Returns:
Devuelve un objeto, tipo 'FeatureCollection' con los objetos geográficos.