PrintGraphicsToFileRequest

Attribute Name	Data Type	Description
filepath	str	Path to the output file.
graphic_export_attributes	google.protobuf.Any	Export attributes specifying the output format and format-specific parameters. Supported types: PrintToImageFileAttributes
color_mode	GraphicColorMode	Color mode of the exported graphics.
frame_type	GraphicFrameType	Frame and title block type.
include_color_scale	bool	Whether to include the color scale in the exported graphics.
graphic_pictures_mode	GraphicPicturesMode	Graphics rendering mode. Default: AS_SCREEN_VIEW.
color_scale_settings	GraphicColorScaleSettings	Color scale position and size settings. Applied only when include_color_scale is true.
graphic_border_settings	GraphicBorderSettings	Graphic border settings.
compress_stretch_settings	GraphicCompressStretchSettings	Compress or stretch model along global axes.
color_of_rendered_objects_enable	bool	Whether to show the “Color of Rendered Objects” overlay. Requires color_rendering_mode to be set to a value other than GRAPHIC_COLOR_RENDERING_MODE_UNSPECIFIED.
display_factors_enable	bool	Whether to apply display factors from the current display settings.
text_size_factor	float	Text size scale factor relative to the default size.
symbol_size_factor	float	Symbol size scale factor relative to the default size.
to_scale_ratio	int	Scale denominator for TO_SCALE mode (e.g. 100 means 1:100). Default: 100.
color_of_rendered_objects_position	GraphicCornerPosition	Position of the “Color of Rendered Objects” panel. Applied only when color_of_rendered_objects_enable is true.
overview_image_settings	GraphicOverviewImageSettings	Overview image settings. Renders a small thumbnail of the full model in a corner of the exported image.
color_rendering_mode	GraphicColorRenderingMode	Color rendering mode to apply to the view during export. Required when color_of_rendered_objects_enable is true.
model_id	ModelId	Unique identifier of the model. If not specified, the active model is used.

Associated Data Types

PrintToImageFileAttributes

Attribute Name	Data Type	Description
picture_quality	GraphicPictureQuality	Picture quality preset. When GRAPHIC_PICTURE_QUALITY_USER_DEFINED, physical_width, physical_height, and pixel_size must be specified.
physical_width	float	Physical width of the output image in meters. Used only when picture_quality is GRAPHIC_PICTURE_QUALITY_USER_DEFINED.
physical_height	float	Physical height of the output image in meters. Used only when picture_quality is GRAPHIC_PICTURE_QUALITY_USER_DEFINED.
pixel_size	int	Pixel count of the longer side of the output image (valid range: 1000..5000). Used only when picture_quality is GRAPHIC_PICTURE_QUALITY_USER_DEFINED.

GraphicColorScaleSettings

Attribute Name	Data Type	Description
alignment	GraphicColorScaleAlignment	Alignment of multiple color scales.
space	float	Space between multiple color scales in meters.
size_mode	GraphicColorScaleSizeMode	Size mode for the color scale window.
height	float	Absolute height of color scale window in meters. Used when size_mode is ABSOLUTE.
width	float	Absolute width of color scale window in meters. Used when size_mode is ABSOLUTE.
position	GraphicColorScalePosition	Position of the color scale inside the graphic picture.
offset_top	float	Offset from the top edge of the graphic picture in meters. Applied when position is USER_DEFINED.
offset_left	float	Offset from the left edge of the graphic picture in meters. Applied when position is USER_DEFINED.
relative_height	float	Height as a fraction of the picture height (0..1). Used when size_mode is RELATIVE.
relative_width	float	Width as a fraction of the picture width (0..1). Used when size_mode is RELATIVE.
relative_max_height	float	Maximum absolute height in meters. Used when size_mode is RELATIVE.
show_percentage	bool	Whether to show result values as percentage.
rotation	GraphicColorScaleRotation	Rotation of the color scale box.

GraphicCompressStretchSettings

Attribute Name	Data Type	Description
enable	bool	Whether to enable compress/stretch transformation.
factor_x	float	Scale factor along global X axis.
factor_y	float	Scale factor along global Y axis.
factor_z	float	Scale factor along global Z axis.

GraphicBorderSettings

Attribute Name	Data Type	Description
enable	bool	Whether to enable custom border margins.
left	float	Border margin as a fraction of the picture size (0.0..0.5) for each side.
right	float
top	float
bottom	float

GraphicOverviewImageSettings

Attribute Name	Data Type	Description
enable	bool	Whether to enable the overview image.
width	float	Width of the overview image in meters (valid range: 0.01..0.05).
height	float	Height of the overview image in meters (valid range: 0.01..0.05).
position	GraphicOverviewImagePosition	Corner position of the overview image.
display_loads	bool	Whether to show loads in the overview image.
display_imperfections	bool	Whether to show imperfections in the overview image.
display_results	bool	Whether to show results in the overview image.

Associated Enums

GraphicColorScalePosition

Name
GRAPHIC_COLOR_SCALE_POSITION_UNSPECIFIED
GRAPHIC_COLOR_SCALE_POSITION_TOP_LEFT
GRAPHIC_COLOR_SCALE_POSITION_TOP_RIGHT
GRAPHIC_COLOR_SCALE_POSITION_BOTTOM_LEFT
GRAPHIC_COLOR_SCALE_POSITION_BOTTOM_RIGHT
GRAPHIC_COLOR_SCALE_POSITION_USER_DEFINED

GraphicColorScaleRotation

Name
GRAPHIC_COLOR_SCALE_ROTATION_UNSPECIFIED
GRAPHIC_COLOR_SCALE_ROTATION_0_DEGREES
GRAPHIC_COLOR_SCALE_ROTATION_90_DEGREES
GRAPHIC_COLOR_SCALE_ROTATION_180_DEGREES
GRAPHIC_COLOR_SCALE_ROTATION_270_DEGREES

GraphicPicturesMode

Name
GRAPHIC_PICTURES_MODE_UNSPECIFIED
GRAPHIC_PICTURES_MODE_AS_SCREEN_VIEW
GRAPHIC_PICTURES_MODE_WINDOW_FILLING
GRAPHIC_PICTURES_MODE_TO_SCALE

GraphicColorScaleAlignment

Name
GRAPHIC_COLOR_SCALE_ALIGNMENT_UNSPECIFIED
GRAPHIC_COLOR_SCALE_ALIGNMENT_HORIZONTAL
GRAPHIC_COLOR_SCALE_ALIGNMENT_VERTICAL

GraphicColorScaleSizeMode

Name
GRAPHIC_COLOR_SCALE_SIZE_MODE_UNSPECIFIED
GRAPHIC_COLOR_SCALE_SIZE_MODE_AUTOMATIC
GRAPHIC_COLOR_SCALE_SIZE_MODE_ABSOLUTE
GRAPHIC_COLOR_SCALE_SIZE_MODE_RELATIVE

GraphicPictureQuality

Name
GRAPHIC_PICTURE_QUALITY_UNSPECIFIED
GRAPHIC_PICTURE_QUALITY_LOW
GRAPHIC_PICTURE_QUALITY_MEDIUM
GRAPHIC_PICTURE_QUALITY_HIGH
GRAPHIC_PICTURE_QUALITY_USER_DEFINED

GraphicColorMode

Name
GRAPHIC_COLOR_MODE_UNSPECIFIED
GRAPHIC_COLOR_MODE_ALL_COLORED
GRAPHIC_COLOR_MODE_GRAYSCALE
GRAPHIC_COLOR_MODE_TEXT_AND_LINES_BLACK

GraphicFrameType

Name
GRAPHIC_FRAME_TYPE_UNSPECIFIED
GRAPHIC_FRAME_TYPE_NONE
GRAPHIC_FRAME_TYPE_FRAMED

GraphicColorRenderingMode

Name
GRAPHIC_COLOR_RENDERING_MODE_UNSPECIFIED
GRAPHIC_COLOR_RENDERING_MODE_OBJECTS
GRAPHIC_COLOR_RENDERING_MODE_LAYERS
GRAPHIC_COLOR_RENDERING_MODE_VISIBILITIES

GraphicCornerPosition

Name
GRAPHIC_CORNER_POSITION_UNSPECIFIED
GRAPHIC_CORNER_POSITION_TOP_LEFT
GRAPHIC_CORNER_POSITION_TOP_RIGHT
GRAPHIC_CORNER_POSITION_BOTTOM_LEFT
GRAPHIC_CORNER_POSITION_BOTTOM_RIGHT

GraphicOverviewImagePosition

Name
GRAPHIC_OVERVIEW_IMAGE_POSITION_UNSPECIFIED
GRAPHIC_OVERVIEW_IMAGE_POSITION_TOP_LEFT
GRAPHIC_OVERVIEW_IMAGE_POSITION_TOP_RIGHT
GRAPHIC_OVERVIEW_IMAGE_POSITION_BOTTOM_LEFT
GRAPHIC_OVERVIEW_IMAGE_POSITION_BOTTOM_RIGHT
GRAPHIC_OVERVIEW_IMAGE_POSITION_OUTSIDE_UNDER_IMAGE