Class: spw.api.MapService

Description

Classe abstraite à partir de laquelle il est possible de créer des services affichables sur la carte

new MapService()

Source:

Overview

MembresMéthodes

Membres

added :Boolean

Indique si le service a été ajouté à la carte.
Type:
  • Boolean
Source:

alpha :Number

L'opacité initiale du service [0;100].
Type:
  • Number
Source:

alphaTimer :Number

L'opacité pour un fond de plan de type Voyage dans le temps [0;1].
Type:
  • Number
Source:

changeVisibility :Boolean

Type:
  • Boolean
Source:

checked :Boolean

Ce service est-il sélectionné dans le BaseMapChooser
Type:
  • Boolean
Source:

clusterLayers

TODO
Source:

disableClientCache :Boolean

Active/désactive le caching des images du service côté client.
Type:
  • Boolean
Source:

displayLevels :Array.<Number>

Définit les niveaux auquels le service doit s'afficher.
Type:
  • Array.<Number>
Source:

grayscale

Permet d'appliquer un filtre niveaux de gris sur le service
Source:

hasLegend :Boolean

Spécifie si le service possède une légende et si celle-ci doit être chargée.
Type:
  • Boolean
Source:

heatLayers

TODO
Source:

identifiable :Boolean

Ce paramètre permet de définir si le service est identifiable. Si c'est le cas, toutes les couches de ce service seront identifiables à moins qu'une configuration spécifique soit définie au niveau du tableau 'layers'.
Type:
  • Boolean
Source:

ignoreAttributes :Array.<String>

La liste des attributs à ignorer lors de l'affichage des résultats de l'identify.
Type:
  • Array.<String>
Source:

inError :Boolean

Indique si le service est en erreur.
Type:
  • Boolean
Source:

inTOC :Boolean

Permet de déterminer si le service est visible dans la toc ou non
Type:
  • Boolean
Source:

isBaseMap :Boolean

Indique si le service est un fond de plan.
Type:
  • Boolean
Source:

label :String

Le label correspond au nom du service qui sera affiché dans l'application.
Type:
  • String
Source:

layer :esri.Layer

Référence vers l'objet original représentant le service Esri.
Type:
  • esri.Layer
Source:

layerDefinitions :Array.<String>

Permet de fournir une "where clause" par couche du service. Voir "layerDefinition" Esri.
Type:
  • Array.<String>
Source:

layers :Array.<Object>

Cette propriété permet de définir un tableau afin de pouvoir configurer de façon spécifique les couches du service de cartes.
Type:
  • Array.<Object>
Source:

legendLoaded :Boolean

Indique si les légendes du services sont chargées.
Type:
  • Boolean
Source:

loaded :Boolean

Indique si le service est chargé.
Type:
  • Boolean
Source:

mapServiceLayers :Array.<spw.api.MapServiceLayer>

Les objets layers encapsulés. Il s'agit des couches définies dans le service.
Type:
Source:

maxScale

Echelle maximum du service.
Source:

metadataPopup :String

Cet object permet de fixer la taille de la popup si on ne désire pas ouvrir le lien 'metadataUrl' dans une nouvelle fenêtre.
Type:
  • String
Propriétés:
Nom Type Description
metadataPopup.width Number largeur en pixel
metadataPopup.height Number hauteur en pixel
Source:

metadataUrl :String

L'URL vers les données descriptives de ce service.
Type:
  • String
Source:

minScale

Echelle minimum du service.
Source:

networkSecured :Boolean

Indique si le service est sécurisé via le réseau (intranet) et s'il doit passer par le serveur de sécurisation pour les différents appels REST.
Type:
  • Boolean
Source:

order :Integer

Permet d'établir l'ordre dans lequel le layer sera dessiné (order supérieur = layer au-dessus)
Type:
  • Integer
Source:

resampling :Boolean

Permet au service de s'afficher en dessous de son échelle minimum définie en redéfinissant la dernière image disponible. Pour s'activer, le serveur fournissant l'image doit renvoyer une erreur 404.
Type:
  • Boolean
Source:

serviceId :String

Le serviceId doit être unique dans le fichier de configuration et représente l'identifiant du service.
Type:
  • String
Source:

tokenSecured :Boolean

