v2.2.0

Core

• Renamed modules (_widget.py → widget.py, etc.) - by @christian-oreilly and @hanayik in #105 (7812824)
• Shifted from name-based to ID-based system for models - by @AnthonyAndroulakis in #139 (e1eae5b)
• Update ipyniivue to use latest niivue version (as of now, 0.57.0) - by @AnthonyAndroulakis in #138 (1ad7e57) and #153 (4d0d0c0)

🚀 Features

• Created documentation site by @bcalford in #99 (4ae99ce) and @AnthonyAndroulakis in #150 (47a5667)
• Added Drawing model and methods - by @bcalford in 04ebe9c
• Added download_dataset - by @bcalford in 44487b9
• Add CI testing - by @christian-oreilly and @hanayik in #105 (7812824)
• Added MeshLayer model - by @AnthonyAndroulakis in #151 (ba4d21b)
• Added event-based synchronization between frontend and backend and all Niivue event hooks - by @AnthonyAndroulakis in #145 (25c9d97)
• Niivue instance and display persistence across cells in Jupyter notebooks (each model points to 1 nv object) - by @AnthonyAndroulakis in #148 (42b36ec)
• Support drag-and-dropped data from frontend (<fromfrontend> name placeholder) - by @AnthonyAndroulakis in #144 (2181a58)
• New methods:
  • colormaps, add_colormap, set_colormap, set_selection_box_color, set_crosshair_color, set_crosshair_width, set_gamma, set_slice_type, set_clip_plane, set_render_azimuth_elevation, set_mesh_shader, mesh_shader_names - by @AnthonyAndroulakis in #152 (bbc7754)
  • save_document, save_html, save_image, and save_scene - by @bcalford in #124 (150ff1f)
• New properties:
  • name in Volume and Mesh - by @AnthonyAndroulakis in #144 (2181a58)
  • colormap_invert in Volume, Mesh, and MeshLayer - by @AnthonyAndroulakis in #152 (bbc7754)
  • background_masks_overlays in NiiVue - by @AnthonyAndroulakis in #152 (bbc7754)
  • multiplanar_show_render option - by @AnthonyAndroulakis in #152 (bbc7754)
  • frame4D in Volume - by @Jolinda and @christian-oreilly in #119 (70baed9)
  • frame4D in MeshLayer - by @AnthonyAndroulakis in #152 (bbc7754)
  • colorbar_visible in MeshLayer - by @AnthonyAndroulakis in #154 (e44b1b6)
• New Constants:
  • ShowRender: Controls when the 3D render view is displayed (NEVER, ALWAYS, AUTO) - by @AnthonyAndroulakis in #152 (bbc7754)

📝 Added new examples

• add_from_frontend.ipynb - by @AnthonyAndroulakis in #144 (2181a58)
• colormaps.ipynb, colormaps.mesh.ipynb, mask.ipynb, and mesh.4d.ipynb - by @AnthonyAndroulakis in #152 (bbc7754)
• drawing.ipynb - by @bcalford in c100924
• example_4d.ipynb - by @Jolinda and @christian-oreilly in #119 (70baed9)
• mesh_and_volume.ipynb - by @kolibril13 in cb6103a
• mosaic.ipynb - by @Jolinda in #143 (13c9d70)
• on_event.ipynb - by @AnthonyAndroulakis in #145 (25c9d97)
• prototypes/meshes_(GIfTI, FreeSurfer, MZ3, OBJ, STL, legacy VTK).ipynb - by @kolibril13 in cb6103a
• prototypes/torso_regions.ipynb - by @kolibril13 in cb6103a
• prototypes/trajectory.ipynb - by @kolibril13 in cb6103a
• saving.ipynb - by @bcalford in #124 (150ff1f)

    View changes on GitHub