Map.js

Summary
Map.js
Prodige.MapClasse principale de l’API Prodige
Properties
id
renderTo
owscontext
legendVisible
keymapVisible
defaultControl
legendRenderer
Functions
Prodige.MapConstructeur d’instances
loadContextCharge une nouvelle carte
addControlAjoute un controle OpenLayers à la carte (si possible, l’ajoute à la barre d’outil de navigation)
getLayerTreeRetourne la racine de l’arbre des couches
getLegendRetourne le contrôleur de la légende
getKeymapRetourne le contrôleur de la carte de situation

Prodige.Map

Classe principale de l’API Prodige

Instancie et gère un objet {OpenLayers.Map} ainsi que la légende et la carte de situation

Summary
Properties
id
renderTo
owscontext
legendVisible
keymapVisible
defaultControl
legendRenderer
Functions
Prodige.MapConstructeur d’instances
loadContextCharge une nouvelle carte
addControlAjoute un controle OpenLayers à la carte (si possible, l’ajoute à la barre d’outil de navigation)
getLayerTreeRetourne la racine de l’arbre des couches
getLegendRetourne le contrôleur de la légende
getKeymapRetourne le contrôleur de la carte de situation

Properties

id

{String}Identifiant unique de l’instance
@api

renderTo

{String|DOMElement}Le domElement ou son ID dans lequel sera rendu la carte
@api

owscontext

{String}The URL to request the OWS context for the map to show
@api
@required

legendVisible

{Boolean}default=true - Permet d’afficher la légende
@api

keymapVisible

{Boolean}default=true - Ajoute à la carte, une carte de situation
@api

defaultControl

{String}Le nom du controle activé par défaut (nom de la classe du controle)
@api

legendRenderer

{String|Prodige.Tree.DefaultRenderer}default=’default’ - Le nom ou l’alias de la classe responsable du rendu de la légende.

Alias connus : ‘default’ et ‘advanced’

@api

Functions

Prodige.Map

Constructeur d’instances

Params

{Object|String}configuration de l’instance
  • {Object} - Objet contenant au minimun l’URL du contexte de carte OWS à charger ainsi que les éventuelles autres propriétés
  • {String} - URL du contexte de carte OWS à charger
Options de construction propres à la classe:
owscontext     - {String} {Obligatoire} URL du contexte de carte OWS à charger
id             - {String}  Identifiant de l'instance.
                           Si fourni à l'initialisation, créée une variable globale de ce nom (si possible)
legendVisible  - {Boolean} Affiche la légende de carte si vaut TRUE.
                           Légende visible par défaut
keymapVisible  - {Boolean} Affiche la carte de situation si vaut TRUE.
                           Carte de situation visible par défaut
defaultControl - {String}  Nom du contrôle de navigation sélectionné par défaut.
                           Le premier contrôle sera utilisé si la valeur est non fourni ou trouvée

loadContext

loadContext : function(owscontext)

Charge une nouvelle carte

@api

Params

{String}URL du contexte de carte OWS à charger.  Recharge entièrement la carte

addControl

addControl : function(control)

Ajoute un controle OpenLayers à la carte (si possible, l’ajoute à la barre d’outil de navigation)

@api

Params

{<OpenLayers.Control>|Array<OpenLayers.Control>}Contrôle(s) à ajouter dans la barre d’outils

getLayerTree

getLayerTree : function()

Retourne la racine de l’arbre des couches

@api

Return

{<Prodige.Tree.Node>}Racine de l’arbre des couches

getLegend

getLegend : function()

Retourne le contrôleur de la légende

@api

Return

{<Prodige.Legend>}Le contrôleur de la légende

getKeymap

getKeymap : function()

Retourne le contrôleur de la carte de situation

@api

Return

{<Prodige.Keymap>}Le contrôleur de la carte de situation
loadContext : function(owscontext)
Charge une nouvelle carte
addControl : function(control)
Ajoute un controle OpenLayers à la carte (si possible, l’ajoute à la barre d’outil de navigation)
getLayerTree : function()
Retourne la racine de l’arbre des couches
getLegend : function()
Retourne le contrôleur de la légende
getKeymap : function()
Retourne le contrôleur de la carte de situation
Close