Last modified by jhurst on 2021/11/18 17:23
Show last authors
1 {{ddtoc/}}
2
3 (% class="wikigeneratedid" id="HFonctionsJavascript28DashboardAPI29" %)
4 Il y a deux façons d'ajouter des comportements customisés dans les tableaux de bords. Le premier est d'utiliser l'éditeur de Javascript global disponible dans l'éditeur de tableaux de bords. Le second est la portlet Editeur de texte. Cet élément permet d'ajouter un bloc de texte (et/ou HTML) à une page de tableau de bord. Les possibilités sont étendues grâce à une interface de programmation (API) permettant d'ajouter des appels Javascript de fonctions de tableau de bord à des hyper-liens dans un éditeur de texte.
5
6 Grâce à ces fonctions, on peut commander un changement de page, un filtrage sur une dimension donnée, changer une variable DigDash, etc.
7
8 Chaque fonction est appelée sur un objet implicite **ddCtrl** défini par le moteur du tableau de bord. Voici la liste des fonctions :
9
10 (% class="box warningmessage" %)
11 (((
12 //Sauf indication contraire, les valeurs de paramètres sont des IDs d'objets, et non les noms formatés et/ou traduits. Pour les autres paramètres qui ne sont pas des IDs, leur type est précisé par une lettre en minuscule préfixant leur nom : 'b' pour booléen, 'o' pour objet, 'l' pour liste (tableau) et 'i' pour entier (integer).//
13
14 //Un paramètre entre crochets [ ] est optionnel et peut-être omis s'il n'est pas nécessaire dans le contexte.//
15 )))
16
17 = Fonctions de variables (DDVariables) =
18
19 **void ddCtrl.{{id name="changeVariable"/}}changeVariable(nom, valeur)**
20
21 Description : Change la valeur de la variable <nom>.
22
23 Exemple :
24
25 (% class="box" %)
26 (((
27 <a href="javascript:__ddCtrl.changeVariable__('ratioEuro', 1.30)">EuroDollar: 1.30</a>
28 )))
29
30
31 **(Nombre) ddCtrl.getDDVar (nom)**
32
33 Description : Retourne le valeur de la variable <nom>.
34
35 Exemple :
36
37 (% class="box" %)
38 (((
39 <a href="javascript:ddCtrl.changeVariable('ratioEuro', __ddCtrl.getDDVar__('ratioEuro') + 0.1)">Augmenter EuroDollar</a>
40 )))
41
42 = Fonctions de filtrage et navigation de données =
43
44 **FilterOperand (dimension, membre, hiérarchie, niveau, membreFormaté, bAjoutFiltre, bExcluFiltre)**
45
46 Description : Objet permettant de spécifier le filtre à appliquer.
47
48 Exemple :
49
50 (% class="box" %)
51 (((
52 <a href="javascript[[:>>path:javascript:ddCtrl.filter('Dim]]ddCtrl.filter('Dim Géo', new FilterOperand('Dim Géo', 'France', 'Géo', 'Pays', false, false))">Filtre France</a>
53 )))
54
55 (% class="box infomessage" %)
56 (((
57 //Note : Le booléen bAjoutFiltre à la valeur true permet d’ajout le filtre au filtre déjà existant sur cette dimension. Le booléen bExcluFiltre à la valeur true permet d’activer le mode exclusion du filtre (au lieu de filtre sur le membre, cela filtre sur tous les autres membres exceptés celui spécifié).//
58 )))
59
60
61 **FilterOperandContinuous (dimension, min, max, bExcluFiltre)**
62
63 Description : Objet permettant de spécifier le filtre de type intervalle à appliquer sur une dimension continue.
64
65 Exemple :
66
67 (% class="box" %)
68 (((
69 <a href="javascript[[:>>path:javascript:ddCtrl.filter('Dim]]ddCtrl.filter('Date', new FilterOperandContinuous('Date', new Date(2018, 0, 1).getTime()/1000, new Date(2019, 0, 1).getTime()/1000, false))">Filtre Année 2018</a>
70 )))
71
72 (% class="box infomessage" %)
73 (((
74 //Note : Le booléen bExcluFiltre à la valeur true permet d’activer le mode exclusion du filtre (au lieu de filtre sur le membre, cela filtre sur tous les autres membres exceptés celui spécifié).//
75 )))
76
77
78 **void ddCtrl.filter (dimension, membre)**
79
80 Description : filtre sur une dimension.
81
82 Exemple :
83
84 (% class="box" %)
85 (((
86 <a href="javascript:__ddCtrl.filter__('Pays', 'France')">Filtre France</a>
87 )))
88
89 (% class="box infomessage" %)
90 (((
91 //Note : Le membre spécifié filtre sur la hiérarchie et le niveau courant pour cette dimension.//
92 )))
93
94
95 **void ddCtrl.filter (oFilterOperand)**
96
97 Description : filtre sur une dimension en spécifiant une hiérarchie et un niveau.
98
99 Exemple :
100
101 (% class="box" %)
102 (((
103 <a href="**javascript:__ddCtrl.filter__(new FilterOperand(**'Lieu', 'FR', 'Géographique', 'Pays'))">Détails France</a>
104 )))
105
106 (% class="box infomessage" %)
107 (((
108 //Note : Lieu// est la dimension, //FR// est l'ID du membre sélectionné, //Géographique// est la hiérarchie et //Pays// est le niveau.
109 )))
110
111
112 **void ddCtrl.filterOnChart (portlet, oFilterOperand, doNotRefresh)**
113
114 Description : filtre un graphique sur une dimension en spécifiant une hiérarchie et un niveau.
115
116 Exemple :
117
118 (% class="box" %)
119 (((
120 <a href="**javascript:__ddCtrl.filterOnChart__(**portletId1, new FilterOperand('Lieu', 'FR', 'Géographique', 'Pays'))">Détails France</a>
121 )))
122
123 (% class="box infomessage" %)
124 (((
125 //Note : portletId1// est l'identifiant du graphique, //Lieu// est la dimension, //FR// est l'ID du membre sélectionné, //Géographique// est la hiérarchie et //Pays// est le niveau.
126 )))
127
128
129 **void ddCtrl.filterAndChangePage (page, dimension, membre)**
130
131 Description : filtre sur une dimension et change de page.
132
133 Exemple :
134
135 (% class="box" %)
136 (((
137 <a href="javascript:__ddCtrl.filterAndChangePage__('Production.Détails Pays', 'Pays', 'France')">Détails France</a>
138 )))
139
140
141 **void ddCtrl.changePageAndFilter (page, dimension, membre)**
142
143 Description : change de page et filtre sur une dimension.
144
145 Exemple :
146
147 (% class="box" %)
148 (((
149 <a href="javascript:__ddCtrl.changePageAndFilter__('Production.Détails Pays', 'Pays', 'France')">Détails France</a>
150 )))
151
152
153 **void ddCtrl.setFilterMinMax (dimension, min, max)**
154
155 Description : filtre sur une dimension continue en spécifiant une valeur min et une valeur max. Note : une date DigDash est un timestamp en secondes.
156
157 Exemple :
158
159 (% class="box" %)
160 (((
161 <a href="javascript:__ddCtrl.setFilterMinMax__('Date', new Date(2014, 0, 1).getTime()/1000, new Date().getTime()/1000">2014 to date</a>
162 )))
163
164
165 **(Tableau de Chaines) ddCtrl.getDimensionFilter (dimension [, bContinue])**
166
167 Description : Renvoie la liste des éléments filtrés sur la dimension (continue ou discrète).
168
169 Exemple :
170
171 (% class="box" %)
172 (((
173 <a href="javascript:alert(__ddCtrl.getDimensionFilter__('Pays'))">Filtres Sur Pays</a>
174 )))
175
176
177 **void ddCtrl.isDimensionFiltered (dimension [, bContinue])**
178
179 Description : Retourne vrai (true) si la dimension (continue ou discrète) est filtrée. Retourne faux (false) dans le cas contraire.
180
181 Exemple :
182
183 (% class="box" %)
184 (((
185 <a href="javascript:alert(__ddCtrl.isDimensionFiltered__('Pays'))">Pays Filtré ?</a>
186 )))
187
188
189 **void ddCtrl.removeAllFilters ()**
190
191 Description : Supprime tous les filtres du tableau de bord.
192
193 Exemple :
194
195 (% class="box" %)
196 (((
197 <a href="javascript:(% class="wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink" %)__ddCtrl.removeAllFilters__(%%)()">Reset</a>
198 )))
199
200
201 **void ddCtrl.removeAllFiltersCurrentPage ()**
202
203 Description : Supprime les filtres de la page courante.
204
205 Exemple :
206
207 (% class="box" %)
208 (((
209 <a href="javascript:(% class="wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink" %)__ddCtrl.removeAllFilters__(%%)__CurrentPage__()">Reset</a>
210 )))
211
212
213 **void ddCtrl.removeFilters (dimension [, bContinue])**
214
215 Description : Supprime les filtres courants sur la dimension (continue ou discrète).
216
217 (% class="box" %)
218 (((
219 Exemple : <a href="javascript:__ddCtrl.removeFilters__('Pays')">Tous les pays</a>
220 )))
221
222
223 **void ddCtrl.beginSelection ()**
224
225 **void ddCtrl.commitSelection ()**
226
227 Description : En conjonction avec la fonction de filtre ddCtrl.filter. Permet de combiner plusieurs filtres sur des dimensions différentes sans exécution à chaque filtre (optimisation).
228
229 Exemple :
230
231 (% class="box" %)
232 (((
233 <a href="javascript:__ddCtrl.beginSelection__(); ddCtrl.filter('Pays', 'France'); ddCtrl.filter('Annee', '2013'); __ddCtrl.commitSelection__()">France en 2013</a>
234 )))
235
236
237 **void ddCtrl.setDimensionNavigation (flux, dimension, bNavigation)**
238
239 Description : Change l'autorisation de naviguer sur une dimension pour le flux spécifié.
240
241 Exemple :
242
243 (% class="box" %)
244 (((
245 <a href="javascript:(% class="wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink" %)__ddCtrl.setDimensionNavigation__(%%)('chart1', 'Région', true)">Activer la navigation sur Région</a>
246 )))
247
248
249 **(Tableau de chaînes) ddCtrl.getCurrentDrill (portlet, dimension[, hiérarchie])**
250
251 Description : Retourne la dimension, la hiérarchie et le niveau exploré d'un graphique sous forme de tableau.
252
253 (% class="box infomessage" %)
254 (((
255 Note : La fonction ne peut-être appelée que sur un graphique ayant une interaction "Naviguer dans la hiérarchie" ou "Changer de dimension".
256 )))
257
258 Exemple :
259
260 {{code language="JAVASCRIPT" cssClass="notranslate"}}
261 ddCtrl.addChartRefreshListener( function(doc, dm, dmsel, chart) {
262  if (chart.title == 'Mon graphique') {
263  var curDrill = ddCtrl.getCurrentDrill(doc.frameId, 'Région', 'Géographique');
264  var dim = curDrill[0];
265  var hier = curDrill[1];
266  var lvl = curDrill[2];
267  alert("L'exploration est " + hier + " / " +lvl + " sur la dimension " + dim);
268  }
269  });
270 {{/code}}
271
272
273 **(BreadPath) ddCtrl.getBreadPath (portlet, dimension)**
274
275 Description : Retourne le chemin de navigation (BreadPath) courant sur une dimension dans un graphique. Cet objet peut être utilisé par drillTo (voir ci-dessous).
276
277 Exemple :
278
279 (% class="box" %)
280 (((
281 <a href="javascript:__ddCtrl.drillTo__(portletId2, 'Lieu', __ddCtrl.getBreadPath__(portletId1, 'Lieu'))">Détails Lieu Courant (Chart 2)</a>
282 )))
283
284
285 **void ddCtrl.drillTo (portlet, dimension, oBreadPath)**
286
287 Description : Navigue dans un graphique sur une hiérarchie de la dimension choisie, en utilisant un chemin de navigation définit par l'objet BreadPath.
288
289 Exemple :
290
291 (% class="box" %)
292 (((
293 Voir exemple ci-dessus (getBreadPath)
294 )))
295
296
297 **void ddCtrl.drillDown (portlet, dimension, hiérarchie, niveau, membre,membreFormaté)**
298
299 Description : Navigue sur une hiérarchie de la dimension choisie vers le membre spécifié au niveau inférieur.
300
301 (% class="box infomessage" %)
302 (((
303 Note : L'action est effectuée sur tous les graphiques partageant la même interaction de navigation ("drill synchronisé").
304 )))
305
306 Exemple :
307
308 (% class="box" %)
309 (((
310 <a href="javascript:__ddCtrl.drillTo__(portletId, 'Lieu', 'Géographique', 'FR', 'France')">Détails France</a>0
311 )))
312
313
314 **void ddCtrl.resetDrill (portlet, dimension[, hiérarchie ])**
315
316 Description : Réinitialise la navigation sur la hiérarchie de la dimension.
317
318 (% class="box infomessage" %)
319 (((
320 Note : L'action est effectuée sur tous les graphiques partageant la même interaction de navigation ("drill synchronisé").
321 )))
322
323 Exemple :
324
325 (% class="box" %)
326 (((
327 <a href="javascript:__ddCtrl.resetDrill__(portletId, 'Lieu')">Retour à la carte du monde</a>
328 )))
329
330
331 **void ddCtrl.selectMeasuresOnChart(portlet, [mesures])**
332
333 Description : Affiche les mesures spécifiées sur le graphique, les autres mesures du graphique seront masquées.
334
335 Exemple :
336
337 (% class="box" %)
338 (((
339 <a href="javascript:__selectMeasuresOnChart__(portletId2, ['CA', 'Marges'])">Afficher CA et Marges</a>
340 )))
341
342
343
344 **(Nombre | Chaîne) ddCtrl.getDataModelDate (dmId, bFormat)**
345
346 Description : Retourne la date de synchronisation d'un cube de données. Les paramètres sont l'identifiant du modèle de données et un booléen pour formater la date (true) ou avoir le timestamp correspondant (false).
347
348 (% class="box infomessage" %)
349 (((
350 Note : Le timestamp est le nombre de millisecondes écoulées depuis le 1er janvier 1970.
351 )))
352
353 Exemple :
354
355 (% class="box" %)
356 (((
357 <a href="javascript:alert(__ddCtrl.getDataModelDate__('a1234567890..', true))">Afficher la date des données</a>
358 )))
359
360
361 **(Nombre | Chaîne) ddCtrl.getDataModelLinesCount (dmId)**
362
363 Description : Retourne le nombre de lignes d'un cube de données. Le paramètre est l'identifiant du modèle de données.
364
365 Exemple :
366
367 (% class="box" %)
368 (((
369 <a href="javascript:alert(__ddCtrl.getDataModelLinesCount__('a1234567890..'))">Afficher le nombre de lignes des données</a>
370 )))
371
372
373
374 **(Nombre | Chaîne) ddCtrl.getFlowDate (flux, bFormat)**
375
376 Description : Retourne la date de synchronisation d'un flux. Les paramètres sont l'identifiant du flux et un booléen pour formater la date (true) ou avoir le timestamp correspondant (false).
377
378 (% class="box infomessage" %)
379 (((
380 Note : Le timestamp est le nombre de millisecondes écoulées depuis le 1er janvier 1970.
381 )))
382
383 Exemple :
384
385 (% class="box" %)
386 (((
387 <a href="javascript:alert(__ddCtrl.getFlowDate__(fluxId, true))">Afficher la date du flux</a>
388 )))
389
390 = Fonctions de requêtage de données =
391
392 **(Nombre | Chaîne) ddCtrl.getResultCubeValue (flux, mesure, lMembres, bFormaté)**
393
394 Description : Retourne la valeur de la mesure pour les membres d'axe spécifiés à partir d'un chart visible. Retourne la valeur comme un nombre ou comme une chaîne formatée.
395
396 Note : La liste des membres d'axe doit préciser //__un et un seul membre pour chaque axe utilisé__// dans le graphique, et ce dans l'ordre naturel des axes du graphique. Le paramètre mesure est l'ID de la mesure.
397
398 Exemple : Pour récupérer une valeur d'un histogramme défini de la manière suivante : Mesure Marge sur l'axe empilement, dimension Année sur l'axe colonne et Pays sur l'axe groupement :
399
400 (% class="box" %)
401 (((
402 <a href="javascript:alert(__ddCtrl.getResultCubeValue__('chart1', 'Marge', ['2013', 'France'], true))">Montrer la marge pour la France en 2013</a>
403 )))
404
405 (% class="box warningmessage" %)
406 (((
407 **Important **: Il est important de s’assurer que le chart est chargé avant d’appeler cette fonction. Le plus simple est d’inclure l’appel de cette fonction dans un écouteur passé à addChartRefreshListener
408 )))
409
410
411 **(Tableau de lignes) ddCtrl.getResultCubeRowSet (flux, oRequêteMembresAxes [, bFormaté])**
412
413 Description : Retourne les lignes aplaties du cube résultat pour les membres d'axes spécifiés à partir d'un chart visible. Retourne le résultat comme un tableau de lignes, chaque ligne étant un tableau des cellules. Les cellules sont les dimensions/axes du chart puis les valeurs des mesures.
414
415 (% class="box infomessage" %)
416 (((
417 Note : La requête des membres d'axe à chercher est un objet Javascript se conformant à la forme suivante (JSON) : {"Axe/Dim titre 1" : "membre 1", "Axe/Dim titre 2" : "membre 2", etc.}..*
418 )))
419
420 Exemple : Pour récupérer les lignes correspondant à l'année 2014 et à la personne 'John' d'un cube résultat d'un chart 'chart1' :
421
422 (% class="box" %)
423 (((
424 <a href="javascript:alert(__ddCtrl.getResultCubeRowSet__('chart1', {'Année' : '2014', 'Personne': 'John'})[0][2])">Montrer la première valeur de John en 2014</a>
425 )))
426
427 (% class="box warningmessage" %)
428 (((
429 **Important**: Il est important de s’assurer que le chart est chargé avant d’appeler cette fonction. Le plus simple est d’inclure l’appel de cette fonction dans un écouteur passé à addChartRefreshListener.
430 )))
431
432
433 **(Nombre) ddCtrl.getResultCubeLinesCount (flux)**
434
435 Description : Retourne le nombre de lignes aplaties du cube résultat.
436
437 Exemple :
438
439 (% class="box" %)
440 (((
441 <a href="javascript:alert((% class="wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink" %)__ddCtrl.getResultCubeLinesCount(__(%%)'chart1')" >Nombre de lignes</a>
442 )))
443
444 = Fonctions du tableau de bord =
445
446 **void ddCtrl.loadJS (urlJS)**
447
448 Description : Charge un fichier Javascript à partir d'une URL.
449
450 Exemple (dans l'éditeur de Javascript) :
451
452 {{code language="javascript" cssClass="notranslate"}}
453 ddCtrl.loadJS('http://crypto-js.googlecode.com/svn/tags/3.1.2/build/rollups/md5.js');
454 var hash = CryptoJS.MD5("Le message");
455 {{/code}}
456
457
458 **void ddCtrl.includeJS (nomJS)**
459
460 Description : Charge un fichier Javascript à partir du dossier de configuration de DigDash Enterprise. Le fichier doit avoir été créé au préalable avec l'éditeur Javascript de l'éditeur de tableaux de bord.
461
462 Exemple (dans l'éditeur de Javascript) :
463
464 {{code language="javascript" cssClass="notranslate"}}
465 ddCtrl.includeJS('fonctions_date.js');
466 {{/code}}
467
468
469 **void ddCtrl.changePage (page)**
470
471 **void ddCtrl.switchPage (page)**
472
473 Description : Change la page courante vers <page>.
474
475 Exemple :
476
477 (% class="box" %)
478 (((
479 <a href="javascript:__ddCtrl.changePage__('Général.Index')">Retour vers l'index</a>
480 )))
481
482
483 **void ddCtrl.nextPage ()**
484
485 Description : Change vers la page suivante (même rôle).
486
487 Exemple :
488
489 (% class="box" %)
490 (((
491 <a href="javascript:__ddCtrl.nextPage__()">Page suivante</a>
492 )))
493
494
495 **void ddCtrl.prevPage ()**
496
497 Description : Change vers la page précédente (même rôle).
498
499 Exemple :
500
501 (% class="box" %)
502 (((
503 <a href="javascript:__ddCtrl.prevPage__()">Page précédente</a>
504 )))
505
506
507 **(Booléen) ddCtrl.isCurrentPage (page)**
508
509 Description : Retourne vrai (true) si la page courante est la page d'identifiant spécifié en paramètre. Retourne faux (false) sinon.
510
511 (% class="box infomessage" %)
512 (((
513 Note : Cette fonction remplace la fonction dépréciée __ddCtrl.getCurrentPage__ ()
514 )))
515
516
517 **(Chaîne) ddCtrl.getCurrentPage ()**
518
519 Description : Retourne le nom de la page courante au format suivant : <//Nom du rôle>.<Nom de la page>//.
520
521 (% class="box warningmessage" %)
522 (((
523 **Dépréciée** : Cette fonction n'est plus supportée depuis Novembre 2014 à cause d'un changement de format du nom des pages. Merci d'utiliser la fonction __ddCtrl.isCurrentPage__ (page) en remplacement.
524 )))
525
526
527 **(Booléen) ddCtrl.isPageLoaded (page)**
528
529 Description : Retourne vrai (true) si la page spécifiée a déjà été chargée. Retourne faux (false) sinon.
530
531
532 **(Objet) ddCtrl.getPage (page)**
533
534 Description : Retourne un objet contenant certaines propriétés (identifiant, nom, titre, liste des objets ...) de la page spécifiée.
535
536
537 **(Tableau) ddCtrl.getPagePath (page)**
538
539 Description : Retourne un tableau contenant le chemin de la page (rôle / groupe de pages / page).
540
541
542 **(Tableau) ddCtrl.dashboardPages**
543
544 Description : Tableau contenant toutes les pages de tous les rôles de l'utilisateur connecté.
545
546
547
548 **(Booléen) canChangeCurrentPage (page)**
549
550 Description : Retourne vrai (true) s'il est possible de changer vers la page <page>. Retourne faux (false) sinon.
551
552
553 **void ddCtrl.hidePage (page)**
554
555 Description : Cache l'onglet de la page <page> s'il est visible, sans changer la page courante.
556
557 Exemple :
558
559 (% class="box" %)
560 (((
561 <a href="javascript:__ddCtrl.hidePage__('Production.Détails Pays'); __ddCtrl.changePage__('Production.Global')">Quitter les détails</a>
562 )))
563
564
565 **void ddCtrl.showPage (page)**
566
567 Description : Affiche l'onglet de la page <page> s'il est caché, sans changer la page courante.
568
569 Exemple :
570
571 (% class="box" %)
572 (((
573 <a href="javascript:__ddCtrl.showPage__('Production.Détails Pays'); __ddCtrl.changePage__('Production.Détails Pays')">Afficher les détails</a>
574 )))
575
576
577 **void ddCtrl.openFlowInWindow (flux, iLargeur, iHauteur)**
578
579 Description : Ouvre un flux dans une fenêtre popup de largeur et hauteur données.
580
581 Exemple :
582
583 (% class="box" %)
584 (((
585 <a href="javascript:__ddCtrl.openFlowInWindow__(fluxId, 250, 200)">Afficher la répartition des produits</a>
586 )))
587
588
589 **void ddCtrl.openPortletInWindow (portlet, iLargeur, iHauteur)**
590
591 Description : Ouvre une portlet dans une fenêtre popup de largeur et hauteur données.
592
593 (% class="box" %)
594 (((
595 Exemple : <a href="javascript:__ddCtrl.openPorletInWindow__(portletId, 250, 200)">Afficher la répartition des produits</a>
596 )))
597
598
599 **void ddCtrl.openFlowInWindowWithFilter (flux, iLargeur, iHauteur, dimension, membre [, dimension, membre, ...])**
600
601 Description : Ouvre un flux dans une fenêtre popup de largeur et hauteur données et le filtre sur la ou les dimensions et membres spécifiés en paramètre (liste de couples dimension / membre).
602
603 (% class="box infomessage" %)
604 (((
605 Note : Les filtres ne seront appliquées que sur la nouvelle fenêtre.
606 )))
607
608 Exemple :
609
610 (% class="box" %)
611 (((
612 <a href="javascript:__ddCtrl.openFlowInWindowWithFilter__(fluxId, 250, 200, 'Année', '2014', 'Pays', 'France')">Afficher les détails France 2014</a>
613 )))
614
615
616 **void ddCtrl.openPortletInWindowWithFilter (portlet, iLargeur, iHauteur, dimension, membre [, dimension, membre, ...])**
617
618 Description : Ouvre une portlet dans une fenêtre popup de largeur et hauteur données et le filtre sur la ou les dimensions et membres spécifiés en paramètre (liste de couples dimension / membre).
619
620 (% class="box infomessage" %)
621 (((
622 Note : Les filtres ne seront appliquées que sur la nouvelle fenêtre.
623 )))
624
625 Exemple :
626
627 (% class="box" %)
628 (((
629 <a href="javascript:__ddCtrl.openPortletInWindowWithFilter__(portletId, 250, 200, 'Année', '2014', 'Pays', 'France')">Afficher les détails France 2014</a>
630 )))
631
632
633 **void ddCtrl.openFlowInElement (div, flux, iLargeur, iHauteur)**
634
635 Description : Ouvre un flux dans un élément DIV existant.
636
637 Exemple :
638
639 (% class="box" %)
640 (((
641 <a href="javascript:__ddCtrl.openFlowInElement__('myDiv', fluxId, 250, 200)">Afficher la répartition des produits</a>
642 )))
643
644
645 **void ddCtrl.openDocument (serverName, fileName)**
646
647 Description: Ouvre un document dans une nouvelle fenêtre.
648
649 Exemple:
650
651 (% class="box" %)
652 (((
653 <a href="javascript:__ddCtrl.openDocument__('Common Datasources', 'catalogue_produits.pdf')">Afficher le catalogue des produits</a>
654 )))
655
656
657 **void ddCtrl.uploadDocument (serverName, fileName)**
658
659 Description: Upload un document vers un serveur de documents. Ouvre une fenêtre de sélection du fichier sur le poste de travail.
660
661 Exemple:
662
663 (% class="box" %)
664 (((
665 <a href="javascript:(% class="wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink" %)__ddCtrl.uploadDocument__(%%)('Common Datasources', 'catalogue_produits.pdf')">Uploader le catalogue des produits</a>
666 )))
667
668
669 **void ddCtrl.refreshDashboard ()**
670
671 Description : Rafraîchit le tableau de bord (même comportement que le bouton Rafraîchir en entête du tableau de bord).
672
673 Exemple :
674
675 (% class="box" %)
676 (((
677 <a href="javascript:__ddCtrl.refreshDashboard__()">Rafraîchir</a>
678 )))
679
680
681 **void ddCtrl.refreshFlow (flow [, événement])**
682
683 Description : Rafraîchit le flux spécifié avec un nom d'événement optionnel.
684
685 Exemple:
686
687 (% class="box" %)
688 (((
689 <a href="javascript:__ddCtrl.refreshFlow__(flowId, null)">Rafraîchir le flux</a>
690 )))
691
692
693 **void ddCtrl.refreshFlows ([événement])**
694
695 Description : Rafraîchit tous les flux du tableau de bord avec un nom d'événement optionnel.
696
697 Exemple:
698
699 (% class="box" %)
700 (((
701 <a href="javascript:__ddCtrl.refreshFlows__('MAJ_QUOTIDIENNE')"> Tout rafraîchir</a>
702 )))
703
704
705 **(Chaîne) ddCtrl.getCurrentRole ()**
706
707 Description : Renvoie l'identifiant du rôle de la page courante ou le nom de l'utilisateur pour une page d'utilisateur.
708
709
710 **(Chaîne) ddCtrl.getRole (page)**
711
712 Description : Renvoie l'identifiant du rôle de la page spécifiée (ex: récupérée précédemment par __ddCtrl.getCurrentPage__()) ou le nom de l'utilisateur si cette page est une page d'utilisateur.
713
714
715 **void ddCtrl.hidePortlet (portlet)**
716
717 **void ddCtrl.showPortlet (portlet)**
718
719 Description : Cache ou montre la portlet du graphique spécifiée. Le paramètre portlet est un identifiant qui peut-être récupéré dans l'éditeur de tableaux de bords, via le menu Information de la portlet.
720
721 Exemple :
722
723 (% class="box" %)
724 (((
725 <a href="javascript:__ddCtrl.showPortlet__(portletId)">Afficher Les Détails</a>
726 )))
727
728
729 **void ddCtrl.setPortletPos (portlet, x, y)**
730
731 **void ddCtrl.setPortletSize (portlet, width, height)**
732
733 Description : Positionne / dimensionne la portlet aux coordonnées / dimensions spécifiées. Le paramètre portlet est un identifiant qui peut-être récupéré dans l'éditeur de tableaux de bords, via le menu Information de la portlet.
734
735 Exemple :
736
737 (% class="box" %)
738 (((
739 <a href="javascript:__ddCtrl.setPortletPos__(portletId, 100, 100); __ddCtrl.setPortletSize__(portletId, 600, 400)">Agrandir Les Détails</a>
740 )))
741
742
743 **void ddCtrl.setPortletMargins (portlet, marginTop, marginRight, marginBottom, marginLeft)**
744
745 Description : Spécifie les marges à ajouter à la portlet. Le paramètre portlet est un identifiant qui peut-être récupéré dans l'éditeur de tableaux de bords, via le menu Information de la portlet.
746
747 Exemple :
748
749 (% class="box" %)
750 (((
751 <a href="javascript:__ddCtrl.setPortletPos__(portletId, 10, 10, 10, 10); __ddCtrl.setPortletMargins__(portletId, 600, 400)">Change les marges</a>
752 )))
753
754
755 **(Booléen) ddCtrl.chartIsHidden (portlet)**
756
757 Description : Retourne vrai (true) lorsque la portlet est cachée (voir hideChart) et faux (false) sinon.
758
759
760 **void ddCtrl.genTemplatePPT (flux)**
761
762 Description : Exécute un flux de type Fabrique De Document PowerPoint(sauvegarde le PPT) d'identifiant flowId avec la sélection courante du tableau de bord. Le téléchargement du PPT généré est proposé à l'utilisateur.
763
764 Exemple :
765
766 (% class="box" %)
767 (((
768 <a href="javascript:__ddCtrl.genTemplatePPT__('Id Fabrique De Document')">Charger le PPT</a>
769 )))
770
771
772 **void ddCtrl.exportCurrentPageAsPPT ()**
773
774 Description : Sauvegarde la page courante du tableau de bord au format PPT. Le téléchargement du PPT généré est proposé à l'utilisateur.
775
776 Exemple :
777
778 (% class="box" %)
779 (((
780 <a href="javascript:__ddCtrl.exportCurrentPageAsPPT__()">Charger cette page au format PPT</a>
781 )))
782
783
784 **void ddCtrl.exportPageAsPPT (role, page)**
785
786 Description : Sauvegarde la page correspondant au rôle et à l’identifiant de la page spécifiés en paramètres. Le téléchargement du PPT généré est proposé à l'utilisateur. L’identifiant de la page peut être récupéré dans l’éditeur de tableau de bord (clic-droit sur un onglet de page).
787
788 Exemple :
789
790 (% class="box" %)
791 (((
792 <a href="javascript:(% class="wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink" %)__ddCtrl.exportPageAsPPT__(%%)('Telecom', 'telecom_ventes_1')">Charger le PPT des ventes telecom</a>
793 )))
794
795
796 **void ddCtrl.genTemplatePDF(flux)**
797
798 Description : Exécute un flux de type Fabrique De Document PDF(sauvegarde le PDF) d'identifiant flowId avec la sélection courante du tableau de bord. Le téléchargement du PDF généré est proposé à l'utilisateur.
799
800 Exemple :
801
802 (% class="box" %)
803 (((
804 <a href="javascript:__ddCtrl.genTemplatePDF__('Id Fabrique De Document')">Charger le PDF</a>
805 )))
806
807
808 **void ddCtrl.exportCurrentPageAsPDF ()**
809
810 Description : Sauvegarde la page courante du tableau de bord au format PDF. Le téléchargement du PDF généré est proposé à l'utilisateur.
811
812 Exemple :
813
814 (% class="box" %)
815 (((
816 <a href="javascript:__ddCtrl.exportCurrentPageAsPDF__()">Charger cette page au format PDF</a>
817 )))
818
819
820 **void ddCtrl.exportPageAsPDF (role, page)**
821
822 Description : Sauvegarde la page correspondant au rôle et à l’identifiant de la page spécifiés en paramètres. Le téléchargement du PDF généré est proposé à l'utilisateur. L’identifiant de la page peut être récupéré dans l’éditeur de tableau de bord (clic-droit sur un onglet de page).
823
824 Exemple :
825
826 (% class="box" %)
827 (((
828 <a href="javascript:(% class="wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink" %)__ddCtrl.exportPageAsP__(%%)__DF__('Telecom', 'telecom_ventes_1')">Charger le PDF des ventes telecom</a>
829 )))
830
831
832 **void ddCtrl.genTemplateXLS (flux)**
833
834 Description : Exécute un flux de type Fabrique De Document Excel (sauvegarde le XLS) d'identifiant flowId avec la sélection courante du tableau de bord. Le téléchargement du XLS généré est proposé à l'utilisateur.
835
836 Exemple :
837
838 (% class="box" %)
839 (((
840 <a href="javascript:__ddCtrl.genTemplateXLS__('Id Fabrique De Document')">Charger le XLS</a>
841 )))
842
843
844 **void ddCtrl.exportAsPDF (flux)**
845
846 Description : Sauvegarde le flux en PDF. Le téléchargement du PDF généré est proposé à l'utilisateur.
847
848
849 **void ddCtrl.exportAsPPT (flux)**
850
851 Description : Sauvegarde le flux en PPT. Le téléchargement du PPT généré est proposé à l'utilisateur.
852
853
854 **void ddCtrl.exportAsXLS (flux)**
855
856 Description : Sauvegarde le flux en XLS. Le téléchargement du XLS généré est proposé à l'utilisateur.
857
858
859 **void ddCtrl.exportAsXLSWithoutStyles (flux)**
860
861 Description : Sauvegarde le flux en XLS sans appliquer les styles des tableaux pour plus de performances. Le téléchargement du XLS généré est proposé à l'utilisateur.
862
863
864 **void ddCtrl.exportAsCSV (flux)**
865
866 Description : Sauvegarde le flux en CSV (Champs Séparés par des Virgules). Le téléchargement du CSV généré est proposé à l'utilisateur.
867
868
869 **void ddCtrl.saveDashboardState (nom, bDéfaut)**
870
871 Description : Sauvegarde l'état courant du tableau de bord (page, filtres, drill, variables). Identique à l'action produite par le bouton de sauvegarde de la sélection dans la barre d'outil du tableau de bord. Le paramètre nom est le nom de la sélection, le paramètre bDéfaut active le chargement de la sélection au démarrage du tableau de bord.
872
873
874 **(Chaîne) ddCtrl.getCurrentPortletInGroupOfTabs (portletTabId)**
875
876 Description : Renvoie l’identifiant de la portlet courante de l’objet Groupe d’onglets. Le paramètre porletTabId est l’identifiant du Groupe d’onglets.
877
878
879 **void ddCtrl.changePortletInGroupOfTabs (portletTabId, portletId)**
880
881 Description : Change la portlet courante de l’objet Groupe d’onglets. Le paramètre porletTabId est l’identifiant du Groupe d’onglets, le paramètre portletId est l’identifiant de la portlet à sélectionnner.
882
883
884 **(Tableau) ddCtrl.getCurrentPagePath ()**
885
886 Description : Renvoie le chemin de la page courante (Rôle / Page / Sous-Page) sous forme de tableau d’objets. Chaque objet possède les attributs suivants : id, title, name, type (role/container/page).
887
888 == Gestion d’événements ==
889
890 Ces fonctions d'écouteurs sont appelées par le système quand des événements spécifiques sont déclenchés. Vous pouvez donc créer de nouveaux comportements en fonction de situations: un graphique est rafraîchi ou dessiné, une page est changée, une dimension est filtrée, etc. Le meilleur endroit pour implémenter ces comportements est dans l'éditeur de Javascript global accessible dans le menu des options de l'éditeur de tableaux de bords.
891
892 == (% id="cke_bm_227S" style="display:none" %) (%%)Diagramme des événements du Tableau de bord ==
893
894 [[image:api_event_diagram.gif||queryString="width=641&height=802"]]
895
896 **void ddCtrl.addChartBeforeRefreshListener (Fonction)**
897
898 Description : Ajoute une fonction d'écoute de l'événement déclenché avant le rafraîchissement du graphique.
899
900 Exemple :
901
902 (% class="box" %)
903 (((
904 ddCtrl.addChartBeforeRefreshListener(function(doc, dm, dmsel, chart, errorMsg) { alert("Le graphique " + chart.title + " va être rafraîchi"); });
905 )))
906
907
908 **void ddCtrl.addChartRefreshListener (Fonction)**
909
910 Description : Ajoute une fonction d'écoute de l'événement déclenché après le rafraîchissement du graphique.
911
912 Exemple :
913
914 (% class="box" %)
915 (((
916 ddCtrl.addChartRefreshListener(function(doc, dm, dmsel, chart, errorMsg) { alert("Le graphique " + chart.title + " a été rafraîchi"); });
917 )))
918
919
920 **void ddCtrl.addChartDrawnListener (Fonction)**
921
922 Description : Ajoute une fonction d'écoute de l'événement déclenché lorsque le graphique a fini d'être dessiné (premier affichage).
923
924 Exemple :
925
926 (% class="box" %)
927 (((
928 ddCtrl.addChartDrawnListener(function(doc, dm, dmsel, chart, errorMsg) { alert("Le graphique " + chart.title + " a été dessiné"); });
929 )))
930
931
932 **void ddCtrl.addChartModelReadyListener (Fonction)**
933
934 Description : Ajoute une fonction d'écoute de l'événement déclenché avant le dessin du graphique (premier affichage).
935
936 Exemple :
937
938 (% class="box" %)
939 (((
940 ddCtrl.addChartModelReadyListener(function(doc, dm, dmsel, chart, errorMsg) { alert("Le graphique " + chart.title + " va être dessiné"); });
941 )))
942
943
944 **void ddCtrl.addDimensionFilterListener (Fonction)**
945
946 Description : Ajoute une fonction d'écoute de l'événement déclenché après filtrage d'une dimension.
947
948 Exemple :
949
950 (% class="box" %)
951 (((
952 ddCtrl.addDimensionFilterListener(function(dimension, hierarchy, niveau, members, membersFormated, bExclude, min, max) { alert("La dimension " + dimension + " a été filtrée sur " + membersFormated); });
953 )))
954
955
956 **void ddCtrl.addVariableChangeListener (Fonction)**
957
958 Description : Ajoute une fonction d'écoute de l'événement déclenché après changement d'une variable.
959
960 Exemple :
961
962 (% class="box" %)
963 (((
964 ddCtrl.addVariableChangeListener(function(variable, valeur) { alert("La variable " + variable + " a changé, nouvelle valeur : " + valeur); });
965 )))
966
967 == Gestion d’événements du Tableau De Bord ==
968
969
970
971 **void ddCtrl.addDashboardLoadListener (Fonction)**
972
973 Description : Ajoute une fonction d'écoute de l'événement déclenché une fois le de tableau de bord chargé mais pas encore dessiné.
974
975 Exemple :
976
977 (% class="box" %)
978 (((
979 ddCtrl.addDashboardLoadListener(function(currentPage) { alert("Initialisation du tableau de bord"); });
980 )))
981
982
983
984 **void ddCtrl.addCurrentPageLoadListener (Fonction)**
985
986 Description : Ajoute une fonction d'écoute de l'événement déclenché une fois la page de tableau de bord complètement chargée.
987
988 Exemple :
989
990 (% class="box" %)
991 (((
992 ddCtrl.addCurrentPageLoadListener(function(currentPage) { alert("La page " + currentPage + " a été chargée"); });
993 )))
994
995
996 **void ddCtrl.addCurrentPageChangeListener (Fonction)**
997
998 Description : Ajoute une fonction d'écoute de l'événement déclenché lors d'un changement de page.
999
1000 Exemple :
1001
1002 (% class="box" %)
1003 (((
1004 ddCtrl.addCurrentPageChangeListener(function(currentPage, bFirstTime) { alert("La page est maintenant " + currentPage); });
1005 )))
1006
1007
1008 **void ddCtrl.addUserLoggedListener (Fonction)**
1009
1010 Description : événement déclenché une fois l'utilisateur authentifié. Peut être utile lors de l'utilisation de la fonction ddCtrl.getUserAttribute.
1011
1012 Exemple :
1013
1014 (% class="box" %)
1015 (((
1016 ddCtrl.addUserLoggedListener(function() { alert("Vous êtes authentifié"); });
1017 )))
1018
1019
1020 **void ddCtrl.addPortletHiddenListener (Fonction)**
1021
1022 Description : événement déclenché lorsque le statut de l’objet est passé de visible à caché.
1023
1024 Exemple :
1025
1026 (% class="box" %)
1027 (((
1028 ddCtrl.addPortletHiddenListener(function(portletId) { alert("L’objet est caché"); });
1029 )))
1030
1031
1032 **void ddCtrl.addPortletVisibleListener (Fonction)**
1033
1034 Description : événement déclenché lorsque le statut de l’objet est passé de caché à visible.
1035
1036 Exemple :
1037
1038 (% class="box" %)
1039 (((
1040 ddCtrl.addPortletVisibleListener(function(portletId) { alert("L’objet est visible"); });
1041 )))
1042
1043
1044 **void ddCtrl.addPortletCollapseListener (Fonction)**
1045
1046 Description : événement déclenché lorsque l’utilisateur clique sur l’icône permettant de masquer un élément rétractable.
1047
1048 Exemple :
1049
1050 (% class="box" %)
1051 (((
1052 ddCtrl.addPortletCollapseListener(function(portletId) { alert("L’objet va être cacher"); });
1053 )))
1054
1055
1056 **void ddCtrl.addPortletCollapsedListener (Fonction)**
1057
1058 Description : événement déclenché une fois l’élément rétractable caché.
1059
1060 Exemple :
1061
1062 (% class="box" %)
1063 (((
1064 ddCtrl.addPortletCollapsedListener(function(portletId) { alert("L’objet est caché"); });
1065 )))
1066
1067
1068 **void ddCtrl.addPortletExpandListener (Fonction)**
1069
1070 Description : événement déclenché lorsque l’utilisateur clique sur l’icône permettant d’afficher un élément rétractable.
1071
1072 Exemple :
1073
1074 (% class="box" %)
1075 (((
1076 ddCtrl.addPortletExpandListener(function(portletId) { alert("L’objet va être afficher"); });
1077 )))
1078
1079
1080 **void ddCtrl.addPortletExpandedListener (Fonction)**
1081
1082 Description : événement déclenché une fois l’élément rétractable affiché.
1083
1084 Exemple :
1085
1086 (% class="box" %)
1087 (((
1088 ddCtrl.addPortletExpandedListener(function(portletId) { alert("L’objet est affiché"); });
1089 )))
1090
1091
1092 **void ddCtrl.addGroupOfTabsChangeListener (Fonction)**
1093
1094 Description : événement déclenché lorsque l’utilisateur change de graphique dans un groupe d’onglets. Le premier paramètre est l’identifant de l’objet groupe d’onglets, le deuxième est l’identifiant de la portlet courante.
1095
1096 Exemple :
1097
1098 (% class="box" %)
1099 (((
1100 ddCtrl.addGroupOfTabsChangeListener(function(portletTabId, curPortletId) { alert("La portlet courante est : " + curPortletId); });
1101 )))
1102
1103
1104 **void ddCtrl.addDocumentUploadListener (Fonction)**
1105
1106 Description : événement déclenché lorsque l’utilisateur ajoute un fichier via le tableau de bord.
1107
1108 Exemple :
1109
1110 (% class="box" %)
1111 (((
1112 ddCtrl.addDocumentUploadListener(function(serverName, filesName) { alert("Le fichier " + filesName[0] + " a bien été ajouté"); });
1113 )))
1114
1115 = Fonctions diverses =
1116
1117 **(Tableau de chaînes) ddCtrl.getUserRoles ()**
1118
1119 Description : Retourne la liste des identifiants des rôles de l'utilisateur connecté.
1120
1121
1122 **(Tableau associatif de chaînes / booléens) ddCtrl.getUserACLs ()**
1123
1124 Description : Retourne la liste des identifiants des droits (ACL) de l'utilisateur connecté. La liste retournée est un tableau associant l'Id de l'acl avec un booléen (true) sir l'ACL est alloué à l'utilisateur.
1125
1126 Exemple :
1127
1128 (% class="box" %)
1129 (((
1130 if (ddCtrl.getUserACLs()['SaveAsPPT']) alert('Vous pouvez sauvegarder en PPT');
1131 )))
1132
1133 Liste de tous les droits possibles :
1134
1135 AccessContentManagement, AccessDBE, AccessDBV, AccessLicenseSettings, AccessServerSettings, AccessUserSettings, AddFlow, AddRoleFlow, ChartNavigation, EditDashboardForGroup, EditDataSourceForGroup, EditDataSource, LoadWalletForGroup, RefreshFlow, RefreshRoleFlow, RefreshDatasource, SaveWalletForGroup, SaveAsPDF, SaveAsPPT, SaveAsXLS, SaveAsCSV, Scheduler, SendSMS, UploadDocument, UpdateDocument, ViewComments, AddCommentDataModel, RemoveCommentDataModel, AddCommentFlow, RemoveCommentFlow, AllowIgnoreDMResivion, DashboardCustomization, EditProtectedDashboardPages
1136
1137
1138 **(Chaîne) ddCtrl.getUserAttribute (attr)**
1139
1140 Description : Retourne l'attribut LDAP <attr> de l'utilisateur.
1141
1142
1143 **(Chaîne) ddCtrl.getUserAttribute (attr, Fonction)**
1144
1145 Description : Retourne l'attribut LDAP <attr> de l'utilisateur via une fonction asynchrone d'appel.
1146
1147 Exemple :
1148
1149 (% class="box" %)
1150 (((
1151 ddCtrl.getUserAttribute('displayName', function (attrVal) {alert(attrVal)});
1152 )))
1153
1154
1155 **(Chaîne) ddCtrl.getSessionAttribute (attr)**
1156
1157 Description : Retourne l'attribut <attr> de la session utilisateur.
1158
1159 Voir le [[Tutoriel Variables de session>>doc:Digdash.user_guide.tutorials.session_variables_tutorial.WebHome]] pour plus d’information sur les variables de session.
1160
1161
1162 **(Chaîne) ddCtrl.getSessionAttribute (attr, Fonction)**
1163
1164 Description : Retourne l'attribut <attr> de la session utilisateur via une fonction asynchrone d'appel.
1165
1166 Exemple :
1167
1168 (% class="box" %)
1169 (((
1170 ddCtrl.getSessionAttribute('regionChoisie', function (attrVal) {alert(attrVal)});
1171 )))
1172
1173 Voir le [[Tutoriel Variables de session>>doc:Digdash.user_guide.tutorials.session_variables_tutorial.WebHome]] pour plus d’information sur les variables de session.
1174
1175
1176 **void ddCtrl.setSessionAttribute (attr, valeur)**
1177
1178 Description : Met à jour l’attribut <attr> de la session utilisateur avec la valeur spécifiée.
1179
1180 Exemple :
1181
1182 (% class="box" %)
1183 (((
1184 ddCtrl.setSessionAttribute('regionChoisie', ‘France’);
1185 )))
1186
1187 Voir le [[Tutoriel Variables de session>>doc:Digdash.user_guide.tutorials.session_variables_tutorial.WebHome]] pour plus d’information sur les variables de session.
1188
1189
1190 **(Chaîne) ddCtrl.getServerAttribute (attr)**
1191
1192 Description : Retourne l'attribut <attr> du serveur. Les attributs (ou variables) de serveur permettent de spécifier des constantes utilisées dans les modèles de données et les flux via le mot-clé ${server.<attr>}.
1193
1194 Voir le document de [[Réglages avancés des paramètres système>>doc:Digdash.deployment.configuration.advanced_system_guide.WebHome]] pour plus d’information sur les variables de serveur.
1195
1196
1197 **(Chaîne) ddCtrl.getServerAttribute (attr, Fonction)**
1198
1199 Description : Retourne l'attribut <attr> du serveur via une fonction asynchrone d'appel.
1200
1201 Exemple :
1202
1203 (% class="box" %)
1204 (((
1205 ddCtrl.getSessionAttribute('serverMode', function (attrVal) {alert(attrVal)});
1206 )))
1207
1208 Voir le document de [[Réglages avancés des paramètres système>>doc:Digdash.deployment.configuration.advanced_system_guide.WebHome]] pour plus d’information sur les variables de serveur.
1209
1210
1211 **(Chaîne) ddCtrl.getUserStorage (attr)**
1212
1213 Description : Retourne l'attribut <attr> de l'utilisateur spécifié sauvegardé précédemment.
1214
1215 Exemple :
1216
1217 (% class="box" %)
1218 (((
1219 var valeur = ddCtrl.getUserStorage('attribut');
1220 )))
1221
1222 **void ddCtrl.setUserStorage (attr, valeur)**
1223
1224 Description : Sauvegarde l'attribut <attr> de l'utilisateur de manière persistante sur le serveur pour une prochaine utilisation.
1225
1226 Exemple :
1227
1228 (% class="box" %)
1229 (((
1230 ddCtrl.setUserStorage('attribut', 'valeur');
1231 )))
1232
1233
1234 **void ddCtrl.fireRefreshEvent (événement)**
1235
1236 Description : Déclenche côté serveur le rafraîchissement des données ayant l'événement spécifié
1237
1238 Exemple :
1239
1240 (% class="box" %)
1241 (((
1242 ddCtrl.fireRefreshEvent('MAJ_QUOTIDIENNE');
1243 )))
1244
1245
1246 **void ddCtrl.newAuthToken ()**
1247
1248 Description : Renvoi un token d'authentification généré par rapport à la session courante.
1249
1250 Exemple :
1251
1252 (% class="box" %)
1253 (((
1254 var token = ddCtrl.newAuthToken();
1255
1256 window.open(http:~/~/localhost:8080/digdash_dashboard/index.html?user=mon_user&authToken=token
1257 )))
1258
1259
1260
1261 **void loadCSS (cssFile)**
1262
1263 Description : Charge un fichier CSS.
1264
1265
1266 **void ddCtrl.loadTheme (cssTheme)**
1267
1268 Description : Charge un thème CSS DigDash sur le tableau de bord.
1269
1270 Exemple :
1271
1272 (% class="box" %)
1273 (((
1274 ddCtrl.loadTheme(‘digdash’);
1275 )))
1276
1277 **void ddCtrl.removeTheme (cssTheme)**
1278
1279 Description : Supprime le thème CSS DigDash sur le tableau de bord.
1280
1281 Exemple :
1282
1283 (% class="box" %)
1284 (((
1285 ddCtrl.removeTheme(‘digdash’);
1286 )))
1287
1288
1289
1290 **void logout ()**
1291
1292 Description : Déconnecte l'utilisateur courant.