Adapter.generateMetricSetBinding Method

Generates a metric set binding for this adapter and bindings for it from a metric set. This is useful when an element is dropped somewhere and a metric set binding and the bindings should be generated. Data is not retrieved for this call, the bindings are just generated, unless auto load is specified.

Parameters

id

Type: String
The ID of the metric set to use to generate.

autoLoadData

Type: Boolean
(optional) Whether or not data should be auto-loaded after the binding has been generated.
Optional: True

metricSet

Type: MetricSet
(optional) The metric set (if already retrieved).
Optional: True

options

Type: Object

(optional) Additional options for generation, such as binding information. Structure:
     addedElements       [type: Array, elementType: Object]              - (optional) An array of objects describing what is being added.
         elementUsage    [type: dundas.data.AnalysisElementUsage]        - The element usage from within the metric set that is the column.
         bindingId       [type: String]                                  - (optional) The binding target ID that the element was added for.
         bindingName     [type: String]                                  - (optional) The binding target name that the element was added for.
         levelUniqueName [type: String]                                  - (optional) The level unique name that this element is for.

     isUndoable          [type: Boolean]                                 - (optional) If provided, this action will create an undo snapshot.

Optional: True

Return Value

Type: jQuery.Promise
Value: Object

A promise object that is resolved when the action is finished.
 The returned object has the following structure:
     metricSet           [type: dundas.entities.MetricSet]               - The metric set object that was retrieved/given.
     metricSetBinding    [type: dundas.view.controls.MetricSetBinding]   - The metric set binding that was generated.