API IDEE Core

Class: MapLibre

IDEE/layer/MapLibre~MapLibre 


import MapLibre from 'IDEE/layer/MapLibre';

Las capas de tipo MapLibre ofrecen la posibilidad de cargar styles (.json) de MapLibre.

new MapLibre(parameters, options, implParam, vendorOptions)

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

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

Name Type Description
parameters string | Mx.parameters.MapLibre

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

  • url: Url del servicio (.json).
  • name: Nombre de la capa, debe ser único en el mapa.
  • visibility: Verdadero si la capa es visible, falso si queremos que no lo sea. En este caso la capa sería detectado por los plugins de tablas de contenidos y aparecería como no visible.
  • extract: Opcional Activa la consulta por click en el objeto geográfico, por defecto verdadero.
  • type: Tipo de la capa.
  • infoEventType: Tipo de evento para mostrar la info de una feature.
  • name: Nombre de la capa.
  • legend: Leyenda de la capa.
  • attribution: Atribución de la capa.
  • maplibrestyle: Url (.json) en formato objeto.
  • 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.

  • opacity: Opacidad de la capa (0-1), por defecto 1.
  • minZoom. Zoom mínimo aplicable a la capa.
  • maxZoom. Zoom máximo aplicable a la capa.
  • minScale. Escala mínima aplicable a la capa.
  • maxScale. Escala máxima aplicable a la capa.
  • minResolution. Resolución mínima aplicable a la capa.
  • maxResolution. Resolución máxima aplicable a la capa.
  • disableBackgroundColor: Desactiva el color de fondo de la capa.
  • displayInLayerSwitcher. Indica si la capa se muestra en el selector de capas.
implParam Object

Valores de la implementación por defecto, se pasa un objeto implementación MapLibre.
vendorOptions Object

Opciones para la biblioteca base.
Properties:
Name Type Description
idLayer String

Identificador de la capa.
extract Boolean

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

Tipo de evento para mostrar la info de una feature.
disableBackgroundColor Boolean

Desactiva el color de fondo de la capa.
url Object

Estilos de la capa.
type String

Tipo de capa.
name String

Nombre de la capa.
opacity Number

Opacidad de la capa.
visibility Boolean

Verdadero si la capa es visible, falso si queremos que no lo sea.
legend String

Leyenda de la capa.
attribution Object

Atribución de la capa.
maplibrestyle Object

Objeto del valor de url.
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/MapLibre~MapLibre.DEFAULT_OPTIONS_STYLE{Object}

Opciones por defecto de la capa.

module:IDEE/layer/MapLibre~MapLibre.DEFAULT_PARAMS_STYLE{Object}

Estilos por defecto de la capa.

Methods

addFeatures()

facade/js/layer/MapLibre.js, line 348

Añade objeto geográficos.

equals(obj){Boolean}

facade/js/layer/MapLibre.js, line 421

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.layer.MapLibre.impl.extract}

facade/js/layer/MapLibre.js, line 159

Devuelve el valor de la propiedad "extract". La propiedad "extract" activa la consulta al hacer clic sobre un objeto geográfico, por defecto verdadero.

Returns:
Devuelve valor del "extract".

extract(newExtract)

facade/js/layer/MapLibre.js, line 235

Sobrescribe el valor de la propiedad "extract". La propiedad "extract" activa la consulta al hacer clic sobre un objeto geográfico, por defecto verdadero.

Name Type Description
newExtract Boolean

Nuevo valor para el "extract".

getFeatureById(id){Null|IDEE.feature}

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

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(){Array.<IDEE.RenderFeature>}

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

Devuelve todos los objetos geográficos de la capa.

Returns:
Devuelve un array con los objetos geográficos.

getGeometryType(){String}

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

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

Returns:
Tipo de geometría de la capa.

getProjection(){IDEE.layer.MapLibre.impl.getProjection}

facade/js/layer/MapLibre.js, line 312

Este método obtiene la proyección del mapa.

Returns:
Devuelve la proyección.

redraw()

facade/js/layer/MapLibre.js, line 375

Este método redibuja la capa.

refresh()

facade/js/layer/MapLibre.js, line 366

Recarga la capa.

removeFeatures()

facade/js/layer/MapLibre.js, line 357

Elimina objeto geográficos.

setFilter(filter)

facade/js/layer/MapLibre.js, line 226

Sobrescribe el filtro de la capa.

Name Type Description
filter IDEE.Filter

Filtro para configurar.

setLayoutProperty(layerId, property, value)

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

Este método establece el valor de una propiedad de diseño.

Name Type Description
layerId String

Id de la capa.
property String

Propiedad de diseño.
value *

Valor de la propiedad.

setMapLibreStyleFromId(newStyle)

facade/js/layer/MapLibre.js, line 255

Este método establece el estilo en capa.

Name Type Description
newStyle Object

Estilo de la capa.

setPaintProperty(layerId, property, value)

facade/js/layer/MapLibre.js, line 287

Este método establece el valor de una propiedad de pintura.

Name Type Description
layerId String

Id de la capa.
property String

Propiedad de pintura.
value *

Valor de la propiedad.

template(){String}

facade/js/layer/MapLibre.js, line 173

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/MapLibre.js, line 187

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()

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

Transforma la capa en un GeoJSON.