SessionVisualizationHighQualityImage Class¶
-
class
NXOpen.Preferences.
SessionVisualizationHighQualityImage
¶ Bases:
object
Represents the High Quality Image preferences for the entire session
To obtain an instance of this class, refer to
NXOpen.Preferences.SessionPreferences
New in version NX4.0.0.
Properties¶
Property | Description |
---|---|
Orientation | Returns or sets the orientation for the High Quality Image (portrait or landscape). |
PlotQuality | Returns or sets the quality of the plot of the High Quality Image. |
SubRegion | Returns or sets the setting for whether the High Quality Image is generated from a sub-region. |
Methods¶
Method | Description |
---|---|
GetImageSize | Returns the image size to use for the generation of the High Quality Image. |
GetResolution | Returns the resolution to use when generating a High Quality Image. |
SetImageSize | Specifies the image size to use for the generation of the High Quality Image. |
SetResolution | Specifies the resolution to use when generating a High Quality Image. |
Enumerations¶
SessionVisualizationHighQualityImageImageSizeType Enumeration | The size at which to generate a High Quality Image. |
SessionVisualizationHighQualityImageOrientationType Enumeration | Whether the High Quality Image is to be generated with portrait or landscape orientation |
SessionVisualizationHighQualityImagePlotQualityType Enumeration | Describes the quality desired when plotting the High Quality Image |
SessionVisualizationHighQualityImageResolutionType Enumeration | The resolution to use when generating a High Quality Image. |
Property Detail¶
Orientation¶
-
SessionVisualizationHighQualityImage.
Orientation
¶ Returns or sets the orientation for the High Quality Image (portrait or landscape).
orientation is not used if image_size is fill_view or user_defined.
-------------------------------------
Getter Method
Signature
Orientation()
Returns: Return type: NXOpen.Preferences.SessionVisualizationHighQualityImageOrientationType
New in version NX4.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
Orientation(orientation)
Parameters: orientation ( NXOpen.Preferences.SessionVisualizationHighQualityImageOrientationType
) –New in version NX4.0.0.
License requirements: None.
PlotQuality¶
-
SessionVisualizationHighQualityImage.
PlotQuality
¶ Returns or sets the quality of the plot of the High Quality Image.
plot_quality is not used if image_size is fill_view
-------------------------------------
Getter Method
Signature
PlotQuality()
Returns: Return type: NXOpen.Preferences.SessionVisualizationHighQualityImagePlotQualityType
New in version NX4.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
PlotQuality(plotQuality)
Parameters: plotQuality ( NXOpen.Preferences.SessionVisualizationHighQualityImagePlotQualityType
) –New in version NX4.0.0.
License requirements: None.
SubRegion¶
-
SessionVisualizationHighQualityImage.
SubRegion
¶ Returns or sets the setting for whether the High Quality Image is generated from a sub-region.
sub_region is only used when image_size is fill_view
-------------------------------------
Getter Method
Signature
SubRegion()
Returns: Return type: bool New in version NX4.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
SubRegion(useSubRegion)
Parameters: useSubRegion (bool) – New in version NX4.0.0.
License requirements: None.
Method Detail¶
GetImageSize¶
-
SessionVisualizationHighQualityImage.
GetImageSize
¶ Returns the image size to use for the generation of the High Quality Image.
x_size and y_size vary only for User Defined image size type. For other image size types, the values returned in them are the x and y sizes fixed for the image size type.
Signature
GetImageSize()
Returns: a tuple Return type: A tuple consisting of (imageSize, xSize, ySize). imageSize is a NXOpen.Preferences.SessionVisualizationHighQualityImageImageSizeType
. xSize is a int. X Pixel size. See note above. ySize is a int. Y Pixel size. See note aboveNew in version NX4.0.0.
License requirements: None.
GetResolution¶
-
SessionVisualizationHighQualityImage.
GetResolution
¶ Returns the resolution to use when generating a High Quality Image.
The resolution is not used if the image_size is fill_view. dots_per_inch is variable only for User Defined resolution type. For other resolution types, the returned dots_per_inch is the number of dots per inch which is fixed for the given resolution type.
Signature
GetResolution()
Returns: a tuple Return type: A tuple consisting of (resolution, dotsPerInch). resolution is a NXOpen.Preferences.SessionVisualizationHighQualityImageResolutionType
. dotsPerInch is a int. Dots per inch. See note above.New in version NX4.0.0.
License requirements: None.
SetImageSize¶
-
SessionVisualizationHighQualityImage.
SetImageSize
¶ Specifies the image size to use for the generation of the High Quality Image.
x_size and y_size only apply for User Defined image size type. For other image size types, they are ignored.
Signature
SetImageSize(imageSize, xSize, ySize)
Parameters: - imageSize (
NXOpen.Preferences.SessionVisualizationHighQualityImageImageSizeType
) – - xSize (int) – X Pixel size. Used only if image_size is user_defined
- ySize (int) – Y Pixel size. Used only if image_size is user_defined
New in version NX4.0.0.
License requirements: None.
- imageSize (
SetResolution¶
-
SessionVisualizationHighQualityImage.
SetResolution
¶ Specifies the resolution to use when generating a High Quality Image.
The given resolution is not used if the image_size is fill_view. dots_per_inch is used only for User Defined resolution. For other resolutions types, the input dots_per_inch is ignored.
Signature
SetResolution(resolution, dotsPerInch)
Parameters: - resolution (
NXOpen.Preferences.SessionVisualizationHighQualityImageResolutionType
) – - dotsPerInch (int) – Dots per inch. Used only if resolution is user_defined
New in version NX4.0.0.
License requirements: None.
- resolution (