Wiki source code of Intégrer un portlet (graphique ou autre élément) dans une page web
Last modified by Aurelie Bertrand on 2026/06/22 14:34
Show last authors
| author | version | line-number | content |
|---|---|---|---|
| 1 | {{ddtoc/}} | ||
| 2 | |||
| 3 | ---- | ||
| 4 | |||
| 5 | In this documentation, we are working within the following context: | ||
| 6 | |||
| 7 | * Server name: ddsrv | ||
| 8 | * Port: 8080 | ||
| 9 | * DigDash domain: ddenterpriseapi | ||
| 10 | * DigDash dashboard domain: digdash_dashboard | ||
| 11 | |||
| 12 | You will, of course, need to adapt the integration to your own environment. | ||
| 13 | |||
| 14 | (% class="box" %) | ||
| 15 | ((( | ||
| 16 | 💡** **You can also use a server-side authentication mechanism to avoid having to use a username and password. See the page [[URL anonymisation>>doc:Digdash.webIntegration.anonymisation_url.WebHome]] for further details. | ||
| 17 | In this case, the //authToken// parameter replaces the //pass// parameter. | ||
| 18 | ))) | ||
| 19 | |||
| 20 | = iFrame integration mode = | ||
| 21 | |||
| 22 | (% class="box infomessage" id="HIntE9grerungraphique28flux29" %) | ||
| 23 | ((( | ||
| 24 | ℹ In iFrame mode, only a graphical portlet ({{glossaryReference glossaryId="Glossary" entryId="Flux"}}Flow{{/glossaryReference}}) can be embedded. Other portlets (filters, legend, comments, etc.) cannot be embedded. | ||
| 25 | ))) | ||
| 26 | |||
| 27 | You can embed a chart ({{glossaryReference glossaryId="Glossary" entryId="Flux"}}Flow{{/glossaryReference}}) from your information portfolio into an iframe using a URL in the following format: | ||
| 28 | |||
| 29 | {{code language="html"}} | ||
| 30 | http://ddsrv:8080/ddenterpriseapi/viewflow?flowId=<flowid> | ||
| 31 | {{/code}} | ||
| 32 | |||
| 33 | You can easily obtain the URL for a flow from the flow management panel in Studio. To do this, right-click on the flow and select **‘Copy flow URL’.** | ||
| 34 | |||
| 35 | **[[image:Copy_flow_url_en.png||alt="Copy flow url" height="445" width="443"]]** | ||
| 36 | |||
| 37 | For example: | ||
| 38 | |||
| 39 | {{code language="html"}} | ||
| 40 | http://ddsrv:8080/ddenterpriseapi/viewflow?flowId=15455f95 | ||
| 41 | {{/code}} | ||
| 42 | |||
| 43 | It is possible to pass parameters in this URL, which will be read by the application to authenticate and customise the content displayed. | ||
| 44 | These parameters are added as a query string at the end of the URL, after a question mark //(?)//. | ||
| 45 | Each parameter is a //key=value// pair, and the different pairs are separated by an //ampersand (&//). | ||
| 46 | See the section [[Available parameters>>doc:||anchor="Paramètres_iframe"]] for a list of parameters. | ||
| 47 | |||
| 48 | For example, to display the graph using: | ||
| 49 | |||
| 50 | * username//15455f95// | ||
| 51 | * the username //‘user1’// and the password //‘pass1’// | ||
| 52 | * the filter bar disabled | ||
| 53 | |||
| 54 | we embed the code in the iFrame tag as follows: | ||
| 55 | |||
| 56 | {{code}} | ||
| 57 | <iframe src="http://ddsrv:8080/ddenterpriseapi/viewflow?flowId=15455f95&user=user1&pass=pass1&hideFilters=true"></iframe> | ||
| 58 | {{/code}} | ||
| 59 | |||
| 60 | == Available parameters{{id name="Paramètres_iframe"/}} == | ||
| 61 | |||
| 62 | The parameters available for charts (flows) are as follows: | ||
| 63 | |||
| 64 | |=(% style="width: 390px;" %)Parameter|=(% style="width: 138px;" %)Value|=(% style="width: 964px;" %)Description | ||
| 65 | |(% style="width:390px" %)((( | ||
| 66 | flowId | ||
| 67 | )))|(% style="width:138px" %)((( | ||
| 68 | flowId | ||
| 69 | )))|(% style="width:964px" %)ID of the flow to be displayed | ||
| 70 | |(% style="width:390px" %)user|(% style="width:138px" %)user|(% style="width:964px" %)User to authenticate | ||
| 71 | |(% style="width:390px" %)pass|(% style="width:138px" %)password|(% style="width:964px" %)Password for the unauthenticated user | ||
| 72 | |(% style="width:390px" %)authToken|(% style="width:138px" %)token|(% style="width:964px" %)Token for the unauthenticated user | ||
| 73 | |(% style="width:390px" %)hideFilters|(% style="width:138px" %)true~|false|(% style="width:964px" %)Hides (true) or displays (false) the filter bar | ||
| 74 | |(% style="width:390px" %)variableName|(% style="width:138px" %)variableValue|(% style="width:964px" %)Specifies the value of the variable variableName | ||
| 75 | |(% style="width:390px" %)((( | ||
| 76 | dimensionName | ||
| 77 | |||
| 78 | If the dimension contains one or more hierarchies, you can select the desired hierarchy and level by adding: | ||
| 79 | |||
| 80 | * **HD**imensionName | ||
| 81 | * **LD**imensionName | ||
| 82 | )))|(% style="width:138px" %)((( | ||
| 83 | filterValue | ||
| 84 | |||
| 85 | |||
| 86 | (% style="color:#ffffff" %)yyyy | ||
| 87 | |||
| 88 | Hierarchy Name Hierarchy Level | ||
| 89 | )))|(% style="width:964px" %)((( | ||
| 90 | Specifies the filtered dimension member | ||
| 91 | |||
| 92 | (% style="color:#ffffff" %)zzzzzzz | ||
| 93 | |||
| 94 | |||
| 95 | Specifies the name of the hierarchy | ||
| 96 | Specifies the level of the hierarchy | ||
| 97 | ))) | ||
| 98 | |||
| 99 | = Embedded JavaScript integration mode = | ||
| 100 | |||
| 101 | (% class="box infomessage" %) | ||
| 102 | ((( | ||
| 103 | ℹ In this mode, in addition to charts, you can embed other types of elements: filters, legends, comments, measure selectors, variables, search and filtered elements. | ||
| 104 | ))) | ||
| 105 | |||
| 106 | (% class="wikigeneratedid" id="HChargerlefichierJavascriptDigdash" %) | ||
| 107 | This mode requires you to load the JavaScript file that enables a DigDash dashboard to be displayed on a web page. To do this, add the following line of code to the //<head>//section of your web page: | ||
| 108 | |||
| 109 | {{code}} | ||
| 110 | <script src="http://ddsrv:8080/digdash_dashboard/digdash.dashboard.js"> | ||
| 111 | {{/code}} | ||
| 112 | |||
| 113 | (% class="wikigeneratedid" %) | ||
| 114 | You can embed a DigDash dashboard either in HTML using dedicated tags, or via JavaScript for a more dynamic configuration. | ||
| 115 | |||
| 116 | == HTML integration == | ||
| 117 | |||
| 118 | A custom <DD-portlet/> tag allows you to embed a chart ({{glossaryReference glossaryId="Glossary" entryId="Flux"}}Flow{{/glossaryReference}}) or other embeddable element directly into the HTML code, without writing any JavaScript. This method is useful for simple pages or where JavaScript is not permitted. | ||
| 119 | |||
| 120 | (% class="box infomessage" %) | ||
| 121 | ((( | ||
| 122 | 💡In this case, authentication takes place just once within the first**<dd-portlet/>** tag on the page. This can be any type of portlet. | ||
| 123 | ))) | ||
| 124 | |||
| 125 | === Chart (flow) === | ||
| 126 | |||
| 127 | To embed a chart, use the code in the following format at the desired location on the web page: | ||
| 128 | |||
| 129 | {{code language="html"}} | ||
| 130 | <dd-portlet type="flow" flowId="flowId"/> | ||
| 131 | {{/code}} | ||
| 132 | |||
| 133 | In this mode, the [[parameters>>doc:||anchor="Paramètres"]] are passed directly as tag attributes. See the section [[Available parameters >>doc:||anchor="Paramètres"]]for the full list. | ||
| 134 | |||
| 135 | For example, to display a graph with: | ||
| 136 | |||
| 137 | * ID//15455f95// | ||
| 138 | * the header hidden | ||
| 139 | * key facts disabled | ||
| 140 | |||
| 141 | we use the following code: | ||
| 142 | |||
| 143 | {{code language="html"}} | ||
| 144 | <dd-portlet type="flow" flowId="flowId" showheader="false" highlightdata="false"/> | ||
| 145 | {{/code}} | ||
| 146 | |||
| 147 | (% class="wikigeneratedid" %) | ||
| 148 | If we incorporate authentication: | ||
| 149 | |||
| 150 | {{code language="html"}} | ||
| 151 | <dd-portlet user="user1" pass="pass1" type="flow" flowId="flowId" showheader="false" highlightdata="false"/> | ||
| 152 | {{/code}} | ||
| 153 | |||
| 154 | === Other elements (filters, captions, etc.) === | ||
| 155 | |||
| 156 | (% class="wikigeneratedid" id="HIntE9grationenmodeJavaScript" %) | ||
| 157 | Using the same principle, it is possible to integrate other types of elements (portlets): filters, legends, comments, measure selectors, variables, search and filtered elements. | ||
| 158 | To do this, use the following general syntax: | ||
| 159 | |||
| 160 | {{code language="html"}} | ||
| 161 | <dd-portlet type="typeDuPortlet" parameterId="value"/> | ||
| 162 | // parameterID for the other parameters according to the type | ||
| 163 | {{/code}} | ||
| 164 | |||
| 165 | (% class="wikigeneratedid" %) | ||
| 166 | See the section [[Available parameters >>doc:||anchor="Paramètres"]]for the full list. | ||
| 167 | |||
| 168 | (% class="wikigeneratedid" %) | ||
| 169 | For example, for a ‘Dimension’ filter-type content: | ||
| 170 | |||
| 171 | {{code language="html"}} | ||
| 172 | <dd-portlet type="dimension" dim="Type of line" datasource="Telecom" viztype="SlicerHorizontal" showsearch="false" showborder="false"/> | ||
| 173 | // dim : Dimension name | ||
| 174 | // datasource : Datasource name | ||
| 175 | // viztype: Vizualization type: here, horizontal list | ||
| 176 | // showsearch : Display search box | ||
| 177 | // showborder : Display border | ||
| 178 | {{/code}} | ||
| 179 | |||
| 180 | == JavaScript integration == | ||
| 181 | |||
| 182 | === Chart (flow) === | ||
| 183 | |||
| 184 | To embed a chart using JavaScript: | ||
| 185 | |||
| 186 | 1. Add a**<div>** tag with a unique identifier at the desired location on the web page: this tag will act as a container for displaying the chart. | ||
| 187 | For example: | ||
| 188 | |||
| 189 | {{code}} | ||
| 190 | <div id="tableflow"></div> // tableflow is the identifier (divId) | ||
| 191 | {{/code}} | ||
| 192 | |||
| 193 | (% start="2" %) | ||
| 194 | 1. Add the JavaScript script to initialise and display the chart. | ||
| 195 | To do this, within a <script> tag, add the following code: | ||
| 196 | |||
| 197 | {{code language="js"}} | ||
| 198 | DigDash.init({ | ||
| 199 | "url":"http://ddsrv:8080/digdash_dashboard", | ||
| 200 | "user": "user", | ||
| 201 | "pass": "pass" | ||
| 202 | }); | ||
| 203 | |||
| 204 | DigDash.drawPortlet("divId",{ | ||
| 205 | "type": "flow", | ||
| 206 | "flowId": "flowId" | ||
| 207 | }); | ||
| 208 | {{/code}} | ||
| 209 | |||
| 210 | * The**DigDash.init()** method allows you to initialise the dashboard by specifying the DigDash server URL and the authentication parameters. | ||
| 211 | * The **DigDash.drawPortlet()**method displays the element (portlet) with the specified parameters in the container defined previously. See the section [[Available Parameters >>doc:||anchor="Paramètres"]]for the full list. | ||
| 212 | |||
| 213 | (% class="box infomessage" %) | ||
| 214 | ((( | ||
| 215 | 💡 Don’t forget to call the draw() function in the body: | ||
| 216 | |||
| 217 | {{code language="html"}} | ||
| 218 | <body onload="draw()"> | ||
| 219 | {{/code}} | ||
| 220 | ))) | ||
| 221 | |||
| 222 | For example, to display a chart (divId = columnflow), we use the following script: | ||
| 223 | |||
| 224 | {{code language="html"}} | ||
| 225 | <script> | ||
| 226 | function draw() { | ||
| 227 | // Initializing connection to DigDash server | ||
| 228 | DigDash.init({ | ||
| 229 | "url": "https://ddsrv:8080/digdash_dashboard/", | ||
| 230 | "user": "user", | ||
| 231 | "pass": "pass" | ||
| 232 | }); | ||
| 233 | |||
| 234 | //Displaying column chart | ||
| 235 | DigDash.drawPortlet("columnflow", { | ||
| 236 | "type": "flow", | ||
| 237 | "flowId": "22a0cc0d", | ||
| 238 | "showborder": false, | ||
| 239 | "showheader": false | ||
| 240 | }); | ||
| 241 | } | ||
| 242 | |||
| 243 | |||
| 244 | {{/code}} | ||
| 245 | |||
| 246 | === Other elements (filters, legends, etc.) === | ||
| 247 | |||
| 248 | Using the same principle, it is possible to integrate other types of elements (portlets): filters, legends, comments, measure selectors, variables, search and filtered elements. | ||
| 249 | To do this, use the following general syntax: | ||
| 250 | |||
| 251 | {{code language="html"}} | ||
| 252 | DigDash.drawPortlet("divId", { | ||
| 253 | type: "portletType", | ||
| 254 | // otther parameters according to portlet type | ||
| 255 | }); | ||
| 256 | {{/code}} | ||
| 257 | |||
| 258 | See the section [[Available parameters >>doc:||anchor="Paramètres"]]for the full list. | ||
| 259 | |||
| 260 | For example, to display a chart (div id = columnflow) and the associated legend (div id = legend), we use the following script: | ||
| 261 | |||
| 262 | {{code language="html"}} | ||
| 263 | <script> | ||
| 264 | function draw() { | ||
| 265 | // Initializing connection to DigDash server | ||
| 266 | DigDash.init({ | ||
| 267 | "url": "https://ddsrv:8080/digdash_dashboard/", | ||
| 268 | "user": "user", | ||
| 269 | "pass": "pass" | ||
| 270 | }); | ||
| 271 | |||
| 272 | // Displaying column chart | ||
| 273 | DigDash.drawPortlet("columnflow", { | ||
| 274 | "type": "flow", | ||
| 275 | "flowId": "22a0cc0d", | ||
| 276 | "showborder": false, | ||
| 277 | "showheader": false | ||
| 278 | }); | ||
| 279 | |||
| 280 | // Legend associated to the column chart | ||
| 281 | DigDash.drawPortlet("legend", { | ||
| 282 | "type": "legend", | ||
| 283 | "flow": "22a0cc0d", | ||
| 284 | "showborder": false, | ||
| 285 | "showheader": true, | ||
| 286 | "layout": "horizontal" | ||
| 287 | }); | ||
| 288 | } | ||
| 289 | |||
| 290 | |||
| 291 | {{/code}} | ||
| 292 | |||
| 293 | == Available parameters{{id name="Paramètres"/}} == | ||
| 294 | |||
| 295 | === Parameters common to all elements (portlets) === | ||
| 296 | |||
| 297 | These parameters are available for both charts and other elements. | ||
| 298 | |||
| 299 | |(% style="background-color:grey; width:184px" %)(% style="color:#ffffff" %)**Parameter**|(% style="background-color:grey; width:233px" %)(% style="color:#ffffff" %)**Value**|(% style="background-color:grey; width:188px" %)(% style="color:#ffffff" %)**Default value**|(% style="background-color:grey; width:167px" %)(% style="color:#ffffff" %)**Dependency**|(% style="background-color:grey; width:525px" %)(% style="color:#ffffff" %)**Description** | ||
| 300 | |(% style="width:184px" %)**type**|(% style="width:233px" %)((( | ||
| 301 | "flow" | ||
| 302 | "filter" | ||
| 303 | "globalfilter" | ||
| 304 | "legend" | ||
| 305 | "comment" | ||
| 306 | "text query" | ||
| 307 | "measure selector" | ||
| 308 | "dimension" | ||
| 309 | "measurefilter" | ||
| 310 | "variable" | ||
| 311 | )))|(% style="width:188px" %)None|(% style="width:167px" %) | ||
| 312 | parameter required|(% style="width:525px" %)Portlet type:((( | ||
| 313 | * "flow": chart ({{glossaryReference glossaryId="Glossary" entryId="Flux"}}Flow{{/glossaryReference}}) | ||
| 314 | * "filter": filtered items | ||
| 315 | * "globalfilter": search | ||
| 316 | * "legend": legend | ||
| 317 | * "comment": comments | ||
| 318 | * "text query": data query | ||
| 319 | * "measure selector": measure selector | ||
| 320 | * "dimension": dimension filter | ||
| 321 | * "measurefilter": measure filter | ||
| 322 | * "variable": variable | ||
| 323 | ))) | ||
| 324 | |(% style="width:184px" %)**subtype**|(% style="width:233px" %)flow_datamodelwrapper.xml|(% style="width:188px" %)None|(% style="width:167px" %) |(% style="width:525px" %)Used to define a subtype for flows | ||
| 325 | |(% style="width:184px" %)**name**|(% style="width:233px" %)String|(% style="width:188px" %)None|(% style="width:167px" %) |(% style="width:525px" %)Name of the portlet to be displayed in the header | ||
| 326 | |(% style="width:184px" %)**colour**|(% style="width:233px" %)Hexadecimal value|(% style="width:188px" %)None|(% style="width:167px" %) |(% style="width:525px" %)Portlet background colour | ||
| 327 | |(% style="width:184px" %)**image**|(% style="width:233px" %)Path to the image|(% style="width:188px" %)None|(% style="width:167px" %) |(% style="width:525px" %)Portlet background image | ||
| 328 | |(% style="width:184px" %)**showborder**|(% style="width:233px" %)Boolean|(% style="width:188px" %)"true"|(% style="width:167px" %) |(% style="width:525px" %)Displays a border around the portlet | ||
| 329 | |(% style="width:184px" %)**showheader**|(% style="width:233px" %)Boolean|(% style="width:188px" %)"true"|(% style="width:167px" %) |(% style="width:525px" %)Displays a header above the portlet | ||
| 330 | |(% style="width:184px" %)**maximise**|(% style="width:233px" %)Boolean|(% style="width:188px" %)"false"|(% style="width:167px" %) |(% style="width:525px" %)Allows the portlet to be maximised in the Dashboard | ||
| 331 | |(% style="width:184px" %)**cssstyle**|(% style="width:233px" %)CSS class|(% style="width:188px" %)none|(% style="width:167px" %) |(% style="width:525px" %)Allows you to apply CSS to this portlet | ||
| 332 | |(% style="width:184px" %)**css**|(% style="width:233px" %)Content of the CSS class|(% style="width:188px" %)none|(% style="width:167px" %)The CSS style ` | ||
| 333 | ` must exist|(% style="width:525px" %)Contents of the CSS class | ||
| 334 | |(% style="width:184px" %)**description**|(% style="width:233px" %)String|(% style="width:188px" %)none|(% style="width:167px" %) |(% style="width:525px" %)Allows context-sensitive help to be displayed via an icon on the portlet | ||
| 335 | |||
| 336 | === Graphics-specific parameters (flows) === | ||
| 337 | |||
| 338 | |(% style="background-color:grey" %)(% style="color:#ffffff" %)**Parameter**|(% style="background-color:grey; width:235px" %)(% style="color:#ffffff" %)**Value**|(% style="background-color:grey; width:197px" %)(% style="color:#ffffff" %)**Default value**|(% style="background-color:grey; width:170px" %)(% style="color:#ffffff" %)**Dependency**|(% style="background-color:grey; width:556px" %)(% style="color:#ffffff" %)**Description** | ||
| 339 | |**highlightdata**|Boolean|"true"| |Show highlights | ||
| 340 | |**flowdetail**|"auto" or flowid|"false"| |Show flow details | ||
| 341 | |**displaycommenticon**|Boolean|"false"| |Show an icon when a comment is present | ||
| 342 | |**displaylegendicon**|Boolean|"false"| |Display an icon that shows the legend when clicked | ||
| 343 | |**layoutlegend**|"horizontal" or "vertical"|"vertical"|displaylegendicon must be set to true|Legend display type: horizontal or vertical | ||
| 344 | |**displayaxisnamelegend**|Boolean|"false"|displaylegendicon must be set to true|Show the axis title | ||
| 345 | |**menu**|Boolean|"true"| |Show the button to open the menu | ||
| 346 | |**exportCSV**|Boolean|"true"|The menu must be set to true|Enable CSV export from the menu | ||
| 347 | |**exportPDF**|Boolean|"true"|menu must be set to true|Enable PDF export from the menu | ||
| 348 | |**exportPPT**|Boolean|"true"|menu must be set to true|Enable PPT export from the menu | ||
| 349 | |**exportXLS**|Boolean|"true"|menu must be set to true|Enable Excel export from the menu | ||
| 350 | |**exportXLSWithoutStyles**|Boolean|"true"|menu must be set to true|Enable Fast Excel export from the menu | ||
| 351 | |**menuinfo**|Boolean|"true"|menu must be set to true|Enable the display of information from the menu | ||
| 352 | |||
| 353 | === Content-specific settings Filtered items === | ||
| 354 | |||
| 355 | |(% style="background-color:grey" %)(% style="color:#ffffff" %)**Parameter**|(% style="background-color:grey; width:235px" %)(% style="color:#ffffff" %)**Value**|(% style="background-color:grey; width:197px" %)(% style="color:#ffffff" %)**Default value**|(% style="background-color:grey; width:556px" %)(% style="color:#ffffff" %)**Description** | ||
| 356 | |displaydimension|Boolean|"false"|Display the dimension name | ||
| 357 | |displayhierarchy|Boolean|"false"|Show the hierarchy name | ||
| 358 | |displaylevel|Boolean|"false"|Display the level name | ||
| 359 | |||
| 360 | === Content-specific parameters Search === | ||
| 361 | |||
| 362 | |(% style="background-color:grey; width:170px" %)(% style="color:#ffffff" %)**Parameter**|(% style="background-color:grey; width:232px" %)(% style="color:#ffffff" %)**Value**|(% style="background-color:grey; width:203px" %)(% style="color:#ffffff" %)**Default value**|(% style="background-color:grey; width:173px" %)(% style="color:#ffffff" %)**Dependency**|(% style="background-color:grey; width:514px" %)(% style="color:#ffffff" %)**Description** | ||
| 363 | |(% style="width:170px" %)flows|(% style="width:232px" %)A comma-separated list of flow identifiers|(% style="width:203px" %)None|(% style="width:173px" %)The flows (charts) must exist on the page|(% style="width:514px" %)Allows you to display only members of the {{glossaryReference glossaryId="Glossary" entryId="Flux"}}Flow{{/glossaryReference}} dimensions with the specified ID | ||
| 364 | |(% style="width:170px" %)label|(% style="width:232px" %)Text|(% style="width:203px" %)None|(% style="width:173px" %) |(% style="width:514px" %)Allows you to change the label ‘Search’ | ||
| 365 | |||
| 366 | === Content-specific settings Caption === | ||
| 367 | |||
| 368 | |(% style="background-color:grey; width:170px" %)(% style="color:#ffffff" %)**Setting**|(% style="background-color:grey; width:232px" %)(% style="color:#ffffff" %)**Value**|(% style="background-color:grey; width:203px" %)(% style="color:#ffffff" %)**Default value**|(% style="background-color:grey; width:171px" %)(% style="color:#ffffff" %)**Dependency**|(% style="background-color:grey; width:516px" %)(% style="color:#ffffff" %)**Description** | ||
| 369 | |**displayaxisname**|Boolean|"true"|(% style="width:171px" %) |(% style="width:516px" %)Display the axis title | ||
| 370 | |**layout**|"horizontal" or "vertical"|"vertical"|(% style="width:171px" %) |(% style="width:516px" %)Legend display type: vertical or horizontal | ||
| 371 | |**flow**|flowid|None|(% style="width:171px" %) |(% style="width:516px" %)The context of the legend will be determined by this {{glossaryReference glossaryId="Glossary" entryId="Flux"}}Flow{{/glossaryReference}} | ||
| 372 | |**hideelement**|"true"|None|(% style="width:171px" %)selectelement must not be defined|(% style="width:516px" %)Displays an icon that allows the element to be hidden on click | ||
| 373 | |**selectelement**|"true"|None|(% style="width:171px" %)hidelement must not be defined|(% style="width:516px" %)Displays an icon that allows the element to be selected on click | ||
| 374 | |**sorttype**|0 or 1|None|(% style="width:171px" %)sortreverse must be set|(% style="width:516px" %)0 = Alphabetical sort, 1 = Numerical sort | ||
| 375 | |**sortreverse**|boolean|None|(% style="width:171px" %)sorttype must be defined|(% style="width:516px" %)Sort in ascending or descending order | ||
| 376 | |||
| 377 | === Content-specific parameters Comments === | ||
| 378 | |||
| 379 | |(% style="background-color:grey; width:170px" %)(% style="color:#ffffff" %)**Parameter**|(% style="background-color:grey; width:232px" %)(% style="color:#ffffff" %)**Value**|(% style="background-color:grey; width:203px" %)(% style="color:#ffffff" %)**Default value**|(% style="background-color:grey; width:171px" %)(% style="color:#ffffff" %)**Dependency**|(% style="background-color:grey; width:516px" %)(% style="color:#ffffff" %)**Description** | ||
| 380 | |**datamodels**|A comma-separated list of data model identifiers|None|The data models must exist on the page|Show only comments on data models with the specified identifier | ||
| 381 | |**flows**|Comma-separated list of flow identifiers|None|The flows (charts) must exist on the page|Show only comments on flows (graphs) with the specified ID | ||
| 382 | |**displaytype**|"displaytypelist" or "displaytypetext"|None| |Comment display type: List or Text | ||
| 383 | |**filtertype**|"all" or "lastdays" or "lastcomments"|"all"|must have a "filter" parameter|Comment filtering option: All, last X days or last X comments | ||
| 384 | |**filter**|Numeric|None|filtertype must be different from "all"|Comment filtering settings: X number of days or comments | ||
| 385 | |**displayallcomments**|Boolean|"false"| |Show all comments | ||
| 386 | |||
| 387 | === Content-specific settings: Documents === | ||
| 388 | |||
| 389 | |(% style="background-color:grey; width:170px" %)(% style="color:#ffffff" %)**Parameter**|(% style="background-color:grey; width:232px" %)(% style="color:#ffffff" %)**Value**|(% style="background-color:grey; width:203px" %)(% style="color:#ffffff" %)**Default value**|(% style="background-color:grey; width:171px" %)(% style="color:#ffffff" %)**Dependency**|(% style="background-color:grey; width:516px" %)(% style="color:#ffffff" %)**Description** | ||
| 390 | |**searchbox**|Boolean|"true"| |Show search field | ||
| 391 | |**server**|Server ID|None| | ||
| 392 | parameter required|((( | ||
| 393 | ID or name of the document server to query | ||
| 394 | ))) | ||
| 395 | |||
| 396 | === Content-specific parameters Measure selector === | ||
| 397 | |||
| 398 | |(% style="background-color:grey; width:170px" %)(% style="color:#ffffff" %)**Parameter**|(% style="background-color:grey; width:232px" %)(% style="color:#ffffff" %)**Value**|(% style="background-color:grey; width:203px" %)(% style="color:#ffffff" %)**Default value**|(% style="background-color:grey; width:171px" %)(% style="color:#ffffff" %)**Dependency**|(% style="background-color:grey; width:516px" %)(% style="color:#ffffff" %)**Description** | ||
| 399 | |**flows**|A comma-separated list of flow identifiers|None| | ||
| 400 | parameter required|Flows (charts) on which to base the metric selector | ||
| 401 | |**viztype**|"list", "combo" or "checkbox"|"list"| |Visualisation type of the metric selector: List, Drop-down list or Checkboxes | ||
| 402 | |**vizlayout**|"vertical" or "horizontal"|"vertical"|No effect in the case of a drop-down list (combo box)|Display type: Vertical or not | ||
| 403 | |**multiselect**|Boolean|"true"| |Allow multiple selection | ||
| 404 | |||
| 405 | === Filter-specific parameters Dimension === | ||
| 406 | |||
| 407 | |(% style="background-color:grey; width:170px" %)(% style="color:#ffffff" %)**Parameter**|(% style="background-color:grey; width:232px" %)(% style="color:#ffffff" %)**Value**|(% style="background-color:grey; width:203px" %)(% style="color:#ffffff" %)**Default value**|(% style="background-color:grey; width:171px" %)(% style="color:#ffffff" %)**Dependency**|(% style="background-color:grey; width:516px" %)(% style="color:#ffffff" %)**Description** | ||
| 408 | |**dim**|Dimension name|None| | ||
| 409 | parameter required|Dimension name | ||
| 410 | |**datasource**|Data model identifier|None| | ||
| 411 | parameter required|Data model identifier | ||
| 412 | |**viztype**|"SlicerOneByOne" | ||
| 413 | "Slicer" | ||
| 414 | "SlicerHorizontal" | ||
| 415 | "SlicerCombo" | ||
| 416 | "SlicerSlider" | ||
| 417 | "SlicerDatePicker" | ||
| 418 | "SlicerCheckBox" "SlicerComboRange" | ||
| 419 | "SlicerTree" | ||
| 420 | "SlicerMatch"|SlicerCheckBox|Required parameter. Available types depend on the nature of the dimension|Filter display type:((( | ||
| 421 | * One by one | ||
| 422 | * Vertical list | ||
| 423 | * Horizontal list | ||
| 424 | * Drop-down list | ||
| 425 | * Slider | ||
| 426 | * Calendar | ||
| 427 | * Tick box | ||
| 428 | * Min/max list | ||
| 429 | * Tree list | ||
| 430 | * Ruler | ||
| 431 | ))) | ||
| 432 | |**Flows**|List of flow identifiers separated by commas| |The flows (charts) must exist on the page|Chart(s) to which the filter will be applied | ||
| 433 | |**hierarchy**|Name of the hierarchy|None|The dimension must be hierarchical|Filter by hierarchy | ||
| 434 | |**level**|Level name|None|The dimension must be hierarchical|Filter by level | ||
| 435 | |**dimlabel**|${dimension}, ${hierarchy} or ${level}, | ||
| 436 | can be used together, separated by '/'|${dimension}|The dimension must be hierarchical | ||
| 437 | ${hierarchy} or ${level}|Change the display of the dimension name | ||
| 438 | |**authorizereversefilter**|Boolean|"false"| |Allow exclusion of members | ||
| 439 | |**multiselect**|Boolean|"true"| |Enable multiple selection when selecting an item | ||
| 440 | |**forbidmultiselect**| |"false"|"muliselect" must be set to false|Disable multiple selection | ||
| 441 | |**filteronsinglemember**|Boolean|"false"| |Filter on a single element | ||
| 442 | |**authorisechange level**|Boolean|"false"|On a hierarchical dimension|Allow level change | ||
| 443 | |**showsearch**|Boolean|"true"|On a continuous dimension|Show the search box | ||
| 444 | |**forbidemptyselection**|Boolean| | |Prohibit empty selection | ||
| 445 | |**hidempty**|Boolean| | |Hide empty values | ||
| 446 | |**range**|Boolean|"false"|On a continuous dimension|Allows you to filter all values within a range | ||
| 447 | |**min**|min|None|range must be set to true|The minimum of the range | ||
| 448 | |**max**|max|None|range must be set to true|The maximum of the interval | ||
| 449 | |**filter**|"first" "last"|None| |Filter by the first or last element | ||
| 450 | |**sorttype**|0 or 1|None|sortreverse must be specified|0 = Alphabetical sort, 1 = Numerical sort | ||
| 451 | |**sortreverse**|Boolean|None|sorttype must be defined|Sort in ascending or descending order | ||
| 452 | |||
| 453 | === Filter-specific parameters Measure === | ||
| 454 | |||
| 455 | |(% style="background-color:grey; width:170px" %)(% style="color:#ffffff" %)**Parameter**|(% style="background-color:grey; width:232px" %)(% style="color:#ffffff" %)**Value**|(% style="background-color:grey; width:203px" %)(% style="color:#ffffff" %)**Default value**|(% style="background-color:grey; width:171px" %)(% style="color:#ffffff" %)**Dependency**|(% style="background-color:grey; width:516px" %)(% style="color:#ffffff" %)**Description** | ||
| 456 | |**measurename**|Measure name|None| | ||
| 457 | parameter required|Name of the measure to filter | ||
| 458 | |**flows**|List of flow identifiers separated by commas|None| | ||
| 459 | parameter required|Flows (charts) affected by this filter | ||
| 460 | |**hidemeasurename**|Boolean|"false"| |Hide the measure name | ||
| 461 | |||
| 462 | === Filter-specific parameters Variable === | ||
| 463 | |||
| 464 | |(% style="background-color:grey; width:170px" %)(% style="color:#ffffff" %)**Parameter**|(% style="background-color:grey; width:232px" %)(% style="color:#ffffff" %)**Value**|(% style="background-color:grey; width:203px" %)(% style="color:#ffffff" %)**Default value**|(% style="background-color:grey; width:171px" %)(% style="color:#ffffff" %)**Dependency**|(% style="background-color:grey; width:516px" %)(% style="color:#ffffff" %)**Description** | ||
| 465 | |**varname**|Variable name|None| | ||
| 466 | parameter required|Name of the variable to be filtered | ||
| 467 | |**viztype**|((( | ||
| 468 | "slider" | ||
| 469 | "verticalslider" | ||
| 470 | "combo" | ||
| 471 | "spinner", | ||
| 472 | "horizontallist" | ||
| 473 | "verticallist" | ||
| 474 | "textfield" | ||
| 475 | )))|"combo", "slider" or "textfield" | ||
| 476 | depending on the variable’s settings|horizontallist and verticallist are only available for variables with explicit values|Variable display type:((( | ||
| 477 | * Horizontal slider | ||
| 478 | * Vertical slider | ||
| 479 | * Drop-down list | ||
| 480 | * Spinner | ||
| 481 | * Horizontal list | ||
| 482 | * Vertical list | ||
| 483 | * Text field | ||
| 484 | ))) | ||
| 485 | |**hidevarname**|boolean|"false"| |Hide the variable name | ||
| 486 | |||
| 487 | = Related pages... = | ||
| 488 | |||
| 489 | * [[Embedding a dashboard in a web page>>doc:Digdash.webIntegration.DD_web_integration.embed_dashboard.WebHome]] | ||
| 490 | * [[Web integration of dashboards and DigDash objects>>doc:Digdash.webIntegration.DD_web_integration.WebHome]] |