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