Managed Dashboards and Reports Embed Viewer

This applies to: Managed Dashboards, Managed Reports

When Symphony is embedded directly onto your page, dundas.context is a dundas.views.embedded.Bootstrap.

Call its embedView method to embed an existing viewType by its ID, which you can find from its URL or properties dialog. It is rendered inside the DOM element you specify, which should have some set size independent of its contents (i.e., not auto). The following embeds a dashboard:

The third argument is an object specifying additional optional values. Important options include passing sessionId as an alternative to first calling and waiting for setSessionId, and viewTypewhen embedding a type of view other than a dashboard like in the next example. A jQuery.Promise is returned that you can use to wait for the embedding to complete.

Content is always embedded on its own without other interface elements like the application's toolbar or main menu, but with most functionality accessible by default as usual from the context menu via right-click or long-tap.

If you are embedding multiple items on your page, a separate EmbeddedViewService is used for displaying each one. Specify an embeddedViewServiceNameof your choice starting at least with the second embedding call (omitting this will cause an error such as "Service EmbeddedViewService is already registered"). Either to wait for the first embedding method to finish, or to call and wait for setSessionId first before embedding any content as follows:

Note: You can use the name you specified for an embedded view service or else its class name EmbeddedViewService when calling getService to get its instance. For example, you can call its dispose method if you want to remove the content from your page.

Parameter Values

When calling embedView, you can use the viewOverrides option to pass in as well as create view parameter values. The same parameter value types are used as shown in Modify a Filter / View Parameter Using Scripting.

The following example sets an existing numeric parameter with the script name viewParameter1 when embedding the dashboard:

Similarly, you can create a view parameter that did not already exist, like the following that sets some specific hierarchy members by their unique names:

Note: Find a visualization's adapterId in the Properties window, and the metricSetBindingId in the metric set settings dialog accessible from the Data Analysis Panel. The parameter ID is defined on each AnalysisElementUsage in a metric set's measures or hierarchies as analysisElementUsage.parameter.id.

Apply Themes

You can use other services from the JavaScript API to use the ThemeService to get a theme by its file ID, then call the method on the current view (e.g., dashboard or report) to apply it. See the following script example.