vdl-tableau
Include a Tableau visualization in the view. Specify the scenario(s) and mirror tables that provide the data to the Tableau visualization, this defaults to using all scenarios. You can use class="vdl-tableau-full-page" directly on the vdl-tableau element to make the viz take the full view height and width. You can omit the workbook and view attributes if your server is in the development environment. This allows you to generate the mirrored data and see the associated selection_id filter whilst developing the Tableau workbook.
since 5.0Example
<!-- Specify a height for the visualization. Defaults to mirroring and using all scenarios in the visualization -->
<vdl-tableau workbook="vdl_language" view="simple_title_1" height="800px"
mirror-tables="factory_supply_demand,mirror_data_1,mirror_data_2"></vdl-tableau>
<!-- Only mirror data from the first scenario, specified by scenario index -->
<vdl-tableau workbook="vdl_language" view="simple_title_1" scenarios="0"
mirror-tables="factory_supply_demand,mirror_data_1,mirror_data_2"></vdl-tableau>
<!-- Expand the visualization to the full view height and width -->
<vdl-tableau workbook="vdl_language" view="simple_title_2"
class="vdl-tableau-full-page"
mirror-tables="factory_supply_demand,mirror_data_1,mirror_data_2"></vdl-tableau>
Attributes
| mirror-tables | Comma separated list of Mirror table names. Should match the names specified in the app companion file. | since 5.0 | required | |||||||
|---|---|---|---|---|---|---|---|---|---|---|
| class | Adding the class "vdl-tableau-full-page" will make the viz take the full view height and width. This will hide other components on the page so should only be used when the vdl-tableau component is the only display component. | since 5.0 | ||||||||
| global-filters | Comma separated list of global filter names. Should match the names specified in the workbook. | since 5.0 | ||||||||
| height | The height to display the Tableau Visualization in the VDL view. By default it will be set to 400px height. | since 5.0 | ||||||||
| id | A unique identifier of the vdl-tableau instance. Can be a static string or an expression that must resolve to a string. | since 5.0 | accepts expression | |||||||
| missing-parameters-message | Message to display when a parameter is specified and not set to a value. Defaults to "Please ensure all Tableau parameters are set to valid values.". This can be an expression that resolves to a string or a static string.
|
since 5.1 | accepts expression | |||||||
| scenarios | References to the scenario(s) that will be mirrored and available in the Tableau Visualization. The scenarios can be specified in various forms: A static string of one or more scenario indexes separated by commas, or an expression that resolves to a single item or array of scenario index, scenario id or scenario object. Defaults to all scenarios in the view selection. | since 5.0 | accepts expression | |||||||
| storage-namespace | Can be used to optionally add a namespace to the storage of Tableau global filters, for example to store separate filter values based on the first scenario: storage-namespace="=scenario.id". | since 5.0 | accepts expression | |||||||
| view | The name of the Tableau View to display from the specified workbook. This attribute is required in a production environment but can be omitted in a development environment so that you can trigger the data to be mirrored and the selection_id filter to be displayed whilst developing the Tableau Workbook. | since 5.0 | ||||||||
| width | The width to display the Tableau Visualization in the VDL view. By default it will fill the width of its parent element. | since 5.0 | ||||||||
| workbook | The name of the Tableau Workbook containing the view to display. This attribute is required in a production environment but can be omitted in a development environment so that you can trigger the data to be mirrored and the selection_id filter to be displayed whilst developing the Tableau Workbook. | since 5.0 |
© 2001-2024 Fair Isaac Corporation. All rights reserved. This documentation is the property of Fair Isaac Corporation (“FICO”). Receipt or possession of this documentation does not convey rights to disclose, reproduce, make derivative works, use, or allow others to use it except solely for internal evaluation purposes to determine whether to purchase a license to the software described in this documentation, or as otherwise set forth in a written software license agreement between you and FICO (or a FICO affiliate). Use of this documentation and the software described in it must conform strictly to the foregoing permitted uses, and no other use is permitted.