// 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"]
  }
);

mapa1.when('ready').then(function(){

  // ara podem treballar amb el mapa1

});

Classes

Clone

Delete

Draw

Edit

Move

Select

Mètodes

addCartography(opcions){geoBCN.Map.CartographyLayer}

Nom paràmetre	Tipus	Descripció
opcions	geoBCN.Map.CartographySpecification	Opcions per afegir una nova cartografia.

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.Location opcional Localització on afegir el marcador. urlIcona string URL de la icona. onClick geoBCN.Map~onClickMarkerCallback opcional Funció de callback que s'executal al fer click al marcador afegit. 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.

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

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.Geometry.Point2D | geoBCN.Location | 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.CoordSystem.Name	EPSG:25831	opcional Sistema de coordenades 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.Map.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.Map~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.Map~geoLocalitzacioCallback	funció que es cridarà quan es deseleccioni un element.

destroy(){void}

Destrueix el mapa i la interfície

disableMouseWheel(){void}

Desactiva la funcionalitat de fer scroll sobre el mapa

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

                setMode: function (mode) {
                    if (Utils.checkValorParametre(mode, "^NAV$|^ADR$|^PAR$|^SEL$")) {
                        console.info("Mode:" + mode);
                        opcions.mode = mode;
                        if ((mode.indexOf("ADR") >= 0 || mode.indexOf("PAR") >= 0) && geoBCN.env.mapEsMobil) {
                            pointerControl.showPointer();
                        } else {
                            popupControl.hidePopup();
                            pointerControl.hidePointer();
                        }
                    } else {
                        throw "Mode de mapa incorrecte";
                    }
                },*\
  
                /**

  Estableix el fons de mapa.

Nom paràmetre	Tipus	Descripció
fons	string	Codi de la cartografia. 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.Map~geoLocalitzacioCallback	funció que es cridarà quan s'obtingui una nova posició del navegador.

geoLocalitzacioError(handler){void}

Permet definir una funció de callback per si la geolocalització dona error

Nom paràmetre	Tipus	Descripció
handler	geoBCN.Map~geoLocalitzacioCallback	funció que es cridarà si falla la geolocalització.

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.Map.MapProperties.

getStandardCoords(coords){geoBCN.Location}

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

Nom paràmetre	Tipus	Descripció
coords	geoBCN.Geometry.Point2D | geoBCN.Location	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.Map~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.Map~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ó html String | DOM opcional String amb l'HTML per mostrar al popup o bé un Node DOM per mostrar al popup localitzacio geoBCN.Location 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ó html String | DOM opcional String amb l'HTML per mostrar al popup o bé un Node DOM per mostrar al popup localitzacio geoBCN.Location 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. onClose function opcional Event de quan es tanca el popup.

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.Map~namespaceCarregatCallback	funció que es cridarà quan s'hagi carregat un namesPace de capes vectorials.

redraw(){void}

Refresca el mapa

removeCartography(layerDef){void}

Refresca el mapa

Nom paràmetre	Tipus	Descripció
layerDef	string | object	String amb el codi de la capa o bé un Objecte del tipus { codi: "codi" }.

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.Map~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.Map~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.Map.aspx#MapProperties geoBCN.Map.MapProperties.

when(status){Promise}

Mètode per detectar cambis d'estat en el Mapa. Vieu documentació del constructor per mes informació

Nom paràmetre	Tipus	Descripció
status	String	nom de l'estat que es vol observar. En aquest moment només accepta el valor 'ready'.

Tipus definits

geoBCN.Map.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.Map.CartographyLayer{object}

Existeixen diversos tipus de cartografies compatibles amb el component mapa:

S'especiifica amb un string. per exemple:

Propietats:

Nom propietat	Tipus	Descripció
tipus	string	Tipus de la cartografia, ha de ser un els definits a geoBCN.Map.CartographySpecification.
nom	string	Nom de la capa (El nom que es mostra a la llegenda).
codi	string	Codi amb el que es guardarà la referència a la capa internament.
visible	function	Determina si la capa serà visible o no.
getExtensio	function	Retorna la extensió de la capa.
getElements	function	Retorna els elements de la capa en cas de ser de tipus 'vector'.
getInnerObject	function	Retorna l'objecte ol.layer d'openlayers.

geoBCN.Map.CartographySpecification{object}

Existeixen diversos tipus de cartografies compatibles amb el component mapa:

S'especiifica amb un string. per exemple:

Propietats:

Nom propietat	Tipus	Argument	Valor per defecte	Descripció
tipus	string			Tipus de la cartografia, determina el contingut dels params ja que depenent del tipus de capa els paràmetres necesàris seran diferents ha de ser un els definits a geoBCN.Map.CartographySpecification.
nom	string			Nom de la capa (El nom que es mostra a la llegenda).
codi	string			Codi amb el que es guardarà la referència a la capa internament.
visible	string	<optional>	false	Determina si la capa serà visible o no.
params	geoBCN.Map.CartographySpecificationTypes			Especificació de la capa segons el tipus definit

geoBCN.Map.CartographySpecificationTypes{object}

Existeixen diversos tipus de cartografies compatibles amb el component mapa:

S'especiifica amb un string. per exemple:

Cartografia configurable: Permet afegir capes de cartografia de diversos orígens i tipus. Cadascuna té la seva parametrització pròpia.

• wms Format estándard de serveis WMS

  Nom propietat	Tipus	Descripció
  url	string	Url de la capa WMS
  capes	string	Capes que ha de mostrar el servei. L'especificació WMS defineix que es un String separat per comes.
  proj	geoBCN.CoordSystem.Name		Codi del sistema de coordenades en la que es tornen les dades
  opacitat	number	1	Opacitat de la capa
  singleTile	boolean	false	Indica si es vol que les tesel·les es carreguin en una unica tessel·la

• xyz Format estándard de serveis xyz

  Nom propietat	Tipus	Descripció
  url	string	Url de la capa XYZ
  proj	geoBCN.CoordSystem.Name		Codi del sistema de coordenades en la que es tornen les dades
  extensio	string	opcional Extensió que es vol aplicar a la capa
  resolucions	string	opcional Resolucions de la capa

• vector Format vectorial. Admet elements amb propietats

  Nom propietat	Tipus	Valor per defecte	Descripció
  file	string		Fitxer d'on carregarà el GeoJSON. Aquest paràmetre deixa sense efecte el paràmetre url
  url	string		Url d'on ha de carregar els features
  activada	boolean		Indica si la capa està activada o desactivada
  proj	geoBCN.CoordSystem.Name		Codi del sistema de coordenades en la que es tornen les dades
  strategy	geoBCN.Map.strategy		Estrategia a seguir a l'hora de carregar les dades (single|bbox)
  maxZoomLevel	integer		Zoom máxim on mostrar les dades
  tileSize	integer	512	opcional Mida en píxels de les tessel·les
  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	4	opcional Umbral de simplificació de les geometries.
  maxfeatures	integer	2000	opcional Nombre màxim d'elelmts que retornarà el servei a cada comanda.
  style	function		opcional Funció d'estil d'OpenLayers. Aquesta funció té la signatura: ({ol.Feature},{integer})
  opacity	function	1	opcional Ratio d'opacitat de tota la capa.
  json	object		opcional Objecte geojson amb la especificació de les features a mostrar
  estils	object		opcional Estils de les Features de la capa. Properties Nom propietat Tipus Descripció normal object opcional Estils de les Features en estat normal(desseleccionat). Properties Nom propietat Tipus Argument Descripció colorLinea string opcional Color de la línia de les Features en estat normal(desseleccionat). gruixLinea integer opcional Gruix de la línia de les Features en estat normal(desseleccionat). colorEmplenat string opcional Color de farciment de les Features en estat normal(desseleccionat). seleccio object opcional Estils de les Features en estat normal(desseleccionat). Properties Nom propietat Tipus Descripció colorLinea string opcional Color de la línia de les Features en estat seleccionat. gruixLinea integer opcional Gruix de la línia de les Features en estat seleccionat. colorEmplenat string opcional Color de farciment de les Features en estat seleccionat.
  source	object		opcional Origen de les dades, no cal especificar si es passa directament un objecte GEOJSON al paràmetre json o si especifiquem una url d'un servei WFS Properties Nom propietat Tipus Descripció type string opcional Tipus de dades que s'utilitzaran per crear les features, ha de ser un dels següents valors: ["wfs","json","file"] format string opcional En cas de que el paràmetre type sigui "file", cal detrminar el format del fitxer, el valor ha de ser un dels següents: ["csv","json","geojson"] specification geoBCN.Map.vectorSpecification opcional Especificació dels elements en cas de que format="csv" o format="json"

• image Format imatge estática

  Nom propietat	Tipus	Descripció
  url	string	Url de la imatge
  extent	array	Array amb l'extensió máxima de la capa.

• tile Format tessel·lat

  Nom propietat	Tipus	Descripció
  url	string	Url de la capa.
  extent	array	Array amb l'extensió máxima de la capa.
  resolucions	string	opcional Resolucions de la capa
  tesselaOrigen	string	opcional Origen de la grid, el valor ha de ser 'NW' o 'SW', per defecte 'SW'

• wmts format de caché ràpida

  Nom propietat	Tipus	Descripció
  url	string	Url del servei de la capa WMTS
  capes	string	Nom de les capes anunciades a les capabilities de la capa WMTS que es volen afegir. L'especificació WMTS defineix que es un String separat per comes
  format	string	opcional Format en que es vol demanar les imatges de les tiles. Per defecte 'image/png'.
  matrixSet	array	MatixSet que volem estirar del servei. Ha d'estar definida a les capabilities del servei.
  urlCapabilities	string	opcional Url per obtenir les capabilities de la capa, si s'especifica fa que altres paràmetres siguin obviats ja que agafa les dades de les capabilities.
  requestEncoding	array	opcional Codificació en la que es demana la petició de getCapabilities al determinar el param urlCapabilities, pot ser 'KVP' o 'REST'
  extent	array	Array amb l'extensió máxima de la capa.

• xyz-imi Format estándard de serveis xyz amb parametrització pròpia de l'Ajuntamet de Barcelona *

  Nom propietat	Tipus	Descripció
  url	string	Url de la capa XYZ

geoBCN.Map.LegendOptions{object}

Propietats:

Nom propietat	Tipus	Descripció
capes	object	Si s'especifica com a null, aleshores no es visibilitza el desplegable de capes.
fons	object	Si s'especifica com a null, aleshores no es visibilitza el desplegable de fons de mapa.

geoBCN.Map.MapProperties{Object}

Propietats:

Nom propietat	Tipus	Descripció
mode	geoBCN.Map.ModeFuncionament	Descripció del concepte modes de funcionament.
zoom	integer	Zoom aplicat a la vista del mapa.
fons	geoBCN.Map.CartographySpecification	Estableix el fons del mapa en un dels disponibles que s'hagin definit en la inicialització del map.

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

geoBCN.Map.vectorSpecification{object}

Propietats:

Nom propietat	Tipus	Argument	Descripció
geometry	object		Especificació de les geometries obtingudes del. Properties Nom propietat Tipus Argument Descripció type string Tipus de geometria. properties Array.<string> <optional> Propietats definides a les dades d'origen que volem afegir a la feature creada.
elementsQuery	string	<optional>	Query json cap l'array que conté els elements.
id	string		Propietat de l'origen de dades de la qual es crearà el camp 'id' a la feature creada.

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.Location	les dades obtingudes.

geoLocalitzacioErrorCallback(resposta)

Callback que es crida quan la geolocalització dona error per part de l'aplicatiu integrador (funció geoLocalitza)

Nom paràmetre	Tipus	Descripció
resposta	geoBCN.Location	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.

onClickMarkerCallback(feature, coords)

Callback que es al clickar en un marcador si s'ha especificat al paràmetre de la funció geoBCN.Map.afegeixMarcador.

Nom paràmetre	Tipus	Descripció
feature	object	feature d'openlayers lligada al marcador.
coords	geoBCN.Geometry.Point2D	Localització del marcador.

seleccioAdrecaCallback(resposta)

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

Nom paràmetre	Tipus	Descripció
resposta	geoBCN.ServiceResponse	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.