The actuate.Parameter class retrieves and displays Actuate BIRT report parameters in an HTML container. Users can interact with the parameters on the page and pass parameter values to an actuate.Viewer object, but not to the server directly.

The actuate.Parameter class displays the parameters by page. The actuate.parameters.navigate( ) function changes the page display or changes the current position on the page.

Constructs a parameter object for a page, initializing the parameter component.

Table 44‑18 lists actuate.Parameter functions.

Retrieves an array of actuate.parameter.ParameterDefinition objects that contain the report parameters for the report and sends the array to the callback function, which must take the array as an input parameter.

This example retrieves a set of report parameters and sends them to a callback function.

Returns an array of the actuate.parameter.ParameterValue objects for the parameter object. If no values have been set, the parameter object downloads the default values from the server.

To download the parameter values and add them to the viewer, the callback function must use the values as an input parameter, as shown in the following code:

Returns the parameter layout type.

String. The parameter layout, which will match one of the layout constants in actuate.parameter.Constants:

This example calls getLayout( ) to display the parameter layout type in an alert box:

Returns all the group names for the parameter page as an array of strings.

Array of strings. Each string is a group name.

This example displays an alert box with the name of the first group for the parameter page:

Returns the name of the report file currently referenced by this Parameter object.

String. The report file name.

This example displays an alert box with the name of the report file:

Returns the name of the transient document generated by running the report currently referenced by this Parameter object.

String.

This example displays an alert box with the name of the transient document:

Hides the navigation bar for the parameter component in the LAYOUT_GROUP layout.

This example hides the navigation bar:

Hides all report parameters that belongs to a group or to a list of groups.

This example hides the report parameters that belong to the groups that are listed in the myGroups string array:

Hides report parameters as specified by name.

This example hides the parameters that are listed in the myParams string array:

Changes the current page of the parameter component. The navTarget determines the new location to display the parameter container.

This example displays the last page of the parameter component in the HTML <div> element with the myParams ID:

Performs garbage collection for the parameter object and unloads JavaScript variables that are no longer needed by Parameter.

This example unloads JavaScript variables and displays an alert box:

Registers an event handler to activate for parameter events. This function can assign several handlers to a single event.

To register an event handler to catch exceptions, call actuate.Parameter.registerEventHandler using the ON_CHANGED constant after creating the viewer object, as shown in the following example:

Removes an event handler.

To remove an event handler, call actuate.Parameter.removeEventHandler with a legal event constant, as shown in the following example:

Renders the parameter component to the container.

This example calls renderContent( ) after hiding parameter groups:

Sets the auto suggest delay time.

This example implements a custom auto suggest list. The list is 10 suggestions long and displays 3 suggestions at a time after a delay of 250 milliseconds.

Sets the fetch size of the auto suggestion list. AutoSuggest fetches all suggestions from the server when the fetch size is not set.

This example implements a custom auto suggest list. The list is 10 suggestions long and displays 3 suggestions at a time after a delay of 250 milliseconds.

Sets the length of the auto suggestion list. AutoSuggest shows all of the suggestions from the server when the list length is not set.

This example implements a custom auto suggest list. The list is 10 suggestions long and displays 3 suggestions at a time after a delay of 250 milliseconds.

Defines a set of groups that are expanded by default.

This example sets the "Motorcycles", "Trucks", and "Airplanes" groups as expanded by default:

Sets the font of the parameter page content after the page is rendered.

This example sets the font to Arial for the parameters page:

Sets the HTML element container for the provided group. All parameter objects listed in groupNames are assigned to the container.

This example assigns the group names in the myGroups string array to the leftpane HTML element:

Sets the parameter layout.

This example sets the parameter object’s layout type to LAYOUT_COLLAPSIBLE:

Sets the parameters to read-only.

This example makes the parameters read-only:

Sets the report file from which to get report parameters.

To set the name using an HTML input tag with an ID of Selector, use the following code:

Sets the target service URL to which the Parameter object links. If the service URL is not set, this Parameter object links to the default service URL set on the actuate object.

This example sets the URL for the Actuate iPortal web application service:

Sets whether localized data is shown or not.

This example hides localized data:

Submits requests to the server for the report parameters. When this function is called, an AJAX request is triggered to submit all the operations. When the server finishes the processing, it returns a response and the results are rendered on the page in the parameter container.

This example calls submit( ) after hiding localized data: