Plugins

// Ensure you have a Run function that takes a params object.
function Run(params) {
    console.log("Plugin was run", params);

    // HTML container the plugin is sitting in.
    // This may not exist if it's run as a background script!
    const container = params.container;

    // The element of the plugin itself.
    // This will be sitting inside the container element.
    // This will not exist if either the container or HTML template is not present.
    const element = params.element;

    // The plugin's own ID and record. The record carries Settings,
    // which is where per-account configuration belongs.
    const pluginId = params.pluginId;
    const plugin = params.plugin;

    // Ensure to return a dispose function.
    return () => {
        console.log("Plugin was disposed");
    };
}

<style>
    #MyPlugin {
        background-color: red;
        padding: 8px;
        border-radius: 8px;
        position: absolute;
        z-index: 1;
        left: 0;
        top: 0;
    }
</style>

<div id="MyPlugin">
    <span>
        My plugin!
    </span>
</div>

function Run(params) {
    console.log("Plugin was run", params);
    const pluginParams = params.pluginParams;

    // Plugin record itself.
    // Useful for accessing the settings object within it.
    const plugin = params.plugin;

    // Reference to the Cesium viewer.
    const viewer = pluginParams.viewer;

    // Reference to the Menu Item manager and visual register.
    // This lets you manage Menu Items and know what is currently rendered in the scene.
    const manager = pluginParams.menuItemManager;
    const register = pluginParams.visualRegister;

    // Reference to Cesium, bruce-models, and bruce-cesium NPM libraries.
    const Cesium = pluginParams.Cesium;
    const BModels = pluginParams.BModels;
    const BEngine = pluginParams.BEngine;

    // The current context, without needing a request for any of it.
    // 'getters' is already pointed at this account and session.
    const getters = pluginParams.getters;
    const session = pluginParams.session;
    const account = pluginParams.account;
    const version = pluginParams.version;

    // Reference to function to call so you can force the plugin to dispose and the tool to be disabled.
    const close = pluginParams.close;
    // close();

    // Reference to function to call to open/close a Navigator side-panel.
    // Options are: "dashboard", "menu-items", "bookmarks", "scene-tree", "user", "scene-config", "entity-editor"
    // "comments", "markup", and "walkthrough".
    // If you have an active side-bar plugin, you can open it through "PLUGIN_<THE_PLUGIN_ID>" eg: "PLUGIN_1234abcd".
    const setPanelActive = pluginParams.setPanelActive;

    // Open a panel:
    // setPanelActive("bookmarks", true);

    // Close a panel:
    // setPanelActive("bookmarks", false);

    // Reference to function to call to select or deselect Entities.
    const select = pluginParams.select;
    /*
     * select({
     *     entityIds: ["a", "b"]
     * })
     */

    // Reference to function to call to refresh Entities in the scene/panels.
    const refreshData = pluginParams.refreshData;
    /*
    * refreshData({
    *     entityIds: ["a", "b"]
    * });
    */

    // Reference to function to call to toggle "liveness" of Entities.
    // When an Entity is live, it periodically refreshes its data.
    const updateLiveData = pluginParams.updateLiveData;

    /*
    * Replace current live Entity IDs with given IDs.
    * updateLiveData({
    *     entityIds: ["a", "b"]
    * });
    */

    /*
    * Add given Entity IDs to the current live Entities.
    * updateLiveData({
    *     entityIds: ["a", "b"],
    *     action: true
    * });
    */

    /*
    * Remove given Entity IDs to the current live Entities.
    * updateLiveData({
    *     entityIds: ["a", "b"],
    *     action: false
    * });
    */

    return () => {
        console.log("Plugin was disposed");
    };
}

{
    "panelWidth": "500px"
}

{
    "panelWidth": "300px-900px"
}

{
    "panelWidth": "300px-900px-480px"
}