dundas.view.ViewParameter Class

 

Inheritance Hierarchy

 
Class
   dundas.view.ViewParameter
 

Constructors

 
  Name Description
init Initializes the ViewParameter. Called during construction.
 
 

Properties

 
  Name Description
clientData Gets or sets any additional information to be stored with this view parameter.
elementParameterLinks Gets or sets the element parameter links for this view parameter, which is the links to each adapter, metric set element usage and parameter that this view parameter is acting on.
elementParameterLinksCount Gets the number of elementParameterLinks contained in this view parameter.
excludeFromExport Gets or sets whether the view parameter is included in export.
friendlyName Gets or sets the friendly name of this view parameter, which is the name shown to the end user.
id Gets or sets the ID of this view parameter.
name Gets or sets the name of this view parameter to be used in script.
parameterValue Gets or sets the parameter value for this view parameter.
 
 

Methods

 
  Name Description
addElementParameterLink Adds an element parameter link to this view parameter.
checkNameGeneration Since generating names is expensive, it should be done only on-demand.
clearElementParameterLinks Clears the collection of element parameter links from this view parameter.
fromJObject Applies the property values from a plain object created from JSON to the properties of this instance. Inherited from Class.
getElementParameterLink Gets the element parameter link for the given information.
getElementParameterLinks Gets the element parameter links for the given information.
getElementParameterLinksByAdapter Finds all the binding links for a given adapter ID.
getFirstParameter Gets the first parameter that this view parameter is acting on. This is most useful when the hierarchy is needed.
getMetricSetBindingsFromLinks When the view parameter is being used in a View, this method will return all the metric set bindings being affected by this View parameter. This includes those in container controls.
getParameterAdapterInfo Gets a parameter adapter info (control info) to represent this view parameter. This is mostly used when a visual adapter is needed from this view parameter, but none is there yet.
getParameterValueType Gets the parameter value type for this view parameter.
invalidateParameterValueLastModifiedTime Invalidates the last modified time of the parameter value (if there is any) to now.
loadAffectedAdaptersData Refreshes the data on all affected adapters that this view parameter is attached to.
refreshAllAdapters Refreshes the UI for all adapter's which are using this view parameter to display parameter choices, as well as calling loadAffectedAdaptersData to load data on all adapters which are affected by this view parameter unless specifically set not to.

Static
refreshAllViewParameters Given many view parameters, this method will attempt to call refreshAllAdapters in a smarter way to avoid excessive requests when only a single adapter is the end target. If multiple adapters are the end target, then the first one found will be gathered into a single call, while the rest of the affected will be refresh as normal.
removeElementParameterLink Removes an element parameter link from this view parameter.
toJSON Implementation for toJSON to return an object that will include this class's prototype property values when stringified. Inherited from Class.