Class actuate.viewer.RenderOptions

Description

The RenderOptions class specifies render options for the actuate.Viewer.downloadReport( ) function. Currently, the only supported option is multisheet.

Constructor

Syntax

actuate.Viewer.RenderOptions( )

Constructs a new RenderOptions object for the parent viewer.

Function summary

Table 4-51 lists actuate.viewer.RenderOptions functions.

Table 4-51

actuate.viewer.RenderOptions functions

Function	Description
getOptions( )	Returns whether mouse scrolling is enabled
setOption( )	Returns whether mouse panning is enabled

actuate.viewer.RenderOptions.getOptions

Syntax

Object[ ] RenderOptions.getOptions( )

Returns the render options map.

Returns

Array, arranged in string and object pairs corresponding to option names and option values.

Example

This example displays an alert box with the options status of render options:

alert("Rendering Options: " + options.getOptions( ));

actuate.viewer.RenderOptions.setOption

Syntax

void RenderOptions.setOption(string option, boolean value)

Specifies a render option and its setting.

Parameters

option

String. The permitted value is actuate.viewer.RenderOptions.IS_MULTISHEET, which is used for xls format download only.

value

Boolean. Enabled value for IS_MULTISHEET. True indicates that the xls format file has multiple worksheets.

Example

To disable multisheet for the options object, use code similar to the following:

options.setOption(actuate.viewer.RenderOptions.IS_MULTISHEET, false);

Copyright Actuate Corporation 2012