Class: spw.api.SpwViewer

▲

Description

Le Viewer. Il s'agit de la classe de base de l'API. Cette classe permet d'obtenir un singleton, une instance unique du viewer. Il s'agit en quelque sorte du "point d'entrée" de l'application.

new SpwViewer()

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

Héritage

  • dijit._WidgetBase

Overview

MembresMéthodes

Membres

bodyClass :string

Classe CSS appliquée à l'élement body de la page html instanciant le viewer
Type:
  • string
Default Value:
  • claro
Source:

bottomRegion

Description de la région bas du viewer
Propriétés:
Nom Type Description
height string hauteur de la zone.
resizable Boolean indique si la zone est redimensionnable par l'utilisateur.
minimizable Boolean indique si la zone peut être réduite.
minimized Boolean indique si la zone est initialement réduite.
Source:

copyRightText

Texte de copyright général du viewer
Source:

dock

Le dock dans lequel les widgets peuvent être minimisés sans pour autant être désactivés.
Source:

dockPosition

La position du dock
Propriétés:
Nom Type Description
top string distance par rapport au sommet.
bottom string distance par rapport au bas.
left string distance par rapport à la gauche.
right string distance par rapport à la droite.
opacity number l'opacité du dock entre 0 et 1.
Source:

fullExtent

Extent maximum de la carte
Source:

fullExtentLabel

Nom donné au fullExtent
Source:

geometryService :esri.tasks.GeometryService

Référence vers le service de géométrie Esri.
Type:
  • esri.tasks.GeometryService
Source:

geometryServiceUrl

Url du service de géométrie
Source:

initialExtent

Extent initial de la carte au démarrage du viewer
Source:

layoutDesign

Permet de définir le type de layout du viewer : 'sidebar' ou 'headline'. Voir dijit/layout/BorderContainer de Dojo pour le détail.
Source:

leftRegion

Description de la région gauche du viewer
Propriétés:
Nom Type Description
width string largeur de la zone.
resizable Boolean indique si la zone est redimensionnable par l'utilisateur.
minimizable Boolean indique si la zone peut être réduite.
minimized Boolean indique si la zone est initialement réduite.
Source:

loadingVerbosity

Indique le niveau de verbosité du chargement : 0, 1, 2
Source:

lods

Permet de forcer les lods disponibles dans le Viewer
Source:

mainBottom :dijit/layout/BorderContainer

Référence vers la région principale "bas" du viewer
Type:
  • dijit/layout/BorderContainer
Source:

mainLeft :dijit/layout/BorderContainer

Référence vers la région principale "gauche" du viewer
Type:
  • dijit/layout/BorderContainer
Source:

mainRight :dijit/layout/BorderContainer

Référence vers la région principale "droite" du viewer
Type:
  • dijit/layout/BorderContainer
Source:

mainTop :dijit/layout/BorderContainer

Référence vers la région principale "dessus" du viewer
Type:
  • dijit/layout/BorderContainer
Source:

mapLoaderPosition

Position du load sur la carte.
Propriétés:
Nom Type Description
top string distance par rapport au sommet.
bottom string distance par rapport au bas.
left string distance par rapport à la gauche.
right string distance par rapport à la droite.
Source:

maxScale

Echelle maximum du viewer
Source:

minScale

Echelle minimum du viewer
Source:

notificationPosition

Position pour l'affichage des messages de notification
Source:

placementNode :string

Id de l'élément dom où placer les différents composants périphériques du viewer (panel, messages, ...).
Type:
  • string
Source:

proxyPageUrl

Url de la page proxy à utiliser par le viewer
Source:

reactiveToolbar

Définit si la toolbar est réactive : opacité partielle et opacité complète lorsque le curseur passe au dessus.
Source:

rightRegion

Description de la région droite du viewer
Propriétés:
Nom Type Description
width string largeur de la zone.
resizable Boolean indique si la zone est redimensionnable par l'utilisateur.
minimizable Boolean indique si la zone peut être réduite.
minimized Boolean indique si la zone est initialement réduite.
Source:

secureServerUrl :string

L'url du serveur de sécurisation des services Esri.
Type:
  • string
Source:

shareable

Indique si l'url doit se synchroniser dans le cadre du share
Source:

shareServlet :String

URL de la ShareServlet à utiliser dans l'API.
Type:
  • String
Source:

sideScreenContext

Définit le contexte utilisée dans la deuxième fenêtre (par défaut, le contexte courant sera utilisé)
Source:

spatialReference

