Embed a dizmo

To embed a dizmo in yours you need to create the embedded dizmo first.

You can do that separately in the same way as you implement and build any other dizmo. The result can then be embedded into your dizmo by copying the .dzm file into your dizmo. The assets folder on the top level of your dizmo is the typical place to put it.

Embedding a dizmo
Embedding a dizmo

Using dizmoGen

dizmoGen allows you to specify one or more embedded dizmos. In order to do so add an “embedded_projects” array to your dizmo’s package.json file. It consists of the bundle identifier for every embedded dizmo.

"settings": {
  "embedded_bundles": [


In order to use your embedded dizmos you will need to indicate their presence to dizmoViewer by including their bundleIDs in the Info.plist file. To do this integrate the following section in your Info.plist file. Without this dizmoViewer will not uninstall your embedded dizmos.


If your main dizmo bundle is deinstalled by dizmoViewer, it will use this list to uninstall any of your embedded dizmos.

Note: Please note that all embedded dizmos must use the same domain prefix as your main dizmo. Otherwise they will not be installed.

Installing an embedded dizmo

In order to instantiate your embedded dizmo later you must first install the bundle from within your main dizmo. Use viewer.installBundle to do this. The installation is done asynchronously so the rest of the environment does not have to wait for procedure to be finished.

To get notified you may specify a callback function that will be executed one the installation is complete. For example this allows to instantiate a dizmo from your bundle as soon as it becomes available.

// install a dizmo that is located inside of my own bundle in the assets directory
viewer.installBundle("bundle://assets/my_embedded_dizmo_v0.1.2.dzm", startDizmo);

// instantiate the embedded dizmo from its bundle
function startDizmo(bundleid,error) {
    var newBundle = new dizmojs.Bundle(bundleid);
    var newDizmo = newBundle.instantiateDizmo();

To check if your bundle has been installed before, you may request a list of bundles installed (viewer.getBundles) and check if the embedded dizmo is part of this list. If so, close all of these dizmo instances before uninstalling the bundle.

Uninstalling an embedded dizmo

If your main dizmo bundle is deinstalled by dizmoViewer, it will use the list in EmbeddedBundles to uninstall any of your embedded dizmos.