Indique si le service est sécurisé via le système de token ArcGIS Server et s'il doit passer par le serveur de sécurisation pour les différents appels REST.
Type:
  • Boolean
Source:

toLoad :Boolean

Permet de déterminer si le service doit être ajouté par défaut (lors du chargement du viewer) à la carte.
Type:
  • Boolean
Source:

type :String

Le type de service. AGS_TILED, AGS_DYNAMIC, FEATURE_LAYER, WMS, STATIC_IMAGE.
Type:
  • String
Source:

url :String

L'url du service.
Type:
  • String
Source:

visible :Boolean

Ce paramètre permet de déterminer si un service est par défaut visible quand celui-ci est ajouté sur la carte.
Type:
  • Boolean
Source:

Méthodes

addToMap(esriMap)

Ajoute le layer à la carte ESRI
Paramètres:
Nom Type Description
esriMap Object carte ESRI
Source:

constructor()

Crée le layer Esri sur base de la configuration du MapService.
Source:

createMapLayer()

Crée le layer Esri sur base de la configuration du MapService.
Source:

createMapLayer()

Crée le layer Esri sur base de la configuration du MapService.
Source:

createMapLayer()

Crée le layer Esri sur base de la configuration du MapService.
Source:

createMapLayer()

Crée le layer Esri sur base de la configuration du MapService.
Source:

createMapLayer()

Crée le layer Esri sur base de la configuration du MapService.
Source:

createMapLayer()

Crée le layer Esri sur base de la configuration du MapService.
Source:

createMapLayer()

Crée le layer Esri sur base de la configuration du MapService.
Source:

createMapLayer()

Crée le layer Esri sur base de la configuration du MapService.
Source:

createMapLayer()

Crée le layer Esri sur base de la configuration du MapService.
Source:

createMapLayer()

Crée le layer Esri sur base de la configuration du MapService.
Source:

createMapLayer()

Crée le layer Esri sur base de la configuration du MapService.
Source:

createMapLayer()

Crée le layer Esri sur base de la configuration du MapService.
Source:

createMapLayer()

Crée le layer Esri sur base de la configuration du MapService.
Source:

createMapLayer()

Crée le layer Esri sur base de la configuration du MapService.
Source:

createMapLayer()

Crée le layer Esri sur base de la configuration du MapService.
Source:

identify()

Identifie les données du service se situant à un certain endroit de la carte
Source:

layerLoaded(loadedEvent)

Appelé lorsque le layer principal est chargé avec succés.
Paramètres:
Nom Type Description
loadedEvent
Source:

loadLegend()

Permet de charger la légende du service
Source:

_afterLayerLoaded()

Appelé après la méthode layerLoaded
Source:

_layerInfoToLayer(layerInfo) → {Object}

Transforme un objet layerInfo Esri (esri.LayerInfo) en objet nécessaire à la contruction du MapServiceLayer
Paramètres:
Nom Type Description
layerInfo esri.LayerInfo
Source:
Retourne:
Type
Object

_updateScale()

Met à jour les échelles du service courant en fonction des sous layers chargés.
Source:

addToMap(esriMap)

Ajoute le service courant à la carte.
Paramètres:
Nom Type Description
esriMap esri.Map l'objet carte d'esri.
Source:

baseMapLayerLoaded(loadedEvent)

Appelé lorsque le layer principal d'une baseMap est chargé avec succès.
Paramètres:
Nom Type Description
loadedEvent
Source:

createMapLayer()

Crée le layer Esri sur base de la configuration du MapService.
Source:

getMapServiceLegend(scale) → {Object}

Obtient les légendes d'un service en fonction de la visibilité de ses couches à une échelle donnée.
Paramètres:
Nom Type Description
scale Le niveau d'échelle
Source:
Retourne:
Mapping entre le label du service et les objets légende des layers.
Type
Object

hasIdentifiableVisibleLayers(scale) → {Boolean}

Détermine si le service possède des layers identifiables à l'échelle donnée.
Paramètres:
Nom Type Description
scale Le niveau d'échelle
Source:
Retourne:
Type
Boolean

hide()

Cache le service de la carte
Source:

layerError(error)

Appelée lorsqu'un service est en erreur.
Paramètres:
Nom Type Description
error L'erreur déclenchée par le service.
Source:

layerLoaded(loadedEvent)

Appelé lorsque le layer principal est chargé avec succés.
Paramètres:
Nom Type Description
loadedEvent
Source:

legendLoadedError(response)

Handler appelé lorsque les légendes du services ont rencontré une erreur lors du chargement.
Paramètres:
Nom Type Description
response Object contenant les informations des légendes.
Source:

legendLoadedSuccess(response)

Handler appelé lorsque les légendes du services sont chargées.
Paramètres:
Nom Type Description
response Object contenant les informations des légendes.
Source:

loadLegend()

Charge les légendes du service.
Source:

refreshLayersVisibility()

Rafraichit la visibilité des layers
Source:

removeFromMap(esriMap)

Supprime le service courant de la carte.
Paramètres:
Nom Type Description
esriMap esri.Map l'objet carte d'esri.
Source:

show()

Affiche le service sur la carte
Source:

Evènements

MapServiceError

Evènement déclenché lorsque le MapService est en erreur.
Source:

MapServiceLayersVisibilityChanged

Evènement déclenché lorsque la visibilité de tous les layers du MapService est changée.
Source:

MapServiceLayerVisibilityChanged

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

MapServiceLayerVisibilityChanged

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

MapServiceLegendError

Evènement déclenché lorsque les légendes du MapService sont en erreur.
Source:

MapServiceLegendLoaded

Evènement déclenché lorsque les légendes du MapService sont chargées.
Source:

MapServiceLoaded

Evènement déclenché lorsque le MapService est chargé.
Source:

MapServiceVisibilityChanged

Evènement déclenché lorsque la visibilité du MapService change.
Source:

Description

Classe encapsulant les types standard de "Layers" Esri.

new MapService(service)

Le construteur ne doit pas être appelé directement, il faut passer par la classe MapServiceFactory pour instancier un service
Paramètres:
Nom Type Description
service Object
Propriétés
Nom Type Description
serviceId String | Number spw.api.MapService#serviceId
label String spw.api.MapService#label
url String spw.api.MapService#url
disableClientCache Boolean spw.api.MapService#disableClientCache
visible Boolean spw.api.MapService#visible
hasLegend Boolean spw.api.MapService#hasLegend
alpha Number spw.api.MapService#alpha
layers Array.<Object> spw.api.MapService#layers
identifiable Boolean spw.api.MapService#identifiable
ignoreAttributes Array.<String> spw.api.MapService#ignoreAttributes
resampling Boolean spw.api.MapService#resampling
wmsParameters Object spw.api.MapService#wmsParameters
toLoad Boolean spw.api.MapService#toLoad
Source:

Overview

MembresMéthodes

Membres

added :Boolean

Indique si le service a été ajouté à la carte.
Type:
  • Boolean
Source:

alpha :Number

L'opacité initiale du service [0;100].
Type:
  • Number
Source:

alphaTimer :Number

L'opacité pour un fond de plan de type Voyage dans le temps [0;1].
Type:
  • Number
Source:

changeVisibility :Boolean

Type:
  • Boolean
Source:

checked :Boolean

Ce service est-il sélectionné dans le BaseMapChooser
Type:
  • Boolean
Source:

clusterLayers

TODO
Source:

disableClientCache :Boolean

Active/désactive le caching des images du service côté client.
Type:
  • Boolean
Source:

displayLevels :Array.<Number>

Définit les niveaux auquels le service doit s'afficher.
Type:
  • Array.<Number>
Source:

grayscale

Permet d'appliquer un filtre niveaux de gris sur le service
Source:

hasLegend :Boolean

Spécifie si le service possède une légende et si celle-ci doit être chargée.
Type:
  • Boolean
Source:

heatLayers

TODO
Source:

identifiable :Boolean

Ce paramètre permet de définir si le service est identifiable. Si c'est le cas, toutes les couches de ce service seront identifiables à moins qu'une configuration spécifique soit définie au niveau du tableau 'layers'.
Type:
  • Boolean
Source:

ignoreAttributes :Array.<String>

La liste des attributs à ignorer lors de l'affichage des résultats de l'identify.
Type:
  • Array.<String>
Source:

inError :Boolean

Indique si le service est en erreur.
Type:
  • Boolean
Source:

inTOC :Boolean

Permet de déterminer si le service est visible dans la toc ou non
Type:
  • Boolean
Source:

isBaseMap :Boolean

Indique si le service est un fond de plan.
Type:
  • Boolean
Source:

label :String

Le label correspond au nom du service qui sera affiché dans l'application.
Type:
  • String
Source:

layer :esri.Layer

Référence vers l'objet original représentant le service Esri.
Type:
  • esri.Layer
Source:

layerDefinitions :Array.<String>

Permet de fournir une "where clause" par couche du service. Voir "layerDefinition" Esri.
Type:
  • Array.<String>
Source:

layers :Array.<Object>

Cette propriété permet de définir un tableau afin de pouvoir configurer de façon spécifique les couches du service de cartes.
Type:
  • Array.<Object>
Source:

legendLoaded :Boolean

Indique si les légendes du services sont chargées.
Type:
  • Boolean
Source:

loaded :Boolean

Indique si le service est chargé.
Type:
  • Boolean
Source:

mapServiceLayers :Array.<spw.api.MapServiceLayer>

Les objets layers encapsulés. Il s'agit des couches définies dans le service.
Type:
Source:

maxScale

Echelle maximum du service.
Source:

metadataPopup :String

Cet object permet de fixer la taille de la popup si on ne désire pas ouvrir le lien 'metadataUrl' dans une nouvelle fenêtre.
Type:
  • String
Propriétés:
Nom Type Description
metadataPopup.width Number largeur en pixel
metadataPopup.height Number hauteur en pixel
Source:

metadataUrl :String

L'URL vers les données descriptives de ce service.
Type:
  • String
Source:

minScale

Echelle minimum du service.
Source:

networkSecured :Boolean

Indique si le service est sécurisé via le réseau (intranet) et s'il doit passer par le serveur de sécurisation pour les différents appels REST.
Type:
  • Boolean
Source:

order :Integer

Permet d'établir l'ordre dans lequel le layer sera dessiné (order supérieur = layer au-dessus)
Type:
  • Integer
Source:

resampling :Boolean

Permet au service de s'afficher en dessous de son échelle minimum définie en redéfinissant la dernière image disponible. Pour s'activer, le serveur fournissant l'image doit renvoyer une erreur 404.
Type:
  • Boolean
Source:

serviceId :String

Le serviceId doit être unique dans le fichier de configuration et représente l'identifiant du service.
Type:
  • String
Source:

tokenSecured :Boolean

Indique si le service est sécurisé via le système de token ArcGIS Server et s'il doit passer par le serveur de sécurisation pour les différents appels REST.
Type:
  • Boolean
Source:

toLoad :Boolean

Permet de déterminer si le service doit être ajouté par défaut (lors du chargement du viewer) à la carte.
Type:
  • Boolean
Source:

type :String

Le type de service. AGS_TILED, AGS_DYNAMIC, FEATURE_LAYER, WMS, STATIC_IMAGE.
Type:
  • String
Source:

url :String

L'url du service.
Type:
  • String
Source:

visible :Boolean

Ce paramètre permet de déterminer si un service est par défaut visible quand celui-ci est ajouté sur la carte.
Type:
  • Boolean
Source:

Méthodes

addToMap(esriMap)

Ajoute le layer à la carte ESRI
Paramètres:
Nom Type Description
esriMap Object carte ESRI
Source:

constructor()

Crée le layer Esri sur base de la configuration du MapService.
Source:

createMapLayer()

Crée le layer Esri sur base de la configuration du MapService.
Source:

createMapLayer()

Crée le layer Esri sur base de la configuration du MapService.
Source:

createMapLayer()

Crée le layer Esri sur base de la configuration du MapService.
Source:

createMapLayer()

Crée le layer Esri sur base de la configuration du MapService.
Source:

createMapLayer()

Crée le layer Esri sur base de la configuration du MapService.
Source:

createMapLayer()

Crée le layer Esri sur base de la configuration du MapService.
Source:

createMapLayer()

Crée le layer Esri sur base de la configuration du MapService.
Source:

createMapLayer()

Crée le layer Esri sur base de la configuration du MapService.
Source:

createMapLayer()

Crée le layer Esri sur base de la configuration du MapService.
Source:

createMapLayer()

Crée le layer Esri sur base de la configuration du MapService.
Source:

createMapLayer()

Crée le layer Esri sur base de la configuration du MapService.
Source:

createMapLayer()

Crée le layer Esri sur base de la configuration du MapService.
Source:

createMapLayer()

Crée le layer Esri sur base de la configuration du MapService.
Source:

createMapLayer()

Crée le layer Esri sur base de la configuration du MapService.
Source:

createMapLayer()

Crée le layer Esri sur base de la configuration du MapService.
Source:

identify()

Identifie les données du service se situant à un certain endroit de la carte
Source:

layerLoaded(loadedEvent)

Appelé lorsque le layer principal est chargé avec succés.
Paramètres:
Nom Type Description
loadedEvent
Source:

loadLegend()

Permet de charger la légende du service
Source:

_afterLayerLoaded()

Appelé après la méthode layerLoaded
Source:

_layerInfoToLayer(layerInfo) → {Object}

Transforme un objet layerInfo Esri (esri.LayerInfo) en objet nécessaire à la contruction du MapServiceLayer
Paramètres:
Nom Type Description
layerInfo esri.LayerInfo
Source:
Retourne:
Type
Object

_updateScale()

Met à jour les échelles du service courant en fonction des sous layers chargés.
Source:

addToMap(esriMap)

Ajoute le service courant à la carte.
Paramètres:
Nom Type Description
esriMap esri.Map l'objet carte d'esri.
Source:

baseMapLayerLoaded(loadedEvent)

Appelé lorsque le layer principal d'une baseMap est chargé avec succès.
Paramètres:
Nom Type Description
loadedEvent
Source:

createMapLayer()

Crée le layer Esri sur base de la configuration du MapService.
Source:

getMapServiceLegend(scale) → {Object}

Obtient les légendes d'un service en fonction de la visibilité de ses couches à une échelle donnée.
Paramètres:
Nom Type Description
scale Le niveau d'échelle
Source:
Retourne:
Mapping entre le label du service et les objets légende des layers.
Type
Object

hasIdentifiableVisibleLayers(scale) → {Boolean}

Détermine si le service possède des layers identifiables à l'échelle donnée.
Paramètres:
Nom Type Description
scale Le niveau d'échelle
Source:
Retourne:
Type
Boolean

hide()

Cache le service de la carte
Source:

layerError(error)

Appelée lorsqu'un service est en erreur.
Paramètres:
Nom Type Description
error L'erreur déclenchée par le service.
Source:

layerLoaded(loadedEvent)

Appelé lorsque le layer principal est chargé avec succés.
Paramètres:
Nom Type Description
loadedEvent
Source:

legendLoadedError(response)

Handler appelé lorsque les légendes du services ont rencontré une erreur lors du chargement.
Paramètres:
Nom Type Description
response Object contenant les informations des légendes.
Source:

legendLoadedSuccess(response)

Handler appelé lorsque les légendes du services sont chargées.
Paramètres:
Nom Type Description
response Object contenant les informations des légendes.
Source:

loadLegend()

Charge les légendes du service.
Source:

refreshLayersVisibility()

Rafraichit la visibilité des layers
Source:

removeFromMap(esriMap)

Supprime le service courant de la carte.
Paramètres:
Nom Type Description
esriMap esri.Map l'objet carte d'esri.
Source:

show()

Affiche le service sur la carte
Source:

Evènements

MapServiceError

Evènement déclenché lorsque le MapService est en erreur.
Source:

MapServiceLayersVisibilityChanged

Evènement déclenché lorsque la visibilité de tous les layers du MapService est changée.
Source:

MapServiceLayerVisibilityChanged

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

MapServiceLayerVisibilityChanged

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

MapServiceLegendError

Evènement déclenché lorsque les légendes du MapService sont en erreur.
Source:

MapServiceLegendLoaded

Evènement déclenché lorsque les légendes du MapService sont chargées.
Source:

MapServiceLoaded

Evènement déclenché lorsque le MapService est chargé.
Source:

MapServiceVisibilityChanged

Evènement déclenché lorsque la visibilité du MapService change.
Source: