IImageFormatParams

class IImageFormatParams

Bases: ImpactCOMWrapperBase

Description:

Specifies the options required to save graphic images.

Remarks:

This object is used in various methods, such as IWindow.save_to_file2, IDrawing.save_drawing_as_image, ILayer.save_layer_as_image.

Wraps a COM object or another wrapper instance. Accepts: - A valid impact_object - An existing impact_com_wrapper_base-derived instance

property background_colour

Gets background_colour.

Description:

Specifies the required background colour to be used in the image.

Remarks:

Introduced in Impact 12.0.0.165

Returns:

The value of background_colour.

Return type:

background_colour (int)

property colour_depth

Gets colour_depth.

Description:

Specifies the number of colours in the saved image file.

Returns:

The value of colour_depth.

Return type:

colour_depth (ipImageColourFormat)

property compression

Gets Compression.

Description:

Specifies the type of compression used when saving the image file.

Returns:

The value of Compression.

Return type:

compression (ipCompressionFormat)

property compression_factor

Gets compression_factor.

Description:

Specifies the compression factor in percent.

Returns:

The value of compression_factor.

Return type:

compression_factor (int)

property height

Gets Height.

Description:

Specifies the height of the saved image in pixels.

Returns:

The value of Height.

Return type:

height (int)

property resolution

Gets Resolution.

Description:

Specifies the resolution of the saved image in dots-per-inch.

Returns:

The value of Resolution.

Return type:

resolution (int)

property width

Gets Width.

Description:

Specifies the width of the saved image in pixels.

Returns:

The value of Width.

Return type:

width (int)

Examples