molstarview design docs/questions

[hainm]

• What's the motivation to write molstarview while we have nglview already?
• Minimal features
  • trajectory support
  • render image
  • download image
  • embed
    • How to trigger saving molstar snapshot if using
      • write_html -> Use threading
      • click Save Notebook Widgets State button
        • Easiest solution is to ask for user to call something like view.save_state before doing above.
  • Basically following nglview's API (and accept nglview's Structure and Trajectory objects)
    • add_structure
    • add_trajectory
    • representations
      • display view with default=False, no repr.
      • add_representation(type, params): https://github.com/molstar/molstar/blob/a56716ab6abb3902d16b9d6f7f208cb345229a7b/src/mol-repr/structure/registry.ts
    • add_shape
    • sync camera
  • shape improvement? added a trajectory after declaring the shapes, the trajectory would simply not move. nglviewer/nglview#1022
  • layout is configurable? https://github.com/molstar/molstar/blob/d1e17785b8404eec280ad04a6285ad9429c5c9f3/src/apps/viewer/app.ts#L118-L170 -> json format about GUI's layout?
    • programmatically update the layout?

[hainm]

Questions to ask/answer

• update coords -> no clear solution
• save state
• full screen mode (we can also use nglview's Fullscreen and implement handle_resize method)
• plugin.managers.structure.component.addRepresentation vs plugin.builders.structure.representation.addRepresentation: https://github.com/molstar/molstar/blob/b99026bba2cca2138aaa5b9566deba70b8ddb22e/src/mol-plugin-state/manager/structure/component.ts#L311-L326
• test for JS code?

[hainm]

Issues

• Overlapping text in full size mode