2019-10-09 02:21:28 -05:00
|
|
|
"""
|
|
|
|
|
ResInsight 2d plot module
|
|
|
|
|
"""
|
|
|
|
|
import rips.generated.Commands_pb2 as Cmd
|
|
|
|
|
|
|
|
|
|
from rips.pdmobject import PdmObject
|
2020-02-21 05:10:02 -06:00
|
|
|
from rips.generated.pdm_objects import PlotWindow, Plot
|
|
|
|
|
from rips.pdmobject import add_method
|
2019-10-09 02:21:28 -05:00
|
|
|
|
2020-04-16 09:06:18 -05:00
|
|
|
|
2020-02-21 05:10:02 -06:00
|
|
|
@add_method(PlotWindow)
|
|
|
|
|
def export_snapshot(self, export_folder='', file_prefix='', output_format='PNG'):
|
|
|
|
|
""" Export snapshot for the current plot
|
2020-04-16 09:06:18 -05:00
|
|
|
|
2020-02-21 05:10:02 -06:00
|
|
|
Arguments:
|
|
|
|
|
export_folder(str): The path to export to. By default will use the global export folder
|
|
|
|
|
prefix (str): Exported file name prefix
|
|
|
|
|
output_format(str): Enum string. Can be 'PNG' or 'PDF'.
|
2020-04-16 09:06:18 -05:00
|
|
|
|
2020-02-21 05:10:02 -06:00
|
|
|
"""
|
|
|
|
|
return self._execute_command(
|
|
|
|
|
exportSnapshots=Cmd.ExportSnapshotsRequest(type='PLOTS',
|
2020-04-16 09:06:18 -05:00
|
|
|
prefix=file_prefix,
|
|
|
|
|
viewId=self.id,
|
|
|
|
|
exportFolder=export_folder,
|
|
|
|
|
plotOutputFormat=output_format))
|
