Print¶

The print commands are used to print selected canvas objects to a file or to a Windows or PostScript printer and to control the format of the printed output.

Other Classes¶

class EpsOptions[source]¶

Bases: _OptionsBase

The EpsOptions object stores the settings that Abaqus uses when printing using Encapsulated PostScript format. The EpsOptions object has no constructor. Abaqus creates the epsOptions member when a session is started.

Note

This object can be accessed by:

session.epsOptions

Note

Check EpsOptions on help.3ds.com/2024.

Member Details:

fontType : --is-rst--:py:class:`~abaqus.UtilityAndView.SymbolicConstant.SymbolicConstant` = 'PS_IF_AVAILABLE'[source]¶: A SymbolicConstant specifying the PostScript font substitution rules to be applied. Possible values are PS_ALWAYS, PS_IF_AVAILABLE, and AS_DISPLAYED. The default value is PS_IF_AVAILABLE.

imageFormat : --is-rst--:py:class:`~abaqus.UtilityAndView.SymbolicConstant.SymbolicConstant` = 'VECTOR'[source]¶: A SymbolicConstant specifying how the viewport display will be represented. Possible values are VECTOR and RASTER. The default value is VECTOR.

imageSize : --is-rst--:py:data:`~typing.Union`\ \[:py:class:`~abaqus.UtilityAndView.SymbolicConstant.SymbolicConstant`, :py:class:`float`] = 'SIZE_ON_SCREEN'[source]¶: The SymbolicConstant SIZE_ON_SCREEN or a pair of Floats specifying the width and height of the image in the units specified by units. Possible numeric values are imageSize ≥ (minWidth, minHeight). The default value is SIZE_ON_SCREEN. Note: The minimum value of width and height (minWidth and minHeight) is 10 mm (approximately 0.4 inches).

resolution : --is-rst--:py:class:`~abaqus.UtilityAndView.SymbolicConstant.SymbolicConstant` = 'DPI_150'[source]¶: A SymbolicConstant specifying the resolution of the image in dots per inch (dpi). The resolution can be DPI_1200 only if imageFormat = VECTOR. Possible values are DPI_75, DPI_150, DPI_300, DPI_450, DPI_600, and DPI_1200. The default value is DPI_150.

setValues( *, imageSize=SIZE_ON_SCREEN, units=INCHES, resolution=DPI_150, fontType=PS_IF_AVAILABLE, imageFormat=VECTOR, shadingQuality=MEDIUM, )[source]¶

This method modifies the EpsOptions object.

Note

Check EpsOptions.setValues on help.3ds.com/2024.

Parameters:¶

imageSize=SIZE_ON_SCREEN¶: The SymbolicConstant SIZE_ON_SCREEN or a pair of Floats specifying the width and height of the image in the units specified by units. Possible numeric values are imageSize ≥ (minWidth, minHeight). The default value is SIZE_ON_SCREEN. Note: The minimum value of width and height (minWidth and minHeight) is 10 mm (approximately 0.4 inches).
units=INCHES¶: A SymbolicConstant specifying the units of the imageSize argument. This argument is ignored if imageSize is SIZE_ON_SCREEN. Possible values are INCHES and MM. The default value is INCHES.
resolution=DPI_150¶: A SymbolicConstant specifying the resolution of the image in dots per inch (dpi). The resolution can be DPI_1200 only if imageFormat = VECTOR. Possible values are DPI_75, DPI_150, DPI_300, DPI_450, DPI_600, and DPI_1200. The default value is DPI_150.
fontType=PS_IF_AVAILABLE¶: A SymbolicConstant specifying the PostScript font substitution rules to be applied. Possible values are PS_ALWAYS, PS_IF_AVAILABLE, and AS_DISPLAYED. The default value is PS_IF_AVAILABLE.
imageFormat=VECTOR¶: A SymbolicConstant specifying how the viewport display will be represented. Possible values are VECTOR and RASTER. The default value is VECTOR.
shadingQuality=MEDIUM¶: A SymbolicConstant specifying how fine the shading of curved surfaces will be for vector images. Possible values are EXTRA COARSE, COARSE, MEDIUM, FINE, and EXTRA FINE. The default value is MEDIUM.

Raises:¶

RangeError – If either element of imageSize is out of range.

shadingQuality : --is-rst--:py:class:`~abaqus.UtilityAndView.SymbolicConstant.SymbolicConstant` = 'MEDIUM'[source]¶: A SymbolicConstant specifying how fine the shading of curved surfaces will be for vector images. Possible values are EXTRA COARSE, COARSE, MEDIUM, FINE, and EXTRA FINE. The default value is MEDIUM.

units : --is-rst--:py:class:`~abaqus.UtilityAndView.SymbolicConstant.SymbolicConstant` = 'INCHES'[source]¶: A SymbolicConstant specifying the units of the imageSize argument. This argument is ignored if imageSize is SIZE_ON_SCREEN. Possible values are INCHES and MM. The default value is INCHES.

class PageSetupOptions[source]¶

Bases: _OptionsBase

The PageSetupOptions object stores the settings that Abaqus uses when printing using a Windows printer. The PageSetupOptions object has no constructor. Abaqus creates the pageSetupOptions member when a session is started.

Note

This object can be accessed by:

session.pageSetupOptions

Note

Check PageSetupOptions on help.3ds.com/2024.

Member Details:

bottomMargin : --is-rst--:py:class:`float` = 0.5[source]¶: A Float specifying the bottom margin of the paper in the currently selected units (inches or millimeters). Possible values are bottomMargin ≥ 0. The default value is 0.5.

date : --is-rst--:py:data:`~typing.Union`\ \[:py:class:`~abaqus.UtilityAndView.AbaqusBoolean.AbaqusBoolean`, :py:class:`bool`] = 1[source]¶: A Boolean specifying whether the output includes the date. The default value is ON.

imageSize : --is-rst--:py:data:`~typing.Union`\ \[:py:class:`~abaqus.UtilityAndView.SymbolicConstant.SymbolicConstant`, :py:class:`float`] = 'FIT_TO_PAGE'[source]¶: The SymbolicConstant SIZE_ON_SCREEN or a pair of Floats specifying the width and height of the image in the units specified by units. Possible numeric values are imageSize ≥ (minWidth, minHeight). The default value is SIZE_ON_SCREEN. Note: The minimum value of width and height (minWidth and minHeight) is 10 mm (approximately 0.4 inches).

leftMargin : --is-rst--:py:class:`float` = 0.5[source]¶: A Float specifying the left margin of the paper in the currently selected units (inches or millimeters). Possible values are leftMargin ≥ 0. The default value is 0.5.

logo : --is-rst--:py:data:`~typing.Union`\ \[:py:class:`~abaqus.UtilityAndView.AbaqusBoolean.AbaqusBoolean`, :py:class:`bool`] = 1[source]¶: A Boolean specifying whether the output includes the Abaqus logo. The default value is ON.

orientation : --is-rst--:py:class:`~abaqus.UtilityAndView.SymbolicConstant.SymbolicConstant` = 'PORTRAIT'[source]¶: A SymbolicConstant specifying the orientation of the image. Possible values are PORTRAIT and LANDSCAPE. The default value is PORTRAIT.

quality : --is-rst--:py:class:`~abaqus.UtilityAndView.SymbolicConstant.SymbolicConstant` = 'MEDIUM'[source]¶: A SymbolicConstant specifying the quality of the image. Possible values are COARSE, MEDIUM, and FINE. The default value is MEDIUM.

rightMargin : --is-rst--:py:class:`float` = 0.5[source]¶: A Float specifying the right margin of the paper in the currently selected units (inches or millimeters). Possible values are rightMargin ≥ 0. The default value is 0.5.

setValues( *, imageSize=FIT_TO_PAGE, units=INCHES, quality=MEDIUM, topMargin=0.5, bottomMargin=0.5, leftMargin=0.5, rightMargin=0.5, orientation=PORTRAIT, logo=1, date=1, )[source]¶

This method modifies the PageSetupOptions object.

Note

Check PageSetupOptions.setValues on help.3ds.com/2024.

Parameters:¶

