Last modified by jhurst on 2021/04/21 10:01
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.setFilterMinMax (dimension, min, max)**
142
143 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.
144
145 Exemple :
146
147 (% class="box" %)
148 (((
149 <a href="javascript:__ddCtrl.setFilterMinMax__('Date', new Date(2014, 0, 1).getTime()/1000, new Date().getTime()/1000">2014 to date</a>
150 )))
151
152
153 **(Tableau de Chaines) ddCtrl.getDimensionFilter (dimension [, bContinue])**
154
155 Description : Renvoie la liste des éléments filtrés sur la dimension (continue ou discrète).
156
157 Exemple :
158
159 (% class="box" %)
160 (((
161 <a href="javascript:alert(__ddCtrl.getDimensionFilter__('Pays'))">Filtres Sur Pays</a>
162 )))
163
164
165 **void ddCtrl.isDimensionFiltered (dimension [, bContinue])**
166
167 Description : Retourne vrai (true) si la dimension (continue ou discrète) est filtrée. Retourne faux (false) dans le cas contraire.
168
169 Exemple :
170
171 (% class="box" %)
172 (((
173 <a href="javascript:alert(__ddCtrl.isDimensionFiltered__('Pays'))">Pays Filtré ?</a>
174 )))
175
176
177 **void ddCtrl.removeAllFilters ()**
178
179 Description : Supprime tous les filtres du tableau de bord.
180
181 Exemple :
182
183 (% class="box" %)
184 (((
185 <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>
186 )))
187
188
189 **void ddCtrl.removeAllFiltersCurrentPage ()**
190
191 Description : Supprime les filtres de la page courante.
192
193 Exemple :
194
195 (% class="box" %)
196 (((
197 <a href="javascript:(% class="wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink" %)__ddCtrl.removeAllFilters__(%%)__CurrentPage__()">Reset</a>
198 )))
199
200
201 **void ddCtrl.removeFilters (dimension [, bContinue])**
202
203 Description : Supprime les filtres courants sur la dimension (continue ou discrète).
204
205 (% class="box" %)
206 (((
207 Exemple : <a href="javascript:__ddCtrl.removeFilters__('Pays')">Tous les pays</a>
208 )))
209
210
211 **void ddCtrl.beginSelection ()**
212
213 **void ddCtrl.commitSelection ()**
214
215 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).
216
217 Exemple :
218
219 (% class="box" %)
220 (((
221 <a href="javascript:__ddCtrl.beginSelection__(); ddCtrl.filter('Pays', 'France'); ddCtrl.filter('Annee', '2013'); __ddCtrl.commitSelection__()">France en 2013</a>
222 )))
223
224
225 **void ddCtrl.setDimensionNavigation (flux, dimension, bNavigation)**
226
227 Description : Change l'autorisation de naviguer sur une dimension pour le flux spécifié.
228
229 Exemple :
230
231 (% class="box" %)
232 (((
233 <a href="javascript:(% class="wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink" %)__ddCtrl.setDimensionNavigation__(%%)('chart1', 'Région', true)">Activer la navigation sur Région</a>
234 )))
235
236
237 **(Tableau de chaînes) ddCtrl.getCurrentDrill (portlet, dimension[, hiérarchie])**
238
239 Description : Retourne la dimension, la hiérarchie et le niveau exploré d'un graphique sous forme de tableau.
240
241 (% class="box infomessage" %)
242 (((
243 Note : La fonction ne peut-être appelée que sur un graphique ayant une interaction "Naviguer dans la hiérarchie" ou "Changer de dimension".
244 )))
245
246 Exemple :
247
248 {{code language="JAVASCRIPT"}}
249 ddCtrl.addChartRefreshListener( function(doc, dm, dmsel, chart) {
250  if (chart.title == 'Mon graphique') {
251  var curDrill = ddCtrl.getCurrentDrill(doc.frameId, 'Région', 'Géographique');
252  var dim = curDrill[0];
253  var hier = curDrill[1];
254  var lvl = curDrill[2];
255  alert("L'exploration est " + hier + " / " +lvl + " sur la dimension " + dim);
256  }
257  });
258 {{/code}}
259
260
261 **(BreadPath) ddCtrl.getBreadPath (portlet, dimension)**
262
263 Description : Retourne le chemin de navigation (BreadPath) courant sur une dimension dans un graphique. Cet objet peut être utilisé par drillTo (voir ci-dessous).
264
265 Exemple :
266
267 (% class="box" %)
268 (((
269 <a href="javascript:__ddCtrl.drillTo__(portletId2, 'Lieu', __ddCtrl.getBreadPath__(portletId1, 'Lieu'))">Détails Lieu Courant (Chart 2)</a>
270 )))
271
272
273 **void ddCtrl.drillTo (portlet, dimension, oBreadPath)**
274
275 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.
276
277 Exemple :
278
279 (% class="box" %)
280 (((
281 Voir exemple ci-dessus (getBreadPath)
282 )))
283
284
285 **void ddCtrl.drillDown (portlet, dimension, hiérarchie, niveau, membre,membreFormaté)**
286
287 Description : Navigue sur une hiérarchie de la dimension choisie vers le membre spécifié au niveau inférieur.
288
289 (% class="box infomessage" %)
290 (((
291 Note : L'action est effectuée sur tous les graphiques partageant la même interaction de navigation ("drill synchronisé").
292 )))
293
294 Exemple :
295
296 (% class="box" %)
297 (((
298 <a href="javascript:__ddCtrl.drillTo__(portletId, 'Lieu', 'Géographique', 'FR', 'France')">Détails France</a>0
299 )))
300
301
302 **void ddCtrl.resetDrill (portlet, dimension[, hiérarchie ])**
303
304 Description : Réinitialise la navigation sur la hiérarchie de la dimension.
305
306 (% class="box infomessage" %)
307 (((
308 Note : L'action est effectuée sur tous les graphiques partageant la même interaction de navigation ("drill synchronisé").
309 )))
310
311 Exemple :
312
313 (% class="box" %)
314 (((
315 <a href="javascript:__ddCtrl.resetDrill__(portletId, 'Lieu')">Retour à la carte du monde</a>
316 )))
317
318
319 **void ddCtrl.selectMeasuresOnChart(portlet, [mesures])**
320
321 Description : Affiche les mesures spécifiées sur le graphique, les autres mesures du graphique seront masquées.
322
323 Exemple :
324
325 (% class="box" %)
326 (((
327 <a href="javascript:__selectMeasuresOnChart__(portletId2, ['CA', 'Marges'])">Afficher CA et Marges</a>
328 )))
329
330
331
332 **(Nombre | Chaîne) ddCtrl.getDataModelDate (dmId, bFormat)**
333
334 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).
335
336 (% class="box infomessage" %)
337 (((
338 Note : Le timestamp est le nombre de millisecondes écoulées depuis le 1er janvier 1970.
339 )))
340
341 Exemple :
342
343 (% class="box" %)
344 (((
345 <a href="javascript:alert(__ddCtrl.getDataModelDate__('a1234567890..', true))">Afficher la date des données</a>
346 )))
347
348
349 **(Nombre | Chaîne) ddCtrl.getFlowDate (flux, bFormat)**
350
351 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).
352
353 (% class="box infomessage" %)
354 (((
355 Note : Le timestamp est le nombre de millisecondes écoulées depuis le 1er janvier 1970.
356 )))
357
358 Exemple :
359
360 (% class="box" %)
361 (((
362 <a href="javascript:alert(__ddCtrl.getFlowDate__(fluxId, true))">Afficher la date du flux</a>
363 )))
364
365 = Fonctions de requêtage de données =
366
367 **(Nombre | Chaîne) ddCtrl.getResultCubeValue (flux, mesure, lMembres, bFormaté)**
368
369 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.
370
371 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.
372
373 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 :
374
375 (% class="box" %)
376 (((
377 <a href="javascript:alert(__ddCtrl.getResultCubeValue__('chart1', 'Marge', ['2013', 'France'], true))">Montrer la marge pour la France en 2013</a>
378 )))
379
380 (% class="box warningmessage" %)
381 (((
382 **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
383 )))
384
385
386 **(Tableau de lignes) ddCtrl.getResultCubeRowSet (flux, oRequêteMembresAxes [, bFormaté])**
387
388 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.
389
390 (% class="box infomessage" %)
391 (((
392 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.}..*
393 )))
394
395 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' :
396
397 (% class="box" %)
398 (((
399 <a href="javascript:alert(__ddCtrl.getResultCubeRowSet__('chart1', {'Année' : '2014', 'Personne': 'John'})[0][2])">Montrer la première valeur de John en 2014</a>
400 )))
401
402 (% class="box warningmessage" %)
403 (((
404 **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.
405 )))
406
407
408 **(Nombre) ddCtrl.getResultCubeLinesCount (flux)**
409
410 Description : Retourne le nombre de lignes aplaties du cube résultat.
411
412 Exemple :
413
414 (% class="box" %)
415 (((
416 <a href="javascript:alert((% class="wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink" %)__ddCtrl.getResultCubeLinesCount(__(%%)'chart1')" >Nombre de lignes</a>
417 )))
418
419 = Fonctions du tableau de bord =
420
421 **void ddCtrl.loadJS (urlJS)**
422
423 Description : Charge un fichier Javascript à partir d'une URL.
424
425 Exemple (dans l'éditeur de Javascript) :
426
427 {{code language="javascript"}}
428 ddCtrl.loadJS('http://crypto-js.googlecode.com/svn/tags/3.1.2/build/rollups/md5.js');
429 var hash = CryptoJS.MD5("Le message");
430 {{/code}}
431
432
433 **void ddCtrl.includeJS (nomJS)**
434
435 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.
436
437 Exemple (dans l'éditeur de Javascript) :
438
439 {{code language="javascript"}}
440 ddCtrl.includeJS('fonctions_date.js');
441 {{/code}}
442
443
444 **void ddCtrl.changePage (page)**
445
446 **void ddCtrl.switchPage (page)**
447
448 Description : Change la page courante vers <page>.
449
450 Exemple :
451
452 (% class="box" %)
453 (((
454 <a href="javascript:__ddCtrl.changePage__('Général.Index')">Retour vers l'index</a>
455 )))
456
457
458 **void ddCtrl.nextPage ()**
459
460 Description : Change vers la page suivante (même rôle).
461
462 Exemple :
463
464 (% class="box" %)
465 (((
466 <a href="javascript:__ddCtrl.nextPage__()">Page suivante</a>
467 )))
468
469
470 **void ddCtrl.prevPage ()**
471
472 Description : Change vers la page précédente (même rôle).
473
474 Exemple :
475
476 (% class="box" %)
477 (((
478 <a href="javascript:__ddCtrl.prevPage__()">Page précédente</a>
479 )))
480
481
482 **(Booléen) ddCtrl.isCurrentPage (page)**
483
484 Description : Retourne vrai (true) si la page courante est la page d'identifiant spécifié en paramètre. Retourne faux (false) sinon.
485
486 (% class="box infomessage" %)
487 (((
488 Note : Cette fonction remplace la fonction dépréciée __ddCtrl.getCurrentPage__ ()
489 )))
490
491
492 **(Chaîne) ddCtrl.getCurrentPage ()**
493
494 Description : Retourne le nom de la page courante au format suivant : <//Nom du rôle>.<Nom de la page>//.
495
496 (% class="box warningmessage" %)
497 (((
498 **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.
499 )))
500
501
502 **(Booléen) ddCtrl.isPageLoaded (page)**
503
504 Description : Retourne vrai (true) si la page spécifiée a déjà été chargée. Retourne faux (false) sinon.
505
506
507 **(Objet) ddCtrl.getPage (page)**
508
509 Description : Retourne un objet contenant certaines propriétés (identifiant, nom, titre, liste des objets ...) de la page spécifiée.
510
511
512 **(Tableau) ddCtrl.getPagePath (page)**
513
514 Description : Retourne un tableau contenant le chemin de la page (rôle / groupe de pages / page).
515
516
517 **(Tableau) ddCtrl.dashboardPages**
518
519 Description : Tableau contenant toutes les pages de tous les rôles de l'utilisateur connecté.
520
521
522
523 **(Booléen) canChangeCurrentPage (page)**
524
525 Description : Retourne vrai (true) s'il est possible de changer vers la page <page>. Retourne faux (false) sinon.
526
527
528 **void ddCtrl.hidePage (page)**
529
530 Description : Cache l'onglet de la page <page> s'il est visible, sans changer la page courante.
531
532 Exemple :
533
534 (% class="box" %)
535 (((
536 <a href="javascript:__ddCtrl.hidePage__('Production.Détails Pays'); __ddCtrl.changePage__('Production.Global')">Quitter les détails</a>
537 )))
538
539
540 **void ddCtrl.showPage (page)**
541
542 Description : Affiche l'onglet de la page <page> s'il est caché, sans changer la page courante.
543
544 Exemple :
545
546 (% class="box" %)
547 (((
548 <a href="javascript:__ddCtrl.showPage__('Production.Détails Pays'); __ddCtrl.changePage__('Production.Détails Pays')">Afficher les détails</a>
549 )))
550
551
552 **void ddCtrl.openFlowInWindow (flux, iLargeur, iHauteur)**
553
554 Description : Ouvre un flux dans une fenêtre popup de largeur et hauteur données.
555
556 Exemple :
557
558 (% class="box" %)
559 (((
560 <a href="javascript:__ddCtrl.openFlowInWindow__(fluxId, 250, 200)">Afficher la répartition des produits</a>
561 )))
562
563
564 **void ddCtrl.openPortletInWindow (portlet, iLargeur, iHauteur)**
565
566 Description : Ouvre une portlet dans une fenêtre popup de largeur et hauteur données.
567
568 (% class="box" %)
569 (((
570 Exemple : <a href="javascript:__ddCtrl.openPorletInWindow__(portletId, 250, 200)">Afficher la répartition des produits</a>
571 )))
572
573
574 **void ddCtrl.openFlowInWindowWithFilter (flux, iLargeur, iHauteur, dimension, membre [, dimension, membre, ...])**
575
576 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).
577
578 (% class="box infomessage" %)
579 (((
580 Note : Les filtres ne seront appliquées que sur la nouvelle fenêtre.
581 )))
582
583 Exemple :
584
585 (% class="box" %)
586 (((
587 <a href="javascript:__ddCtrl.openFlowInWindowWithFilter__(fluxId, 250, 200, 'Année', '2014', 'Pays', 'France')">Afficher les détails France 2014</a>
588 )))
589
590
591 **void ddCtrl.openPortletInWindowWithFilter (portlet, iLargeur, iHauteur, dimension, membre [, dimension, membre, ...])**
592
593 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).
594
595 (% class="box infomessage" %)
596 (((
597 Note : Les filtres ne seront appliquées que sur la nouvelle fenêtre.
598 )))
599
600 Exemple :
601
602 (% class="box" %)
603 (((
604 <a href="javascript:__ddCtrl.openPortletInWindowWithFilter__(portletId, 250, 200, 'Année', '2014', 'Pays', 'France')">Afficher les détails France 2014</a>
605 )))
606
607
608 **void ddCtrl.openFlowInElement (div, flux, iLargeur, iHauteur)**
609
610 Description : Ouvre un flux dans un élément DIV existant.
611
612 Exemple :
613
614 (% class="box" %)
615 (((
616 <a href="javascript:__ddCtrl.openFlowInElement__('myDiv', fluxId, 250, 200)">Afficher la répartition des produits</a>
617 )))
618
619
620 **void ddCtrl.openDocument (serverName, fileName)**
621
622 Description: Ouvre un document dans une nouvelle fenêtre.
623
624 Exemple:
625
626 (% class="box" %)
627 (((
628 <a href="javascript:__ddCtrl.openDocument__('Common Datasources', 'catalogue_produits.pdf')">Afficher le catalogue des produits</a>
629 )))
630
631
632 **void ddCtrl.uploadDocument (serverName, fileName)**
633
634 Description: Upload un document vers un serveur de documents. Ouvre une fenêtre de sélection du fichier sur le poste de travail.
635
636 Exemple:
637
638 (% class="box" %)
639 (((
640 <a href="javascript:(% class="wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink" %)__ddCtrl.uploadDocument__(%%)('Common Datasources', 'catalogue_produits.pdf')">Uploader le catalogue des produits</a>
641 )))
642
643
644 **void ddCtrl.refreshDashboard ()**
645
646 Description : Rafraîchit le tableau de bord (même comportement que le bouton Rafraîchir en entête du tableau de bord).
647
648 Exemple :
649
650 (% class="box" %)
651 (((
652 <a href="javascript:__ddCtrl.refreshDashboard__()">Rafraîchir</a>
653 )))
654
655
656 **void ddCtrl.refreshFlow (flow [, événement])**
657
658 Description : Rafraîchit le flux spécifié avec un nom d'événement optionnel.
659
660 Exemple:
661
662 (% class="box" %)
663 (((
664 <a href="javascript:__ddCtrl.refreshFlow__(flowId, null)">Rafraîchir le flux</a>
665 )))
666
667
668 **void ddCtrl.refreshFlows ([événement])**
669
670 Description : Rafraîchit tous les flux du tableau de bord avec un nom d'événement optionnel.
671
672 Exemple:
673
674 (% class="box" %)
675 (((
676 <a href="javascript:__ddCtrl.refreshFlows__('MAJ_QUOTIDIENNE')"> Tout rafraîchir</a>
677 )))
678
679
680 **(Chaîne) ddCtrl.getCurrentRole ()**
681
682 Description : Renvoie l'identifiant du rôle de la page courante ou le nom de l'utilisateur pour une page d'utilisateur.
683
684
685 **(Chaîne) ddCtrl.getRole (page)**
686
687 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.
688
689
690 **void ddCtrl.hidePortlet (portlet)**
691
692 **void ddCtrl.showPortlet (portlet)**
693
694 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.
695
696 Exemple :
697
698 (% class="box" %)
699 (((
700 <a href="javascript:__ddCtrl.showPortlet__(portletId)">Afficher Les Détails</a>
701 )))
702
703
704 **void ddCtrl.setPortletPos (portlet, x, y)**
705
706 **void ddCtrl.setPortletSize (portlet, width, height)**
707
708 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.
709
710 Exemple :
711
712 (% class="box" %)
713 (((
714 <a href="javascript:__ddCtrl.setPortletPos__(portletId, 100, 100); __ddCtrl.setPortletSize__(portletId, 600, 400)">Agrandir Les Détails</a>
715 )))
716
717
718 **void ddCtrl.setPortletMargins (portlet, marginTop, marginRight, marginBottom, marginLeft)**
719
720 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.
721
722 Exemple :
723
724 (% class="box" %)
725 (((
726 <a href="javascript:__ddCtrl.setPortletPos__(portletId, 10, 10, 10, 10); __ddCtrl.setPortletMargins__(portletId, 600, 400)">Change les marges</a>
727 )))
728
729
730 **(Booléen) ddCtrl.chartIsHidden (portlet)**
731
732 Description : Retourne vrai (true) lorsque la portlet est cachée (voir hideChart) et faux (false) sinon.
733
734
735 **void ddCtrl.genTemplatePPT (flux)**
736
737 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.
738
739 Exemple :
740
741 (% class="box" %)
742 (((
743 <a href="javascript:__ddCtrl.genTemplatePPT__('Id Fabrique De Document')">Charger le PPT</a>
744 )))
745
746
747 **void ddCtrl.exportCurrentPageAsPPT ()**
748
749 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.
750
751 Exemple :
752
753 (% class="box" %)
754 (((
755 <a href="javascript:__ddCtrl.exportCurrentPageAsPPT__()">Charger cette page au format PPT</a>
756 )))
757
758
759 **void ddCtrl.exportPageAsPPT (role, page)**
760
761 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).
762
763 Exemple :
764
765 (% class="box" %)
766 (((
767 <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>
768 )))
769
770
771 **void ddCtrl.genTemplatePDF(flux)**
772
773 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.
774
775 Exemple :
776
777 (% class="box" %)
778 (((
779 <a href="javascript:__ddCtrl.genTemplatePDF__('Id Fabrique De Document')">Charger le PDF</a>
780 )))
781
782
783 **void ddCtrl.exportCurrentPageAsPDF ()**
784
785 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.
786
787 Exemple :
788
789 (% class="box" %)
790 (((
791 <a href="javascript:__ddCtrl.exportCurrentPageAsPDF__()">Charger cette page au format PDF</a>
792 )))
793
794
795 **void ddCtrl.exportPageAsPDF (role, page)**
796
797 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).
798
799 Exemple :
800
801 (% class="box" %)
802 (((
803 <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>
804 )))
805
806
807 **void ddCtrl.genTemplateXLS (flux)**
808
809 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.
810
811 Exemple :
812
813 (% class="box" %)
814 (((
815 <a href="javascript:__ddCtrl.genTemplateXLS__('Id Fabrique De Document')">Charger le XLS</a>
816 )))
817
818
819 **void ddCtrl.exportAsPDF (flux)**
820
821 Description : Sauvegarde le flux en PDF. Le téléchargement du PDF généré est proposé à l'utilisateur.
822
823
824 **void ddCtrl.exportAsPPT (flux)**
825
826 Description : Sauvegarde le flux en PPT. Le téléchargement du PPT généré est proposé à l'utilisateur.
827
828
829 **void ddCtrl.exportAsXLS (flux)**
830
831 Description : Sauvegarde le flux en XLS. Le téléchargement du XLS généré est proposé à l'utilisateur.
832
833
834 **void ddCtrl.exportAsXLSWithoutStyles (flux)**
835
836 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.
837
838
839 **void ddCtrl.exportAsCSV (flux)**
840
841 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.
842
843
844 **void ddCtrl.saveDashboardState (nom, bDéfaut)**
845
846 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.
847
848
849 **(Chaîne) ddCtrl.getCurrentPortletInGroupOfTabs (portletTabId)**
850
851 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.
852
853
854 **void ddCtrl.changePortletInGroupOfTabs (portletTabId, portletId)**
855
856 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.
857
858
859 **(Tableau) ddCtrl.getCurrentPagePath ()**
860
861 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).
862
863 == Gestion d’événements ==
864
865 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.
866
867 == (% id="cke_bm_227S" style="display:none" %) (%%)Diagramme des événements du Tableau de bord ==
868
869 [[image:api_event_diagram.gif||queryString="width=641&height=802"]]
870
871 **void ddCtrl.addChartBeforeRefreshListener (Fonction)**
872
873 Description : Ajoute une fonction d'écoute de l'événement déclenché avant le rafraîchissement du graphique.
874
875 Exemple :
876
877 (% class="box" %)
878 (((
879 ddCtrl.addChartBeforeRefreshListener(function(doc, dm, dmsel, chart, errorMsg) { alert("Le graphique " + chart.title + " va être rafraîchi"); });
880 )))
881
882
883 **void ddCtrl.addChartRefreshListener (Fonction)**
884
885 Description : Ajoute une fonction d'écoute de l'événement déclenché après le rafraîchissement du graphique.
886
887 Exemple :
888
889 (% class="box" %)
890 (((
891 ddCtrl.addChartRefreshListener(function(doc, dm, dmsel, chart, errorMsg) { alert("Le graphique " + chart.title + " a été rafraîchi"); });
892 )))
893
894
895 **void ddCtrl.addChartDrawnListener (Fonction)**
896
897 Description : Ajoute une fonction d'écoute de l'événement déclenché lorsque le graphique a fini d'être dessiné (premier affichage).
898
899 Exemple :
900
901 (% class="box" %)
902 (((
903 ddCtrl.addChartDrawnListener(function(doc, dm, dmsel, chart, errorMsg) { alert("Le graphique " + chart.title + " a été dessiné"); });
904 )))
905
906
907 **void ddCtrl.addChartModelReadyListener (Fonction)**
908
909 Description : Ajoute une fonction d'écoute de l'événement déclenché avant le dessin du graphique (premier affichage).
910
911 Exemple :
912
913 (% class="box" %)
914 (((
915 ddCtrl.addChartModelReadyListener(function(doc, dm, dmsel, chart, errorMsg) { alert("Le graphique " + chart.title + " va être dessiné"); });
916 )))
917
918
919 **void ddCtrl.addDimensionFilterListener (Fonction)**
920
921 Description : Ajoute une fonction d'écoute de l'événement déclenché après filtrage d'une dimension.
922
923 Exemple :
924
925 (% class="box" %)
926 (((
927 ddCtrl.addDimensionFilterListener(function(dimension, hierarchy, niveau, members, membersFormated, bExclude, min, max) { alert("La dimension " + dimension + " a été filtrée sur " + membersFormated); });
928 )))
929
930
931 **void ddCtrl.addVariableChangeListener (Fonction)**
932
933 Description : Ajoute une fonction d'écoute de l'événement déclenché après changement d'une variable.
934
935 Exemple :
936
937 (% class="box" %)
938 (((
939 ddCtrl.addVariableChangeListener(function(variable, valeur) { alert("La variable " + variable + " a changé, nouvelle valeur : " + valeur); });
940 )))
941
942 == Gestion d’événements du Tableau De Bord ==
943
944
945
946 **void ddCtrl.addDashboardLoadListener (Fonction)**
947
948 Description : Ajoute une fonction d'écoute de l'événement déclenché une fois le de tableau de bord chargé mais pas encore dessiné.
949
950 Exemple :
951
952 (% class="box" %)
953 (((
954 ddCtrl.addDashboardLoadListener(function(currentPage) { alert("Initialisation du tableau de bord"); });
955 )))
956
957
958
959 **void ddCtrl.addCurrentPageLoadListener (Fonction)**
960
961 Description : Ajoute une fonction d'écoute de l'événement déclenché une fois la page de tableau de bord complètement chargée.
962
963 Exemple :
964
965 (% class="box" %)
966 (((
967 ddCtrl.addCurrentPageLoadListener(function(currentPage) { alert("La page " + currentPage + " a été chargée"); });
968 )))
969
970
971 **void ddCtrl.addCurrentPageChangeListener (Fonction)**
972
973 Description : Ajoute une fonction d'écoute de l'événement déclenché lors d'un changement de page.
974
975 Exemple :
976
977 (% class="box" %)
978 (((
979 ddCtrl.addCurrentPageChangeListener(function(currentPage, bFirstTime) { alert("La page est maintenant " + currentPage); });
980 )))
981
982
983 **void ddCtrl.addUserLoggedListener (Fonction)**
984
985 Description : événement déclenché une fois l'utilisateur authentifié. Peut être utile lors de l'utilisation de la fonction ddCtrl.getUserAttribute.
986
987 Exemple :
988
989 (% class="box" %)
990 (((
991 ddCtrl.addUserLoggedListener(function() { alert("Vous êtes authentifié"); });
992 )))
993
994
995 **void ddCtrl.addPortletHiddenListener (Fonction)**
996
997 Description : événement déclenché lorsque le statut de l’objet est passé de visible à caché.
998
999 Exemple :
1000
1001 (% class="box" %)
1002 (((
1003 ddCtrl.addPortletHiddenListener(function(portletId) { alert("L’objet est caché"); });
1004 )))
1005
1006
1007 **void ddCtrl.addPortletVisibleListener (Fonction)**
1008
1009 Description : événement déclenché lorsque le statut de l’objet est passé de caché à visible.
1010
1011 Exemple :
1012
1013 (% class="box" %)
1014 (((
1015 ddCtrl.addPortletVisibleListener(function(portletId) { alert("L’objet est visible"); });
1016 )))
1017
1018
1019 **void ddCtrl.addPortletCollapseListener (Fonction)**
1020
1021 Description : événement déclenché lorsque l’utilisateur clique sur l’icône permettant de masquer un élément rétractable.
1022
1023 Exemple :
1024
1025 (% class="box" %)
1026 (((
1027 ddCtrl.addPortletCollapseListener(function(portletId) { alert("L’objet va être cacher"); });
1028 )))
1029
1030
1031 **void ddCtrl.addPortletCollapsedListener (Fonction)**
1032
1033 Description : événement déclenché une fois l’élément rétractable caché.
1034
1035 Exemple :
1036
1037 (% class="box" %)
1038 (((
1039 ddCtrl.addPortletCollapsedListener(function(portletId) { alert("L’objet est caché"); });
1040 )))
1041
1042
1043 **void ddCtrl.addPortletExpandListener (Fonction)**
1044
1045 Description : événement déclenché lorsque l’utilisateur clique sur l’icône permettant d’afficher un élément rétractable.
1046
1047 Exemple :
1048
1049 (% class="box" %)
1050 (((
1051 ddCtrl.addPortletExpandListener(function(portletId) { alert("L’objet va être afficher"); });
1052 )))
1053
1054
1055 **void ddCtrl.addPortletExpandedListener (Fonction)**
1056
1057 Description : événement déclenché une fois l’élément rétractable affiché.
1058
1059 Exemple :
1060
1061 (% class="box" %)
1062 (((
1063 ddCtrl.addPortletExpandedListener(function(portletId) { alert("L’objet est affiché"); });
1064 )))
1065
1066
1067 **void ddCtrl.addGroupOfTabsChangeListener (Fonction)**
1068
1069 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.
1070
1071 Exemple :
1072
1073 (% class="box" %)
1074 (((
1075 ddCtrl.addGroupOfTabsChangeListener(function(portletTabId, curPortletId) { alert("La portlet courante est : " + curPortletId); });
1076 )))
1077
1078
1079 **void ddCtrl.addDocumentUploadListener (Fonction)**
1080
1081 Description : événement déclenché lorsque l’utilisateur ajoute un fichier via le tableau de bord.
1082
1083 Exemple :
1084
1085 (% class="box" %)
1086 (((
1087 ddCtrl.addDocumentUploadListener(function(serverName, filesName) { alert("Le fichier " + filesName[0] + " a bien été ajouté"); });
1088 )))
1089
1090 = Fonctions diverses =
1091
1092 **(Tableau de chaînes) ddCtrl.getUserRoles ()**
1093
1094 Description : Retourne la liste des identifiants des rôles de l'utilisateur connecté.
1095
1096
1097 **(Tableau associatif de chaînes / booléens) ddCtrl.getUserACLs ()**
1098
1099 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.
1100
1101 Exemple :
1102
1103 (% class="box" %)
1104 (((
1105 if (ddCtrl.getUserACLs()['SaveAsPPT']) alert('Vous pouvez sauvegarder en PPT');
1106 )))
1107
1108 Liste de tous les droits possibles :
1109
1110 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
1111
1112
1113 **(Chaîne) ddCtrl.getUserAttribute (attr)**
1114
1115 Description : Retourne l'attribut LDAP <attr> de l'utilisateur.
1116
1117
1118 **(Chaîne) ddCtrl.getUserAttribute (attr, Fonction)**
1119
1120 Description : Retourne l'attribut LDAP <attr> de l'utilisateur via une fonction asynchrone d'appel.
1121
1122 Exemple :
1123
1124 (% class="box" %)
1125 (((
1126 ddCtrl.getUserAttribute('displayName', function (attrVal) {alert(attrVal)});
1127 )))
1128
1129
1130 **(Chaîne) ddCtrl.getSessionAttribute (attr)**
1131
1132 Description : Retourne l'attribut <attr> de la session utilisateur.
1133
1134 Voir le [[Tutoriel Variables de session>>doc:Digdash.user_guide.tutorials.session_variables_tutorial.WebHome]] pour plus d’information sur les variables de session.
1135
1136
1137 **(Chaîne) ddCtrl.getSessionAttribute (attr, Fonction)**
1138
1139 Description : Retourne l'attribut <attr> de la session utilisateur via une fonction asynchrone d'appel.
1140
1141 Exemple :
1142
1143 (% class="box" %)
1144 (((
1145 ddCtrl.getSessionAttribute('regionChoisie', function (attrVal) {alert(attrVal)});
1146 )))
1147
1148 Voir le [[Tutoriel Variables de session>>doc:Digdash.user_guide.tutorials.session_variables_tutorial.WebHome]] pour plus d’information sur les variables de session.
1149
1150
1151 **void ddCtrl.setSessionAttribute (attr, valeur)**
1152
1153 Description : Met à jour l’attribut <attr> de la session utilisateur avec la valeur spécifiée.
1154
1155 Exemple :
1156
1157 (% class="box" %)
1158 (((
1159 ddCtrl.setSessionAttribute('regionChoisie', ‘France’);
1160 )))
1161
1162 Voir le [[Tutoriel Variables de session>>doc:Digdash.user_guide.tutorials.session_variables_tutorial.WebHome]] pour plus d’information sur les variables de session.
1163
1164
1165 **(Chaîne) ddCtrl.getServerAttribute (attr)**
1166
1167 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>}.
1168
1169 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.
1170
1171
1172 **(Chaîne) ddCtrl.getServerAttribute (attr, Fonction)**
1173
1174 Description : Retourne l'attribut <attr> du serveur via une fonction asynchrone d'appel.
1175
1176 Exemple :
1177
1178 (% class="box" %)
1179 (((
1180 ddCtrl.getSessionAttribute('serverMode', function (attrVal) {alert(attrVal)});
1181 )))
1182
1183 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.
1184
1185
1186 **(Chaîne) ddCtrl.getUserStorage (attr)**
1187
1188 Description : Retourne l'attribut <attr> de l'utilisateur spécifié sauvegardé précédemment.
1189
1190 Exemple :
1191
1192 (% class="box" %)
1193 (((
1194 var valeur = ddCtrl.getUserStorage('attribut');
1195 )))
1196
1197 **void ddCtrl.setUserStorage (attr, valeur)**
1198
1199 Description : Sauvegarde l'attribut <attr> de l'utilisateur de manière persistante sur le serveur pour une prochaine utilisation.
1200
1201 Exemple :
1202
1203 (% class="box" %)
1204 (((
1205 ddCtrl.setUserStorage('attribut', 'valeur');
1206 )))
1207
1208
1209 **void ddCtrl.fireRefreshEvent (événement)**
1210
1211 Description : Déclenche côté serveur le rafraîchissement des données ayant l'événement spécifié
1212
1213 Exemple :
1214
1215 (% class="box" %)
1216 (((
1217 ddCtrl.fireRefreshEvent('MAJ_QUOTIDIENNE');
1218 )))
1219
1220
1221 **void loadCSS (cssFile)**
1222
1223 Description : Charge un fichier CSS.
1224
1225
1226 **void ddCtrl.loadTheme (cssTheme)**
1227
1228 Description : Charge un thème CSS DigDash sur le tableau de bord.
1229
1230 Exemple :
1231
1232 (% class="box" %)
1233 (((
1234 ddCtrl.loadTheme(‘digdash’);
1235 )))
1236
1237 **void ddCtrl.removeTheme (cssTheme)**
1238
1239 Description : Supprime le thème CSS DigDash sur le tableau de bord.
1240
1241 Exemple :
1242
1243 (% class="box" %)
1244 (((
1245 ddCtrl.removeTheme(‘digdash’);
1246 )))
1247
1248
1249
1250 **void logout ()**
1251
1252 Description : Déconnecte l'utilisateur courant.