Skip to main content

Mechanical scripting interface

GraphicsImageExportSettings

Last update: 14.01.2025

class Ansys.Mechanical.Graphics.GraphicsImageExportSettings

Bases: object

GraphicsImageExportSettings class.

Overview

Properties

Name Description
AppendGraph Specifies whether to append the viewport graph(s) to the exported image. Defaults to false.
Background Specifies the background color. Defaults to GraphicsAppearanceSetting.
Capture Specifies what to include in the capture. Defaults to ImageAndLegend.
CurrentGraphicsDisplay Specifies whether to use the current graphics display settings. Defaults to true.
FontMagnification Specifies the font magnification factor. Defaults to 1.0.
Height Specifies the image height. Defaults to 0. If width AND height are zero, this uses the current dimensions. If only one of the two are nonzero, the current dimension’s ratio is used along with the nonzero of the two properties to determine the computed value of the zero property.
Resolution Specifies the resolution type. Defaults to NormalResolution.
Width Specifies the image width. Defaults to 0. If width AND height are zero, this uses the current dimensions. If only one of the two are nonzero, the current dimension’s ratio is used along with the nonzero of the two properties to determine the computed value of the zero property.

Property detail

property GraphicsImageExportSettings.AppendGraph : bool | None

Specifies whether to append the viewport graph(s) to the exported image. Defaults to false.

property GraphicsImageExportSettings.Background : Ansys.Mechanical.DataModel.Enums.GraphicsBackgroundType | None

Specifies the background color. Defaults to GraphicsAppearanceSetting.

property GraphicsImageExportSettings.Capture : Ansys.Mechanical.DataModel.Enums.GraphicsCaptureType | None

Specifies what to include in the capture. Defaults to ImageAndLegend.

property GraphicsImageExportSettings.CurrentGraphicsDisplay : bool | None

Specifies whether to use the current graphics display settings. Defaults to true.

property GraphicsImageExportSettings.FontMagnification : float | None

Specifies the font magnification factor. Defaults to 1.0.

property GraphicsImageExportSettings.Height : int | None

Specifies the image height. Defaults to 0. If width AND height are zero, this uses the current dimensions. If only one of the two are nonzero, the current dimension’s ratio is used along with the nonzero of the two properties to determine the computed value of the zero property.

property GraphicsImageExportSettings.Resolution : Ansys.Mechanical.DataModel.Enums.GraphicsResolutionType | None

Specifies the resolution type. Defaults to NormalResolution.

property GraphicsImageExportSettings.Width : int | None

Specifies the image width. Defaults to 0. If width AND height are zero, this uses the current dimensions. If only one of the two are nonzero, the current dimension’s ratio is used along with the nonzero of the two properties to determine the computed value of the zero property.