Initializing help system before first use

vdl-tableau-parameter

Define a Tableau parameter to pass into the visualization. If the value is an expression and changes then the visualization will be updated. The name for parameter is static and should reference a parameter name defined in the Tableau workbook. You cannot use the vdl-repeat or vdl-if attributes directly on a vdl-tableau-parameter component as Tableau parameter names must be statically defined when loading the visualization and correspond to parameter names in the workbook.

since 5.1

Required parent element

Must be contained within one of the following elements:

Example

<vdl-tableau workbook="my_workbook"
             view="my_worksheet"
             mirror-tables="factory_supply_demand,mirror_2">
    <vdl-tableau-parameter name="string_param" value="=scenario.entities.my_string.value"></vdl-tableau-parameter>
    <vdl-tableau-parameter name="show_chart" value="=vars.showVisualizationChart"></vdl-tableau-parameter>
    <vdl-tableau-parameter name="current_datetime" value="=new Date()"></vdl-tableau-parameter>
</vdl-tableau>

Attributes

name The name of the Tableau parameter in the associated workbook. Initial values for integer, float, boolean and string types are sent to the visualization on load. But Date and DateTime types will only be sent to the visualization after load. The following names are reserved and cannot be used: disableUrlActionsPopups, hideTabs, hideToolbar, width, height, instanceIdToClone, device, onFirstInteractive, onFirstVizSizeKnown, toolbarPosition, selection_id. since 5.1 required
value The value for the Tableau parameter. If this is an expression, the data type returned from the expression should match the data type of the Tableau parameter as declared in the workbook. A Date or DateTime parameter defined in a workbook must be set as JavaScript Date object. since 5.1 accepts expression required
Parent Topic VDL 5 Reference

© 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.