Global

Members

(readonly) documentExportFormats :number

Enumeration of available menu types for the export menu
Type:
  • number
Properties:
Name Type Description
SUBMENU number
INPUT number
CHECKBOX number
COLOR number
Source:

DRILLDOWNANDSUBREPORTSDISABLED

DRILLDOWN and SUBREPORTS are only enabled in Online mode and not when the reports parameter is used
Source:

HASPROMPTS

If the report has prompts ...
Source:

PROMPTONREFRESH

This parameter needs to be reset after the first page request.
Source:

TIMEOUTBEFOREERROR

Timeout of loading an internal frame before an error pops up.
Source:

vgen

Global variable to maintain the cache over the report render session
Source:

Methods

__hideByKey()

Hide the popup by pressing the excape key
Source:

addBody(body)

Add a body element to the popup content panel
Parameters:
Name Type Description
body Element a body element
Source:

addDetail(label, value, showDefault)

Add an entry to the detail section. Will open the section if it does not yet exist.
Parameters:
Name Type Description
label string the label of the detail entry
value string a value that will be printed preformatted
showDefault boolean display this value by default
Source:

addHeader(header)

add a header element to the content panel
Parameters:
Name Type Description
header string the header string
Source:

addI18n(translations)

Add additional translations.
Parameters:
Name Type Description
translations the new translations to add
Source:

addParametersToAJAX(ajax, additionalParams)

Uses prepareAddParameter to set all variables to the AJAX request
Parameters:
Name Type Description
ajax object the AJAX Request
additionalParams Array the parameters
Source:

addPromptToAjax(ajax)

add PROMPT Values to ajax request Will always be encoded
Parameters:
Name Type Description
ajax object The AJAX Request
Source:

addPromptToObject(object, keepPreviousopt)

Adds the content of PROMPT to an object
Parameters:
Name Type Attributes Default Description
object object Object to put the PROMPTs into
keepPrevious boolean <optional>
 false if previously set parameters should be kept
Source:

alreadyEncoded(input)

Check if a string is already url encoded
Parameters:
Name Type Description
input
Source:
Returns:
true if already encoded

buildBASEURLForPageFile(pageopt, isPOST, additionalParams, keepPreviousopt) → {string}

Build the page URL.
Parameters:
Name Type Attributes Default Description
page string <optional>
 '' the page to open, can be number or string if it is a subreport
isPOST boolean send via POST?
additionalParams object list of additional parameters
keepPrevious boolean <optional>
 false if previously set parameters should be kept
Source:
Returns:
The full URL to request a report file
Type
string

buildParameterString(additionalParams, keepPreviousopt) → {string}

Prepares the parameter statement to be send to the server. It will put all the additionParams together, add the PROMT parameters and return a string of them
Parameters:
Name Type Attributes Default Description
additionalParams Array the parameters
keepPrevious boolean <optional>
 false if previously set parameters should be kept
Source:
Returns:
the combined list of additionalParams and PROMPTS
Type
string

closeAllPopUps()

Close all popups that have been opened with the popupHandler
Source:

documentFrameHolder() → {element}

Retrieve the element that will hold the popup div.
Source:
Returns:
the element that will hold the popup
Type
element

ensureDefaultZoom()

Ensure that the default zoom has a reasonable value
Source:
Returns:
a curated zoom value

ensureParameterPromptKey(name)

Prompts for subreports may contain paramters that need special treatment.
Parameters:
Name Type Description
name a parameter name with a potential #-sign
Source:
Returns:
if the parameter name included a #-sign, encoded vbalue

getPromptsField()

Return the save prompt fields
Source:

hide(timed)

Hide the popup after an amount of time
Parameters:
Name Type Description
timed number timout to close the popup
Source:

initHTMLViewer()

Initializes the htmlViewer.
Source:

isReportFinished()

Check if the report rendering already finished.
Source:

popupHandler(popupURL, finishFunction, popUpId, singular) → {object}

Opens a URL in a popup / popover This is inteded for login forms and the prompt dialog.
Parameters:
Name Type Description
popupURL string The URL to open
finishFunction function Function to execute when page has been opened
popUpId string unique popupID if you know it already
singular boolean if true, same popUpId can be reused, meaning addtional dialogs in same container
Source:
Returns:
The popup
Type
object

prepareAddParameter(additionalParams, encode) → {Array}

Prepare additional parameters and encode if needed. Will also generte a vgen if not set already Uses prepareaddParameterToArray
Parameters:
Name Type Description
additionalParams Array parameters to put together
encode boolean if it should encode
Source:
Returns:
Array of parameters
Type
Array

prepareAddParameterToArray(array, additionalParams, encode) → {Array}

Merge URL parameters into array of existing URL parameters The function is intended to prepare the URL parameters that will be send to the server
Parameters:
Name Type Description
array Array Array to merge the new parameters into
additionalParams Array Array of parameters to be merged
encode boolean If the parameters shoud be encodeUROComponent encoded
Source:
Returns:
Array of merged paramters
Type
Array

prepareRemoveParameterFromArray(array, additionalParams) → {Array}

Remove parameters from the Array.
Parameters:
Name Type Description
array Array Input Array
additionalParams Array List of names to be removed from the input array
Source:
Returns:
Array with removed entries
Type
Array

promptHandling(data, finishFunction)

Handler for the prompt dialog
Parameters:
Name Type Description
data string URL to open
finishFunction function function to execute when done
Source:

setPromptsField()

Return the save prompt fields
Source:

show()

Show the popup
Source:

startPolling()

Start polling the server if we are in online mode.
Source:

stopPolling()

Stop polling the server
Source: