Bootstrap.embedMetricSet Method

Gets a metric set and embeds it in the given DOM element.

Parameters

element

Type: HTMLElement
The HTML element to render the metric set in.

metricSetId

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

options

Type: Object

 (optional)
     sessionId                   [type: String, optional: true]      - (optional) A session ID to automatically use to set the session on the bootstrap.

     embeddedViewServiceName     [type: String, optional: true]      - (optional) If multiple items are being embedded, an embedded
                                                                                 view service is required for each. The name of the one to be generated can be specified with this argument.

     doNotCreateTemporaryCopy    [type: Boolean, optional: true]     - (optional) By default the metric set is copied into a temporary folder so the user can make changes to it even if it
                                                                                 is is not checked out to them. Setting this to true will use the metric set as-is.

Optional: True

Return Value

Type: jQuery.Promise
A promise object that is resolved when the call is complete.