Class: spw.api.SpwMap

▲

Description

Classe représentant la carte. Elle crée la carte (esri.Map) et interagit avec elle.

new SpwMap()

Source:

Héritage

  • dijit._WidgetBase

Overview

MembresMéthodes

Membres

_currentCursor

Curseur actuel de la carte
Source:

_cursor

Curseur de la carte
Source:

_loadingImagePath

Chemin d'accès sur le serveur pour l'image de chargement
Source:

_mapServices

Tableau contenant les spw.api.MapService ajouté sur la carte.
Source:

_navigationToolBar

Navigation tool bar d'esri
Source:

<private> esriMap :esri.Map

Objet esri représentant la carte
Type:
  • esri.Map
Source:

hasBaseMap

Indique si au moins un service fond de plan est attaché à la carte.
Source:

loaded

Indique si la carte est chargée
Source:

mapParams

Paramètres passés à la map esri
Source:

spwViewer

Référence vers l'instance de spw.api.SpwViewer
Source:

watchLoaded

Crée les services fonds de plan sur base de la configuration.
Source:

Méthodes

activateNavigationMode(mode)

Modifie le mode de navigation de la toolbar
Paramètres:
Nom Type Description
mode le nouveau mode de navigation à appliquer
Source:

addBaseMap(service, visible)

Ajoute un fond de plan sur la carte
Paramètres:
Nom Type Description
service le service fond de plan à ajouter
visible indique si le fond de plan à ajouter doit être visible ou non.
Source:
Retourne:
le spw.api.MapService du type baseMap

addMapService(service)

Ajoute un service sur la carte
Paramètres:
Nom Type Description
service
Source:
Retourne:
l'instance du spw.api.MapService

addMarkerOnPoint(point, options)

Affiche un marqeur sur la carte pour un point donné
Paramètres:
Nom Type Description
point esri.Geometry.Point
options object
Source:

addServiceFromGeoJSONResource(resource)

