Jupyter CadQuery API¶
The functions this viewer has beyond the shared Python API. Everything shared — the show family, set_defaults, set_viewer_config, status, save_screenshot, animation, color maps — is documented once, in the shared chapters, and takes this viewer's viewer= keyword as described under Addressing a viewer.
| function | see |
|---|---|
open_viewer(title, ...) |
Managing viewers |
close_viewer(title) |
Managing viewers |
close_viewers() |
Managing viewers |
get_viewer(title=None) |
Managing viewers |
get_viewers() |
Managing viewers |
get_viewer_by_id(id) |
Managing viewers |
get_viewers_by_id() |
Managing viewers |
set_default_viewer(title, anchor=) |
Addressing a viewer |
get_default_viewer() |
Addressing a viewer |
export_html(filename, ...) |
Export |
auto_show() |
Auto display |
get_pick(assembly, pick) |
Reading a pick back |
enable_replay(...) |
Replay, from jupyter_cadquery.replay |
disable_replay() |
Replay, from jupyter_cadquery.replay |
replay(obj, ...) |
Replay, from jupyter_cadquery.replay |
save_user_defaults() |
Workspace Config |
get_user_defaults() |
Workspace Config |
cvw_version |
the installed cad-viewer-widget version, the one an export loads |
show returns the CadViewer it drew into. Its properties (zoom, position, quaternion, target, tab, axes, grid, the clip and zebra settings, last_pick, …) read the viewer's live state and, where the viewer can change, set it — cv.tab = "clip" is set_viewer_config(tab=UiTab.CLIP) by another route.