parameter
The parameter property allows you to read and write parameters that exist in the context of the Dashboard and user session. Parameters can be created in several ways, including the following:
-
Variables that have been defined in a Data Worksheet (see Filter Data in Prepare Your Data)
-
Form components that have been defined in a Dashboard (see Dynamically Set Properties in Visualize Your Data)
-
Parameters passed into the Dashboard via hyperlink (see Drill with Chart Hyperlinks, for example)
-
Session parameters such as those listed below (see parameter._GROUPS_ for example)
-
Parameters defined in the Dashboard itself, either explicitly in script by using the
parameterkeyword, or implicitly by their use in the ‘Variable’ option of a Condition (see Add Conditions for example) -
Parameters passed into an embedded Dashboard from a parent Dashboard using thisParameter
The syntax for accessing a parameter is
parameter.variableNamewhere variableName is the name of the Variable asset defined in the Data Worksheet or the Form component defined in the Dashboard.
parameter.stateSelectorparameter.RadioButton1parameter.myParamName = 'Hello';
parameter.__principle__
| Property is read-only. It cannot be set in script. |
Returns the SRPrincipal object, which contains session information. See Access the User Session in Advanced Server Integration for details on writing user data to SRPrincipal.