Wiki source code of Dashboard API

Last modified by Aurelie Bertrand on 2025/05/15 14:19
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 **(Tableau de lignes) ddCtrl.getResultCubeRowSet (flux, oRequêteMembresAxes [, bFormaté])**
466
467 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.
468
469 (% class="box infomessage" %)
470 (((
471 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.}..*
472 )))
473
474 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' :
475
476 (% class="box" %)
477 (((
478 <a href="javascript:alert(__ddCtrl.getResultCubeRowSet__('chart1', {'Année' : '2014', 'Personne': 'John'})[0][2])">Montrer la première valeur de John en 2014</a>
479 )))
480
481 (% class="box warningmessage" %)
482 (((
483 **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.
484 )))
485
486
487 **(Nombre) ddCtrl.getResultCubeLinesCount (flux)**
488
489 Description : Retourne le nombre de lignes aplaties du cube résultat.
490
491 Exemple :
492
493 (% class="box" %)
494 (((
495 <a href="javascript:alert((% class="wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink" %)__ddCtrl.getResultCubeLinesCount(__(%%)'chart1')" >Nombre de lignes</a>
496 )))
497
498
499 (% class="wikigeneratedid" %)
500 **ddCtrl.getLastDimensionDate('id du modèle de données', 'Dimension temps')**
501
502 (% class="wikigeneratedid" %)
503 Description : Retourne la date maximale d'une dimension temps sous forme d'un timestamp.
504
505 (% class="wikigeneratedid" %)
506 Exemple :
507
508 (% class="box" %)
509 (((
510 <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>
511 )))
512
513
514 **ddCtrl.getCubeValue ("id du modèle de données", [filtres], 'nom de la dimension ou mesure', bUseContext)**
515
516 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).
517 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.
518
519 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 :
520
521 (% class="box" %)
522 (((
523 <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>
524 )))
525
526
527 **ddCtrl.getCubeValue ("id du flux", [filtres], 'nom de la dimension ou mesure', bUseContext)**
528
529 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).
530 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.
531
532 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 :
533
534 (% class="box" %)
535 (((
536 <a href="javascript:alert(ddCtrl.getFlowValue("b312f6be", [{"dim":"Matériel", "member":"Samsung Galaxy"}], 'Type de ligne', false)>Membre Type de ligne</a>
537 )))
538
539 = Fonctions du tableau de bord{{id name="Fonction_TDB"/}} =
540
541 (% class="box infomessage" %)
542 (((
543 ℹ Pour les fonctions impliquant un export PDF, l'ajout d'un rapport HTML ou de mises en formes avancées est susceptible de poser des problèmes de rendu.
544 )))
545
546 **void ddCtrl.loadJS (urlJS)**
547
548 Description : Charge un fichier Javascript à partir d'une URL.
549
550 Exemple (dans l'éditeur de Javascript) :
551
552 {{code language="javascript" cssClass="notranslate"}}
553 ddCtrl.loadJS('http://crypto-js.googlecode.com/svn/tags/3.1.2/build/rollups/md5.js');
554 var hash = CryptoJS.MD5("Le message");
555 {{/code}}
556
557
558 **void ddCtrl.includeJS (nomJS)**
559
560 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.
561
562 Exemple (dans l'éditeur de Javascript) :
563
564 {{code language="javascript" cssClass="notranslate"}}
565 ddCtrl.includeJS('fonctions_date.js');
566 {{/code}}
567
568 **void ddCtrl.drawFlowInElement ('Identifiant élément HTML ou widget', 'Identifiant du flux');**
569
570 Description : Affiche un flux dans un élément HTML
571
572 Exemple (dans l'éditeur de Javascript) :
573
574 (% class="box" %)
575 (((
576 <a href="javascript:ddCtrl.drawFlowInElement ('elementHTMLId', 'fluxId')">Afficher flux</a>
577 )))
578
579 (% class="box infomessage" %)
580 (((
581 💡L'identifiant est celui de la portlet. Vous pouvez le copier depuis l'onglet **Informations** du panneau des **Paramètres **de l'élément.
582
583 [[image:ID_html.png||alt="Identifiant"]]
584 \\Par exemple : <a href="javascript:ddCtrl.drawFlowInElement ('Retail_Coûts_editor', '1898358537')">Afficher flux</a>
585 )))
586
587
588 **void ddCtrl.changePage (page)**
589
590 **void ddCtrl.switchPage (page)**
591
592 Description : Change la page courante vers <page>.
593
594 Exemple :
595
596 (% class="box" %)
597 (((
598 <a href="javascript:__ddCtrl.changePage__('Général.Index')">Retour vers l'index</a>
599 )))
600
601
602 **void ddCtrl.nextPage ()**
603
604 Description : Change vers la page suivante (même rôle).
605
606 Exemple :
607
608 (% class="box" %)
609 (((
610 <a href="javascript:__ddCtrl.nextPage__()">Page suivante</a>
611 )))
612
613
614 **void ddCtrl.prevPage ()**
615
616 Description : Change vers la page précédente (même rôle).
617
618 Exemple :
619
620 (% class="box" %)
621 (((
622 <a href="javascript:__ddCtrl.prevPage__()">Page précédente</a>
623 )))
624
625
626 **(Booléen) ddCtrl.isCurrentPage (page)**
627
628 Description : Retourne vrai (true) si la page courante est la page d'identifiant spécifié en paramètre. Retourne faux (false) sinon.
629
630 (% class="box infomessage" %)
631 (((
632 Note : Cette fonction remplace la fonction dépréciée __ddCtrl.getCurrentPage__ ()
633 )))
634
635
636 **(Chaîne) ddCtrl.getCurrentPage ()**
637
638 Description : Retourne le nom de la page courante au format suivant : <//Nom du rôle>.<Nom de la page>//.
639
640 (% class="box warningmessage" %)
641 (((
642 **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.
643 )))
644
645
646 **(Booléen) ddCtrl.isPageLoaded (page)**
647
648 Description : Retourne vrai (true) si la page spécifiée a déjà été chargée. Retourne faux (false) sinon.
649
650
651 **(Objet) ddCtrl.getPage (page)**
652
653 Description : Retourne un objet contenant certaines propriétés (identifiant, nom, titre, liste des objets ...) de la page spécifiée.
654
655
656 **(Tableau) ddCtrl.getPagePath (page)**
657
658 Description : Retourne un tableau contenant le chemin de la page (rôle / groupe de pages / page).
659
660
661 **(Tableau) ddCtrl.dashboardPages**
662
663 Description : Tableau contenant toutes les pages de tous les rôles de l'utilisateur connecté.
664
665 Exemple :
666
667 {{code language="shell"}}
668 ddCtrl.addCurrentPageLoadListener(function()
669 {
670     console.log(ddCtrl.dashboardPages);
671 });
672 {{/code}}
673
674
675 **(Booléen) canChangeCurrentPage (page)**
676
677 Description : Retourne vrai (true) s'il est possible de changer vers la page <page>. Retourne faux (false) sinon.
678
679
680 **void ddCtrl.hidePage (page)**
681
682 Description : Cache l'onglet de la page <page> s'il est visible, sans changer la page courante.
683
684 Exemple :
685
686 (% class="box" %)
687 (((
688 <a href="javascript:__ddCtrl.hidePage__('Production.Détails Pays'); __ddCtrl.changePage__('Production.Global')">Quitter les détails</a>
689 )))
690
691
692 **void ddCtrl.showPage (page)**
693
694 Description : Affiche l'onglet de la page <page> s'il est caché, sans changer la page courante.
695
696 Exemple :
697
698 (% class="box" %)
699 (((
700 <a href="javascript:__ddCtrl.showPage__('Production.Détails Pays'); __ddCtrl.changePage__('Production.Détails Pays')">Afficher les détails</a>
701 )))
702
703
704 **void ddCtrl.openFlowInWindow (flux, iLargeur, iHauteur)**
705
706 Description : Ouvre un flux dans une fenêtre popup de largeur et hauteur données.
707
708 Exemple :
709
710 (% class="box" %)
711 (((
712 <a href="javascript:__ddCtrl.openFlowInWindow__('fluxId', '250', '200')">Afficher la répartition des produits</a>
713 )))
714
715
716 **void ddCtrl.openPortletInWindow (portlet, iLargeur, iHauteur)**
717
718 Description : Ouvre une portlet dans une fenêtre popup de largeur et hauteur données.
719
720 Exemple :
721
722 (% class="box" %)
723 (((
724 <a href="javascript:__ddCtrl.openPortletInWindow__('portletId', '250', '200')">Afficher la répartition des produits</a>
725 )))
726
727
728 **void ddCtrl.openFlowInWindowWithFilter (flux, iLargeur, iHauteur, dimension, membre [, dimension, membre, ...])**
729
730 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).
731
732 (% class="box infomessage" %)
733 (((
734 Note : Les filtres ne seront appliquées que sur la nouvelle fenêtre.
735 )))
736
737 Exemple :
738
739 (% class="box" %)
740 (((
741 <a href="javascript:__ddCtrl.openFlowInWindowWithFilter__('fluxId', '250', '200', 'Année', '2014', 'Pays', 'France')">Afficher les détails France 2014</a>
742 )))
743
744
745 **void ddCtrl.openPortletInWindowWithFilter (portlet, iLargeur, iHauteur, dimension, membre [, dimension, membre, ...])**
746
747 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).
748
749 (% class="box infomessage" %)
750 (((
751 Note : Les filtres ne seront appliquées que sur la nouvelle fenêtre.
752 )))
753
754 Exemple :
755
756 (% class="box" %)
757 (((
758 <a href="javascript:__ddCtrl.openPortletInWindowWithFilter__('portletId', '250', '200', 'Année', '2014', 'Pays', 'France')">Afficher les détails France 2014</a>
759 )))
760
761
762 **void ddCtrl.closeFlowInWindow (flux)**
763
764 Description : Permet de fermer programmatiquement une popup affichée par l'intermédiaire des fonctions **openFlowInWindow**, **openPortletInWindow**, et **openFormInWindow**.
765
766 Cette fonction prend en paramètre l'identifiant qui a été passé dans la fonction d'affichage de la popup.
767
768 Exemple :
769
770 {{code}}
771 ddCtrl.openFlowInWindow('716abf12', '80%', '80%');
772
773 ddCtrl.closeFlowInWindow('716abf12')
774 {{/code}}
775
776
777 **void ddCtrl.openDocument (serverName, fileName)**
778
779 Description: Ouvre un document dans une nouvelle fenêtre.
780
781 Exemple:
782
783 (% class="box" %)
784 (((
785 <a href="javascript:__ddCtrl.openDocument__('Common Datasources', 'catalogue_produits.pdf')">Afficher le catalogue des produits</a>
786 )))
787
788
789 **void ddCtrl.uploadDocument (serverName, fileName)**
790
791 Description: Upload un document vers un serveur de documents. Ouvre une fenêtre de sélection du fichier sur le poste de travail.
792
793 Exemple:
794
795 (% class="box" %)
796 (((
797 <a href="javascript:(% class="wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink" %)__ddCtrl.uploadDocument__(%%)('Common Datasources', 'catalogue_produits.pdf')">Uploader le catalogue des produits</a>
798 )))
799
800
801 **void ddCtrl.deleteDocument (serverName, fileName)**
802
803 Description : Supprime un document du serveur de documents.
804
805 Exemple:
806
807 (% class="box" %)
808 (((
809 <a href="javascript:__ddCtrl.deleteDocument__('Common Datasources', 'catalogue_produits.pdf')">Supprimer le catalogue des produits</a>
810 )))
811
812
813 **void ddCtrl.downloadDocument (serverName, fileName)**
814
815 Description : Télécharge un document du serveur de documents.
816
817 Exemple:
818
819 (% class="box" %)
820 (((
821 <a href="javascript:__ddCtrl.downloadDocument__('Common Datasources', 'catalogue_produits.pdf')">Télécharger le catalogue des produits</a>
822 )))
823
824
825
826 **void ddCtrl.refreshDashboard ()**
827
828 Description : Rafraîchit le tableau de bord (même comportement que le bouton Rafraîchir en entête du tableau de bord).
829
830 Exemple :
831
832 (% class="box" %)
833 (((
834 <a href="javascript:__ddCtrl.refreshDashboard__()">Rafraîchir</a>
835 )))
836
837
838 **void ddCtrl.refreshFlow (flow, [événement])**
839
840 Description : Rafraîchit le flux spécifié avec un nom d'événement optionnel.
841
842 Exemple:
843
844 (% class="box" %)
845 (((
846 <a href="javascript:__ddCtrl.refreshFlow__('flowId', 'MAJ_QUOTIDIENNE')">Rafraîchir le flux</a>
847 )))
848
849
850 **void ddCtrl.refreshFlows ([événement])**
851
852 Description : Rafraîchit tous les flux du tableau de bord avec un nom d'événement optionnel.
853
854 Exemple:
855
856 (% class="box" %)
857 (((
858 <a href="javascript:__ddCtrl.refreshFlows__('MAJ_QUOTIDIENNE')"> Tout rafraîchir</a>
859 )))
860
861
862 **(Chaîne) ddCtrl.getCurrentRole ()**
863
864 Description : Renvoie l'identifiant du rôle de la page courante ou le nom de l'utilisateur pour une page d'utilisateur.
865
866
867 **(Chaîne) ddCtrl.getRole (page)**
868
869 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.
870
871
872 **void ddCtrl.hidePortlet (portlet)**
873
874 **void ddCtrl.showPortlet (portlet)**
875
876 (% class="box warningmessage" %)
877 (((
878 ❗Ces fonctions ne doivent être utilisées que sur les portlets présents sur la page actuelle.
879 )))
880
881 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.
882
883 Exemple :
884
885 (% class="box" %)
886 (((
887 <a href="javascript:__ddCtrl.showPortlet__('portletId')">Afficher Les Détails</a>
888 )))
889
890
891 **void ddCtrl.setPortletPos (portlet, x, y)**
892
893 **void ddCtrl.setPortletSize (portlet, width, height)**
894
895 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.
896
897 Exemple :
898
899 (% class="box" %)
900 (((
901 <a href="javascript:__ddCtrl.setPortletPos__('portletId', '100', '100'); __ddCtrl.setPortletSize__('portletId', '600', '400')">Agrandir Les Détails</a>
902 )))
903
904
905 **void ddCtrl.setPortletMargins (portlet, marginTop, marginRight, marginBottom, marginLeft)**
906
907 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.
908
909 Exemple :
910
911 (% class="box" %)
912 (((
913 <a href="javascript:__ddCtrl.setPortletPos__('portletId', '10', '10', '10', '10'); __ddCtrl.setPortletMargins__('portletId', '600', '400')">Change les marges</a>
914 )))
915
916
917 **(Booléen) ddCtrl.chartIsHidden (portlet)**
918
919 Description : Retourne vrai (true) lorsque la portlet est cachée (voir hideChart) et faux (false) sinon.
920
921
922 **void ddCtrl.genTemplatePPT (flux)**
923
924 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.
925
926 Exemple :
927
928 (% class="box" %)
929 (((
930 <a href="javascript:__ddCtrl.genTemplatePPT__('Id Fabrique De Document')">Charger le PPT</a>
931 )))
932
933
934 **void ddCtrl.exportCurrentPageAsPPT ()**
935
936 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.
937
938 Exemple :
939
940 (% class="box" %)
941 (((
942 <a href="javascript:__ddCtrl.exportCurrentPageAsPPT__()">Charger cette page au format PPT</a>
943 )))
944
945
946 **void ddCtrl.exportPageAsPPT (role, page)**
947
948 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).
949
950 Exemple :
951
952 (% class="box" %)
953 (((
954 <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>
955 )))
956
957
958 **void ddCtrl.genTemplatePDF(flux)**
959
960 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.
961
962 Exemple :
963
964 (% class="box" %)
965 (((
966 <a href="javascript:__ddCtrl.genTemplatePDF__('Id Fabrique De Document')">Charger le PDF</a>
967 )))
968
969
970 **void ddCtrl.exportCurrentPageAsPDF ()**
971
972 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.
973
974 Exemple :
975
976 (% class="box" %)
977 (((
978 <a href="javascript:__ddCtrl.exportCurrentPageAsPDF__()">Charger cette page au format PDF</a>
979 )))
980
981
982 **void ddCtrl.exportPageAsPDF (role, page)**
983
984 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).
985
986 Exemple :
987
988 (% class="box" %)
989 (((
990 <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>
991 )))
992
993
994 **void ddCtrl.genTemplateXLS (flux)**
995
996 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.
997
998 Exemple :
999
1000 (% class="box" %)
1001 (((
1002 <a href="javascript:__ddCtrl.genTemplateXLS__('Id Fabrique De Document')">Charger le XLS</a>
1003 )))
1004
1005
1006 **void ddCtrl.exportAsPDF (flux)**
1007
1008 Description : Sauvegarde le flux en PDF. Le téléchargement du PDF généré est proposé à l'utilisateur.
1009
1010
1011 **void ddCtrl.exportAsPPT (flux)**
1012
1013 Description : Sauvegarde le flux en PPT. Le téléchargement du PPT généré est proposé à l'utilisateur.
1014
1015
1016 **void ddCtrl.exportAsXLS (flux)**
1017
1018 Description : Sauvegarde le flux en XLS. Le téléchargement du XLS généré est proposé à l'utilisateur.
1019
1020
1021 **void ddCtrl.exportAsXLSWithoutStyles (flux)**
1022
1023 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.
1024
1025
1026 **void ddCtrl.exportAsCSV (flux)**
1027
1028 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.
1029
1030
1031 **void ddCtrl.saveDashboardState (nom, bDéfaut)**
1032
1033 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.
1034
1035
1036 **(Chaîne) ddCtrl.getCurrentPortletInGroupOfTabs (portletTabId)**
1037
1038 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.
1039
1040
1041 **void ddCtrl.changePortletInGroupOfTabs (portletTabId, portletId)**
1042
1043 Description : Change la portlet courante de l’objet Groupe d’onglets. Le paramètre portletTabId est l’identifiant du Groupe d’onglets, le paramètre portletId est l’identifiant de la portlet à sélectionnner.
1044
1045
1046 **(Tableau) ddCtrl.getCurrentPagePath ()**
1047
1048 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).
1049
1050
1051 **void ddCtrl.expandCollapseNavigationMenu()**
1052
1053 Description : Réduit le menu de navigation s'il est développé et vice versa.
1054
1055 == Gestion d’événements ==
1056
1057 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.
1058
1059 == (% id="cke_bm_227S" style="display:none" %) (%%)Diagramme des événements du Tableau de bord ==
1060
1061 [[image:api_event_diagram.gif||queryString="width=641&height=802"]]
1062
1063 **void ddCtrl.addChartBeforeRefreshListener (Fonction)**
1064
1065 Description : Ajoute une fonction d'écoute de l'événement déclenché avant le rafraîchissement du graphique.
1066
1067 Exemple :
1068
1069 (% class="box" %)
1070 (((
1071 ddCtrl.addChartBeforeRefreshListener(function(doc, dm, dmsel, chart, errorMsg) { alert("Le graphique " + chart.title + " va être rafraîchi"); });
1072 )))
1073
1074
1075 **void ddCtrl.addChartRefreshListener (Fonction)**
1076
1077 Description : Ajoute une fonction d'écoute de l'événement déclenché après le rafraîchissement du graphique.
1078
1079 Exemple :
1080
1081 (% class="box" %)
1082 (((
1083 ddCtrl.addChartRefreshListener(function(doc, dm, dmsel, chart, errorMsg) { alert("Le graphique " + chart.title + " a été rafraîchi"); });
1084 )))
1085
1086
1087 **void ddCtrl.addChartDrawnListener (Fonction)**
1088
1089 Description : Ajoute une fonction d'écoute de l'événement déclenché lorsque le graphique a fini d'être dessiné (premier affichage).
1090
1091 Exemple :
1092
1093 (% class="box" %)
1094 (((
1095 ddCtrl.addChartDrawnListener(function(doc, dm, dmsel, chart, errorMsg) { alert("Le graphique " + chart.title + " a été dessiné"); });
1096 )))
1097
1098
1099 **void ddCtrl.addChartModelReadyListener (Fonction)**
1100
1101 Description : Ajoute une fonction d'écoute de l'événement déclenché avant le dessin du graphique (premier affichage).
1102
1103 Exemple :
1104
1105 (% class="box" %)
1106 (((
1107 ddCtrl.addChartModelReadyListener(function(doc, dm, dmsel, chart, errorMsg) { alert("Le graphique " + chart.title + " va être dessiné"); });
1108 )))
1109
1110
1111 **void ddCtrl.addDimensionFilterListener (Fonction)**
1112
1113 Description : Ajoute une fonction d'écoute de l'événement déclenché après filtrage d'une dimension.
1114
1115 Exemple :
1116
1117 (% class="box" %)
1118 (((
1119 ddCtrl.addDimensionFilterListener(function(dimension, hierarchy, niveau, members, membersFormated, bExclude, min, max) { alert("La dimension " + dimension + " a été filtrée sur " + membersFormated); });
1120 )))
1121
1122
1123 **void ddCtrl.addVariableChangeListener (Fonction)**
1124
1125 Description : Ajoute une fonction d'écoute de l'événement déclenché après changement d'une variable.
1126
1127 Exemple :
1128
1129 (% class="box" %)
1130 (((
1131 ddCtrl.addVariableChangeListener(function(variable, valeur) { alert("La variable " + variable + " a changé, nouvelle valeur : " + valeur); });
1132 )))
1133
1134 == Gestion d’événements du Tableau De Bord ==
1135
1136
1137
1138 **void ddCtrl.addDashboardLoadListener (Fonction)**
1139
1140 Description : Ajoute une fonction d'écoute de l'événement déclenché une fois le de tableau de bord chargé mais pas encore dessiné.
1141
1142 Exemple :
1143
1144 (% class="box" %)
1145 (((
1146 ddCtrl.addDashboardLoadListener(function(currentPage) { alert("Initialisation du tableau de bord"); });
1147 )))
1148
1149
1150
1151 **void ddCtrl.addCurrentPageLoadListener (Fonction)**
1152
1153 Description : Ajoute une fonction d'écoute de l'événement déclenché une fois la page de tableau de bord complètement chargée.
1154
1155 Exemple :
1156
1157 (% class="box" %)
1158 (((
1159 ddCtrl.addCurrentPageLoadListener(function(currentPage) { alert("La page " + currentPage + " a été chargée"); });
1160 )))
1161
1162
1163 **void ddCtrl.addCurrentPageChangeListener (Fonction)**
1164
1165 Description : Ajoute une fonction d'écoute de l'événement déclenché lors d'un changement de page.
1166
1167 Exemple :
1168
1169 (% class="box" %)
1170 (((
1171 ddCtrl.addCurrentPageChangeListener(function(currentPage, bFirstTime) { alert("La page est maintenant " + currentPage); });
1172 )))
1173
1174
1175 **void ddCtrl.addUserLoggedListener (Fonction)**
1176
1177 Description : événement déclenché une fois l'utilisateur authentifié. Peut être utile lors de l'utilisation de la fonction ddCtrl.getUserAttribute.
1178
1179 Exemple :
1180
1181 (% class="box" %)
1182 (((
1183 ddCtrl.addUserLoggedListener(function() { alert("Vous êtes authentifié"); });
1184 )))
1185
1186
1187 **void ddCtrl.addPortletHiddenListener (Fonction)**
1188
1189 Description : événement déclenché lorsque le statut de l’objet est passé de visible à caché.
1190
1191 Exemple :
1192
1193 (% class="box" %)
1194 (((
1195 ddCtrl.addPortletHiddenListener(function(portletId) { alert("L’objet est caché"); });
1196 )))
1197
1198
1199 **void ddCtrl.addPortletVisibleListener (Fonction)**
1200
1201 Description : événement déclenché lorsque le statut de l’objet est passé de caché à visible.
1202
1203 Exemple :
1204
1205 (% class="box" %)
1206 (((
1207 ddCtrl.addPortletVisibleListener(function(portletId) { alert("L’objet est visible"); });
1208 )))
1209
1210
1211 **void ddCtrl.addPortletCollapseListener (Fonction)**
1212
1213 Description : événement déclenché lorsque l’utilisateur clique sur l’icône permettant de masquer un élément rétractable.
1214
1215 Exemple :
1216
1217 (% class="box" %)
1218 (((
1219 ddCtrl.addPortletCollapseListener(function(portletId) { alert("L’objet va être cacher"); });
1220 )))
1221
1222
1223 **void ddCtrl.addPortletCollapsedListener (Fonction)**
1224
1225 Description : événement déclenché une fois l’élément rétractable caché.
1226
1227 Exemple :
1228
1229 (% class="box" %)
1230 (((
1231 ddCtrl.addPortletCollapsedListener(function(portletId) { alert("L’objet est caché"); });
1232 )))
1233
1234
1235 **void ddCtrl.addPortletExpandListener (Fonction)**
1236
1237 Description : événement déclenché lorsque l’utilisateur clique sur l’icône permettant d’afficher un élément rétractable.
1238
1239 Exemple :
1240
1241 (% class="box" %)
1242 (((
1243 ddCtrl.addPortletExpandListener(function(portletId) { alert("L’objet va être afficher"); });
1244 )))
1245
1246
1247 **void ddCtrl.addPortletExpandedListener (Fonction)**
1248
1249 Description : événement déclenché une fois l’élément rétractable affiché.
1250
1251 Exemple :
1252
1253 (% class="box" %)
1254 (((
1255 ddCtrl.addPortletExpandedListener(function(portletId) { alert("L’objet est affiché"); });
1256 )))
1257
1258
1259 **void ddCtrl.addGroupOfTabsChangeListener (Fonction)**
1260
1261 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.
1262
1263 Exemple :
1264
1265 (% class="box" %)
1266 (((
1267 ddCtrl.addGroupOfTabsChangeListener(function(portletTabId, curPortletId) { alert("La portlet courante est : " + curPortletId); });
1268 )))
1269
1270
1271 **void ddCtrl.addDocumentUploadListener (Fonction)**
1272
1273 Description : événement déclenché lorsque l’utilisateur ajoute un fichier via le tableau de bord.
1274
1275 Exemple :
1276
1277 (% class="box" %)
1278 (((
1279 ddCtrl.addDocumentUploadListener(function(serverName, filesName) { alert("Le fichier " + filesName[0] + " a bien été ajouté"); });
1280 )))
1281
1282 = Fonctions diverses =
1283
1284 **(Tableau de chaînes) ddCtrl.getUserRoles ()**
1285
1286 Description : Retourne la liste des identifiants des rôles de l'utilisateur connecté.
1287
1288
1289 **(Tableau associatif de chaînes / booléens) ddCtrl.getUserACLs ()**
1290
1291 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.
1292
1293 Exemple :
1294
1295 (% class="box" %)
1296 (((
1297 if (ddCtrl.getUserACLs()['SaveAsPPT']) alert("Vous pouvez sauvegarder en PPT");
1298 )))
1299
1300 Liste de tous les droits possibles :
1301
1302 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
1303
1304
1305 **(Chaîne) ddCtrl.getUserAttribute (attr)**
1306
1307 Description : Retourne l'attribut LDAP <attr> de l'utilisateur.
1308
1309
1310 **(Chaîne) ddCtrl.getUserAttribute (attr, Fonction)**
1311
1312 Description : Retourne l'attribut LDAP <attr> de l'utilisateur via une fonction asynchrone d'appel.
1313
1314 Exemple :
1315
1316 (% class="box" %)
1317 (((
1318 ddCtrl.getUserAttribute('displayName', function (attrVal) {alert(attrVal)});
1319 )))
1320
1321
1322 **(Chaîne) ddCtrl.getSessionAttribute (attr)**
1323
1324 Description : Retourne l'attribut <attr> de la session utilisateur.
1325
1326 Voir le [[Tutoriel Variables de session>>doc:Digdash.user_guide.tutorials.session_variables_tutorial.WebHome]] pour plus d’information sur les variables de session.
1327
1328
1329 **(Chaîne) ddCtrl.getSessionAttribute (attr, Fonction)**
1330
1331 Description : Retourne l'attribut <attr> de la session utilisateur via une fonction asynchrone d'appel.
1332
1333 Exemple :
1334
1335 (% class="box" %)
1336 (((
1337 ddCtrl.getSessionAttribute('regionChoisie', function (attrVal) {alert(attrVal)});
1338 )))
1339
1340 Voir le [[Tutoriel Variables de session>>doc:Digdash.user_guide.tutorials.session_variables_tutorial.WebHome]] pour plus d’information sur les variables de session.
1341
1342
1343 **void ddCtrl.setSessionAttribute (attr, valeur)**
1344
1345 Description : Met à jour l’attribut <attr> de la session utilisateur avec la valeur spécifiée.
1346
1347 Exemple :
1348
1349 (% class="box" %)
1350 (((
1351 ddCtrl.setSessionAttribute('regionChoisie', ‘France’);
1352 )))
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.getServerAttribute (attr)**
1358
1359 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>}.
1360
1361 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.
1362
1363
1364 **(Chaîne) ddCtrl.getServerAttribute (attr, Fonction)**
1365
1366 Description : Retourne l'attribut <attr> du serveur via une fonction asynchrone d'appel.
1367
1368 Exemple :
1369
1370 (% class="box" %)
1371 (((
1372 ddCtrl.getSessionAttribute('serverMode', function (attrVal) {alert(attrVal)});
1373 )))
1374
1375 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.
1376
1377
1378 **(Chaîne) ddCtrl.getUserStorage (attr)**
1379
1380 Description : Retourne l'attribut <attr> de l'utilisateur spécifié sauvegardé précédemment.
1381
1382 Exemple :
1383
1384 (% class="box" %)
1385 (((
1386 var valeur = ddCtrl.getUserStorage('attribut');
1387 )))
1388
1389 **void ddCtrl.setUserStorage (attr, valeur)**
1390
1391 Description : Sauvegarde l'attribut <attr> de l'utilisateur de manière persistante sur le serveur pour une prochaine utilisation.
1392
1393 Exemple :
1394
1395 (% class="box" %)
1396 (((
1397 ddCtrl.setUserStorage('attribut', 'valeur');
1398 )))
1399
1400
1401 **void ddCtrl.fireRefreshEvent (événement)**
1402
1403 Description : Déclenche côté serveur le rafraîchissement des données ayant l'événement spécifié
1404
1405 Exemple :
1406
1407 (% class="box" %)
1408 (((
1409 ddCtrl.fireRefreshEvent('MAJ_QUOTIDIENNE');
1410 )))
1411
1412
1413 **void ddCtrl.newAuthToken ()**
1414
1415 Description : Renvoi un token d'authentification généré par rapport à la session courante.
1416
1417 Exemple :
1418
1419 (% class="box" %)
1420 (((
1421 var token = ddCtrl.newAuthToken();
1422
1423 window.open("http:~/~/localhost:8080/digdash_dashboard/index.html?user=mon_user&authToken=token");
1424 )))
1425
1426
1427 **void loadCSS (cssFile)**
1428
1429 Description : Charge un fichier CSS.
1430
1431
1432 **void ddCtrl.loadTheme (cssTheme)**
1433
1434 Description : Charge un thème CSS DigDash sur le tableau de bord.
1435
1436 Exemple :
1437
1438 (% class="box" %)
1439 (((
1440 ddCtrl.loadTheme(‘digdash’);
1441 )))
1442
1443 **void ddCtrl.removeTheme (cssTheme)**
1444
1445 Description : Supprime le thème CSS DigDash sur le tableau de bord.
1446
1447 Exemple :
1448
1449 (% class="box" %)
1450 (((
1451 ddCtrl.removeTheme(‘digdash’);
1452 )))
1453
1454 **void openFormInWindow (portlet, largeur, hauteur, dimension, membre [, dimension, membre, ...])**
1455
1456 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).
1457
1458 Exemple :
1459
1460 (% class="box" %)
1461 (((
1462 <a href="javascript:__ddCtrl.openFormInWindow__('portletId', '80%', '80%', 'Année', '2014', 'Pays', 'France')">Affiche le formulaire avec les valeurs France 2014</a>
1463 )))
1464
1465
1466 **void initFormData (portlet, nom du champ, valeur du champ [, nom, valeur, ...])**
1467
1468 Description : Initialise un formulaire avec les valeurs spécifiés en paramètre (liste de couples nom du champ / valeur du champ du formulaire).
1469
1470 Exemple :
1471
1472 (% class="box" %)
1473 (((
1474 <a href="javascript:__ddCtrl.initFormData__('portletId', '80%', '80%', 'Année', '2014', 'Pays', 'France')">Initialise le formulaire avec les valeurs France 2014</a>
1475 )))
1476
1477
1478 **void logout ()**
1479
1480 Description : Déconnecte l'utilisateur courant.