Wiki source code of Dashboard API

Last modified by Aurelie Bertrand on 2026/07/13 14:55

version	line-number	content
1.1	1	{{ddtoc/}}
	2
55.1	3	----
	4
1.1	5	(% class="wikigeneratedid" id="HFonctionsJavascript28DashboardAPI29" %)
84.1	6	There are two ways to add customised behaviour to dashboards. The first is to use the global JavaScript editor available in the dashboard editor. The second is the Text Editor portlet. This element allows you to add a block of text (and/or HTML) to a dashboard page. The possibilities are expanded thanks to an application programming interface (API) that allows you to add JavaScript calls to dashboard functions to hyperlinks within a text editor.
1.1	7
84.1	8	Using these functions, you can trigger a page change, apply a filter to a given dimension, change a DigDash variable, and so on.
1.1	9
84.1	10	Each function is called on an implicit ddCtrl object defined by the dashboard engine. Here is the list of functions:
1.1	11
	12	(% class="box warningmessage" %)
	13	(((
84.1	14	//Unless otherwise stated, parameter values are object IDs, not formatted and/or translated names. For other parameters that are not IDs, their type is specified by a lower-case letter prefixed to their name: ‘b’ for Boolean, ‘o’ for object, ‘l’ for list (array) and ‘i’ for integer.//
1.1	15
84.1	16	//A parameter enclosed in square brackets [ ] is optional and may be omitted if it is not required in the context.//
1.1	17	)))
	18
84.1	19	= Variable functions (DDVariables) =
1.1	20
58.1	21	(% class="wikigeneratedid" id="HvoidddCtrl.changeVariable28nom2Cvaleur29" %)
84.1	22	void ddCtrl.{{id name="changeVariable"/}} changeVariable(name, value)
1.1	23
84.1	24	Description: Changes the value of the variable <name>.
1.1	25
84.1	26	Example:
1.1	27
	28	(% class="box" %)
	29	(((
	30	<a href="javascript:__ddCtrl.changeVariable__('ratioEuro', 1.30)">EuroDollar: 1.30</a>
	31	)))
	32
	33
84.1	34	(Number) ddCtrl.getDDVar(name)
1.1	35
84.1	36	Description: Returns the value of the variable <name>.
1.1	37
84.1	38	Example:
1.1	39
	40	(% class="box" %)
	41	(((
84.1	42	<a href="javascript:ddCtrl.changeVariable('ratioEuro', __ddCtrl.getDDVar__('ratioEuro') + 0.1)">Increase EuroDollar</a>
1.1	43	)))
	44
84.1	45	= Data filtering and navigation functions =
1.1	46
84.1	47	FilterOperand (dimension, member, hierarchy, level, formattedMember, bAddFilter, bExcludeFilter)
1.1	48
84.1	49	Description: Object used to specify the filter to be applied.
1.1	50
84.1	51	Example:
1.1	52
	53	(% class="box" %)
	54	(((
84.1	55	<a href="javascript[[:>>path:javascript:ddCtrl.filter('Dim]]ddCtrl.filter('Geo Dim', new FilterOperand('Geo Dim', 'France', 'Geo', 'Country', false, false))">France filter</a>
1.1	56	)))
	57
	58	(% class="box infomessage" %)
	59	(((
84.1	60	//Note: Setting the boolean bAjoutFiltre to true allows the filter to be added to the existing filter on this dimension. Setting the boolean bExcludeFilter to true enables the filter’s exclusion mode (rather than filtering on the member, this filters all other members except the one specified).//
1.1	61	)))
	62
	63
84.1	64	FilterOperandContinuous (dimension, min, max, bExcludeFilter)
1.1	65
84.1	66	Description: Object used to specify the interval filter to be applied to a continuous dimension.
1.1	67
84.1	68	Example:
1.1	69
	70	(% class="box" %)
	71	(((
84.1	72	<a href="javascript[[:>>path:javascript:ddCtrl.filter('Dim]]ddCtrl.filter('Country', new FilterOperandContinuous('Date', new Date(2018, 0, 1).getTime()/1000, new Date(2019, 0, 1).getTime()/1000, false))">Filter: Year 2018</a>
1.1	73	)))
	74
	75	(% class="box infomessage" %)
	76	(((
84.1	77	//Note: Setting the boolean bExcluFiltre to true enables exclusion mode for the filter (rather than filtering on the specified member, it filters on all other members except the one specified).//
1.1	78	)))
	79
	80
84.1	81	FilterOperandMatch (dimension, hierarchy, level, [values], [operators], mode, ExcludeFilter)
9.1	82
84.1	83	Description: Object used to specify a ‘Rule’ type filter to be applied to a continuous dimension.
9.1	84
84.1	85	Example:
9.1	86
	87	(% class="box" %)
	88	(((
84.1	89	<a href="javascript[[:>>path:javascript:ddCtrl.filter('Dim]]ddCtrl.filter('Geo Dim', new FilterOperandMatch('Geo Dim', 'Geographical', 'Country', ['A'], [13], 0, false))">Filter: Countries starting with A</a>
9.1	90	)))
	91
	92	(% class="box infomessage" %)
	93	(((
84.1	94	//Note~://
9.1	95
84.1	96	//The ‘Operators’ table contains the filter type for each rule~://
9.1	97
84.1	98	//0: not empty//
9.1	99
84.1	100	//1: is empty//
9.1	101
84.1	102	//2: is equal to//
9.1	103
84.1	104	//3: contains//
9.1	105
84.1	106	//4: does not contain//
9.1	107
84.1	108	//5: is not equal to//
9.1	109
84.1	110	//6: matches the regular expression//
9.1	111
84.1	112	//7: contains the word//
9.1	113
84.1	114	//8: does not contain the word//
9.1	115
84.1	116	//9: is greater than//
9.1	117
84.1	118	//10: is less than//
9.1	119
84.1	120	//11: is greater than or equal to//
9.1	121
84.1	122	//12: is less than or equal to//
9.1	123
84.1	124	//13: starts with//
9.1	125
84.1	126	//14: ends with//
9.1	127
84.1	128	//15: is contained in//
9.1	129
84.1	130	//16: is not contained in//
9.1	131
84.1	132	//The values table contains the required values corresponding to the filter type.//
9.1	133	)))
	134
	135
84.1	136	void ddCtrl.filter (dimension, member)
1.1	137
84.1	138	Description: filters by a dimension.
1.1	139
84.1	140	Example:
1.1	141
	142	(% class="box" %)
	143	(((
84.1	144	<a href="javascript:__ddCtrl.filter__('Pays', 'France')">Filter France</a>
1.1	145	)))
	146
	147	(% class="box infomessage" %)
	148	(((
84.1	149	//Note: The specified member filters the hierarchy and the current level for this dimension.//
1.1	150	)))
	151
	152
	153	void ddCtrl.filter (oFilterOperand)
	154
84.1	155	Description: Filters on a dimension by specifying a hierarchy and a level.
1.1	156
84.1	157	Example:
1.1	158
	159	(% class="box" %)
	160	(((
84.1	161	<a href="javascript:__ddCtrl.filter__(new FilterOperand('Lieu', 'FR', 'Géographique', 'Pays'))">France Details</a>
1.1	162	)))
	163
	164	(% class="box infomessage" %)
	165	(((
84.1	166	//Note: Location// is the dimension, //FR// is the ID of the selected member, //Geographical// is the hierarchy and //Country// is the level.
1.1	167	)))
	168
	169
5.1	170	void ddCtrl.filterOnChart (portlet, oFilterOperand, doNotRefresh)
	171
84.1	172	Description: Filters a chart by a dimension by specifying a hierarchy and a level.
5.1	173
84.1	174	Example:
5.1	175
	176	(% class="box" %)
	177	(((
84.1	178	<a href="javascript:__ddCtrl.filterOnChart__('portletId1', new FilterOperand('Lieu', 'FR', 'Géographique', 'Pays'))">Details for France</a>
5.1	179	)))
	180
	181	(% class="box infomessage" %)
	182	(((
84.1	183	//Note: portletId1//is the chart ID, //Location// is the dimension, //FR// is the ID of the selected member, //Geographical// is the hierarchy and //Country// is the level.
5.1	184	)))
	185
	186
84.1	187	void ddCtrl.filterAndChangePage (page, dimension, member)
1.1	188
84.1	189	Description: filters by a dimension and changes the page.
1.1	190
84.1	191	Example:
1.1	192
	193	(% class="box" %)
	194	(((
84.1	195	<a href="javascript:__ddCtrl.filterAndChangePage__('Production.Details Country', 'Country', 'France')">France Details</a>
1.1	196	)))
	197
	198
84.1	199	void ddCtrl.changePageAndFilter (page, dimension, member)
8.1	200
84.1	201	Description: changes the page and filters by a dimension.
8.1	202
84.1	203	Example:
8.1	204
	205	(% class="box" %)
	206	(((
84.1	207	<a href="javascript:__ddCtrl.changePageAndFilter__('Production.Details Country', 'Country', 'France')">France Details</a>
8.1	208	)))
	209
	210
1.1	211	void ddCtrl.setFilterMinMax (dimension, min, max)
	212
84.1	213	Description: Filters by a continuous dimension by specifying a minimum and maximum value. Note: A DigDash date is a timestamp in seconds.
1.1	214
84.1	215	Example:
1.1	216
	217	(% class="box" %)
	218	(((
11.1	219	<a href="javascript:__ddCtrl.setFilterMinMax__('Date', new Date(2014, 0, 1).getTime()/1000, new Date().getTime()/1000)">2014 to date</a>
1.1	220	)))
	221
	222
84.1	223	(String Array) ddCtrl.getDimensionFilter (dimension [, bContinue])
1.1	224
84.1	225	Description: Returns the list of elements filtered by the dimension (continuous or discrete).
1.1	226
84.1	227	Example:
1.1	228
	229	(% class="box" %)
	230	(((
84.1	231	<a href="javascript:alert(__ddCtrl.getDimensionFilter__('Pays'))">Filters by Country</a>
1.1	232	)))
	233
	234
	235	void ddCtrl.isDimensionFiltered (dimension [, bContinue])
	236
84.1	237	Description: Returns true if the dimension (continuous or discrete) is filtered. Returns false otherwise.
1.1	238
84.1	239	Example:
1.1	240
	241	(% class="box" %)
	242	(((
84.1	243	<a href="javascript:alert(__ddCtrl.isDimensionFiltered__('Pays'))">Is the country filtered?</a>
1.1	244	)))
	245
	246
	247	void ddCtrl.removeAllFilters ()
	248
84.1	249	Description: Removes all filters from the dashboard.
1.1	250
84.1	251	Example:
1.1	252
	253	(% class="box" %)
	254	(((
	255	<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>
	256	)))
	257
	258
	259	void ddCtrl.removeAllFiltersCurrentPage ()
	260
84.1	261	Description: Removes the filters from the current page.
1.1	262
84.1	263	Example:
1.1	264
	265	(% class="box" %)
	266	(((
84.1	267	<a href="javascript:(% class="wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink" %)__ddCtrl.__(%%)__removeAllFiltersCurrentPage__()">Reset</a>
1.1	268	)))
	269
	270
	271	void ddCtrl.removeFilters (dimension [, bContinue])
	272
84.1	273	Description: Removes the current filters on the dimension (continuous or discrete).
1.1	274
	275	(% class="box" %)
	276	(((
84.1	277	Example: <a href="javascript:__ddCtrl.removeFilters__('Pays')">All countries</a>
1.1	278	)))
	279
	280
	281	void ddCtrl.beginSelection ()
	282
	283	void ddCtrl.commitSelection ()
	284
84.1	285	Description: Used in conjunction with the ddCtrl.filter function. Allows multiple filters on different dimensions to be combined without having to run each filter individually (optimisation).
1.1	286
84.1	287	Example:
1.1	288
	289	(% class="box" %)
	290	(((
84.1	291	<a href="javascript:__ddCtrl.beginSelection__(); ddCtrl.filter('Country', 'France'); ddCtrl.filter('Year', '2013'); __ddCtrl.commitSelection__()">France in 2013</a>
1.1	292	)))
	293
	294
84.1	295	void ddCtrl.setDimensionNavigation (dimension, {{glossaryReference glossaryId="Glossary" entryId="Flux"}}Flow{{/glossaryReference}}, bNavigation)
1.1	296
84.1	297	Description: Changes the permission to navigate by a dimension for the specified flow.
1.1	298
84.1	299	Example:
1.1	300
	301	(% class="box" %)
	302	(((
84.1	303	<a href="javascript:(% class="wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink" %)__ddCtrl.setDimensionNavigation__(%%)('Region', 'chart1', true)">Enable navigation by Region</a>
1.1	304	)))
	305
	306
84.1	307	(String array) ddCtrl.getCurrentDrill (portlet, dimension[, hierarchy])
1.1	308
84.1	309	Description: Returns the dimension, hierarchy and current level of a chart as an array.
1.1	310
	311	(% class="box infomessage" %)
	312	(((
84.1	313	Note: This function can only be called on a chart with a “Navigate hierarchy” or “Change dimension” interaction.
1.1	314	)))
	315
84.1	316	Example:
1.1	317
7.1	318	{{code language="JAVASCRIPT" cssClass="notranslate"}}
1.1	319	ddCtrl.addChartRefreshListener( function(doc, dm, dmsel, chart) {
	320	if (chart.title == 'Mon graphique') {
	321	var curDrill = ddCtrl.getCurrentDrill(doc.frameId, 'Région', 'Géographique');
	322	var dim = curDrill[0];
	323	var hier = curDrill[1];
	324	var lvl = curDrill[2];
	325	alert("L'exploration est " + hier + " / " +lvl + " sur la dimension " + dim);
	326	}
	327	});
	328	{{/code}}
	329
	330
	331	(BreadPath) ddCtrl.getBreadPath (portlet, dimension)
	332
84.1	333	Description: Returns the current navigation path (BreadPath) for a dimension in a chart. This object can be used by `drillTo` (see below).
1.1	334
84.1	335	Example:
1.1	336
	337	(% class="box" %)
	338	(((
84.1	339	<a href="javascript:__ddCtrl.drillTo__('portletId2', 'Lieu', __ddCtrl.getBreadPath__('portletId1', 'Location'))">Current Location Details (Chart 2)</a>
1.1	340	)))
	341
	342
62.1	343	void ddCtrl.drillTo (portletId, dimension, oBreadPath)
1.1	344
84.1	345	Description: Navigates within a chart along a hierarchy of the selected dimension, using a navigation path defined by the BreadPath object.
1.1	346
84.1	347	Example:
1.1	348
	349	(% class="box" %)
	350	(((
84.1	351	See example above (getBreadPath)
1.1	352	)))
	353
	354
84.1	355	void ddCtrl.drillDown (portletId, dimension, hierarchy, level, member, formattedMember)
1.1	356
84.1	357	Description: Navigates down a hierarchy of the selected dimension to the specified member at the lower level.
1.1	358
	359	(% class="box infomessage" %)
	360	(((
84.1	361	Note: The action is performed on all charts sharing the same navigation interaction (“synchronised drill-down”).
1.1	362	)))
	363
84.1	364	Example:
1.1	365
	366	(% class="box" %)
	367	(((
84.1	368	<a href="javascript:__ddCtrl.drillTo__('portletId', 'Location', 'Geographic', 'FR', 'France')">France Details</a>0
1.1	369	)))
	370
	371
84.1	372	void ddCtrl.resetDrill (portlet, dimension, [hierarchy])
1.1	373
84.1	374	Description: Resets navigation on the dimension hierarchy.
1.1	375
	376	(% class="box infomessage" %)
	377	(((
84.1	378	Note: The action is performed on all charts sharing the same navigation interaction (“synchronised drill”).
1.1	379	)))
	380
84.1	381	Example:
1.1	382
	383	(% class="box" %)
	384	(((
84.1	385	<a href="javascript:__ddCtrl.resetDrill__('portletId', 'Location')">Back to the world map</a>
1.1	386	)))
	387
	388
84.1	389	void ddCtrl.selectMeasuresOnChart(portlet, [measures])
6.1	390
84.1	391	Description: Displays the specified measures on the chart; the other measures on the chart will be hidden.
6.1	392
84.1	393	Example:
6.1	394
	395	(% class="box" %)
	396	(((
84.1	397	<a href="javascript:__selectMeasuresOnChart__('portletId2', ['Turnover', 'Margins'])">Display Turnover and Margins</a>
6.1	398	)))
	399
	400
	401
84.1	402	(Number \| String) ddCtrl.getDataModelDate (dmId, bFormat)
1.1	403
84.1	404	Description: Returns the synchronisation date of a data cube. The parameters are the data model ID and a Boolean value to format the date (true) or return the corresponding timestamp (false).
1.1	405
	406	(% class="box infomessage" %)
	407	(((
84.1	408	Note: The timestamp is the number of milliseconds elapsed since 1 January 1970.
1.1	409	)))
	410
84.1	411	Example:
1.1	412
	413	(% class="box" %)
	414	(((
84.1	415	<a href="javascript:alert(__ddCtrl.getDataModelDate__('a1234567890..', true))">Display the data date</a>
1.1	416	)))
	417
	418
84.1	419	(Number \| String) ddCtrl.getDataModelLinesCount (dmId)
8.1	420
84.1	421	Description: Returns the number of rows in a data cube. The parameter is the data model identifier.
8.1	422
84.1	423	Example:
8.1	424
	425	(% class="box" %)
	426	(((
84.1	427	<a href="javascript:alert(__ddCtrl.getDataModelLinesCount__('a1234567890..'))">Display the number of rows in the data</a>
8.1	428	)))
	429
	430
	431
84.1	432	(Number \| String) ddCtrl.getFlowDate ({{glossaryReference glossaryId="Glossary" entryId="Flux"}}Flow{{/glossaryReference}}, bFormat)
1.1	433
84.1	434	Description: Returns the synchronisation date of a flow. The parameters are the flow ID and a Boolean value to format the date (true) or return the corresponding timestamp (false).
1.1	435
	436	(% class="box infomessage" %)
	437	(((
84.1	438	Note: The timestamp is the number of milliseconds elapsed since 1 January 1970.
1.1	439	)))
	440
84.1	441	Example:
1.1	442
	443	(% class="box" %)
	444	(((
84.1	445	<A href="javascript:alert(__ddCtrl.getFlowDate__('fluxId', true))">Display the {{glossaryReference glossaryId="Glossary" entryId="Flux"}}Flow{{/glossaryReference}} date</A>
1.1	446	)))
	447
84.1	448	= Data query functions =
1.1	449
84.1	450	(Number \| String) ddCtrl.getResultCubeValue ({{glossaryReference glossaryId="Glossary" entryId="Flux"}}Flow{{/glossaryReference}}, measure, lMembers, bFormatted)
1.1	451
84.1	452	Description: Returns the value of the measure for the specified axis members from a visible chart. Returns the value as a number or as a formatted string.
1.1	453
84.1	454	Note: The list of axis members must specify //__one and only one member for each axis used__// in the chart, in the natural order of the chart’s axes. The measure parameter is the measure ID.
1.1	455
84.1	456	Example: To retrieve a value from a histogram defined as follows: Measure ‘Margin’ on the stack axis, dimension ‘Year’ on the column axis and ‘Country’ on the group axis:
1.1	457
	458	(% class="box" %)
	459	(((
84.1	460	<a href="javascript:alert(__ddCtrl.getResultCubeValue__('chart1', 'Margin', ['2023', 'France'], true))">Show the margin for France in 2023</a>
1.1	461	)))
	462
	463	(% class="box warningmessage" %)
	464	(((
84.1	465	Important: It is important to ensure that the chart has loaded before calling this function. The simplest way is to include the call to this function within a listener passed to `addChartRefreshListener`
1.1	466	)))
	467
84.1	468	(Row table) ddCtrl.getResultCubeRowSet ({{glossaryReference glossaryId="Glossary" entryId="Flux"}}Flow{{/glossaryReference}}, oAxisMemberQuery [, bFormatted])
1.1	469
84.1	470	Description: Returns the flattened rows of the result cube for the specified axis members from a visible chart. Returns the result as an array of rows, each row being an array of cells. The cells consist of the chart’s dimensions/axes followed by the measure values.
1.1	471
	472	(% class="box infomessage" %)
	473	(((
84.1	474	Note: The query for the axis members to be retrieved is a JavaScript object conforming to the following format (JSON): {"Axis/Dim title 1": "member 1", "Axis/Dim title 2": "member 2", etc.}..*
1.1	475	)))
	476
84.1	477	Example: To retrieve the rows corresponding to the year 2024 and the person ‘John’ from a result cube of a chart named ‘chart1’:
1.1	478
	479	(% class="box" %)
	480	(((
84.1	481	<a href="javascript:alert(__ddCtrl.getResultCubeRowSet__('chart1', {'Year' : '2024', 'Person': 'John'})[0][2])">Show John’s first value in 2024</a>
1.1	482	)))
	483
	484	(% class="box warningmessage" %)
	485	(((
84.1	486	Important: It is important to ensure that the chart is loaded before calling this function. The simplest way is to include the call to this function in a listener passed to `addChartRefreshListener`.
1.1	487	)))
	488
	489
84.1	490	(Number) ddCtrl.getResultCubeLinesCount ({{glossaryReference glossaryId="Glossary" entryId="Flux"}}Flow{{/glossaryReference}})
1.1	491
84.1	492	Description: Returns the number of flattened rows in the result cube.
1.1	493
84.1	494	Example:
1.1	495
	496	(% class="box" %)
	497	(((
84.1	498	<a href="javascript:alert((% class="wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink" %)__ddCtrl.getResultCubeLinesCount(__(%%)'chart1')" >Number of rows</a>
1.1	499	)))
	500
23.1	501
13.1	502	(% class="wikigeneratedid" %)
84.1	503	ddCtrl.getLastDimensionDate('data model ID', 'Time dimension')
13.1	504
	505	(% class="wikigeneratedid" %)
84.1	506	Description: Returns the maximum date of a time dimension as a timestamp.
13.1	507
	508	(% class="wikigeneratedid" %)
84.1	509	Example:
13.1	510
14.1	511	(% class="box" %)
	512	(((
84.1	513	<a href="javascript:alert((% class="wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink" %)__ddCtrl.__(%%)getLastDimensionDate(% class="wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink" %)__(__(%%)'a866caa04fabdd35687fa3bd3758d6a8', 'Date')" >Maximum date</a>
14.1	514	)))
13.1	515
36.1	516
84.1	517	ddCtrl.getCubeValue ("data model ID", [filters], 'dimension or measure name', bUseContext)
36.1	518
84.1	519	Description: Retrieves the value of a measure or the member of a dimension in a data model with the filters applied (so that only one row of data is returned by the server).
	520	The UseContext parameter, which is a Boolean, allows you to specify whether or not the dashboard’s filtering context should be taken into account when calculating the data.
37.1	521
84.1	522	Example: To retrieve the value of the ‘Communication Cost’ measure with the filtered elements ‘Mobile’ for //Line Type// and ‘Samsung Galaxy’ for //Hardware, //in the data model with the identifier// " //0b2583609f86d37754ce2ada372f31ae", and taking into account the dashboard’s filter context:
37.1	523
38.1	524	(% class="box" %)
	525	(((
84.1	526	<a href="javascript:alert(ddCtrl.getCubeValue("0b2583609f86d37754ce2ada372f31ae", [{"dim":"Line type", "member":"Mobile"}, {"dim":"Hardware", "member":"Samsung Galaxy"}], 'Communication cost', true)">Communication cost value</a>
38.1	527	)))
36.1	528
84.1	529	ddCtrl.getFlowValue ("flow ID", [filters], 'dimension or measure name', bUseContext)
36.1	530
84.1	531	Description: Retrieves the value of a measure or the member of a dimension in a {{glossaryReference glossaryId="Glossary" entryId="Flux"}}Flow{{/glossaryReference}} with the filters applied (so that only one row of data is returned by the server).
	532	The UseContext parameter, which is a Boolean, allows you to specify whether or not to take the dashboard’s filtering context into account when calculating the data.
38.1	533
84.1	534	Example: To retrieve the member of the ‘Line Type’ dimension with the filtered element “Samsung Galaxy” for //Hardware, in //the flow with the identifier// “ //b312f6be”, and without taking the dashboard’s filter context into account:
38.1	535
	536	(% class="box" %)
	537	(((
84.1	538	<a href="javascript:alert(ddCtrl.getFlowValue("b312f6be", [{"dim":"Hardware", "member":"Samsung Galaxy"}], 'Line Type', false)>Line Type member</a>
38.1	539	)))
	540
84.1	541	= Dashboard functions{{id name="Fonction_TDB"/}} =
1.1	542
35.1	543	(% class="box infomessage" %)
	544	(((
84.1	545	ℹ For functions involving PDF export, adding an HTML report or advanced formatting may cause rendering issues.
35.1	546	)))
	547
1.1	548	void ddCtrl.loadJS (urlJS)
	549
84.1	550	Description: Loads a JavaScript file from a URL.
1.1	551
84.1	552	Example (in the JavaScript editor):
1.1	553
7.1	554	{{code language="javascript" cssClass="notranslate"}}
1.1	555	ddCtrl.loadJS('http://crypto-js.googlecode.com/svn/tags/3.1.2/build/rollups/md5.js');
	556	var hash = CryptoJS.MD5("Le message");
	557	{{/code}}
	558
	559
84.1	560	void ddCtrl.includeJS (JS_name)
1.1	561
84.1	562	Description: Loads a JavaScript file from the DigDash Enterprise configuration folder. The file must have been created beforehand using the JavaScript editor in the dashboard editor.
1.1	563
84.1	564	Example (in the JavaScript editor):
1.1	565
7.1	566	{{code language="javascript" cssClass="notranslate"}}
1.1	567	ddCtrl.includeJS('fonctions_date.js');
	568	{{/code}}
	569
32.1	570
	571
84.1	572	void ddCtrl.drawFlowInElement ('HTML element or widget ID', '{{glossaryReference glossaryId="Glossary" entryId="Flux"}}Flow{{/glossaryReference}} ID');
1.1	573
84.1	574	Description: Displays a flow within an HTML element
31.1	575
84.1	576	Example (in the JavaScript editor):
31.1	577
34.1	578	(% class="box" %)
	579	(((
84.1	580	<A href="javascript:ddCtrl.drawFlowInElement ('elementHTMLId', 'fluxId')">Display {{glossaryReference glossaryId="Glossary" entryId="Flux"}}Flow{{/glossaryReference}}</A>
34.1	581	)))
31.1	582
46.1	583	(% class="box infomessage" %)
	584	(((
84.1	585	💡The ID is that of the portlet. You can copy it from the Information tab in the element’s Settings panel.
47.1	586
46.1	587	[[image:1747310722673-137.png]]
84.1	588	\\For example: <A href="javascript:ddCtrl.drawFlowInElement ('Retail_Coûts_editor', '1898358537')">Display flow</A>
46.1	589	)))
31.1	590
33.1	591
1.1	592	void ddCtrl.changePage (page)
	593
	594	void ddCtrl.switchPage (page)
	595
84.1	596	Description: Changes the current page to <page>.
1.1	597
84.1	598	Example:
1.1	599
	600	(% class="box" %)
	601	(((
84.1	602	<a href="javascript:__ddCtrl.changePage__('Général.Index')">Back to index</a>
1.1	603	)))
	604
	605
	606	void ddCtrl.nextPage ()
	607
84.1	608	Description: Moves to the next page (same function).
1.1	609
84.1	610	Example:
1.1	611
	612	(% class="box" %)
	613	(((
84.1	614	<a href="javascript:__ddCtrl.nextPage__()">Next page</a>
1.1	615	)))
	616
	617
	618	void ddCtrl.prevPage ()
	619
84.1	620	Description: Moves to the previous page (same role).
1.1	621
84.1	622	Example:
1.1	623
	624	(% class="box" %)
	625	(((
84.1	626	<a href="javascript:__ddCtrl.prevPage__()">Previous page</a>
1.1	627	)))
	628
	629
84.1	630	(Boolean) ddCtrl.isCurrentPage (page)
1.1	631
84.1	632	Description: Returns true if the current page is the page with the ID specified as a parameter. Returns false otherwise.
1.1	633
	634	(% class="box infomessage" %)
	635	(((
84.1	636	Note: This function replaces the deprecated function __ddCtrl.getCurrentPage__ ()
1.1	637	)))
	638
	639
84.1	640	(String) ddCtrl.getCurrentPage ()
1.1	641
84.1	642	Description: Returns the name of the current page in the following format: <//Role name>.<Page name>//.
1.1	643
	644	(% class="box warningmessage" %)
	645	(((
84.1	646	Deprecated: This function has not been supported since November 2014 due to a change in the page name format. Please use the function __ddCtrl.isCurrentPage__ (page) instead.
1.1	647	)))
	648
	649
84.1	650	(Boolean) ddCtrl.isPageLoaded(page)
6.1	651
84.1	652	Description: Returns true if the specified page has already been loaded. Returns false otherwise.
6.1	653
	654
84.1	655	(Boolean) ddCtrl.isCurrentPageLoaded()
56.1	656
84.1	657	Description: Returns true if the current page has already been loaded. Returns false otherwise.
56.1	658
	659
84.1	660	(Object) ddCtrl.getPage(page)
6.1	661
84.1	662	Description: Returns an object containing certain properties (ID, name, title, list of objects, etc.) of the specified page.
6.1	663
	664
84.1	665	(Array) ddCtrl.getPagePath (page)
6.1	666
84.1	667	Description: Returns an array containing the page path (role / page group / page).
6.1	668
	669
84.1	670	(Array) ddCtrl.dashboardPages
6.1	671
84.1	672	Description: An array containing all the pages for all roles of the logged-in user.
6.1	673
84.1	674	Example:
6.1	675
46.1	676	(% aria-label="Élément macro : code" contenteditable="false" role="region" tabindex="-1" %)
	677	(((
47.1	678	{{code language="shell"}}
	679	ddCtrl.addCurrentPageLoadListener(function()
	680	{
21.1	681	console.log(ddCtrl.dashboardPages);
47.1	682	});
	683	{{/code}}
6.1	684
84.1	685	(% 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"]]
46.1	686	)))
	687
	688
84.1	689	(Boolean) canChangeCurrentPage (page)
1.1	690
84.1	691	Description: Returns true if it is possible to switch to the page <page>. Returns false otherwise.
1.1	692
	693
	694	void ddCtrl.hidePage (page)
	695
84.1	696	Description: Hides the tab for page <page> if it is visible, without changing the current page.
1.1	697
84.1	698	Example:
1.1	699
	700	(% class="box" %)
	701	(((
84.1	702	<a href="javascript:__ddCtrl.hidePage__('Production.Détails Pays'); __ddCtrl.changePage__('Production.Global')">Exit details</a>
1.1	703	)))
	704
	705
	706	void ddCtrl.showPage (page)
	707
84.1	708	Description: Displays the tab for page <page> if it is hidden, without changing the current page.
1.1	709
84.1	710	Example:
1.1	711
	712	(% class="box" %)
	713	(((
84.1	714	<a href="javascript:__ddCtrl.showPage__('Production.Détails Pays'); __ddCtrl.changePage__('Production.Détails Pays')">Show details</a>
1.1	715	)))
	716
	717
84.1	718	void ddCtrl.openFlowInWindow (flow, iWidth, iHeight)
1.1	719
84.1	720	Description: Opens a flow in a pop-up window with the specified width and height.
1.1	721
84.1	722	Example:
1.1	723
	724	(% class="box" %)
	725	(((
84.1	726	<a href="javascript:__ddCtrl.openFlowInWindow__('fluxId', '250', '200')">Display product breakdown</a>
1.1	727	)))
	728
	729
84.1	730	void ddCtrl.openPortletInWindow (portlet, iWidth, iHeight)
1.1	731
84.1	732	Description: Opens a portlet in a pop-up window with the specified width and height.
1.1	733
84.1	734	Example:
12.1	735
1.1	736	(% class="box" %)
	737	(((
84.1	738	<a href="javascript:__ddCtrl.openPortletInWindow__('portletId', '250', '200')">Display product breakdown</a>
1.1	739	)))
	740
	741
84.1	742	void ddCtrl.openFlowInWindowWithFilter (flow, iWidth, iHeight, dimension, member [, dimension, member, ...])
1.1	743
84.1	744	Description: Opens a flow in a pop-up window with specified width and height, and filters it by the dimension(s) and member(s) specified as parameters (a list of dimension/member pairs).
1.1	745
	746	(% class="box infomessage" %)
	747	(((
84.1	748	Note: Filters will only be applied to the new window.
1.1	749	)))
	750
84.1	751	Example:
1.1	752
	753	(% class="box" %)
	754	(((
84.1	755	<a href="javascript:__ddCtrl.openFlowInWindowWithFilter__('fluxId', '250', '200', 'Année', '2014', 'Pays', 'France')">Display details for France 2014</a>
1.1	756	)))
	757
	758
84.1	759	void ddCtrl.openPortletInWindowWithFilter (portlet, iWidth, iHeight, dimension, member [, dimension, member, ...])
1.1	760
84.1	761	Description: Opens a portlet in a pop-up window with the specified width and height, and applies a filter based on the dimensions and members specified as parameters (a list of dimension/member pairs).
1.1	762
	763	(% class="box infomessage" %)
	764	(((
84.1	765	Note: Filters will only be applied to the new window.
1.1	766	)))
	767
84.1	768	Example:
1.1	769
	770	(% class="box" %)
	771	(((
84.1	772	<a href="javascript:__ddCtrl.openPortletInWindowWithFilter__('portletId', '250', '200', 'Année', '2014', 'Pays', 'France')">Display details for France 2014</a>
1.1	773	)))
	774
	775
84.1	776	void ddCtrl.closeFlowInWindow (flow)
12.1	777
84.1	778	Description: Allows you to programmatically close a pop-up displayed using the openFlowInWindow, openPortletInWindow and openFormInWindow functions.
12.1	779
84.1	780	This function takes as a parameter the identifier that was passed to the function used to display the pop-up.
12.1	781
84.1	782	Example:
12.1	783
46.1	784	(% aria-label="Élément macro : code" contenteditable="false" role="region" tabindex="-1" %)
	785	(((
47.1	786	{{code}}
	787	ddCtrl.openFlowInWindow('716abf12', '80%', '80%');
12.1	788
47.1	789	ddCtrl.closeFlowInWindow('716abf12')
	790	{{/code}}
12.1	791
84.1	792	(% 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"]]
46.1	793	)))
	794
	795
1.1	796	void ddCtrl.openDocument (serverName, fileName)
	797
84.1	798	Description: Opens a document in a new window.
1.1	799
84.1	800	Example:
1.1	801
	802	(% class="box" %)
	803	(((
84.1	804	<a href="javascript:__ddCtrl.openDocument__('Common Datasources', 'catalogue_produits.pdf')">Display the product catalogue</a>
1.1	805	)))
	806
	807
	808	void ddCtrl.uploadDocument (serverName, fileName)
	809
84.1	810	Description: Uploads a document to a document server. Opens a file selection window on the workstation.
1.1	811
84.1	812	Example:
1.1	813
	814	(% class="box" %)
	815	(((
84.1	816	<a href="javascript:(% class="wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink" %)__ddCtrl.uploadDocument__(%%)('Common Datasources', 'catalogue_produits.pdf')">Upload the product catalogue</a>
1.1	817	)))
	818
	819
24.1	820	void ddCtrl.deleteDocument (serverName, fileName)
	821
84.1	822	Description: Deletes a document from the document server.
24.1	823
84.1	824	Example:
24.1	825
	826	(% class="box" %)
	827	(((
84.1	828	<a href="javascript:__ddCtrl.deleteDocument__('Common Datasources', 'catalogue_produits.pdf')">Delete the product catalogue</a>
24.1	829	)))
	830
	831
	832	void ddCtrl.downloadDocument (serverName, fileName)
	833
84.1	834	Description: Downloads a document from the document server.
24.1	835
84.1	836	Example:
24.1	837
	838	(% class="box" %)
	839	(((
84.1	840	<a href="javascript:__ddCtrl.downloadDocument__('Common Datasources', 'catalogue_produits.pdf')">Download the product catalogue</a>
24.1	841	)))
	842
	843
	844
1.1	845	void ddCtrl.refreshDashboard ()
	846
84.1	847	Description: Refreshes the dashboard (same behaviour as the Refresh button in the dashboard header).
1.1	848
84.1	849	Example:
1.1	850
	851	(% class="box" %)
	852	(((
84.1	853	<a href="javascript:__ddCtrl.refreshDashboard__()">Refresh</a>
1.1	854	)))
	855
	856
84.1	857	void ddCtrl.refreshFlow (flow, [event])
1.1	858
84.1	859	Description: Refreshes the specified flow with an optional event name.
1.1	860
84.1	861	Example:
1.1	862
	863	(% class="box" %)
	864	(((
84.1	865	<A href="javascript:__ddCtrl.refreshFlow__('flowId', 'MAJ_QUOTIDIENNE')">Refresh {{glossaryReference glossaryId="Glossary" entryId="Flux"}}Flow{{/glossaryReference}}</A>
1.1	866	)))
	867
	868
84.1	869	void ddCtrl.refreshFlows ([event])
1.1	870
84.1	871	Description: Refreshes all flows on the dashboard with an optional event name.
1.1	872
84.1	873	Example:
1.1	874
	875	(% class="box" %)
	876	(((
84.1	877	<a href="javascript:__ddCtrl.refreshFlows__('MAJ_QUOTIDIENNE')"> Refresh all </a>
1.1	878	)))
	879
	880
84.1	881	(String) ddCtrl.getCurrentRole ()
1.1	882
84.1	883	Description: Returns the role ID of the current page or the user’s name for a user page.
1.1	884
	885
84.1	886	(String) ddCtrl.getRole(page)
1.1	887
84.1	888	Description: Returns the role ID of the specified page (e.g. previously retrieved by __ddCtrl.getCurrentPage__()) or the user’s name if this page is a user page.
1.1	889
	890
	891	void ddCtrl.hidePortlet (portlet)
	892
	893	void ddCtrl.showPortlet (portlet)
	894
43.1	895	(% class="box warningmessage" %)
	896	(((
84.1	897	❗These functions must only be used on portlets present on the current page.
43.1	898	)))
	899
84.1	900	Description: Hides or displays the specified chart portlet. The portlet parameter is an identifier that can be retrieved in the dashboard editor via the portlet’s ‘Information’ menu.
1.1	901
84.1	902	Example:
1.1	903
	904	(% class="box" %)
	905	(((
84.1	906	<a href="javascript:__ddCtrl.showPortlet__('portletId')">Show Details</a>
1.1	907	)))
	908
	909
	910	void ddCtrl.setPortletPos (portlet, x, y)
	911
	912	void ddCtrl.setPortletSize (portlet, width, height)
	913
84.1	914	Description: Positions or resizes the portlet to the specified coordinates or dimensions. The `portlet` parameter is an identifier that can be retrieved in the dashboard editor via the portlet’s ‘Information’ menu.
1.1	915
84.1	916	Example:
1.1	917
	918	(% class="box" %)
	919	(((
84.1	920	<a href="javascript:__ddCtrl.setPortletPos__('portletId', '100', '100'); __ddCtrl.setPortletSize__('portletId', '600', '400')">Expand Details</a>
1.1	921	)))
	922
	923
	924	void ddCtrl.setPortletMargins (portlet, marginTop, marginRight, marginBottom, marginLeft)
	925
84.1	926	Description: Specifies the margins to be added to the portlet. The `portlet` parameter is an identifier that can be retrieved from the dashboard editor via the portlet’s Information menu.
1.1	927
84.1	928	Example:
1.1	929
	930	(% class="box" %)
	931	(((
84.1	932	<a href="javascript:__ddCtrl.setPortletPos__('portletId', '10', '10', '10', '10'); __ddCtrl.setPortletMargins__('portletId', '600', '400')">Change the margins</a>
1.1	933	)))
	934
	935
84.1	936	(Boolean) ddCtrl.chartIsHidden (portlet)
1.1	937
84.1	938	Description: Returns true when the portlet is hidden (see hideChart) and false otherwise.
1.1	939
	940
84.1	941	void ddCtrl.genTemplatePPT ({{glossaryReference glossaryId="Glossary" entryId="Flux"}}Flow{{/glossaryReference}})
1.1	942
84.1	943	Description: Runs a PowerPoint {{glossaryReference glossaryId="Glossary" entryId="fabrique de documents"}}document builder{{/glossaryReference}} flow (saves the PPT) with the identifier flowId using the current selection from the dashboard. The user is offered the option to download the generated PPT.
1.1	944
84.1	945	Example:
1.1	946
	947	(% class="box" %)
	948	(((
84.1	949	<A href="javascript:__ddCtrl.genTemplatePPT__('Id Fabrique De Document')">Download PPT</A>
1.1	950	)))
	951
	952
	953	void ddCtrl.exportCurrentPageAsPPT ()
	954
84.1	955	Description: Saves the current dashboard page in PPT format. The user is offered the option to download the generated PPT.
75.1	956
84.1	957	Example:
1.1	958
	959	(% class="box" %)
	960	(((
84.1	961	<a href="javascript:__ddCtrl.exportCurrentPageAsPPT__()">Download this page as a PPT</a>
1.1	962	)))
	963
	964
	965	void ddCtrl.exportPageAsPPT (role, page)
	966
84.1	967	Description: Saves the page corresponding to the role and page ID specified as parameters. The user is prompted to download the generated PPT. The page ID can be retrieved in the dashboard editor (right-click on a page tab).
75.1	968
84.1	969	Example:
1.1	970
	971	(% class="box" %)
	972	(((
84.1	973	<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')">Load the telecoms sales PPT</a>
1.1	974	)))
	975
	976
84.1	977	void ddCtrl.genTemplatePDF(flow)
1.1	978
84.1	979	Description: Runs a ‘PDF builder’ flow (saves the PDF) with the identifier flowId using the current selection from the dashboard. The user is prompted to download the generated PDF.
1.1	980
84.1	981	Example:
1.1	982
	983	(% class="box" %)
	984	(((
84.1	985	<A href="javascript:__ddCtrl.genTemplatePDF__('Id Fabrique De Document')">Download the PDF</A>
1.1	986	)))
	987
	988
	989	void ddCtrl.exportCurrentPageAsPDF ()
	990
84.1	991	Description: Saves the current dashboard page in PDF format. The user is offered the option to download the generated PDF.
75.1	992
84.1	993	Example:
1.1	994
	995	(% class="box" %)
	996	(((
84.1	997	<a href="javascript:__ddCtrl.exportCurrentPageAsPDF__()">Download this page as a PDF</a>
1.1	998	)))
	999
	1000
	1001	void ddCtrl.exportPageAsPDF (role, page)
	1002
84.1	1003	Description: Saves the page corresponding to the role and page ID specified as parameters. The user is offered the option to download the generated PDF. The page ID can be retrieved in the dashboard editor (right-click on a page tab).
75.1	1004
84.1	1005	Example:
1.1	1006
	1007	(% class="box" %)
	1008	(((
84.1	1009	<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.__(%%)__exportPageAsPDF__('Telecom', 'telecom_ventes_1')">Download the telecoms sales PDF</a>
1.1	1010	)))
	1011
	1012
84.1	1013	void ddCtrl.genTemplateXLS ({{glossaryReference glossaryId="Glossary" entryId="Flux"}}Flow{{/glossaryReference}})
1.1	1014
84.1	1015	Description: Runs an Excel {{glossaryReference glossaryId="Glossary" entryId="fabrique de documents"}}document builder{{/glossaryReference}} flow (saves the XLS file) with the identifier flowId using the current selection from the dashboard. The user is prompted to download the generated XLS file.
1.1	1016
84.1	1017	Example:
1.1	1018
	1019	(% class="box" %)
	1020	(((
84.1	1021	<A href="javascript:__ddCtrl.genTemplateXLS__('Id Fabrique De Document')">Download the XLS</A>
1.1	1022	)))
	1023
84.1	1024	void ddCtrl.genTemplateHTML ({{glossaryReference glossaryId="Glossary" entryId="Flux"}}Flow{{/glossaryReference}})
1.1	1025
84.1	1026	Description: Runs an {{glossaryReference glossaryId="Glossary" entryId="Fabrique HTML"}}HTML Builder{{/glossaryReference}} flow (saves the HTML) with the identifier flowId using the current selection from the dashboard. The user is offered the option to download the generated HTML.
29.1	1027
84.1	1028	Example:
29.1	1029
	1030	(% class="box" %)
	1031	(((
84.1	1032	<A href="javascript:__ddCtrl.genTemplateHTML__('Id Fabrique De Document')">Download the HTML</A>
29.1	1033	)))
	1034
84.1	1035	void ddCtrl.exportAsPDF ({{glossaryReference glossaryId="Glossary" entryId="Flux"}}Flow{{/glossaryReference}})
1.1	1036
84.1	1037	Description: Saves the flow as a PDF. The user is offered the option to download the generated PDF.
1.1	1038
	1039
84.1	1040	void ddCtrl.exportAsPPT ({{glossaryReference glossaryId="Glossary" entryId="Flux"}}Flow{{/glossaryReference}})
1.1	1041
84.1	1042	Description: Saves the flow as a PPT. The user is offered the option to download the generated PPT.
1.1	1043
	1044
84.1	1045	void ddCtrl.exportAsXLS ({{glossaryReference glossaryId="Glossary" entryId="Flux"}}Flow{{/glossaryReference}})
1.1	1046
84.1	1047	Description: Saves the flow as an XLS file. The user is offered the option to download the generated XLS file.
1.1	1048
	1049
84.1	1050	void ddCtrl.exportAsXLSWithoutStyles ({{glossaryReference glossaryId="Glossary" entryId="Flux"}}Flow{{/glossaryReference}})
1.1	1051
84.1	1052	Description: Saves the flow as an XLS file without applying table styles to improve performance. The user is prompted to download the generated XLS file.
1.1	1053
	1054
84.1	1055	void ddCtrl.exportAsCSV ({{glossaryReference glossaryId="Glossary" entryId="Flux"}}Flow{{/glossaryReference}})
1.1	1056
84.1	1057	Description: Saves the flow as a CSV (Comma-Separated Values) file. The user is prompted to download the generated CSV file.
1.1	1058
	1059
84.1	1060	void ddCtrl.saveDashboardState (name, default)
1.1	1061
84.1	1062	Description: Saves the current state of the dashboard (page, filters, drill-down, variables). This is identical to the action triggered by the ‘Save Selection’ button in the dashboard toolbar. The name parameter is the name of the selection; the bDefault parameter enables the selection to be loaded when the dashboard starts.
1.1	1063
	1064
84.1	1065	(String) ddCtrl.getCurrentPortletInGroupOfTabs (portletTabId)
1.1	1066
84.1	1067	Description: Returns the ID of the current portlet in the Tab Group object. The `portletTabId` parameter is the ID of the Tab Group.
1.1	1068
	1069
	1070	void ddCtrl.changePortletInGroupOfTabs (portletTabId, portletId)
	1071
84.1	1072	Description: Changes the current portlet of the Tab Group object. The `portletTabId` parameter is the identifier of the Tab Group; the `portletId` parameter is the identifier of the portlet to be selected.
1.1	1073
	1074
84.1	1075	(Array) ddCtrl.getCurrentPagePath ()
1.1	1076
84.1	1077	Description: Returns the path of the current page (Role / Page / Subpage) as an array of objects. Each object has the following attributes: id, title, name, type (role/container/page).
1.1	1078
19.1	1079
18.1	1080	void ddCtrl.expandCollapseNavigationMenu()
	1081
84.1	1082	Description: Collapses the navigation menu if it is expanded, and vice versa.
18.1	1083
66.1	1084
84.1	1085	== Scale Mode Functions{{id name="scale"/}} ==
66.1	1086
84.1	1087	These functions relate to zoom selection in Scale or Grid + Scale mode.
66.1	1088
66.2	1089	void ddCtrl.setScalingZoom(zoom)
	1090
84.1	1091	Description: Sets the zoom level to the specified value.
66.2	1092
84.1	1093	Example:
66.2	1094
	1095	(% class="box" %)
	1096	(((
84.1	1097	<a href="javascript:__ddCtrl.setScalingZoom(0.65)__">Set the page zoom to 65%</a>
66.2	1098	)))
	1099
69.1	1100
66.2	1101	void ddCtrl.setScalingAdaptWidth()
	1102
84.1	1103	Description: applies the ‘Adapt to width’ zoom.
66.2	1104
	1105
69.1	1106
66.2	1107	void ddCtrl.setScalingAdaptHeight()
	1108
84.1	1109	Description: applies the ‘Adapt to height’ zoom.
66.2	1110
	1111
69.1	1112
66.2	1113	void ddCtrl.setScalingZoomRange(min, max)
	1114
84.1	1115	Description: sets the minimum and maximum zoom limits. The user will not be able to set a zoom level outside these values.
66.2	1116
84.1	1117	Example:
66.2	1118
	1119	(% class="box" %)
	1120	(((
84.1	1121	<a href="javascript:__setScalingZoomRange(0.4,1.2)__">Set a zoom range between 40 and 120%</a>
66.2	1122	)))
	1123
84.1	1124	= Event handling =
1.1	1125
84.1	1126	These listener functions are called by the system when specific events are triggered. You can therefore create new behaviours depending on different situations: a chart is refreshed or drawn, a page is changed, a dimension is filtered, etc. The best place to implement these behaviours is in the global JavaScript editor, accessible via the options menu in the dashboard editor.
1.1	1127
84.1	1128	== Dashboard Events Diagram ==
1.1	1129
84.1	1130	(% 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" %)
1.1	1131
84.1	1132	void ddCtrl.addChartBeforeRefreshListener (Function)
1.1	1133
84.1	1134	Description: Adds a listener function for the event triggered before the chart is refreshed.
1.1	1135
84.1	1136	Example:
1.1	1137
	1138	(% class="box" %)
	1139	(((
84.1	1140	ddCtrl.addChartBeforeRefreshListener(function(doc, dm, dmsel, chart, errorMsg) { alert("The chart " + chart.title + " is about to be refreshed"); });
1.1	1141	)))
	1142
	1143
84.1	1144	void ddCtrl.addChartRefreshListener (Function)
1.1	1145
84.1	1146	Description: Adds a function to listen for the event triggered after the chart has been refreshed.
1.1	1147
84.1	1148	Example:
1.1	1149
	1150	(% class="box" %)
	1151	(((
84.1	1152	ddCtrl.addChartRefreshListener(function(doc, dm, dmsel, chart, errorMsg) { alert("The chart " + chart.title + " has been refreshed"); });
1.1	1153	)))
	1154
	1155
84.1	1156	void ddCtrl.addChartDrawnListener (Function)
1.1	1157
84.1	1158	Description: Adds a function to listen for the event triggered when the chart has finished being drawn (first display).
1.1	1159
84.1	1160	Example:
1.1	1161
	1162	(% class="box" %)
	1163	(((
84.1	1164	ddCtrl.addChartDrawnListener(function(doc, dm, dmsel, chart, errorMsg) { alert("The chart " + chart.title + " has been drawn"); });
1.1	1165	)))
	1166
	1167
84.1	1168	void ddCtrl.addChartModelReadyListener (Function)
1.1	1169
84.1	1170	Description: Adds a listener function for the event triggered before the chart is drawn (first display).
1.1	1171
84.1	1172	Example:
1.1	1173
	1174	(% class="box" %)
	1175	(((
84.1	1176	ddCtrl.addChartModelReadyListener(function(doc, dm, dmsel, chart, errorMsg) { alert("The chart " + chart.title + " is about to be drawn"); });
1.1	1177	)))
	1178
	1179
84.1	1180	void ddCtrl.addDimensionFilterListener (Function)
1.1	1181
84.1	1182	Description: Adds a listener function for the event triggered after a dimension has been filtered.
1.1	1183
84.1	1184	Example:
1.1	1185
	1186	(% class="box" %)
	1187	(((
84.1	1188	ddCtrl.addDimensionFilterListener(function(dimension, hierarchy, level, members, membersFormatted, bExclude, min, max) { alert("The dimension " + dimension + " has been filtered to " + membersFormatted); });
1.1	1189	)))
	1190
	1191
84.1	1192	void ddCtrl.addVariableChangeListener (Function)
1.1	1193
84.1	1194	Description: Adds a listener function for the event triggered after a variable has been changed.
1.1	1195
84.1	1196	Example:
1.1	1197
	1198	(% class="box" %)
	1199	(((
84.1	1200	ddCtrl.addVariableChangeListener(function(variable, value) { alert("The variable " + variable + " has changed; new value: " + value); });
1.1	1201	)))
	1202
67.1	1203
84.1	1204	== Dashboard Event Handling{{id name="event_tdb"/}} ==
1.1	1205
5.1	1206
84.1	1207	void ddCtrl.addDashboardLoadListener (Function)
5.1	1208
84.1	1209	Description: Adds a listener for the event triggered once the dashboard has loaded but has not yet been rendered.
5.1	1210
84.1	1211	Example:
5.1	1212
	1213	(% class="box" %)
	1214	(((
84.1	1215	ddCtrl.addDashboardLoadListener(function(currentPage) { alert("Initialising the dashboard"); });
5.1	1216	)))
	1217
	1218
	1219
84.1	1220	void ddCtrl.addCurrentPageLoadListener (Function)
1.1	1221
84.1	1222	Description: Adds a function to listen for the event triggered once the dashboard page has fully loaded.
1.1	1223
84.1	1224	Example:
1.1	1225
	1226	(% class="box" %)
	1227	(((
84.1	1228	ddCtrl.addCurrentPageLoadListener(function(currentPage) { alert("Page " + currentPage + " has been loaded"); });
1.1	1229	)))
	1230
	1231
84.1	1232	void ddCtrl.addCurrentPageChangeListener (Function)
1.1	1233
84.1	1234	Description: Adds a function to listen for the event triggered when a page changes.
1.1	1235
84.1	1236	Example:
1.1	1237
	1238	(% class="box" %)
	1239	(((
84.1	1240	ddCtrl.addCurrentPageChangeListener(function(currentPage, bFirstTime) { alert("The page is now " + currentPage); });
1.1	1241	)))
	1242
	1243
84.1	1244	void ddCtrl.addUserLoggedListener (Function)
1.1	1245
84.1	1246	Description: Event triggered once the user has been authenticated. May be useful when using the ddCtrl.getUserAttribute function.
1.1	1247
84.1	1248	Example:
1.1	1249
	1250	(% class="box" %)
	1251	(((
84.1	1252	ddCtrl.addUserLoggedListener(function() { alert("You are logged in"); });
1.1	1253	)))
	1254
	1255
84.1	1256	void ddCtrl.addPortletHiddenListener (Function)
1.1	1257
84.1	1258	Description: Event triggered when the object’s status changes from visible to hidden.
1.1	1259
84.1	1260	Example:
1.1	1261
	1262	(% class="box" %)
	1263	(((
84.1	1264	ddCtrl.addPortletHiddenListener(function(portletId) { alert("The object is hidden"); });
1.1	1265	)))
	1266
	1267
84.1	1268	void ddCtrl.addPortletVisibleListener (Function)
1.1	1269
84.1	1270	Description: Event triggered when the object’s status changes from hidden to visible.
1.1	1271
84.1	1272	Example:
1.1	1273
	1274	(% class="box" %)
	1275	(((
84.1	1276	ddCtrl.addPortletVisibleListener(function(portletId) { alert("The object is visible"); });
1.1	1277	)))
	1278
	1279
84.1	1280	void ddCtrl.addPortletCollapseListener (Function)
1.1	1281
84.1	1282	Description: Event triggered when the user clicks the icon to hide a retractable element.
1.1	1283
84.1	1284	Example:
1.1	1285
	1286	(% class="box" %)
	1287	(((
84.1	1288	ddCtrl.addPortletCollapseListener(function(portletId) { alert("The object is about to be hidden"); });
1.1	1289	)))
	1290
	1291
84.1	1292	void ddCtrl.addPortletCollapsedListener (Function)
1.1	1293
84.1	1294	Description: Event triggered once the retractable element has been hidden.
1.1	1295
84.1	1296	Example:
1.1	1297
	1298	(% class="box" %)
	1299	(((
84.1	1300	ddCtrl.addPortletCollapsedListener(function(portletId) { alert("The object is hidden"); });
1.1	1301	)))
	1302
	1303
84.1	1304	void ddCtrl.addPortletExpandListener (Function)
1.1	1305
84.1	1306	Description: Event triggered when the user clicks the icon to expand a retractable element.
1.1	1307
84.1	1308	Example:
1.1	1309
	1310	(% class="box" %)
	1311	(((
84.1	1312	ddCtrl.addPortletExpandListener(function(portletId) { alert("The object is about to be displayed"); });
1.1	1313	)))
	1314
	1315
84.1	1316	void ddCtrl.addPortletExpandedListener (Function)
1.1	1317
84.1	1318	Description: Event triggered once the retractable element has been displayed.
1.1	1319
84.1	1320	Example:
1.1	1321
	1322	(% class="box" %)
	1323	(((
84.1	1324	ddCtrl.addPortletExpandedListener(function(portletId) { alert("The object is displayed"); });
1.1	1325	)))
	1326
	1327
84.1	1328	void ddCtrl.addGroupOfTabsChangeListener (Function)
1.1	1329
84.1	1330	Description: Event triggered when the user changes the chart within a group of tabs. The first parameter is the identifier of the group of tabs object; the second is the identifier of the current portlet.
1.1	1331
84.1	1332	Example:
1.1	1333
	1334	(% class="box" %)
	1335	(((
84.1	1336	ddCtrl.addGroupOfTabsChangeListener(function(portletTabId, curPortletId) { alert("The current portlet is: " + curPortletId); });
1.1	1337	)))
	1338
	1339
84.1	1340	void ddCtrl.addDocumentUploadListener (Function)
1.1	1341
84.1	1342	Description: event triggered when the user adds a file via the dashboard.
1.1	1343
84.1	1344	Example:
1.1	1345
	1346	(% class="box" %)
	1347	(((
84.1	1348	ddCtrl.addDocumentUploadListener(function(serverName, filesName) { alert("The file " + filesName[0] + " has been successfully added"); });
1.1	1349	)))
	1350
68.1	1351
84.1	1352	void ddCtrl.addScalingZoomListener(function(zoomConfig){}) (Function){{id name="event_scale"/}}
68.1	1353
84.1	1354	Description: Adds a listener for the event triggered after a change in the zoom level for a page in Scale or Grid + Scale mode.
68.1	1355
84.1	1356	Example:
68.1	1357
	1358	(% class="box" %)
	1359	(((
	1360	ddCtrl.addScalingZoomListener(function(zoomConfig){
84.1	1361	console.log("The zoom level has been changed: " + JSON.stringify(zoomConfig));
68.1	1362	});
	1363	)))
	1364
84.1	1365	= Miscellaneous functions =
77.1	1366
84.1	1367	(String array) ddCtrl.getUserRoles ()
77.1	1368
84.1	1369	Description: Returns the list of role IDs for the logged-in user.
77.1	1370
	1371
84.1	1372	(Associative array of strings / booleans) ddCtrl.getUserACLs ()
77.1	1373
84.1	1374	Description: Returns a list of the access control list (ACL) IDs for the logged-in user. The returned list is an associative array linking the ACL ID to a Boolean (true) if the ACL is granted to the user.
77.1	1375
84.1	1376	Example:
77.1	1377
76.1	1378	(% class="box" %)
	1379	(((
84.1	1380	if (ddCtrl.getUserACLs()['SaveAsPPT']) alert("You can save as PPT");
76.1	1381	)))
	1382
84.1	1383	List of all possible authorizations:
1.1	1384
84.1	1385	AccessDBV, AccessDBE, EditDashboardForGroup, LoadWalletForGroup, SaveWalletForGroup, AddFlow, AddRoleFlow, RefreshFlow, RefreshRoleFlow, AccessServerSettings, AccessUserSettings, AccessLicenseSettings, AccessContentManagement, Scheduler, EditDataSourceForGroup, EditDataSource, SaveAsPDF, SaveAsPPT, SaveAsXLS, SaveAsXLSWithoutStyles, SaveAsCSV, ChartNavigation, SendSMS, UploadDocument, UpdateDocument, ListDocumentServers, ListDocuments, ViewComments, AddCommentDataModel, RemoveCommentDataModel, AddCommentFlow, RemoveCommentFlow, AllowIgnoreDMResivion, DashboardCustomization, DashboardJSCustom, DashboardTheme, EditProtectedDashboardPages, DashboardOfflineMode, DashboardNavigationMenu, DictionaryManager, DeviceManager, FormatManager, DBConnectionManager, ColorPaletteManager, PredefinedFunctionManager, StylesManager, HierarchyManager, IconManager, MapManager, ManageACLGroup, ManageProfil, AccessServerStatus, AccessBackup, AccessRestore, ManageScripts, ManageSentences, ManageRole, ManageAllRoles, ManageSchedules, ManageD3, PrintChart, EditUserAttributes, EditUserVariables, AssignProfil, ManageACL, EditProtectedUserVariables, UseAdHocAnalysis, SaveView, SavePublicView, ViewRestrictedData, DependencyAnalyser, TextQuery, AccessStudio, AccessDashboardAssistant, ViewAllComments, DownloadFromCMDR, CreateForm, AddFormData, ManageFormData, ManageAllForms, AllowImpersonate, ManageCommonItems, ManageRoleItems, ExportUsers, ImportUsers, ViewAllUsersInfo, SendMail, AddRole, EditFileDataSource, EditDBDataSource, EditReportDataSource, EditUnionDataSource, EditJoinDataSource, EditTransformerDataSource, EditColTransformerDataSource, EditIODataSource, EditDataCatalogDataSource, AllowSetQuotaByModel, ManageUserParams
1.1	1386
	1387
84.1	1388	(String) ddCtrl.getUserAttribute (attr)
1.1	1389
84.1	1390	Description: Returns the user’s LDAP attribute <attr>.
1.1	1391
	1392
84.1	1393	(String) ddCtrl.getUserAttribute (attr, Function)
1.1	1394
84.1	1395	Description: Returns the user’s LDAP attribute <attr> via an asynchronous call function.
1.1	1396
84.1	1397	Example:
1.1	1398
	1399	(% class="box" %)
	1400	(((
	1401	ddCtrl.getUserAttribute('displayName', function (attrVal) {alert(attrVal)});
	1402	)))
	1403
	1404
84.1	1405	(String) ddCtrl.getSessionAttribute (attr)
1.1	1406
84.1	1407	Description: Returns the <attr> attribute of the user’s session.
1.1	1408
84.1	1409	See the [[Session Variables Tutorial>>doc:Digdash.user_guide.tutorials.session_variables_tutorial.WebHome]] for more information on session variables.
1.1	1410
	1411
84.1	1412	(String) ddCtrl.getSessionAttribute (attr, Function)
1.1	1413
84.1	1414	Description: Returns the <attr> attribute of the user session via an asynchronous callback function.
1.1	1415
84.1	1416	Example:
1.1	1417
	1418	(% class="box" %)
	1419	(((
84.1	1420	ddCtrl.getSessionAttribute('regionSelected', function (attrVal) {alert(attrVal)});
1.1	1421	)))
	1422
84.1	1423	See the [[Session Variables Tutorial>>doc:Digdash.user_guide.tutorials.session_variables_tutorial.WebHome]] for more information on session variables.
1.1	1424
	1425
84.1	1426	void ddCtrl.setSessionAttribute (attr, value)
1.1	1427
84.1	1428	Description: Updates the <attr> attribute of the user session with the specified value.
1.1	1429
84.1	1430	Example:
1.1	1431
	1432	(% class="box" %)
	1433	(((
84.1	1434	ddCtrl.setSessionAttribute('regionSelected', ‘France’);
1.1	1435	)))
	1436
84.1	1437	See the [[Session Variables Tutorial>>doc:Digdash.user_guide.tutorials.session_variables_tutorial.WebHome]] for more information on session variables.
1.1	1438
	1439
84.1	1440	(String) ddCtrl.getServerAttribute (attr)
1.1	1441
84.1	1442	Description: Returns the <ATTR> attribute of the server. Server attributes (or variables) allow you to specify constants used in data models and Flows via the keyword ${server.<ATTR>}.
1.1	1443
84.1	1444	See the [[Advanced System Settings>>doc:Digdash.deployment.configuration.advanced_system_guide.WebHome]] for more information on server variables.
1.1	1445
	1446
84.1	1447	(String) ddCtrl.getServerAttribute (attr, Function)
1.1	1448
84.1	1449	Description: Returns the <attr> server attribute via an asynchronous call.
1.1	1450
84.1	1451	Example:
1.1	1452
	1453	(% class="box" %)
	1454	(((
	1455	ddCtrl.getSessionAttribute('serverMode', function (attrVal) {alert(attrVal)});
	1456	)))
	1457
84.1	1458	See the [[Advanced System Settings>>doc:Digdash.deployment.configuration.advanced_system_guide.WebHome]] for more information on server variables.
1.1	1459
	1460
84.1	1461	(String) ddCtrl.getUserStorage (attr)
5.1	1462
84.1	1463	Description: Returns the <attr> attribute of the specified user that was previously saved.
5.1	1464
84.1	1465	Example:
5.1	1466
	1467	(% class="box" %)
	1468	(((
84.1	1469	var value = ddCtrl.getUserStorage('attribute');
5.1	1470	)))
	1471
84.1	1472	void ddCtrl.setUserStorage (attr, value)
5.1	1473
84.1	1474	Description: Saves the user’s <attr> attribute persistently on the server for future use.
5.1	1475
84.1	1476	Example:
5.1	1477
	1478	(% class="box" %)
	1479	(((
84.1	1480	ddCtrl.setUserStorage('attribute', 'value');
5.1	1481	)))
	1482
	1483
84.1	1484	void ddCtrl.fireRefreshEvent (event)
5.1	1485
84.1	1486	Description: Triggers a server-side refresh of the data associated with the specified event
6.1	1487
84.1	1488	Example:
6.1	1489
	1490	(% class="box" %)
	1491	(((
84.1	1492	ddCtrl.fireRefreshEvent('DAILY_UPDATE');
6.1	1493	)))
	1494
	1495
84.1	1496	void ddCtrl.newAuthToken ()
8.1	1497
84.1	1498	Description: Returns an authentication token generated for the current session.
8.1	1499
84.1	1500	Example:
8.1	1501
	1502	(% class="box" %)
	1503	(((
	1504	var token = ddCtrl.newAuthToken();
	1505
27.1	1506	window.open("http:~/~/localhost:8080/digdash_dashboard/index.html?user=mon_user&authToken=token");
8.1	1507	)))
	1508
	1509
84.1	1510	void loadCSS(cssFile)
1.1	1511
84.1	1512	Description: Loads a CSS file.
1.1	1513
	1514
	1515	void ddCtrl.loadTheme (cssTheme)
	1516
84.1	1517	Description: Loads a DigDash CSS theme onto the dashboard.
1.1	1518
84.1	1519	Example:
1.1	1520
	1521	(% class="box" %)
	1522	(((
	1523	ddCtrl.loadTheme(‘digdash’);
	1524	)))
	1525
6.1	1526	void ddCtrl.removeTheme (cssTheme)
1.1	1527
84.1	1528	Description: Removes the DigDash CSS theme from the dashboard.
6.1	1529
84.1	1530	Example:
6.1	1531
	1532	(% class="box" %)
	1533	(((
84.1	1534	ddCtrl.removeTheme('digdash');
6.1	1535	)))
	1536
84.1	1537	void openFormInWindow (portlet, width, height, dimension, member [, dimension, member, ...])
9.1	1538
84.1	1539	Description: Opens a form (where `portlet` is the form object added to a dashboard page) in a pop-up window and filters it by the dimension(s) and member(s) specified as parameters (a list of dimension/member pairs).
9.1	1540
84.1	1541	Example:
9.1	1542
	1543	(% class="box" %)
	1544	(((
84.1	1545	<a href="javascript:__ddCtrl.openFormInWindow__('portletId', '80%', '80%', 'Year', '2024', 'Country', 'France')">Displays the form with the values ‘France 2024’</a>
9.1	1546	)))
	1547
12.1	1548
84.1	1549	void initFormData (portlet, field name, field value [, name, value, ...])
9.1	1550
84.1	1551	Description: Initialises a form with the values specified as parameters (a list of key-value pairs for the form fields).
9.1	1552
84.1	1553	Example:
9.1	1554
	1555	(% class="box" %)
	1556	(((
84.1	1557	<a href="javascript:__ddCtrl.initFormData__('1906313430','//f_project_name//','DigDash')">Initialises the form with the value ‘DigDash’ for the ‘Project Name’ field</a>
9.1	1558	)))
	1559
84.1	1560	* To retrieve the portlet ID, open the portlet’s Information tab in the Dashboard Editor and copy the Unique ID.
	1561	* To retrieve the key for a form field: edit the form, click the ‘Edit JSON ’ button in the top right-hand corner of the form and copy the ‘key’ value: in this example, //‘f_project_name//’.
9.1	1562
1.1	1563	void logout ()
	1564
84.1	1565	Description: Logs out the current user.

Wiki source code of Dashboard API

Sommaire