API IDEE Core

Class: OGCAPIFeatures

IDEE/layer/OGCAPIFeatures~OGCAPIFeatures 


import OGCAPIFeatures from 'IDEE/layer/OGCAPIFeatures';

OGCAPIFeatures(OGC API - Features) es un estándar que ofrece la capacidad de crear, modificar y consultar datos espaciales en la Web y especifica requisitos y recomendaciones para las API que desean seguir una forma estándar de compartir datos de entidades.

new OGCAPIFeatures(userParams, options, vendorOpts)

facade/js/layer/OGCAPIFeatures.js, line 53

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

Name Type Description
userParams string | Mx.parameters.OGCAPIFeatures

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

  • legend: Indica el nombre que queremos que aparezca en el árbol de contenidos, si lo hay.
  • url: URL del servicio.
  • name: Nombre de la capa en el servidor.
  • limit: Límite de objetos geográficos a mostrar.
  • bbox: Filtro para mostrar los resultados en un bbox específico.
  • format: Formato de los objetos geográficos.
  • offset: Determina desde que número comenzará a leer los objetos geográficos.Ejemplo: El parámetro offset tiene valor 10 con límite de 5 objetos geográficos, devolverá los 5 primeros objetos geográficos desde número 10 de los resultados.
  • id: Filtro por ID para un objeto geográfico.
  • conditional: Declaración de filtros literales por atributos del objeto geográfico.
  • crs: Definición de la proyección de los datos.
  • geometry: Tipo de geometría: POINT(Punto), MPOINT(Multiples puntos), LINE(línea), MLINE(Multiples línes), POLYGON(Polígono), or MPOLYGON(Multiples polígonos).
  • extract: Opcional, activa la consulta por clic en el objeto geográfico, por defecto verdadero.
  • maxExtent: La medida en que restringe la visualización a una región específica.
  • 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

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

  • predefinedStyles: Estilos predefinidos para la capa.
  • visibility: Define si la capa es visible o no. Verdadero por defecto.
  • displayInLayerSwitcher: Indica si la capa se muestra en el selector de capas.
  • minZoom: Zoom mínimo aplicable a la capa.
  • maxZoom: Zoom máximo aplicable a la capa.
  • minScale: Escala mínima.
  • maxScale: Escala máxima.
  • opacity: Opacidad de capa, por defecto 1.
  • 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. Disponible para gemetrías poligonales. 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.
vendorOpts Object

Opciones para la biblioteca base. -cql: Declaración CQL para filtrar las características (Sólo disponible para servicios en PostgreSQL). Ejemplo vendorOptions:


import OLSourceVector from 'ol/source/Vector';
{
  cql: 'id IN (3,5)',
}
Properties:
Name Type Description
idLayer String

Identificador de la capa.
legend String

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

URL del servicio.
name String

Nombre de la capa en el servidor.
limit Number

Límite de objetos geográficos a mostrar.
bbox Array.<Number>

Filtro para mostrar los resultados en un bbox específico.
format String

Formato de los objetos geográficos.
offset Number

Determina desde que número comenzará a leer los objetos geográficos. Ejemplo: El parámetro offset tiene valor 10 con límite de 5 objetos geográficos, devolverá los 5 primeros objetos geográficos desde número 10 de los resultados.
id Number

Filtro por ID para un objeto geográfico.
predefinedStyles Array.<IDEE.style>

Estilos predefinidos para la capa.
cql String

Declaración CQL para filtrar las características (Sólo disponible para servicios en PostgreSQL).
conditional Object

Declaración de filtros literales por atributos del objeto geográfico.
crs String

Definición de la proyección de los datos.
geometry String

Tipo de geometría: POINT(Punto), MPOINT(Multiples puntos), LINE(línea), MLINE(Multiples línes), POLYGON(Polígono), or MPOLYGON(Multiples polígonos).
opt Object

Opciones de la capa.
extract Boolean

Opcional. Activa la consulta haciendo clic en el objeto geográfico. Por defecto, verdadero.
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

Members

module:IDEE/layer/OGCAPIFeatures~OGCAPIFeatures.DEFAULT_OPTS_STYLE{Object}

Estilo predeterminado para capas OGCAPIFeatures.

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

Parámetros predeterminados para las capas OGCAPIFeatures de estilo.

Methods

bbox(){IDEE.layer.OGCAPIFeature.impl.bbox}

facade/js/layer/OGCAPIFeatures.js, line 290

Devuelve el rectángulo geográfico envolvente.

Returns:
Devuelve el rectángulo geográfico envolvente.

bbox(newBbox)

facade/js/layer/OGCAPIFeatures.js, line 300

Sobrescribe el rectángulo geográfico envolvente.

Name Type Description
newBbox Array

Nuevo bbox.

conditional(){IDEE.layer.OGCAPIFeature.impl.conditional}

facade/js/layer/OGCAPIFeatures.js, line 385

Devuelve el condicional aplicado.

Returns:
Devuelve el conditional aplicado.

conditional(newConditional)

facade/js/layer/OGCAPIFeatures.js, line 395

Sobrescribe el condicional.

Name Type Description
newConditional String

Nuevo condicional.

equals(obj){Boolean}

facade/js/layer/OGCAPIFeatures.js, line 465

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/OGCAPIFeatures.js, line 430

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/OGCAPIFeatures.js, line 444

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".

format(){IDEE.layer.OGCAPIFeature.impl.format}

facade/js/layer/OGCAPIFeatures.js, line 314

Devuelve el formato aplicado.

Returns:
Devuelve el formato aplicado.

format(newFormat)

facade/js/layer/OGCAPIFeatures.js, line 324

Sobrescribe el formato.

Name Type Description
newFormat String

Nuevo formato.

id(){IDEE.layer.OGCAPIFeature.impl.id}

facade/js/layer/OGCAPIFeatures.js, line 361

Devuelve el id aplicado.

Returns:
Devuelve el id aplicado.

id(newId)

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

Sobrescribe el id.

Name Type Description
newId Number

Nuevo id.

limit(){IDEE.layer.OGCAPIFeature.impl.limit}

facade/js/layer/OGCAPIFeatures.js, line 266

Devuelve el límite de resultados.

Returns:
Devuelve el límite de resultados.

limit(newLimit)

facade/js/layer/OGCAPIFeatures.js, line 276

Sobrescribe el límite.

Name Type Description
newLimit Number

Nuevo límite.

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

facade/js/layer/OGCAPIFeatures.js, line 242

Devuelve el nombre de la capa.

Returns:
Devuelve el nombre de la capa.

name(newName)

facade/js/layer/OGCAPIFeatures.js, line 252

Sobrescribe el nombre.

Name Type Description
newName String

Nuevo nombre.

offset(){IDEE.layer.OGCAPIFeature.impl.offset}

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

Devuelve el offset aplicado.

Returns:
Devuelve el offset aplicado.

offset(newOffset)

facade/js/layer/OGCAPIFeatures.js, line 347

Sobrescribe el offset.

Name Type Description
newOffset String

Nuevo offset.

setStyle(styleParam, applyToFeature, defaultStyle)

facade/js/layer/OGCAPIFeatures.js, line 416

Este método establece el estilo en capa.

Name Type Default Description
styleParam 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.OGCAPIFeatures.DEFAULT_OPTIONS_STYLE

Estilo por defecto, se define en OGCAPIFeatures.js.