imageSize=FIT_TO_PAGE¶: A SymbolicConstant or a pair of Floats specifying the size of the printed image in the currently selected units (inches or millimeters). Possible values are FIT_TO_PAGE and SIZE_ON_SCREEN. The default value is FIT_TO_PAGE. Note: The minimum value of width and height (minWidth and minHeight) is 10 mm (approximately 0.4 inches).
units=INCHES¶: A SymbolicConstant specifying the units to use for the margins and image size. Possible values are INCHES and MM. The default value is INCHES.
quality=MEDIUM¶: A SymbolicConstant specifying the quality of the image. Possible values are COARSE, MEDIUM, and FINE. The default value is MEDIUM.
topMargin=0.5¶: A Float specifying the top margin of the paper in the currently selected units (inches or millimeters). Possible values are topMargin ≥ 0. The default value is 0.5.
bottomMargin=0.5¶: A Float specifying the bottom margin of the paper in the currently selected units (inches or millimeters). Possible values are bottomMargin ≥ 0. The default value is 0.5.
leftMargin=0.5¶: A Float specifying the left margin of the paper in the currently selected units (inches or millimeters). Possible values are leftMargin ≥ 0. The default value is 0.5.
rightMargin=0.5¶: A Float specifying the right margin of the paper in the currently selected units (inches or millimeters). Possible values are rightMargin ≥ 0. The default value is 0.5.
orientation=PORTRAIT¶: A SymbolicConstant specifying the orientation of the image. Possible values are PORTRAIT and LANDSCAPE. The default value is PORTRAIT.
logo=1¶: A Boolean specifying whether the output includes the Abaqus logo. The default value is ON.
date=1¶: A Boolean specifying whether the output includes the date. The default value is ON.

Raises:¶

RangeError – Note: The minimum value of width and height (minWidth and minHeight) is 10 mm (approximately 0.4 inches).
RangeError – If leftMargin + rightMargin is out of range.
RangeError – If topMargin + bottomMargin is out of range.

topMargin : --is-rst--:py:class:`float` = 0.5[source]¶: A Float specifying the top margin of the paper in the currently selected units (inches or millimeters). Possible values are topMargin ≥ 0. The default value is 0.5.

units : --is-rst--:py:class:`~abaqus.UtilityAndView.SymbolicConstant.SymbolicConstant` = 'INCHES'[source]¶: A SymbolicConstant specifying the units to use for the margins and image size. Possible values are INCHES and MM. The default value is INCHES.

class PngOptions[source]¶

Bases: _OptionsBase

The PngOptions object stores the settings that Abaqus uses when printing in PNG format.

The PngOptions object has no constructor. Abaqus creates the pngOptions member when a session is started.

Note

Check PngOptions on help.3ds.com/2024.

Member Details:

imageSize : --is-rst--:py:class:`~abaqus.UtilityAndView.SymbolicConstant.SymbolicConstant` = 'SIZE_ON_SCREEN'[source]¶: The SymbolicConstant SIZE_ON_SCREEN or a pair of Ints specifying the width and height of the image in pixels. Possible values are (minWidth, minHeight) ≤ imageSize ≤ (maxWidth and maxHeight). The default value is SIZE_ON_SCREEN. Note: The minimum value of width and height (minWidth and minHeight) is the number of pixels that occupy 10 mm at the current screen resolution. The value is typically around 50pixels and may be different for width and height. The maximum value of width and height (maxWidth and maxHeight) is the largest number of pixels supported by the system graphics and will be at least as large as the screen dimensions.

setValues(*, imageSize=SIZE_ON_SCREEN)[source]¶

This method modifies the PngOptions object.

Note

Check PngOptions.setValues on help.3ds.com/2024.

Parameters:¶

imageSize=SIZE_ON_SCREEN¶: The SymbolicConstant SIZE_ON_SCREEN or a pair of Ints specifying the width and height of the image in pixels. Possible values are (minWidth, minHeight) ≤ imageSize ≤ (maxWidth and maxHeight). The default value is SIZE_ON_SCREEN. Note: The minimum value of width and height (minWidth and minHeight) is the number of pixels that occupy 10 mm at the current screen resolution. The value is typically around 50 pixels and may be different for width and height. The maximum value of width and height (maxWidth and maxHeight) is the largest number of pixels supported by the system graphics and will be at least as large as the screen dimensions.

Raises:¶

RangeError – imageSize must be SIZE_ON_SCREEN or a sequence of 2 Ints in the range (minWidth, minHeight) <= (width, height) <= (maxWidth, maxHeight) If either the width or height arguments of imageSize are out of range (where minWidth and minHeight are the number of pixels corresponding to approximately 10 mm for a given display and maxWidth and maxHeight are the largest allowable number of pixels supported by the system graphics).

class PrintOptions[source]¶

Bases: _OptionsBase

The PrintOptions object stores the common settings that Abaqus uses for all print methods. The PrintOptions object has no constructor. Abaqus creates the printOptions member when a session is started.

Note

This object can be accessed by:

session.printOptions

Note

Check PrintOptions on help.3ds.com/2024.

Member Details:

compass : --is-rst--:py:data:`~typing.Union`\ \[:py:class:`~abaqus.UtilityAndView.AbaqusBoolean.AbaqusBoolean`, :py:class:`bool`] = 0[source]¶: A Boolean specifying whether the output includes the view compass. The default value is OFF.

deleteTemporaryFiles : --is-rst--:py:data:`~typing.Union`\ \[:py:class:`~abaqus.UtilityAndView.AbaqusBoolean.AbaqusBoolean`, :py:class:`bool`] = 1[source]¶: A Boolean specifying whether to delete the temporary files created when an image is printed. The default value is ON. You should set the deleteTemporaryFiles argument to False if your printer does not support print spooling.

printCommand : --is-rst--:py:class:`str` = 'lpr'[source]¶: A String specifying the default print command that will be used by the printToPrinter method if no printCommand argument is provided. The default value is “lpr”.

reduceColors : --is-rst--:py:data:`~typing.Union`\ \[:py:class:`~abaqus.UtilityAndView.AbaqusBoolean.AbaqusBoolean`, :py:class:`bool`] = 0[source]¶: A Boolean specifying whether the raster image printed is reduced from true color to 256 colors to reduce file size. The quality of the image will be compromised. The default value is OFF.

rendition : --is-rst--:py:class:`~abaqus.UtilityAndView.SymbolicConstant.SymbolicConstant` = 'COLOR'[source]¶: A SymbolicConstant specifying how the image is rendered. Possible values are BLACK_AND_WHITE, GREYSCALE, and COLOR. The default value is COLOR.

setValues( *, rendition=COLOR, vpDecorations=1, vpBackground=0, compass=0, printCommand='lpr', deleteTemporaryFiles=1, reduceColors=0, )[source]¶

This method modifies the PrintOptions object.

Note

Check PrintOptions.setValues on help.3ds.com/2024.

Parameters:¶

rendition=COLOR¶: A SymbolicConstant specifying how the image is rendered. Possible values are BLACK_AND_WHITE, GREYSCALE, and COLOR. The default value is COLOR.
vpDecorations=1¶: A Boolean specifying whether the output includes the viewport border and title. The default value is ON.
vpBackground=0¶: A Boolean specifying whether the output includes viewport backgrounds. The default value is OFF.
compass=0¶: A Boolean specifying whether the output includes the view compass The default value is OFF.
printCommand='lpr'¶: A String specifying the default print command that will be used by the printToPrinter method if no printCommand argument is provided. The default value is “lpr”.
deleteTemporaryFiles=1¶: A Boolean specifying whether to delete the temporary files created when an image is printed. The default value is ON. You should set the deleteTemporaryFiles argument to False if your printer does not support print spooling.
reduceColors=0¶: A Boolean specifying whether the raster image printed is reduced from true color to 256 colors to reduce file size. The quality of the image will be compromised. The default value is OFF.

vpBackground : --is-rst--:py:data:`~typing.Union`\ \[:py:class:`~abaqus.UtilityAndView.AbaqusBoolean.AbaqusBoolean`, :py:class:`bool`] = 0[source]¶: A Boolean specifying whether the output includes viewport backgrounds. The default value is OFF.

vpDecorations : --is-rst--:py:data:`~typing.Union`\ \[:py:class:`~abaqus.UtilityAndView.AbaqusBoolean.AbaqusBoolean`, :py:class:`bool`] = 1[source]¶: A Boolean specifying whether the output includes the viewport border and title. The default value is ON.

class PsOptions[source]¶

Bases: _OptionsBase

The PsOptions object stores the settings that Abaqus uses when printing using PostScript format. The PsOptions object has no constructor. Abaqus creates the psOptions member when a session is started.

Note

This object can be accessed by:

session.psOptions

Note

Check PsOptions on help.3ds.com/2024.

Member Details:

bottomMargin : --is-rst--:py:class:`float` = 0.5[source]¶: A Float specifying the bottom margin of the paper in inches. Possible values are bottomMargin ≥ 0. The default value is 0.5.

date : --is-rst--:py:data:`~typing.Union`\ \[:py:class:`~abaqus.UtilityAndView.AbaqusBoolean.AbaqusBoolean`, :py:class:`bool`] = 1[source]¶: A Boolean specifying whether the output includes the date. The default value is ON.

fontType : --is-rst--:py:class:`~abaqus.UtilityAndView.SymbolicConstant.SymbolicConstant` = 'PS_IF_AVAILABLE'[source]¶

imageFormat : --is-rst--:py:class:`~abaqus.UtilityAndView.SymbolicConstant.SymbolicConstant` = 'VECTOR'[source]¶

leftMargin : --is-rst--:py:class:`float` = 0.5[source]¶: A Float specifying the left margin of the paper in inches. Possible values are leftMargin ≥ 0. The default value is 0.5.

logo : --is-rst--:py:data:`~typing.Union`\ \[:py:class:`~abaqus.UtilityAndView.AbaqusBoolean.AbaqusBoolean`, :py:class:`bool`] = 1[source]¶: A Boolean specifying whether the output includes the Abaqus logo. The default value is ON.

orientation : --is-rst--:py:class:`~abaqus.UtilityAndView.SymbolicConstant.SymbolicConstant` = 'PORTRAIT'[source]¶: A SymbolicConstant specifying the orientation of the image. Possible values are PORTRAIT and LANDSCAPE. The default value is PORTRAIT.

paperSize : --is-rst--:py:class:`~abaqus.UtilityAndView.SymbolicConstant.SymbolicConstant` = 'LETTER'[source]¶

A SymbolicConstant specifying the paper size. Possible values are:

LETTER
LEGAL
LEDGER
A0
A1
A2
A3
A4
A5

The default value is LETTER.

resolution : --is-rst--:py:class:`~abaqus.UtilityAndView.SymbolicConstant.SymbolicConstant` = 'DPI_150'[source]¶

rightMargin : --is-rst--:py:class:`float` = 0.5[source]¶: A Float specifying the right margin of the paper in inches. Possible values are rightMargin ≥ 0. The default value is 0.5.

setValues( *, paperSize=LETTER, topMargin=0.5, bottomMargin=0.5, leftMargin=0.5, rightMargin=0.5, orientation=PORTRAIT, logo=1, date=1, resolution=DPI_150, fontType=PS_IF_AVAILABLE, imageFormat=VECTOR, shadingQuality=MEDIUM, )[source]¶

This method modifies the PsOptions object.

Note

Check PsOptions.setValues on help.3ds.com/2024.

Parameters:¶

paperSize=LETTER¶

A SymbolicConstant specifying the paper size. Possible values are:

LETTER
LEGAL
LEDGER
A0
A1
A2
A3
A4
A5

The default value is LETTER.

topMargin=0.5¶

A Float specifying the top margin of the paper in inches. Possible values are topMargin ≥ 0. The default value is 0.5.

bottomMargin=0.5¶

A Float specifying the bottom margin of the paper in inches. Possible values are bottomMargin ≥ 0. The default value is 0.5.

leftMargin=0.5¶

A Float specifying the left margin of the paper in inches. Possible values are leftMargin ≥ 0. The default value is 0.5.

