ViewWindow

class rips.ViewWindow(pb2_object: PdmObject | None = None, channel: Channel | None = None)

Bases: PdmObjectBase

The Base Class for all Views and Plots in ResInsight

Methods Summary

export_snapshot([export_folder, prefix, ...])

Export a snapshot of the view or plot to a file

Methods Documentation

export_snapshot(export_folder: str = '', prefix: str = '', width: int = -1, height: int = -1, file_format: SnapshotFileFormat = SnapshotFileFormat.PNG) → None

Export a snapshot of the view or plot to a file

Parameters:

  • export_folder (str) -- Folder to export to. Defaults to the 'snapshots' folder next to the project file.

  • prefix (str) -- Prefix for the generated file name

  • width (int) -- Image width in pixels. Use -1 for the current size.

  • height (int) -- Image height in pixels. Use -1 for the current size.

  • file_format (SnapshotFileFormat) -- One of [PNG, PDF]

Returns: