(v24) Embed Components Into Your Application

Embed Components Into Your Application

This applies to: Visual Data Discovery

You can embed Symphony components into your own applications.

The following components can be embedded:

• dashboards, lite dashboards

• visual authoring experience

• source editor

When components are embedded, the way in which users can interact with them is determined by settings established in their Symphony user account. See Embedded Symphony Component Controls.

Note: insightsoftware recommends using Trusted Access for all embed-related workflows.

The list of options available on an embedded visual's drop-down menu depends on:

• The mode setting for the dashboard. If the embed mode is readonly or Read Only, no menu is available at all.

• The visual interactivity settings specified in the visual definition.

• The dashboard interactivity settings specified for the dashboard, if those settings include override interactivity settings for all visuals in the dashboard.

When options are shown for a visual in an embedded dashboard, they may be shown in the visual sidebar menu or within the visual drop-down menu itself, depending on the setting of the editor.placement property.

• If editor.placement is set to dockRight, the options appear in sidebars using the visual sidebar menu and the resulting sidebar editing panels.

  If editor.placement is set to modals, the options appear in the visual drop-down menu itself and the resulting floating dialogs.

Note: In environments where you use Typescript for your client side code, you can use Embed Manager as an npm package. See https://www.npmjs.com/package/logi-embed.

See the following topics for embedding components using JavaScript:

• Embedded Component Prerequisites

• Token-Related Configuration Properties

• Embed Symphony Components Using JavaScript and Trusted Access

• EmbedManager Methods

• Embedded Dashboard Properties and Objects

• Embedded Visual Authoring Properties and Objects

• Embedded Events

• Interactivity Properties

• Embedded Symphony Component Controls

See the following topics for embedding a dashboard using an embeddable dashboard snippet:

• Embedded Component Prerequisites

• Generate an Embeddable Dashboard HTML Snippet

• Generate a Visual Gallery HTML Snippet

• Embed a Dashboard Using a Generated Snippet and Trusted Access Tokens

• Embedded Symphony Component Controls

• Embed Multiple Symphony Dashboards On a Single Page

See the following topics for embedding the source editor:

• Embedded Source Editor

• Embed Source Editor Properties