dundas.view.controls.MetricSetBinding Class

Defines how a metric set is bound to a data visualization.
 

Inheritance Hierarchy

 
Class
   dundas.view.controls.MetricSetBinding
 

Constructors

 
  Name Description
init Initializes the MetricSetBinding. Called during construction.
 
 

Properties

 
  Name Description
bindings Gets or sets the bindings for this metric set (see dundas.view.controls.Binding). This is used to link to columns within the metric set.
bypassDataCache Gets or sets a value indicating whether the data cache should be bypassed for the this metric set binding.
bypassResultSizeLimit Gets or sets a value indicating whether the engine must ignore any result size limitations or not.
dataResult Gets the current data result for this metric set. This might be null if a request has never occurred.
friendlyName Gets or sets the friendly name for this binding, which is the name shown to the end user.
id Gets or sets the ID of this binding.
includeAnnotations Gets or sets a value indicating whether to include data annotations.
includeMeasureCorrections Gets or sets a value indicating whether to include measure corrections.
isLocalDataResult Gets or sets if the dundas.data.DataResult is locally assigned for this metric set.
metricSetId Gets or sets the ID of the metric set that this binding is linked to.
name Gets or sets the name of this binding. The name is used in script, and may change over time, but must be unique between all bindings on this adapter.
 
 

Methods

 
  Name Description
copyTransientMetricSet If called, the underlying metric set will be retrieved. If it is a transient metric set, it will be copied and this metric set binding will be updated to use this instead.
fromJObject Applies the property values from a plain object created from JSON to the properties of this instance. Inherited from Class.
getMetricSet Gets the metric set associated with this binding. Typically the result will be cached, so the return will be near instant, however there's no guarantee, so this call is async.
toJSON Implementation for toJSON to return an object that will include this class's prototype property values when stringified. Inherited from Class.