Class actuate.XTabAnalyzer
The XTabAnalyzer class represents a XTab Analyzer viewer.
Member of: actuate.
Constructor Attributes | Constructor Name and Description |
---|---|
actuate.XTabAnalyzer(container, (UIOptions))
The XTabAnalyzer class represents a XTab Analyzer viewer.
|
Method Attributes | Method Name and Description |
---|---|
addParameterValue(parameterValue)
Adds a parameter value object.
|
|
commit(callback)
Commit all changes.
|
|
Force to restart viewer
|
|
Returns the connection Handle.
|
|
Returns the current crosstab object.
|
|
Returns the current page content object.
|
|
Returns the current page number.
|
|
Returns the datamart file.
|
|
Returns the current gadget id of the xtab to be shown.
|
|
Returns the viewer height
|
|
getLeft()
Returns the viewer left margin
|
|
Returns parameter value object array.
|
|
Returns the persistent report file.
|
|
Returns the viewer CSS position attribute.
|
|
Returns the report design file.
|
|
Returns the report document.
|
|
getTop()
Returns the viewer top margin
|
|
Returns the total page count.
|
|
Sets features availability.
|
|
<static> |
getViewer(elementId)
Get a viewer by given container or bookmark element.
|
getWidth()
Returns the viewer width
|
|
Returns the current bookmark name of the xtab to be shown.
|
|
Returns the current instance id of the xtab to be shown.
|
|
isActive()
Check whether current xtab analyzer is acitve.
|
|
Whether under dashboard mode.
|
|
Whether DA viewer is interactive.
|
|
Whether DA is launched from datamart file.
|
|
registerEventHandler(viewerEvent, handler)
Registers an event listener.
|
|
removeEventHandler(viewerEvent, handler)
Removes an event listener.
|
|
reset()
Reset the viewer
|
|
resizeTo(width, height)
Resize the viewer.
|
|
rollback(callback)
roll back all changes.
|
|
setDatamartFile(datamartFile)
Updates the datamart file
|
|
setGadgetId(id)
Sets the gadget id for xtab rendering.
|
|
setHeight(height)
Sets the viewer height.
|
|
setIVMode(ivMode)
Set whether it is under IV mode
True or false
|
|
setLeft(left)
Sets the viewer left margin.
|
|
setOnClosed(callback)
Set callback when popup window is closed.
|
|
setPageNum(pageNum)
Sets the page number.
|
|
setParameterValues(parameterValues)
Sets parameter value object array.
|
|
setPersistentReport(report,)
Sets persistent report file name.
|
|
setPosition(position)
Sets the viewer CSS position attribute.
|
|
setReportDesign(reportDesign)
Updates the report design file.
|
|
setReportDocument(reportDocument, connectionHandler)
Updates the report document and connection handle
|
|
setReportletDocumentMode(isReportletDocument)
Set whether it is under reportlet document mode
True or false
|
|
setReportName(reportName, connectionHandler)
Sets the report file name which can be report document file or report design file.
|
|
setService(iportalUrl, requestOptions)
Sets the iportal URL and an optional request options.
|
|
setSupportSVG(svgFlag)
Sets whether the client browser supports SVG.
|
|
setTop(top)
Sets the viewer top margin.
|
|
setUIOptions(options)
Sets features availability.
|
|
setWidth(width)
Sets the viewer width.
|
|
setXTabBookmark(bookmark)
Sets the bookmark name for xtab rendering.
|
|
setXTabIid(iid)
Sets the instance id for xtab rendering.
|
|
submit(callback, indicate)
The entry to load the data analyzer viewer instance.
|
Class Detail
actuate.XTabAnalyzer(container, (UIOptions))
The XTabAnalyzer class represents a XTab Analyzer viewer.
- Parameters:
- {String} container
- container object or id of a container in the current document
- (UIOptions)
- uiOptions the UIOption object to config viewer ui
Method Detail
addParameterValue(parameterValue)
Adds a parameter value object.
- Parameters:
- {actuate.xtabanalyzer.ParameterValue|actuate.parameter.ParameterValue} parameterValue
- Parameter value object
commit(callback)
Commit all changes.
- Parameters:
- callback
- Returns:
- void
forceSoftRestart()
Force to restart viewer
{String} getConnectionHandle()
Returns the connection Handle.
- Returns:
- {String} connectionHandle
{actuate.xtabanalyzer.Crosstab} getCrosstab()
Returns the current crosstab object.
- Returns:
- {actuate.xtabanalyzer.Crosstab} instance of Crosstab
{actuate.xtabanalyzer.PageContent} getCurrentPageContent()
Returns the current page content object.
- Returns:
- {actuate.xtabanalyzer.PageContent} instance of PageContent
{int} getCurrentPageNum()
Returns the current page number.
- Returns:
- {int} current page number
{String} getDatamartFile()
Returns the datamart file.
- Returns:
- {String} datamart file
{String} getGadgetId()
Returns the current gadget id of the xtab to be shown.
- Returns:
- {String} Gadget Id
{number} getHeight()
Returns the viewer height
- Returns:
- {number} height
{number} getLeft()
Returns the viewer left margin
- Returns:
- {number} left
{Array} getParameterValues()
Returns parameter value object array.
- Returns:
- {Array} Parameter value object array
{String} getPersistentReport()
Returns the persistent report file.
- Returns:
- {String} persistent report file
{String} getPosition()
Returns the viewer CSS position attribute.
- Returns:
- {String} position CSS position attribute
{String} getReportDesign()
Returns the report design file.
- Returns:
- {String} report design file
{String} getReportDocument()
Returns the report document.
- Returns:
- {String} report document file name
{number} getTop()
Returns the viewer top margin
- Returns:
- {number} top
{int} getTotalPageCount()
Returns the total page count.
- Returns:
- {int} totalPageCount total page count
{actuate.xtabanalyzer.UIOptions} getUIOptions()
Sets features availability.
- Returns:
- {actuate.xtabanalyzer.UIOptions} options UI options object
<static>
{actuate.XTabAnalyzer} getViewer(elementId)
Get a viewer by given container or bookmark element.
If no specified, return current viewer instance
- Parameters:
- {String or HTMLElement} elementId
- name of the bookmark or container within the viewer to retrieve; it can be an html element object too
- Returns:
- {actuate.XTabAnalyzer} XTabAnalyzer instance
{number} getWidth()
Returns the viewer width
- Returns:
- {number} width
{String} getXTabBookmark()
Returns the current bookmark name of the xtab to be shown.
- Returns:
- {String} bookmark
{String} getXTabIid()
Returns the current instance id of the xtab to be shown.
- Returns:
- {String} xtabIid
isActive()
Check whether current xtab analyzer is acitve.
Only useful for popup launch.
- Returns:
- true or false
isDashboard()
Whether under dashboard mode.
isInteractive()
Whether DA viewer is interactive.
isLoadedFromDatamart()
Whether DA is launched from datamart file.
registerEventHandler(viewerEvent, handler)
Registers an event listener.
- Parameters:
- {String} viewerEvent
- viewer event string
- {Function} handler
- event handler function
- Throws:
- {actuate.xtabanalyzer.Exception}
- if invalid arguments have been passed.
removeEventHandler(viewerEvent, handler)
Removes an event listener.
- Parameters:
- {String} viewerEvent
- viewer event string
- {Function} handler
- event handler function
- Throws:
- {actuate.xtabanalyzer.Exception}
- if invalid arguments have been passed.
reset()
Reset the viewer
resizeTo(width, height)
Resize the viewer.
- Parameters:
- {number} width
- {number} height
rollback(callback)
roll back all changes.
- Parameters:
- callback
- Returns:
- void
setDatamartFile(datamartFile)
Updates the datamart file
- Parameters:
- {String} datamartFile
- datamart file name
setGadgetId(id)
Sets the gadget id for xtab rendering.
- Parameters:
- {String} id
- gadget id used to render xtab
setHeight(height)
Sets the viewer height.
- Parameters:
- {number} height
setIVMode(ivMode)
Set whether it is under IV mode
True or false
- Parameters:
- ivMode
setLeft(left)
Sets the viewer left margin.
- Parameters:
- {number} left
setOnClosed(callback)
Set callback when popup window is closed.
- Parameters:
- {Function} callback
- callback
- Returns:
setPageNum(pageNum)
Sets the page number.
- Parameters:
- {int} pageNum
setParameterValues(parameterValues)
Sets parameter value object array.
- Parameters:
- {Array} parameterValues
- Parameter value object array
setPersistentReport(report,)
Sets persistent report file name.
- Parameters:
- report,
- report file name
setPosition(position)
Sets the viewer CSS position attribute.
- Parameters:
- {String} position
- CSS position attribute
setReportDesign(reportDesign)
Updates the report design file.
- Parameters:
- {String} reportDesign
- report design file name
- Throws:
- {actuate.xtabanalyzer.Exception}
- if an unknown file type is passed
setReportDocument(reportDocument, connectionHandler)
Updates the report document and connection handle
- Parameters:
- {String} reportDocument
- report document file name
- {int} connectionHandler
- connection handle (optional)
- Throws:
- {actuate.xtabanalyzer.Exception}
- if an unknown file type is passed
setReportletDocumentMode(isReportletDocument)
Set whether it is under reportlet document mode
True or false
- Parameters:
- isReportletDocument
setReportName(reportName, connectionHandler)
Sets the report file name which can be report document file or report design file.
- Parameters:
- {String} reportName
- report file
- {int} connectionHandler
- connection handle (optional)
- Throws:
- {actuate.xtabanalyzer.Exception}
- if an unknown file type is passed
setService(iportalUrl, requestOptions)
Sets the iportal URL and an optional request options.
- Parameters:
- {String} iportalUrl
- iportal URL
- {actuate.RequestOptions} requestOptions
- optional request options
setSupportSVG(svgFlag)
Sets whether the client browser supports SVG.
- Parameters:
- {boolean} svgFlag
- SVG support flag
setTop(top)
Sets the viewer top margin.
- Parameters:
- {number} top
setUIOptions(options)
Sets features availability.
- Parameters:
- {actuate.xtabanalyzer.UIOptions} options
- UI options object
setWidth(width)
Sets the viewer width.
- Parameters:
- {number} width
setXTabBookmark(bookmark)
Sets the bookmark name for xtab rendering.
- Parameters:
- {String} bookmark
- bookmark id used to render xtab
setXTabIid(iid)
Sets the instance id for xtab rendering.
- Parameters:
- {String} iid
- instance id used to render xtab
submit(callback, indicate)
The entry to load the data analyzer viewer instance.
Throws an exception if a previous operation started with submit()
is still pending.
If the data analyzer content is changed, a CONTENT_CHANGED event will be fired.
- Parameters:
- {Function} callback
- optional callback function.
The callback takes the following arguments:
- actuate.XTabAnalyzer: current data analyzer
- {Boolean} indicate
- whether re-run the report design when refreshing. Default to true.