Class actuate.viewer.UIOptions

The UIOptions class specifies feature availability for the Viewer object.
Member of: actuate.viewer.

Class Summary
Constructor Attributes	Constructor Name and Description
	actuate.viewer.UIOptions() The UIOptions class specifies feature availability for the Viewer object.

Method Summary
Method Attributes	Method Name and Description
	enableAdvancedSort(enabled) Specifies whether the advanced sort feature must be enabled.
	enableAggregation(enabled) Specifies whether the aggregation feature must be enabled.
	enableCalculatedColumn(enabled) Specifies whether the calculated column feature must be enabled.
	enableChartProperty(enabled) Specifies whether the chart properties feature must be enabled.
	enableChartSubType(enabled) Specifies whether the chart subtype selection feature must be enabled.
	enableCollapseExpand(enabled) Specifies whether the collapse/expand feature must be enabled.
	enableColumnEdit(enabled) Specifies whether the column editing feature must be enabled.
	enableColumnResize(enabled) Specifies whether the column resizing feature must be enabled.
	enableContentMargin(enabled) Specifies whether the content margin feature must be enabled.
	enableDataAnalyzer(enabled) Specifies whether the Launch DA feature must be enabled.
	enableDataExtraction(enabled) Specifies whether the data extraction feature must be enabled.
	enableEditReport(enabled) Specifies whether the report editing feature must be enabled.
	enableExportReport(enabled) Specifies whether the export report feature must be enabled.
	enableFacebookComments(enabled) Specifies whether the show tooltip feature must be enabled.
	enableFilter(enabled) Specifies whether the filter feature must be enabled.
	enableFlashGadgetType(enabled) Specifies whether the flash gadget type change feature must be enabled.
	enableFormat(enabled) Specifies whether the format editing feature must be enabled.
	enableGroupEdit(enabled) Specifies whether the group editing feature must be enabled.
	enableHideShowItems(enabled) Specifies whether the hide/show item feature must be enabled.
	enableHighlight(enabled) Specifies whether the highlight feature must be enabled.
	enableHoverHighlight(enabled) Specifies whether the hover highlight feature must be enabled.
	enableLaunchViewer(enabled) Specifies whether the Launch Viewer feature must be enabled.
	enableLinkToThisPage(enabled) Specifies whether the "link to this page" feature must be enabled.
	enableMainMenu(enabled) Specifies whether the main menu feature must be enabled.
	enableMoveColumn(enabled) Specifies whether the column moving feature must be enabled.
	enablePageBreak(enabled) Specifies whether the page break editing feature must be enabled.
	enablePageNavigation(enabled) Specifies whether the page navigation feature must be enabled.
	enableParameterPage(enabled) Specifies whether the parameter page feature must be enabled.
	enablePrint(enabled) Specifies whether the print feature must be enabled.
	enableReorderColumns(enabled) Specifies whether the column reordering feature must be enabled.
	enableRowResize(enabled) Specifies whether the row resizing feature must be enabled.
	enableSaveDesign(enabled) Specifies whether the report design save feature must be enabled.
	enableSaveDocument(enabled) Specifies whether the report document save feature must be enabled.
	enableShowToolTip(enabled) Specifies whether the show tooltip feature must be enabled.
	enableSort(enabled) Specifies whether the sort feature must be enabled.
	enableSuppressDuplicate(enabled) Specifies whether the duplication suppression feature must be enabled.
	enableSwitchView(enabled) Specifies whether the switch view feature must be enabled.
	enableTextEdit(enabled) Specifies whether the text editing feature must be enabled.
	enableTOC(enabled) Specifies whether the table of contents feature must be enabled.
	enableToolBar(enabled) Specifies whether the tool bar feature must be enabled.
	enableToolbarContextMenu(enabled) Specifies whether to show toolbar features in a context menu.
	enableToolbarHelp(enabled) Specifies whether the tool bar help feature must be enabled.
	enableTopBottomNFilter(enabled) Specifies whether the top N and bottom N filter feature must be enabled.
	enableUndoRedo(enabled) Specifies whether the show tooltip feature must be enabled.
	getFeatureMap() Returns the features and their Boolean values as an associative array.

Class Detail

actuate.viewer.UIOptions()

The UIOptions class specifies feature availability for the Viewer object.

Method Detail

{void} enableAdvancedSort(enabled)

Specifies whether the advanced sort feature must be enabled.

Parameters:
{boolean} enabled: true for enabled, false for disabled.

Returns:: {void}

{void} enableAggregation(enabled)

Specifies whether the aggregation feature must be enabled.

Parameters:
{boolean} enabled: true for enabled, false for disabled.

Returns:: {void}

{void} enableCalculatedColumn(enabled)

Specifies whether the calculated column feature must be enabled.

Parameters:
{boolean} enabled: true for enabled, false for disabled.

Returns:: {void}

{void} enableChartProperty(enabled)

Specifies whether the chart properties feature must be enabled.

Parameters:
{boolean} enabled: true for enabled, false for disabled.

Returns:: {void}

{void} enableChartSubType(enabled)

Specifies whether the chart subtype selection feature must be enabled.

Parameters:
{boolean} enabled: true for enabled, false for disabled.

Returns:: {void}

{void} enableCollapseExpand(enabled)

Specifies whether the collapse/expand feature must be enabled.

Parameters:
{boolean} enabled: true for enabled, false for disabled.

Returns:: {void}

{void} enableColumnEdit(enabled)

Specifies whether the column editing feature must be enabled.

Parameters:
{boolean} enabled: true for enabled, false for disabled.

Returns:: {void}

{void} enableColumnResize(enabled)

Specifies whether the column resizing feature must be enabled.

Parameters:
{boolean} enabled: true for enabled, false for disabled.

Returns:: {void}

{void} enableContentMargin(enabled)

Specifies whether the content margin feature must be enabled.

Parameters:
{boolean} enabled: true for enabled, false for disabled.

Returns:: {void}

{void} enableDataAnalyzer(enabled)

Specifies whether the Launch DA feature must be enabled.

Parameters:
{boolean} enabled: true for enabled, false for disabled.

Returns:: {void}

{void} enableDataExtraction(enabled)

Specifies whether the data extraction feature must be enabled.

Parameters:
{boolean} enabled: true for enabled, false for disabled.

Returns:: {void}

{void} enableEditReport(enabled)

Specifies whether the report editing feature must be enabled.

Parameters:
{boolean} enabled: true for enabled, false for disabled.

Returns:: {void}

{void} enableExportReport(enabled)

Specifies whether the export report feature must be enabled.

Parameters:
{boolean} enabled: true for enabled, false for disabled.

Returns:: {void}

{void} enableFacebookComments(enabled)

Specifies whether the show tooltip feature must be enabled.

Parameters:
{boolean} enabled: true for enabled, false for disabled.

Returns:: {void}

{void} enableFilter(enabled)

Specifies whether the filter feature must be enabled.

Parameters:
{boolean} enabled: true for enabled, false for disabled.

Returns:: {void}

{void} enableFlashGadgetType(enabled)

Specifies whether the flash gadget type change feature must be enabled.

Parameters:
{boolean} enabled: true for enabled, false for disabled.

Returns:: {void}

{void} enableFormat(enabled)

Specifies whether the format editing feature must be enabled.

Parameters:
{boolean} enabled: true for enabled, false for disabled.

Returns:: {void}

{void} enableGroupEdit(enabled)

Specifies whether the group editing feature must be enabled.

Parameters:
{boolean} enabled: true for enabled, false for disabled.

Returns:: {void}

{void} enableHideShowItems(enabled)

Specifies whether the hide/show item feature must be enabled.

Parameters:
{boolean} enabled: true for enabled, false for disabled.

Returns:: {void}

{void} enableHighlight(enabled)

Specifies whether the highlight feature must be enabled.

Parameters:
{boolean} enabled: true for enabled, false for disabled.

Returns:: {void}

{void} enableHoverHighlight(enabled)

Specifies whether the hover highlight feature must be enabled.

Parameters:
{boolean} enabled: true for enabled, false for disabled.

Returns:: {void}

{void} enableLaunchViewer(enabled)

Specifies whether the Launch Viewer feature must be enabled.

Parameters:
{boolean} enabled: true for enabled, false for disabled.

Returns:: {void}

{void} enableLinkToThisPage(enabled)

Specifies whether the "link to this page" feature must be enabled.

Parameters:
{boolean} enabled: true for enabled, false for disabled.

Returns:: {void}

{void} enableMainMenu(enabled)

Specifies whether the main menu feature must be enabled.

Parameters:
{boolean} enabled: true for enabled, false for disabled.

Returns:: {void}

{void} enableMoveColumn(enabled)

Specifies whether the column moving feature must be enabled.

Parameters:
{boolean} enabled: true for enabled, false for disabled.

Returns:: {void}

{void} enablePageBreak(enabled)

Specifies whether the page break editing feature must be enabled.

Parameters:
{boolean} enabled: true for enabled, false for disabled.

Returns:: {void}

{void} enablePageNavigation(enabled)

Specifies whether the page navigation feature must be enabled.

Parameters:
{boolean} enabled: true for enabled, false for disabled.

Returns:: {void}

{void} enableParameterPage(enabled)

Specifies whether the parameter page feature must be enabled.

Parameters:
{boolean} enabled: true for enabled, false for disabled.

Returns:: {void}

{void} enablePrint(enabled)

Specifies whether the print feature must be enabled.

Parameters:
{boolean} enabled: true for enabled, false for disabled.

Returns:: {void}

{void} enableReorderColumns(enabled)

Specifies whether the column reordering feature must be enabled.

Parameters:
{boolean} enabled: true for enabled, false for disabled.

Returns:: {void}

{void} enableRowResize(enabled)

Specifies whether the row resizing feature must be enabled.

Parameters:
{boolean} enabled: true for enabled, false for disabled.

Returns:: {void}

{void} enableSaveDesign(enabled)

Specifies whether the report design save feature must be enabled.

Parameters:
{boolean} enabled: true for enabled, false for disabled.

Returns:: {void}

{void} enableSaveDocument(enabled)

Specifies whether the report document save feature must be enabled.

Parameters:
{boolean} enabled: true for enabled, false for disabled.

Returns:: {void}

{void} enableShowToolTip(enabled)

Specifies whether the show tooltip feature must be enabled.

Parameters:
{boolean} enabled: true for enabled, false for disabled.

Returns:: {void}

{void} enableSort(enabled)

Specifies whether the sort feature must be enabled.

Parameters:
{boolean} enabled: true for enabled, false for disabled.

Returns:: {void}

{void} enableSuppressDuplicate(enabled)

Specifies whether the duplication suppression feature must be enabled.

Parameters:
{boolean} enabled: true for enabled, false for disabled.

Returns:: {void}

{void} enableSwitchView(enabled)

Specifies whether the switch view feature must be enabled.

Parameters:
{boolean} enabled: true for enabled, false for disabled.

Returns:: {void}

{void} enableTextEdit(enabled)

Specifies whether the text editing feature must be enabled.

Parameters:
{boolean} enabled: true for enabled, false for disabled.

Returns:: {void}

{void} enableTOC(enabled)

Specifies whether the table of contents feature must be enabled.

Parameters:
{boolean} enabled: true for enabled, false for disabled.

Returns:: {void}

{void} enableToolBar(enabled)

Specifies whether the tool bar feature must be enabled.

Parameters:
{boolean} enabled: true for enabled, false for disabled.

Returns:: {void}

{void} enableToolbarContextMenu(enabled)

Specifies whether to show toolbar features in a context menu.

Parameters:
{boolean} enabled: true for enabled, false for disabled.

Returns:: {void}

{void} enableToolbarHelp(enabled)

Specifies whether the tool bar help feature must be enabled. This code initializes a new viewer display, using enableToolbarHelp(true) to enable the toolbar help feature:

	function initDisplay( ){
		var uioptions = new actuate.viewer.UIOptions( );
		viewer = new actuate.Viewer("viewerpane");
		var viewerwidth = 800;
		var viewerheight = 600;
		viewer.setWidth(viewerwidth);
		viewer.setHeight(viewerheight);
		uioptions.enableToolBar(true);
		uioptions.enableToolbarHelp(true);
		viewer.setUIOptions(uioptions);
		document.getElementById("display").disabled = false;
	}

Parameters:
{boolean} enabled: true for enabled, false for disabled.

Returns:: {void}

{void} enableTopBottomNFilter(enabled)

Specifies whether the top N and bottom N filter feature must be enabled.

Parameters:
{boolean} enabled: true for enabled, false for disabled.

Returns:: {void}

{void} enableUndoRedo(enabled)

Specifies whether the show tooltip feature must be enabled.

Parameters:
{boolean} enabled: true for enabled, false for disabled.

Returns:: {void}

{Object} getFeatureMap()

Returns the features and their Boolean values as an associative array. This function makes the name of each feature an object property and sets the value of that property to the associated enabled Boolean value.

Returns:: {Object} Associative array with the feature map.

Classes

Class actuate.viewer.UIOptions