Référence spatiale de la carte
Source:

spwMap :spw.api.SpwMap

Référence vers la carte
Type:
Source:

spwWidgetsManager :spw.api.SpwWidgetManager

Référence vers le SpwWidgetManager.
Type:
  • spw.api.SpwWidgetManager
Source:

toolbar :spw.api.SpwBaseToolBar

Référence vers la toolbar.
Type:
Source:

toolbarPosition

Définit la position de la toolbar sur la carte
Propriétés:
Nom Type Description
top string distance par rapport au sommet.
bottom string distance par rapport au bas.
left string distance par rapport à la gauche.
right string distance par rapport à la droite.
Source:

topRegion

Description de la région haut du viewer
Propriétés:
Nom Type Description
height string hauteur de la zone.
resizable Boolean indique si la zone est redimensionnable par l'utilisateur.
minimizable Boolean indique si la zone peut être réduite.
minimized Boolean indique si la zone est initialement réduite.
Source:

viewerLoaded :Boolean

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

Méthodes

getInstance()

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

_prepareLayout()

Parcourt la configuration des widgets et pré-initialise les régions possibles dans le viewer.
Source:

addResizer(regionAP)

Ajout un resizer (bouton permettant de changer à la volée la taille de la région) à la région
Paramètres:
Nom Type Description
regionAP la région à laquelle il faut ajouter le resizer
Source:

addTabToTabContainer(tabContainer, widget, forceSelect)

Ajoute un widget dans une région contenant déjà plusieurs widgets.
Paramètres:
Nom Type Description
tabContainer dijit.layout.TabContainer le tabContainer de la région
widget spw.api.SpwBaseWidget le widget à ajouter
forceSelect Boolean indique si l'onglet du widget doit être sélectionné.
Source:

addToSidePanel()

Affiche un widget dans un panel latéral (version mobile)
Source:

addWidgetInToolbar(widget)

Ajoute un widget dans la toolbar.
Paramètres:
Nom Type Description
widget
Source:

addWidgetOnMap(widget)

Ajoute un widget sur la carte.
Paramètres:
Nom Type Description
widget
Source:

buildRendering()

Au rendering, prépare le layout général du viewer.
Source:

centerExtentForVisibleZone(extent)

Adapte le cadrage de la map pour le mobile
Paramètres:
Nom Type Description
extent l'extent sur lequel centrer la map
Source:

centerInVisibleZone()

Place un point au centre de la zone visible de la carte et recentre la carte
Source:

centerPointForVisibleZone(pt, pt)

Crée un point sur base d'un x et d'un y en l'adaptant à l'écran du téléphone
Paramètres:
Nom Type Description
pt la coordonnée X du point
pt la coordonnée Y du point
Source:
Retourne:
le point adapté

checkCorsStatus(cfg)

Vérifie la configuration CORS du viewer
Paramètres:
Nom Type Description
cfg la configuration CORS du viewer
Source:

createMinimizeRegionButton(region, container, direction, inverseDirection)

Crée les boutons permettant à l'utilisateur de minimiser les régions principales du viewer.
Paramètres:
Nom Type Description
region Object l'objet configuration correspondant à une région.
container dijit.layout.borderContainer le widget content la région.
direction String direction soit : left, right, bottom ou top.
inverseDirection String la direction inverse.
Source:

createTabContainer(regionAP, widget, child, forceSelect, place)

Crée un TabContainer dans une région qui contiendra plus d'un widget.
Paramètres:
Nom Type Description
regionAP dijit.layout.BorderContainer Référence vers la région principale du viewer.
widget spw.api.SpwBaseWidget le widget à placer
child spw.api.SpwBaseWidget le widget déjà existant dans la région.
forceSelect Boolean
place String la "sous-région", soit top, bottom, left ou right.
Source:

destroy()

Appelé à la destruction du SpwViewer
Source:

disableCors(cfg)

Désactive le CORS
Paramètres:
Nom Type Description
cfg la configuration CORS du viewer
Source:

doubleScreen()

Active le mode double écran
Source:

getRegion(region) → {dijit.layout.BorderContainer}

Récupère la référence vers une région principale du viewer sur base de son code (left, right, top, bottom).
Paramètres:
Nom Type Description
region code région
Source:
Retourne:
Type
dijit.layout.BorderContainer

getTabContainerInRegion(region) → {dijit.layout.TabContainer}

Récupère le TabContainer dans une région du viewer.
Paramètres:
Nom Type Description
region la région principale du viewer.
Source:
Retourne:
TabContainer
Type
dijit.layout.TabContainer

getTabWidgetInRegion(region, place) → {spw.api.SpwBaseWidget}

Récupère la référence vers le widget d'une région qui va contenir d'autres widgets.
Paramètres:
Nom Type Description
region dijit.layout.TabContainer la région principale du viewer.
place String la "sous-région", soit top, bottom, left ou right.
Source:
Retourne:
widget
Type
spw.api.SpwBaseWidget

hasSideWindow()

Détermine si le viewer possède une seconde fenêtre (si le mode double écran est actif)
Source:

hideWidget(widget)

Retire un widget de sa région (sans le détruire).
Paramètres:
Nom Type Description
widget le widget à retirer.
Source:

isSideWindow()

Détermine si la fenêtre actuelle est la seconde fenêtre du viewer ou la fenêtre principale
Source:

makeSureRegionIsCollapsed(region)

S'assure que la région dans laquelle un widget va être affiché est bien visible (afin d'éviter des bugs d'affichage).
Paramètres:
Nom Type Description
region string le nom de la région à vérifier
Source:

onSideWindowClose()

Appelé lorsque le deuxième écran du mode double écran est fermé
Source:

onWidgetsCreated()

Méthode appellée lorsque tous les widgets de l'application ont été instanciés
Source:

placeWidgetInRegion(widget, regionAP, place)

Place un widget dans une région
Paramètres:
Nom Type Description
widget spw.api.SpwBaseWidget le widget à placer
regionAP dijit.layout.TabContainer
place String la "sous-région", soit top, bottom, left ou right.
Source:

postMixInProperties()

Lorsque le propriétés ont été "mixées" au Viewer, surcharge l'extent avec celui définit dans l'url, initialise le GeometryService et la page proxy si renseignée.
Source:

projectFromMap(dest, x, y)

Permet de projeter un point de la même référence spatiale que la carte vers une autre référence spatiale.
Paramètres:
Nom Type Description
dest référence spatiale dans laquelle projeter
x coordonnée X du point
y coordonnée Y du point
Source:

projectToMap(from, x, y)

Permet de projeter un point dans la projection actuelle de la carte.
Paramètres:
Nom Type Description
from référence spatiale du point
x coordonnée X du point
y coordonnée Y du point
Source:

regionCollapserClicked(region, container, direction, inverseDirection)

Méthode appelée lorsque le collapser d'une région est cliqué (petit flèche permettant de déployer / retracter la région)
Paramètres:
Nom Type Description
region la configuration de la région
container le container html de la région
direction string la direction de la région
inverseDirection stirng la direction inverse de la direction de la région
Source:

removeMobileWidget(widget)

Méthode appelée pour masquer un widget en mobile
Paramètres:
Nom Type Description
widget le widget à masquer
Source:

removeWidgetFromToolbar(widget)

Retire un widget de la toolbar.
Paramètres:
Nom Type Description
widget
Source:

repositionWidgets(reset)

Repositionne les widgets une fois le mode double écran activé / désactivé
Paramètres:
Nom Type Description
reset string détermine s'il faut positionner les widgets sur 1 écran ou sur les 2
Source:

resize()

Redimensionne la carte
Source:

showMobileWidget(widget)

Méthode appelée pour afficher un widget en mobile
Paramètres:
Nom Type Description
widget le widget à afficher
Source:

showWidget(widget, region, place, forceSelect)

Affiche un widget dans le viewer
Paramètres:
Nom Type Description
widget spw.api.SpwBaseWidget le widget à afficher
region String le code région dans laquelle placer le widget
place String la "sous-région", soit top, bottom, left ou right.
forceSelect Boolean indique si le widget doit être sélectionné si plusieurs widgets sont dans la région.
Source:

sideViewerLoaded(viewer)

Appelé lorsque le viewer de la seconde fenêtre est chargé
Paramètres:
Nom Type Description
viewer l'instance de SpwViewer
Source:

startup()

Démarre le viewer. Lorsque la structure du viewer est en place, initialise la carte (chargement des services de cartes) et le widgetManager (instanciation des widgets).
Source:

trackEvent(category, action, label, value)

Permet d'enregistrer un évènement dans Google Analytics.
Paramètres:
Nom Type Description
category String catégorie de l'évènement
action String axction d'évènement
label String libellé pour l'action
value String valeur de l'action
Source:

Evènements

viewerLoaded

Le Viewer est complètement chargé et prêt à être affiché.
Source: