Class actuate.Parameter
Parameter class represents a Parameter object.
Member of: actuate.
Constructor Attributes | Constructor Name and Description |
---|---|
actuate.Parameter(container)
Constructs a new Parameter object.
|
Method Attributes | Method Name and Description |
---|---|
downloadParameterMap(callback)
Returns ParameterValues as a collection of key/value pair, where parameterName is the key and parameterValue is the value.
|
|
downloadParameters(callBack)
Returns an array list of ParameterDefinition based on the report parameters
of the report name.
|
|
downloadParameterValues(callback)
Returns an array list of ParameterValue.
|
|
This method should be called after report parameter is available.
|
|
returns the report name used by the Parameter object
|
|
returns the transient report document name
|
|
Hides the navigation bar
|
|
hideParameterGroup(groupNames)
Hide all report parameters that belongs to a group or to a list of groups.
|
|
hideParameterName(parameterNames)
Hides a list of parameter names or a single report parameter name.
|
|
navigate(containerId, navTarget)
Programmatic way of controlling a customized navigation bar
|
|
onUnload()
unloads javascript variables that are no longer needed by Parameter
|
|
registerEventHandler(eventName, handler)
Register the event handler
|
|
removeEventHandler(eventName, handler)
Remove the event handler
|
|
renderContent(pds, callback)
Render the Parameter Definitions content to the container.
|
|
setAutoSuggestDelay(delay)
Sets the autosuggest delay time in milliseconds for autosuggest control type
|
|
setAutoSuggestFetchSize(size)
Set the fetch size of the autosuggestion list.
|
|
setAutoSuggestListSize(size)
Set the list size of the autosuggestion list.
|
|
setContainer(containerID)
The container that will be used for rendering the parameter page html fragment
|
|
setGroupContainer(groupNames, containerID)
Set the container ID for the group.
|
|
setLayout(layout)
Set the layout for the parameters
|
|
setReadOnly(readOnly)
Set if parameter UI should be set to read only or not.
|
|
setReportName(reportName)
Set's the report path to be used for querying report parameters
NOTE: Accepts report designs as well as persistent report documents
|
|
setService(iportalURL, requestOptions)
Set the iportal service this Parameter component points to
|
|
setShowDisplayType(showDisplayType)
Set if localized info is to be shown or not like "Required" etc.
|
|
setTransientDocumentName(docName, connHandle)
Set the transient report document name
|
|
submit(callback)
submit the parameter page component request.
|
Class Detail
actuate.Parameter(container)
Constructs a new Parameter object.
- Parameters:
- {String} container
- container object or name of a container in the current document
Method Detail
downloadParameterMap(callback)
Returns ParameterValues as a collection of key/value pair, where parameterName is the key and parameterValue is the value.
Sample: var myparams = new Object(); myparams[parameterName] = parameterValue; return myparams;This method takes a callback since multi-value parameters need to be encoded through iPortal.
- Parameters:
- {Function} callback
- The function to call after the parameter values have been downloaded. The function will receive an array of actuate.parameter.ParameterValue as an input argument.
- Returns:
- {void}
{void} downloadParameters(callBack)
Returns an array list of ParameterDefinition based on the report parameters
of the report name. This method will send an AJAX GetReportParameters
web service request to iPortal
- Parameters:
- {Function} callBack
- The function to call after the download of report parameters is completed. Sends an array of actuate.parameter.ParameterDefinition to the callBack function as an input argument
- Returns:
- {void}
{void} downloadParameterValues(callback)
Returns an array list of ParameterValue. This method takes a callback since multi-value parameters need to be encoded through iportal.
- Parameters:
- {Function} callback
- The function to call after the parameter values have been downloaded. The function will receive an array of actuate.parameter.ParameterValue as an input argument.
- Returns:
- {void}
getParameterGroupNames()
This method should be called after report parameter is available.
returns group names of this report
- Returns:
- An Array of group names.
{String} getReportName()
returns the report name used by the Parameter object
- Returns:
- {String}
{String} getTransientDocumentName()
returns the transient report document name
- Returns:
- {String}
{void} hideNavBar()
Hides the navigation bar
- Returns:
- {void}
{void} hideParameterGroup(groupNames)
Hide all report parameters that belongs to a group or to a list of groups.
- Parameters:
- {String} groupNames
- If an array of strings is passed in, this method will iterate through the Array of String to hide each parameter group name. Otherwise if groupNames is just a String, then only hide that parameter group name.
- Returns:
- {void}
{void} hideParameterName(parameterNames)
Hides a list of parameter names or a single report parameter name.
- Parameters:
- {String} parameterNames
- If an array of strings is passed in, this method will iterate through the Array of String to hide each parameter name. Otherwise if parameterNames is just a String, then only hide that parameter name.
- Returns:
- {void}
{void} navigate(containerId, navTarget)
Programmatic way of controlling a customized navigation bar
- Parameters:
- {String} containerId
- Id of container of navTarget
- {String} navTarget
- Navigation to trigger
- Returns:
- {void}
- See:
- actuate.parameter.Constants
- actuate.parameter.Constants.NAV_FIRST
- actuate.parameter.Constants.NAV_PREV
- actuate.parameter.Constants.NAV_NEXT
- actuate.parameter.Constants.NAV_LAST
{void} onUnload()
unloads javascript variables that are no longer needed by Parameter
- Returns:
- {void}
{void} registerEventHandler(eventName, handler)
Register the event handler
- Parameters:
- {String} eventName
- Event name to capture.
- {Function} handler
- Where to pass control to, after fetching & rendering is done
- Returns:
- {void}
- See:
- actuate.parameter.EventConstants for supported parameter events
{void} removeEventHandler(eventName, handler)
Remove the event handler
- Parameters:
- {String} eventName
- Event name to remove from the registered events.
- {Function} handler
- Handler function name to make sure that the correct eventName is being removed from the event handler.
- Returns:
- {void}
- See:
- actuate.parameter.EventConstants for supported parameter events
{void} renderContent(pds, callback)
Render the Parameter Definitions content to the container. The submit api will internally call this renderContent api.
The renderContent assumes that the user has already a list of ParameterDefinition to process.
- Parameters:
- {Array} pds
- An array of actuate.parameter.ParameterDefinition to render
- {Function} callback
- Where to pass control to, after rendering is done
- Returns:
- {void}
{void} setAutoSuggestDelay(delay)
Sets the autosuggest delay time in milliseconds for autosuggest control type
- Parameters:
- {long} delay
- Returns:
- {void}
{void} setAutoSuggestFetchSize(size)
Set the fetch size of the autosuggestion list. If not set, by default fetch all suggestions from the server
This will impact all autosuggest control type
- Parameters:
- {Integer} size
- Returns:
- {void}
{void} setAutoSuggestListSize(size)
Set the list size of the autosuggestion list. If not set, show all suggestions from the server
- Parameters:
- {Integer} size
- Returns:
- {void}
{void} setContainer(containerID)
The container that will be used for rendering the parameter page html fragment
- Parameters:
- {String} containerID
- the container id
- Returns:
- {void}
{void} setGroupContainer(groupNames, containerID)
Set the container ID for the group. Parameters with this group name will
be rendered in the specified container
- Parameters:
- {String} groupNames
- array of group name or a single group name
- {String} containerID
- ID of the container in which the parameter with given group name need to be rendered
- Returns:
- {void}
{void} setLayout(layout)
Set the layout for the parameters
- Parameters:
- {String} layout
- Type of layout (see actuate.parameter.Constants for options)
- Returns:
- {void}
- See:
- actuate.parameter.Constants
- actuate.parameter.Constants.LAYOUT_NONE
- actuate.parameter.Constants.LAYOUT_GROUP
{void} setReadOnly(readOnly)
Set if parameter UI should be set to read only or not.
- Parameters:
- {boolean} readOnly
- Returns:
- {void}
{void} setReportName(reportName)
Set's the report path to be used for querying report parameters
NOTE: Accepts report designs as well as persistent report documents
- Parameters:
- {String} reportName
- The fully qualified repository path name of a report
- Returns:
- {void}
{void} setService(iportalURL, requestOptions)
Set the iportal service this Parameter component points to
- Parameters:
- {String} iportalURL
- {actuate.RequestOptions} requestOptions
- Returns:
- {void}
{void} setShowDisplayType(showDisplayType)
Set if localized info is to be shown or not like "Required" etc.
- Parameters:
- {boolean} showDisplayType
- Returns:
- {void}
{void} setTransientDocumentName(docName, connHandle)
Set the transient report document name
- Parameters:
- {String} docName
- The fully qualified path to the transient report document
- {String} connHandle
- Connection handle of the transient report document
- Returns:
- {void}
{void} submit(callback)
submit the parameter page component request.
This api will download the report parameters and then render the list of parameter definitions to the container.
- Parameters:
- {Function} callback
- Where to pass control to, after fetching & rendering is done
- Returns:
- {void}