save_snapshot

Viewport.save_snapshot(file_path: str | Path, settings: SnapshotSettings | None = None) → None

Take a snapshot of this viewport and save it to PNG.

Parameters:

file_pathstr | Path

Path to save the PNG image.

settingsSnapshotSettings, optional

Snapshot settings to control what elements appear in the image (timestamp, logo, legend, solution name, etc.). If None, uses server defaults.