addParameter(name, default, type, alias, hidden)

Adds a parameter to the report. This function is available only within the onInit Handler, and is equivalent to defining a report parameter using the 'Parameter Definition' dialog box in Style Studio.

Parameters

name name of the parameter (String)

default parameter default value

type an XType Data Types constant

alias label to use when prompting (String)

hidden Boolean:
false (default): prompt user
true: do not prompt user

Example

addParameter('start_time', new Date(), XType.DATE,
   'Start date', false);

The 'hidden' flag allows you to suppress user prompting for the parameter, equivalent to deselecting the 'Prompt User' option in the 'Parameter Definition' dialog box.

See Also

Defining and Editing Report Parameters, in Report Design, for the parameter interface.

<< SI.1 Global Functions © 1996-2013 InetSoft Technology Corporation (v11.4) newInstance(name) >>