Class: Mapa

geoBCN.Mapa

Versió 0.5

new geoBCN.Mapa(opcions)

Classe Mapa: Encapsula el mapa i les utilitats necessàries.

Nom paràmetre Descripció
opcions

Opcions del constructor de mapa.

Nom paràmetre Tipus Valor per defecte Descripció
divId object

Identificador del div HTML contenidor.

divContainer object

Referència a l'objecte DOM HTML contenidor. Aquest paràmetre deixa sense efecte el paràmetre divId.

mapaBlanc object

booleà indicant si s'ha de carregar un mapa en blanc sense fos

extent Array.<double>

Array amb l'extensió màxima del mapa.

maxZoom integer

Zoom màxim del mapa.

minZoom integer

Zoom mínimm del mapa.

fons Array.<geoBCN.Mapa.FonsMapa> opcional

array valors possibles:

mode geoBCN.Mapa.ModeFuncionament NAV opcional

El mode de funcionament que volem.

eines Array.<geoBCN.Mapa.Eina>

llista d'eines que volem al mapa.

seleccioAdreca geoBCN.Mapa~seleccioAdrecaCallback

Funció que cridarà quan l'usuari seleccioni una adreça.

mapClick geoBCN.Mapa~mapClickCallback

Funció que es cridarà quan l'usuari faci click al mapa.

mapMove geoBCN.Mapa~mapMoveCallback

Funció que es cridarà quan el mapa canviï de posició.

geoLocalitzacio geoBCN.Mapa~geoLocalitzacioCallback

Funció que es cridarà quan s'obtingui una nova posició del navegador.

seleccioFeature geoBCN.Mapa~seleccioFeatureCallback

Funció que es cridarà quan es seleccioni un element d'una capa vectorial.

deSeleccioFeature geoBCN.Mapa~deSeleccioFeatureCallback

Funció que es cridarà quan es deseleccioni un element d'una capa vectorial.

confirmacioSeleccio geoBCN.Mapa~confirmacioSeleccioCallback

Funció que es cridarà quan es confirmi la selecció vectorial per part de l'usuari.

Exemple

Exemple de creació d'un mapa.

// Crear un mapa amb les opcions per defecte, amb el satèl·lit activat per defecte i que es pugui canviar pel fons bàsic

var mapa1 = new geoBCN.Map(
  {
  divId: "map",
  fons: ["SAT", "BAS"]
  }
);

Mètodes

afegeixControl(control){void}

Funció avançada per afegir un control d'OpenLayers3 al mapa

Nom paràmetre Descripció
control

Control OpenLayers3 per afegir al mapa

afegeixMarcador(opcions){void}

Afegeix un marcador al mapa

Nom paràmetre Descripció
opcions

Opcions per afegir el marcador.

Nom paràmetre Tipus Descripció
localitzacio geoBCN.Localitzacio opcional

Localització on afegir el marcador.

urlIcona string

URL de la icona.

opcionsIcona opcional

Opcions de la icona.

Nom paràmetre Tipus Valor per defecte Descripció
opacitat number 1 opcional

Opacitat de la icona on 0 es transparent i 1 totalment opac.

anchorUnits string fraction opcional

Unitats pel anchor, valors possibles: 'fraction' o 'pixels'.

escalat number 1 opcional

Escalat de tamany de la icona

anchor Array.<number> 0.5, 1 opcional

Valor per l'ancorament.

amagaHoverPopup(){void}

Amaga el popup que es mostra al mapa.

amagaPopup(){void}

Amaga el popup que es mostra al mapa.

CapaVector(definicio){geoBCN.Mapa.Capa}

Afegeix una capa vectorial

Nom paràmetre Tipus Descripció
definicio geoBCN.Mapa.DefinicioCapaVector

Definició de la capa

CapaWMS(opcions){geoBCN.Mapa.Capa}

Afegeix una capa WMS sobre el mapa

Nom paràmetre Descripció
opcions

Opcions per afegir la capa

Nom paràmetre Tipus Descripció
url string

URL de la capa WMS

nom string

Nom de la capa (El nom que es mostra a la llegenda)

capes string

Capes que ha de mostrar el servei. L'especificació WMS defineix que es un String separat per comes.

carregaNamespace(namespace){void}

Executa la càrrega dels layers vectorials disponibles per un determinat namespace

Nom paràmetre Tipus Descripció
namespace string

Cadena que identifica el namespace que es vol carregar

centraMapa(opcions){void}

Deprecated

Centra el mapa en una posició i opcionalment un nivell de zoom

Nom paràmetre Descripció
opcions

Opcions per afegir el marcador

Nom paràmetre Tipus Descripció
Localitzacio geoBCN.Localitzacio

Localització on afegir el marcador

zoom integer opcional

Zoom al que s'ha de mostrar el mapa

Obsolescència:
  • Utilitza mètode centrar()

    centrar(opcions){Promise}

    Centra el mapa en una localització donada -i opcionalment un nivell de zoom- o bé en una extensió donada i retorna una promise per quan acaba el centrat.

    Nom paràmetre Tipus Valor per defecte Descripció
    opcions

    Opcions per posicionar

    Nom paràmetre Tipus Descripció
    localitzacio geoBCN.Coordenada2D | geoBCN.Localitzacio | external:ol.geom.Geometry | external:ol.Feature | Array

    Localització on afegir el marcador. Pot ser una Geometry, un punt o un array de punts que definiràn l'enquadrament on centrar.

    options.proj geoBCN.Mapa.Proj EPSG:25831 opcional

    Projecció per defecte dels punts de la localitzacio. Es la projecció que es prendrà per a cada punt que no la tingui especificada.

    opcions.zoom integer | String opcional

    zoom que aplicarà el mapa sobre el centre calculat. Si s'epecifica "auto", fa el zoom de manera que es visualitzen tots els punts.

    opcions.extensio Array opcional

    Extensió que es vol aplicar.

    opcions.padding Array opcional

    Padding (en pixels) que es netegen dins de la vista. Array de 4 valors que representen els 4 costats de la vista "[superior, dret, inferior, esquerre]"

    opcions.animacio geoBCN.Mapa.Animacio opcional

    Animació que es desitja fer a l'hora de centrar el mapa.

    confirmacioSeleccio(handler){void}

    Permet definir una funció de callback per obtenir l'element vectorial seleccionat i confirmat per l'usuari -solament versió mòbil-

    Nom paràmetre Tipus Descripció
    handler geoBCN.Mapa~geoLocalitzacioCallback

    funció que es cridarà quan es seleccioni un element i l'usuari accepti la selecció.

    deSeleccioFeature(handler){void}

    Permet definir una funció de callback per obtenir l'element vectorial deseleccionat per l'usuari

    Nom paràmetre Tipus Descripció
    handler geoBCN.Mapa~geoLocalitzacioCallback

    funció que es cridarà quan es deseleccioni un element.

    disableMouseWheel(){void}

    Desactiva la funcionalitat de fer scroll sobre el mapa

    donaNivellZoom(){integer}

    Deprecated

    Retorna el nivell de zoom del mapa. 1 es el mes allunyat.

    Obsolescència:
    • Utilitzar get("zoom")

      enableMouseWheel(){void}

      Activa la funcionalitat de fer scroll sobre el mapa

      esborraMarcador(marcador){void}

      Esborra un marcador del mapa

      Nom paràmetre Descripció
      marcador

      Marcador que s'ha recuperat en la funció afegeixMarcador

      estableixFons(fons){void}

      Estableix el fons de mapa.

      Nom paràmetre Tipus Descripció
      fons geoBCN.Mapa.FonsMapa

      Estableix el fons del mapa en un dels disponibles que s'hagin definit en la inicialització del mapa

      geoLocalitzacio(handler){void}

      Permet definir una funció de callback per obtenir la posició de l'usuari que retorna el navegador

      Nom paràmetre Tipus Descripció
      handler geoBCN.Mapa~geoLocalitzacioCallback

      funció que es cridarà quan s'obtingui una nova posició del navegador.

      get(key){Objects}

      Retorna el valor de una propietat key que pot ser zoom, mode o fons

      Nom paràmetre Tipus Descripció
      key String

      Clau de la propietat demanada, ha d'estar inclosa en geoBCN.Mapa.MapProperties.

      getStandardCoords(coords){geoBCN.Localitzacio}

      Rep una coordenada que pot estar en diferents formats i la estandaritza al format {geoBCN.Localitzacio} amb la projecció actual del mapa i la retorna

      Nom paràmetre Tipus Descripció
      coords geoBCN.Coordenada2D | geoBCN.Localitzacio

      Localització que es vol estandaritzar.

      mapClick(handler){void}

      Permet definir una funció de callback per obtenir els clicks de l'usuari sobre el mapa

      Nom paràmetre Tipus Descripció
      handler geoBCN.Mapa~mapClickCallback

      funció que es cridarà quan s'obtingui un nou click al mapa.

      mapMove(handler){void}

      Permet definir una funció de callback per obtenir els moviments del mapa

      Nom paràmetre Tipus Descripció
      handler geoBCN.Mapa~mapMoveCallback

      funció que es cridarà quan s'obtingui una nova posició del mapa.

      mostraHoverPopup(opcions){void}

      Mostra un popup sobre el mapa.

      Nom paràmetre Descripció
      opcions

      Opcions per mostrar el popup

      Nom paràmetre Tipus Descripció
      contingut String | DOM opcional

      String amb l'HTML per mostrar al popup o bé un Node DOM per mostrar al popup

      localitzacio geoBCN.Localitzacio opcional

      Localització on mostrar el popup -En mode mòbil, no aplica-.

      offsetX integer opcional

      Desplaçament x que aplicarà al popup en pixels. Admet valors negatius.

      offsetY integer opcional

      Desplaçament y que aplicarà al popup en pixels. Admet valors negatius.

      mostraPopup(opcions){void}

      Mostra un popup sobre el mapa.

      Nom paràmetre Descripció
      opcions

      Opcions per mostrar el popup

      Nom paràmetre Tipus Descripció
      contingut String | DOM opcional

      String amb l'HTML per mostrar al popup o bé un Node DOM per mostrar al popup

      localitzacio geoBCN.Localitzacio opcional

      Localització on mostrar el popup -En mode mòbil, no aplica-.

      offsetX integer opcional

      Desplaçament x que aplicarà al popup en pixels. Admet valors negatius.

      offsetY integer opcional

      Desplaçament y que aplicarà al popup en pixels. Admet valors negatius.

      namespaceCarregat(handler){void}

      Permet definir una funció de callback per obtenir les capes vectorials disponibles procedents de carregar un namespace

      Nom paràmetre Tipus Descripció
      handler geoBCN.Mapa~namespaceCarregatCallback

      funció que es cridarà quan s'hagi carregat un namesPace de capes vectorials.

      redraw(){void}

      Refresca el mapa

      rotaMapa(opcions){void}

      Rota el mapa segons l'angle definit

      Nom paràmetre Descripció
      opcions

      Opcions per fer la rotació

      Nom paràmetre Tipus Descripció
      angle double

      Double amb valors compresos entre 0 i 360 indicant l'angle de rotació

      seleccioAdreca(handler){void}

      Permet definir una funció de callback per obtenir les adreces seleccionades per l'usuari

      Nom paràmetre Tipus Descripció
      handler geoBCN.Mapa~seleccioAdrecaCallback

      funció que es cridarà quan s'obtingui una nova adreça.

      seleccioFeature(handler){void}

      Permet definir una funció de callback per obtenir l'element vectorial seleccionat per l'usuari

      Nom paràmetre Tipus Descripció
      handler geoBCN.Mapa~geoLocalitzacioCallback

      funció que es cridarà quan es seleccioni un nou element.

      set(props){void}

      Assigna un valor a una propietat concreta del mapa. Ja poden ser el zoom, el mode o el fons de mapa

      Nom paràmetre Tipus Descripció
      props object

      Objecte que pot contenir varies parelels clau-valor que han d'estar incloses en ha d'estar inclosa en {@link http://relative/../0.5/geoBCN.Mapa.aspx#MapProperties geoBCN.Mapa.MapProperties.

      setMode(mode){void}

      Deprecated

      Estableix el mode. Es poden establir els següents modes:

      • NAV per navegació (defecte)
      • ADR per cerca d'adreces
      • PAR mode de cercar parceles.
      • SEL mode de selecció amb confirmació
      Nom paràmetre Tipus Descripció
      mode string

      Type of the media

      Obsolescència:
      • Utilitzar set({mode: mode})

        Tipus definits

        geoBCN.Mapa.Animacio{Object}

        Propietats:
        Nom propietat Tipus Argument Descripció
        tipus string <optional>

        Tipus d'animació. Tres posibilitats: pan, bounce i elastic.

        duracio integer <optional>

        Temps que durarà l'efecte de l'animació.

        funcio function <optional>

        Funció que s'utilitzarà per fer l'animació en cas de no voler un tipus per defecte (pan, bounce o elastic).

        geoBCN.Mapa.DefinicioCapaVector{object}

        Propietats:
        Nom propietat Tipus Argument Valor per defecte Descripció
        nom string

        Nom de la capa

        codi string

        Identificador de la capa

        url string

        Url d'on ha de carregar els features

        activada boolean

        Indica si la capa està activada o desactivada

        proj geoBCN.Mapa.Proj

        Codi de la projecció en la que es tornen les dades

        datatype geoBCN.ajaxDataType

        json|jsonp

        strategy geoBCN.Mapa.strategy

        Estrategia a seguir a l'hora de carregar les dades (single|bbox)

        maxZoomLevel integer

        Zoom máxim on mostrar les dades

        tileSize integer <optional>
        512

        Mida en píxels de les tessel·les

        etiqId string

        Codi de l'etiqueta a mostrar

        etiq geoBCN.Etiqueta

        Text que es mostrarà a la llegenda

        mostraLlegenda boolean

        Coordenada X de l'emplaçament

        expiracio string

        Temps de validesa de les dades de la memòria cau (cache). El valor especificat son segons si s'especifica un numero o bé dies si a més s'afegeix una 'd' al final.

        threshold integer <optional>
        4

        Umbral de simplificació de les geometries.

        maxfeatures integer <optional>
        2000

        Nombre màxim d'elelmts que retornarà el servei a cada comanda.

        style function <optional>

        Funció d'estil d'OpenLayers. Aquesta funció té la signatura: ({ol.Feature},{integer})

        opacity function <optional>
        1

        Ratio d'opacitat de tota la capa.

        estils object <optional>

        Estils de les Features de la capa.

        Properties
        Nom propietat Tipus Argument Descripció
        normal object <optional>

        Estils de les Features en estat normal(desseleccionat).

        Properties
        Nom propietat Tipus Argument Descripció
        colorLinea string <optional>

        Color de la línia de les Features en estat normal(desseleccionat).

        gruixLinea integer <optional>

        Gruix de la línia de les Features en estat normal(desseleccionat).

        colorEmplenat string <optional>

        Color de farciment de les Features en estat normal(desseleccionat).

        seleccio object <optional>

        Estils de les Features en estat normal(desseleccionat).

        Properties
        Nom propietat Tipus Argument Descripció
        colorLinea string <optional>

        Color de la línia de les Features en estat seleccionat.

        gruixLinea integer <optional>

        Gruix de la línia de les Features en estat seleccionat.

        colorEmplenat string <optional>

        Color de farciment de les Features en estat seleccionat.

        geoBCN.Mapa.Eina{string}

        Existeixen diferents eines:

        • ZOOM Botons + i - de zoom al mapa
        • GPSNAV Botó que es mostrarà a l'usuari per situar-se al mapa segons la posició detectada pel navegador
        • ROTACIO Afegir control de rotació
        • SELPOINT Botó que es mostrarà a l'usuari per realitzar la selecció puntual sobre una capa vectorial
        • ESCALIMETRE Mostra l'escalímetre

        geoBCN.Mapa.FonsMapa{string}

        Existeixen tres fons de mapa possibles:

        • BAS basic
        • PAR parcel·lari
        • SAT satel·lit
        • GUIA Guia

        geoBCN.Mapa.MapProperties{Object}

        Propietats:
        Nom propietat Tipus Descripció
        mode geoBCN.Mapa.ModeFuncionament

        Descripció del concepte modes de funcionament.

        zoom integer

        Zoom aplicat a la vista del mapa.

        fons geoBCN.Mapa.FonsMapa

        Estableix el fons del mapa en un dels disponibles que s'hagin definit en la inicialització del map.

        geoBCN.Mapa.ModeFuncionament{string}

        Descripció del concepte modes de funcionament. Enumeració:

        • NAV per navegació (mode per defecte si no s'especifica)
        • ADR per cerca d'adreces
        • PAR mode de cercar parceles.
        • SEL mode de selecció amb confirmació

        geoBCN.Mapa.Proj{string}

        La llibreria es capaç de tractar les següents projeccions:

        • EPSG:23031 ED50 Zona 31
        • EPSG:25831 ETRS89 Zona 31
        • EPSG:4326 Geogràfiques
        • TRESOR Sistema de coordenades comprimides per ED50
        • TRESOR89 Sistema de coordenades comprimides per ETRS89

        geoBCN.Mapa.strategy{string}

        Defineix el mode com el mapa ha d'obtenir els elements:

        • single Es sol·licitarà un sol cop totes les geometries a la url
        • bbox Es demanaràn les geometries fent servir l'extensió del mapa com a filtre (Ha d'estar suportat pel servei)

        confirmacioSeleccioCallback(resposta)

        Callback que es crida quan es confirma la selecció per part de l'usuari amb el mapa en mode SEL i comportament mòbil

        Nom paràmetre Tipus Descripció
        resposta geoBCN.Seleccio

        les dades obtingudes.

        deSeleccioFeatureCallback(resposta)

        Callback que es crida quan es deselecciona un feature d'una capa vectorial. Aquesta deselecció pot venir de la selecció d'un altre element sense tenir activada la multiselecció.

        Nom paràmetre Tipus Descripció
        resposta geoBCN.Seleccio

        les dades obtingudes.

        geoLocalitzacioCallback(resposta)

        Callback que es crida quan arriba una nova geoLocalització procedent del navegador, tant quan ha estat sol·licitada per l'usuari (Eina geoLocalitzar) com quan s'ha sol·licitat per part de l'aplicatiu integrador (funció geoLocalitza)

        Nom paràmetre Tipus Descripció
        resposta geoBCN.Localitzacio

        les dades obtingudes.

        mapClickCallback(resposta)

        Callback que es crida en seleccionar una adreça per l'usuari.

        Nom paràmetre Tipus Descripció
        resposta geoBCN.ClickEvent

        les dades obtingudes.

        mapMoveCallback(resposta)

        Callback que es crida quan hi ha un canvi de posició o escala del mapa.

        Nom paràmetre Tipus Descripció
        resposta geoBCN.MoveEvent

        les dades obtingudes.

        namespaceCarregatCallback(resposta)

        Callback que es crida quan les dades del namespace especificat estan carregades.

        Nom paràmetre Tipus Descripció
        resposta geoBCN.Seleccio

        les dades obtingudes.

        seleccioAdrecaCallback(resposta)

        Callback que es crida en seleccionar una adreça per l'usuari.

        Nom paràmetre Tipus Descripció
        resposta geoBCN.resposta

        les dades obtingudes.

        seleccioFeatureCallback(resposta)

        Callback que es crida quan l'usuari efectua una selecció sobre una capa vectoria activa

        Nom paràmetre Tipus Descripció
        resposta geoBCN.Seleccio

        les dades obtingudes.