Wiki source code of Dashboard API

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