plain-JS wrapper for embeddable LGV

rbuels commented 4 years ago

wraps the embeddable-LGV state model and theme providers (#1027) with plain JS and provides a CDN build of it, so that people can run something like:

<html>
<head>
  <script src="(CDN URL)/component.js"></script>
</head>
<body>
  <div id="jb2_lgv"></div>
  <script>

    const genomeView = new JBrowseLinearGenomeView({
      container: document.getElementById('jb2_lgv'),
      assembly: { /* full assembly config snapshotin */ },
      tracks: [ /* full track snapshotIns */ ],
      plugins: [ /* optional list of runtime plugins to load */ ],
      defaultSession: {
        /* session snapshot just for an LGV */
        bpPerPx: 1,
        displayedRegions: [ /* list of displayed regions */ ]
      }
    })

    // here's how you can react to changes in the state
    genomeView.addChangeListener( (mst_patch) => {
      /* handler for reacting to changes in the LGV's state tree */
    })

    // the view's MST model would just be exposed in the .view attribute, and
    // people could call actions on it
    genomeView.view.navTo("chr4:234235-235245")

    // JBrowseLinearGenomeView would be a subclass of JBrowseEmbeddedViewContainer,
    // which would set up the environment necessary for the view to run (theme, pluginManager,
    // root MST model, etc).
  </script>
</body>

</html>

This code might be a little hard to test so let's try to keep it a very thin wrapper around the code made in #1027. Mostly just a plain-JS class that looks a little like protein-widget/src/Viewer.js, and a webpack configuration that does a CDN-able UMD build of it.

CDN URLs (needs review)

cmdcolin commented 4 years ago

It was briefly mentioned that packaging webworker bundles might be tricky for example. Does that mean embeddable LGV will be limited to MainThreadRpc? Any way to allow web worker? I just ask because RPC adds a fair bit of overhead (not sure we have a way to measure that overhead, maybe by comparing to something like JB1)

rbuels commented 4 years ago

Seems a little bit weird for an embedded thing to be launching web workers. But maybe not too weird. It's not really out of the question that an embedded browser could launch them, it would just need to have a web worker entry point that it builds as well.

On Sun, Sep 6, 2020 at 11:15 AM Colin Diesh notifications@github.com wrote:

It was briefly mentioned that packaging webworker bundles might be tricky for example. Does that mean embeddable LGV will be limited to MainThreadRpc? Any way to allow web worker? I just ask because RPC adds a fair bit of overhead (not sure we have a way

— You are receiving this because you authored the thread. Reply to this email directly, view it on GitHub https://github.com/GMOD/jbrowse-components/issues/1028#issuecomment-687860277, or unsubscribe https://github.com/notifications/unsubscribe-auth/AAASAFP4JMJHMQL7UWAODG3SEPGVRANCNFSM4OJS5L5Q .