Specifying variable values using parameters
Parameters are a way of specifying variable values for use by your visual project.
About this task
- Capture user input.
- Capture current context, such as query results, object property values, or locations.
- Pass user input or context information from one part of a dashboard to another.
- Vary query results based on dynamic criteria.
- Vary navigation results based on dynamic criteria.
- Vary visual project design elements based on dynamic criteria.
The following types of parameters are available:
- Global Parameters
- A parameter that is available to your entire visual project and to the user of your visual dashboard. You can pass global parameters when you specify object properties or when you create event actions. You also have the option of making global parameters public at runtime so they are accessible to the user.
- Scene Parameters
- A parameter that is available only to a specific scene in a visual dashboard. You can pass scene parameters when you create embedded scenes and event actions.
- Query Parameters
- Query parameters contain the value that will be sent to the query and used at runtime.
You can use parameters in many ways. Event actions typically capture user input in a parameter. You can use global and scene parameters when you design interactive controls in your scenes; when a user makes a selection in the control, an underlying event action sets the parameter value. The parameter value determines what data is displayed or how it is displayed.
Global,
scene, and query parameters contain the following attributes:
- Name (parameter names must be unique)
- Data type
- Description (optional)
- Default value (optional)
Note: You should provide a default value for your parameters
so you can test them.