Lit un GeoJSON passé en paramètre et l'ajoute sur la carte.
Paramètres:
Nom Type Description
resource le GeoJSON à ajouter (une URL sur laquelle aller chercher le fichier, un GeoJSON au format texte ou le GeoJSON déjà parsé
Source:
Retourne:
une promesse de l'ajout du service sur la carte

buildEsriMap(opts)

Construit l'objet EsriMap sur base des options passée
Paramètres:
Nom Type Description
opts options pour la création de la EsriMap
Source:

centerAndZoom(x, y, level)

Centre et zoom sur un point
Paramètres:
Nom Type Description
x
y
level niveau de zoom
Source:

centerAt(x, y)

Centre la carte sur les coordonnées passées.
Paramètres:
Nom Type Description
x
y
Source:

copyServices(fromMap)

Copie les services présents dans la carte passée en paramètre
Paramètres:
Nom Type Description
fromMap la carte dont il faut copier les services
Source:

createBaseMap()

Crée les services fonds de plan de la carte. Cette méthode démarre l'initialisation de la carte.
Source:

createDefaultSymbol(feature)

Crée un symbol par défaut en fonction du type de géométrie passé.
Paramètres:
Nom Type Description
feature
Source:

createHighlightSymbol(feature)

Crée un symbol de mise en évidence par défaut en fonction du type de géométrie passé.
Paramètres:
Nom Type Description
feature
Source:

createMapServiceBaseMap(service, visible)

Crée les MapServices de type baseMap correspondant à la configuration
Paramètres:
Nom Type Description
service
visible
Source:
Retourne:

createServices()

Crée tous les services définis dans la configuration du catalogue.
Source:

deactivateNavigation()

Désactive la navigation de la toolbar
Source:

destroy()

Appelé à la destruction de SpwMap
Source:

getBaseMapLayerCount() → {Number}

Récupère le nombre de baseMaps actuellement attachées à la carte.
Source:
Retourne:
Le nombre de fonds de plan
Type
Number

getCurrentExtent() → {Array.<Number>}

Récupère l'extent courant de la carte
Source:
Retourne:
Type
Array.<Number>

getCurrentScale() → {Number}

Récupère l'échelle courante de la carte
Source:
Retourne:
scale
Type
Number

getCurrentToolMapCursor() → {string}

Obtient le curseur actuel de la carte
Source:
Retourne:
cursor (valeur css)
Type
string

getExtentForScale(scale)

Retourne l'extent de la carte à une échelle donnée
Paramètres:
Nom Type Description
scale l'échelle à laquelle on veut l'extent
Source:

getHeight()

Retourne la hauteur de la esriMap
Source:

getLegend(mapService)

Permet de récupérer la légende d'un MapService.
Paramètres:
Nom Type Description
mapService
Source:

getLevel()

Retourne le niveau de la esriMap
Source:

getMapCursor()

Mobient le curseur de la carte
Source:

getMapServiceById(serviceId) → {spw.api.MapService}

Récupère un spw.api.MapService sur base du serviceId.
Paramètres:
Nom Type Description
serviceId l'identifiant du service
Source:
Retourne:
Type
spw.api.MapService

getMapServices(serviceQuery) → {Array}

Récupère un ou plusieurs MapService sur base d'un queryObject
Paramètres:
Nom Type Description
serviceQuery Objet de mapping clé-valeur sur base duquel effectuer la comparaison avec les services.
Source:
Retourne:
Les MapServices correspondant au queryObject passé.
Type
Array

getServicesFromGroup(serviceGroup) → {Array}

Obtient la liste des services d'un groupe.
Paramètres:
Nom Type Description
serviceGroup le nom du groupe de service
Source:
Retourne:
les services de ce groupe
Type
Array

getSpatialReference()

Retourne la référence spatiale actuelle de la Esri map
Source:

getSpatialReferenceSRID()

Retourne le SRID de la référence spatiale actuelle de l'Esri Map
Source:

getWidth()

Retourne la largeur de la esriMap
Source:

getZoom()

Retourne le niveau de zoom de la esriMap
Source:

hideInfoWindow()

Cache l'info window Esri
Source:

hideMapLoading()

Cache le loader sur la carte
Source:

hideService(serviceId)

Cache un MapService sur la carte
Paramètres:
Nom Type Description
serviceId l'identifiant du service
Source:

highlightFeature(feature)

Met en évidence le feature passé sur la carte
Paramètres:
Nom Type Description
feature esri.Graphic
Source:

isUpdating()

Permet de déterminer si la carte est en train d'être mise à jour ou pas
Source:

mapEvents(map)

Initialise les handlers pour les différents MapEvents
Paramètres:
Nom Type Description
map référence à SpwMap
Source:
Retourne:
un tableau contenant les handlers

mapExtentChanged(extentEvent)

Appelée lorsque l'extent de la carte change
Paramètres:
Nom Type Description
extentEvent
Source:

mapLoaded()

Appelée lorsque la carte est chargée
Source:

mapMouseDblClicked()

Emet l'événement mapMouseDblClicked
Source:

mapMouseMove()

Emet l'événement mapMouseMove
Source:

mapPanEnd()

Emet l'événement mapPanEnd
Source:

mapServiceLoaded(mapService)

Appelé lorsqu'un MapService est chargé.
Paramètres:
Nom Type Description
mapService
Source:

mapServiceVisibilityChanged(mapService)

Appelé lorsque la visibilité d'un MapService change.
Paramètres:
Nom Type Description
mapService
Source:

mapZoom()

Emet l'événement mapZoom
Source:

mapZoomEnd()

Emet l'événement mapZoomEnd
Source:

mapZoomStart()

Emet l'événement mapZoomStart
Source:

placeIn(obj)

Place un élément UI sur la carte (widget, html, ...)
Paramètres:
Nom Type Description
obj l'objet à afficher sur la carte
Source:

postCreate()

Méthode appelée après la création de la classe
Source:

removeBaseMaps()

Supprime tous les fonds de plan de la carte.
Source:

removeFeature(feature)

Supprime un objet graphique de la carte
Paramètres:
Nom Type Description
feature esri.Graphic
Source:

removeFeatures(features)

Supprime les objets graphiques spécifiés de la carte
Paramètres:
Nom Type Description
features Array.<esri.Graphic>
Source:

removeMapService(serviceId)

Supprimer un service de la carte sur base du serviceId
Paramètres:
Nom Type Description
serviceId l'identifiant du MapService à supprimer de la carte
Source:

resetCursor()

Réinitialise le curseur de la carte
Source:

resizeInfoWindow(width, height)

Redimensionne l'infoWindow Esri
Paramètres:
Nom Type Description
width
height
Source:

setAllMapServiceNotBaseMapOrder(mapServicesId)

Réordonne les mapServices de la carte en plaçant systématiquement les fonds de plan à l'arrière plan.
Paramètres:
Nom Type Description
mapServicesId Array.<Number> tableau avec les identifiant des services à réordonner.
Source:

setCurrentToolMapCursor(cursor, permet)

Met à jour le curseur actuelle de la carte
Paramètres:
Nom Type Description
cursor string (valeur css)
permet activate de déterminer s'il faut appliquer le changement maintenant
Source:

setLevel(level)

Met à jour le niveau de la esriMap
Paramètres:
Nom Type Description
level le nouveau niveau
Source:

setMapCursor(cursor)

Définit un curseur de carte.
Paramètres:
Nom Type Description
cursor le curseur de carte
Source:

setMapServiceOrder(serviceId, index)

Réordonne un MapService sur base de son identifiant.
Paramètres:
Nom Type Description
serviceId l'identifiant du service à déplacer
index le nouvel index du service
Source:

setScale(scale)

Met à jour l'échelle de la esriMap
Paramètres:
Nom Type Description
scale la nouvelle échelle
Source:

setZoom(level)

Met à jour le niveau de zoom de la esriMap
Paramètres:
Nom Type Description
level le nouveau niveau de zoom
Source:

showFeature(feature)

Affiche un objet graphique sur la carte du type esri.Graphic
Paramètres:
Nom Type Description
feature esri.Graphic
Source:

showFeatures(features)

Affiche un groupe d'objets graphiques sur la carte du type esri.Graphic
Paramètres:
Nom Type Description
features esri.Graphic
Source:

showGeometries(feature)

Affiche un tableau de géométries sur la carte et retourne les Graphics esri créés
Paramètres:
Nom Type Description
feature esri.Graphic
Source:

showGeometry(feature)

Affiche une géométrie sur la carte et retourne le Graphic esri créé
Paramètres:
Nom Type Description
feature esri.Graphic
Source:

showInfoWindowAt(title, content, point)

Affiche l'infoWindow Esri sur la carte
Paramètres:
Nom Type Description
title Titre de l'infoWindow
content contenu de l'infoWindow
point Coordonnée du point sur la carte où l'infoWindow doit pointer.
Source:

showMapLoading()

Affiche le loader sur la carte
Source:

showService(serviceId)

Affiche un MapService sur la carte
Paramètres:
Nom Type Description
serviceId l'identifiant du service
Source:

startup()

Démarre la carte
Source:

toMapPoint(x, y)

Projette le point donné dans la référence spatiale actuelle de la carte.
Paramètres:
Nom Type Description
x la coordonnée X du point
y la coordonnée Y du point
Source:
Retourne:
le point converti

toScreenPoint(x, y, extent, width, height)

Convertit une coordonnée en point pixel
Paramètres:
Nom Type Description
x la coordonnée X du point
y la coordonnée Y du point
extent l'extent à prendre en compte lors du calcul
width la largeur de la carte à prendre en compte lors du calcul
height la hauteur de la carte à prendre en compte lors du calcul
Source:
Retourne:
le point converti

unhighlightFeature(feature)

Retire la mise en évidence du feature passé sur la carte
Paramètres:
Nom Type Description
feature esri.Graphic
Source:

zoomToBbox(xMin, xMax, yMin, yMax)

Zoom sur la BBox passée en paramètre
Paramètres:
Nom Type Description
xMin
xMax
yMin
yMax
Source:

zoomToExtent(extent)

Zoom sur l'extent passé en paramètre
Paramètres:
Nom Type Description
extent
Source:

zoomToFeature(feature)

Zoom sur un objet feature (esri.Graphic)
Paramètres:
Nom Type Description
feature esri.Graphic
Source:

zoomToFeatures(features)

Zoom sur un ensemble d'objet feature (esri.Graphic)
Paramètres:
Nom Type Description
features Array.<esri.Graphic>
Source:

zoomToFullExtent()

Recadre la carte à l'extent complet
Source:

zoomToInitExtent()

Recadre la carte à l'extent initial
Source:

zoomToPoint(x, y, radius)

Zoom sur un point en fonction de ses coordonnées et d'un rayon passé.
Paramètres:
Nom Type Description
x
y
radius le rayon autour du point
Source:

Evènements

FirstServiceAdded

Evènement déclenché lorsque le premier service est ajouté à la carte.
Source:

MapClicked

Evènement déclenché lorsque la carte est cliquée.
Source:

MapDblClicked

Evènement déclenché lorsque l'on double clique sur la carte.
Source:

MapExtentChanged

Evènement déclenché lorsque l'extent de la carte change.
Source:

MapLoaded

Evènement déclenché lorsque la carte est chargée.
Source:

MapMouseMove

Evènement déclenché lorsque le curseur est déplacé sur la carte.
Source:

MapPanEnd

Evènement déclenché lorsque le pan est fini.
Source:

MapServiceAdded

Evènement déclenché lorsqu'un MapService est ajouté.
Source:

MapServiceAddedToMap

Événement déclenché lorsque le layer du MapService est ajouté à la carte esri.
Source:

MapServiceLoaded

Evènement déclenché lorsqu'un MapService est chargé.
Source:

MapServiceRemoved

Evènement déclenché lorsqu'un MapService est supprimé.
Source:

MapServiceVisibilityChanged

Evènement déclenché lorsque la visibilité d'un MapService est modifiée.
Source:

MapZoomEnd

Evènement déclenché lorsque lors du processus de zoom.
Source:

MapZoomEnd

Evènement déclenché lorsque le processus de zoom commence.
Source:

MapZoomEnd

Evènement déclenché lorsque le processus de zoom est fini.
Source: