Class: spw.api.ConfigLoader

▲

Description

Charge et manipule les configurations du Viewer.

new ConfigLoader()

Le constructeur ne doit pas être appelé directement. ConfigLoader est une classe statique et doit être accédée via la méthode getInstance.
Source:

Overview

MembresMéthodes

Membres

_baseMapConfig :Object

Variable contenant la configuration des fonds de plan.
Type:
  • Object
Source:

_catalogConfig :Object

Variable contenant la configuration du catalogue.
Type:
  • Object
Source:

_contextConfig :Object

Variable contenant la configuration des contextes.
Type:
  • Object
Source:

_dictionnary :Object

Objet dictionnaire contenant le mapping clé/valeur des objets de configuration.
Type:
  • Object
Propriétés:
Nom Type Description
viewer
baseMap
catalog
widget
context
Source:

_viewerConfig :Object

Variable contenant la configuration du viewer.
Type:
  • Object
Source:

_widgetsConfig :Object

Variable contenant la configuration des widgets.
Type:
  • Object
Source:

configBaseUrl :string

Url de base commune des fichiers de configuration.
Type:
  • string
Source:

Méthodes

getInstance()

Permet de récupérer l'instance du ConfigLoader
Source:
Retourne:
spw.api.ConfigLoader

_jsonObjectsMerge(list, objectIdentifier) → {Array.<Object>}

Fusionne un tableau d'objet json de configuration sur base d'une propriété clé da la configuration
Paramètres:
Nom Type Description
list Array.<Object> Tableau d'objets json d'une configuration
objectIdentifier clé de configuration sur laquelle est effectuée la comparaison pour la fusion.
Source:
Retourne:
Tableau d'objet json fusionnés.
Type
Array.<Object>

addMapServicesFromURL()

Ajoute le(s) service(s) AGS définis dans l'url à la configuration courante.
Source:

get(configKey) → {Object}

Récupère une copie d'un objet de configuration sur base de sa clé.
Paramètres:
Nom Type Description
configKey string clé de l'objet de configuration : context ; baseMap ; catalog ; widgets ; viewer.
Source:
Retourne:
l'objet json de configuration.
Type
Object

getContext(queryObject) → {Array.<Object>}

Récupère un/plusieurs contexte(s) définit dans la configuration 'context'.
Paramètres:
Nom Type Description
queryObject Object Association clé-valeur permettant la comparaison des objets.
Source:
Retourne:
Le(s) contexte(s) correspondant au queryObject.
Type
Array.<Object>

getService(queryObject) → {Array.<Object>}

Récupère un/plusieurs service(s) définit dans la configuration 'catalog'.
Paramètres:
Nom Type Description
queryObject Object Association clé-valeur permettant la comparaison des objets.
Source:
Retourne:
Le(s) service(s) correspondant au queryObject.
Type
Array.<Object>

getServicesFromGroup(serviceGroup) → {Array}

Récupère les services d'un groupe de service dans la configuration du catalogue.
Paramètres:
Nom Type Description
serviceGroup String le code du groupe de services.
Source:
Retourne:
Les services contenu dans le groupe.
Type
Array

load(context)

Charge les configurations pour un contexte donné
Paramètres:
Nom Type Description
context String le code du contexte à charger
Source:

loadConfigFile(fileName) → {Deffered}

Charge un fichier de configuration sur base de son nom.
Paramètres:
Nom Type Description
fileName String Nom du fichier
Source:
Retourne:
Objet Deffered de Dojo pour le XHR de chargement du fichier.
Type
Deffered

loadFile(url) → {Deffered}

Charge un fichier sur base de son url.
Paramètres:
Nom Type Description
url String du fichier à charger.
Source:
Retourne:
Objet Deffered de Dojo pour le XHR de chargement du fichier.
Type
Deffered

mergeConfig(fileConfigType, json) → {Object}

Fusionne les différents objets de configuration.
Paramètres:
Nom Type Description
fileConfigType String le type d'objet à fusionner.
json Array.<Object> les objets de configuration à fusionner.
Source:
Retourne:
l'objet json de configuration fusionné.
Type
Object

retroConfigureBaseMapFromURL(baseMapStateString)

Adapte la configuration courante des baseMaps avec les informations (share) contenue dans l'url.
Paramètres:
Nom Type Description
baseMapStateString String chaine de configuration de l'état des fonds de plan
Source:

retroConfigureMapServicesFromURL(mapServicesStatesString)

Adapte la configuration courante du catalogue avec les informations (share) contenue dans l'url.
Paramètres:
Nom Type Description
mapServicesStatesString String chaine de configuration de l'état des services
Source:

Evènements

CONFIG_LOADED

Evènement déclenché lorsque les configuration sont chargées.
Source: