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