rightMargin=0.5¶

A Float specifying the right margin of the paper in inches. Possible values are rightMargin ≥ 0. The default value is 0.5.

orientation=PORTRAIT¶

A SymbolicConstant specifying the orientation of the image. Possible values are PORTRAIT and LANDSCAPE. The default value is PORTRAIT.

logo=1¶

A Boolean specifying whether the output includes the Abaqus logo. The default value is ON.

date=1¶

A Boolean specifying whether the output includes the date. The default value is ON.

resolution=DPI_150¶

A SymbolicConstant specifying the resolution of the image in dots per inch (dpi). The resolution can be DPI_1200 only if imageFormat = VECTOR. Possible values are DPI_75, DPI_150, DPI_300, DPI_450, DPI_600, and DPI_1200. The default value is DPI_150.

fontType=PS_IF_AVAILABLE¶

A SymbolicConstant specifying the PostScript font substitution rules to be applied. Possible values are PS_ALWAYS, PS_IF_AVAILABLE, and AS_DISPLAYED. The default value is PS_IF_AVAILABLE.

imageFormat=VECTOR¶

A SymbolicConstant specifying how the viewport display will be represented. Possible values are VECTOR and RASTER. The default value is VECTOR.

shadingQuality=MEDIUM¶

A SymbolicConstant specifying how fine the shading of curved surfaces will be for vector images. Possible values are EXTRA COARSE, COARSE, MEDIUM, FINE, and EXTRA FINE. The default value is MEDIUM.

Raises:¶

RangeError – Note: The minimum value of width and height (minWidth and minHeight) is 10 mm (approximately 0.4 inches).
RangeError – If leftMargin + rightMargin is out of range.
RangeError – If topMargin + bottomMargin is out of range.

shadingQuality : --is-rst--:py:class:`~abaqus.UtilityAndView.SymbolicConstant.SymbolicConstant` = 'MEDIUM'[source]¶

topMargin : --is-rst--:py:class:`float` = 0.5[source]¶: A Float specifying the top margin of the paper in inches. Possible values are topMargin ≥ 0. The default value is 0.5.

class SvgOptions[source]¶

Bases: _OptionsBase

The SvgOptions object stores the settings that Abaqus uses when printing in SVG format. The SvgOptions object has no constructor. Abaqus creates the svgOptions member when a session is started.

Note

This object can be accessed by:

session.svgOptions

Note

Check SvgOptions on help.3ds.com/2024.

Member Details:

imageSize : --is-rst--:py:class:`~abaqus.UtilityAndView.SymbolicConstant.SymbolicConstant` = 'SIZE_ON_SCREEN'[source]¶: The SymbolicConstant SIZE_ON_SCREEN or a pair of Ints specifying the width and height of the image in pixels. Possible values are (minWidth, minHeight ) ≤ imageSize ≤ (maxWidth and maxHeight). The default value is SIZE_ON_SCREEN. Note: The minimum value of width and height (minWidth and minHeight) is the number of pixels that occupy 10 mm at the current screen resolution. The value is typically around 50 pixels and may be different for width and height.The maximum value of width and height (maxWidth and maxHeight) is the largest number of pixels supported by the system graphics and will be at least as large as the screen dimensions.

setValues(*, imageSize=SIZE_ON_SCREEN)[source]¶

This method modifies the SvgOptions object.

Note

Check SvgOptions.setValues on help.3ds.com/2024.

Parameters:¶

imageSize=SIZE_ON_SCREEN¶: The SymbolicConstant SIZE_ON_SCREEN or a pair of Ints specifying the width and height of the image in pixels. Possible values are (minWidth, minHeight ) ≤ imageSize ≤ (maxWidth and maxHeight). The default value is SIZE_ON_SCREEN. Note: The minimum value of width and height (minWidth and minHeight) is the number of pixels that occupy 10 mm at the current screen resolution. The value is typically around 50 pixels and may be different for width and height.The maximum value of width and height (maxWidth and maxHeight) is the largest number of pixels supported by the system graphics and will be at least as large as the screen dimensions.

Raises:¶