EmfImage Class

Summary: The API for Enhanced Metafile Format (EMF) vector image format support is
a comprehensive tool for processing graphical images in a device-independent
manner while preserving their original properties. Developed to maintain
proportions, dimensions, colors, and other graphic attributes, it includes
EMF Plus format support and features for cropping regions, resizing canvas
and images, rotating, flipping, setting image palettes, exporting and importing
to APS device context, compressing and converting EMF to other formats, ensuring
versatile manipulation and seamless integration of EMF images across applications.

Module: aspose.imaging.fileformats.emf

Full Name: aspose.imaging.fileformats.emf.EmfImage

Inheritance: IObjectWithBounds, IObjectWithSizeF, MetaImage

Aspose.Imaging Version: 24.7.0

Constructors

Name	Description
EmfImage()	Start working with EMF images by initializing a new instance of the EmfImage class. Ideal for quickly incorporating EMF images into your projects with ease and efficiency.
EmfImage(width, height)	Create a new instance of the EmfImage class by specifying the width and height parameters. This constructor simplifies the process of initializing EMF images with specific dimensions, enhancing the efficiency of your development workflow.

Properties

Name	Type	Access	Description
auto_adjust_palette	bool	r/w	Gets or sets a value indicating whether automatic adjust palette.
background_color	Color	r/w	Gets or sets a value for the background color.
bits_per_pixel	int	r	Retrieve the bit-per-pixel count specific to raster images, as this parameter doesn’t apply to vector images. Quickly ascertain the pixel depth of raster images for precise analysis and manipulation, ensuring accurate handling of image data.
bounds	Rectangle	r	Gets the object bounds.
buffer_size_hint	int	r/w	Gets or sets the buffer size hint which is defined max allowed size for all internal buffers.
container	Image	r	Gets the Image container.
data_stream_container	StreamContainer	r	Gets the object’s data stream.
disposed	bool	r	Gets a value indicating whether this instance is disposed.
file_format	FileFormat	r	Access the file format value associated with the object. Easily determine the format of the file associated with the object for streamlined processing and compatibility checks. Simplify your workflow by retrieving the file format information with ease.
has_background_color	bool	r/w	Gets or sets a value indicating whether image has background color.
header	EmfMetafileHeader	r/w	Retrieve or modify the EMF metafile header record with this property. Ideal for managing metafile data efficiently within your application. Improve your workflow with streamlined access to metafile header information.
height	int	r	Retrieve the image’s height, facilitating accurate rendering and layout adjustments. Accessing the height property ensures compatibility and seamless integration across different platforms and applications.
height_f	float	r	Gets the object height, in inches.
interrupt_monitor	InterruptMonitor	r/w	Gets or sets the interrupt monitor.
is_cached	bool	r	Access a value indicating whether the object’s data is currently cached, eliminating the need for additional data reading. Enhance efficiency by quickly determining if cached data is available for immediate access. Optimize your workflow with streamlined data retrieval processes.
palette	IColorPalette	r/w	Gets or sets the color palette. The color palette is not used when pixels are represented directly.
records	MetaObjectList	r/w	Retrieve or modify the records associated with the object. Efficiently access and manage the collection of records for enhanced data manipulation and processing. Optimize your workflow by seamlessly interacting with the object’s records.
size	Size	r	Gets the object size.
size_f	SizeF	r	Gets the object size, in inches.
use_palette	bool	r	Gets a value indicating whether the image palette is used.
width	int	r	Access to the width of the image, providing essential information for precise rendering and processing. Quickly retrieve the image’s width to ensure compatibility and proper layout within various applications and platforms.
width_f	float	r	Gets the object width, in inches.

Methods

Name	Description
cache_data()	Efficiently cache data and prevent redundant loading from the underlying DataStreamSupporter.data_stream_container with this method. Enhance performance and streamline data access in your application, optimizing resource utilization for improved responsiveness.
can_load(file_path)	Determines whether image can be loaded from the specified file path.
can_load(file_path, load_options)	Determines whether image can be loaded from the specified file path and optionally using the specified open options.
can_load(stream)	Determines whether image can be loaded from the specified stream.
can_load(stream, load_options)	Determines whether image can be loaded from the specified stream and optionally using the specified loadOptions.
can_load_stream(stream)	Determines whether image can be loaded from the specified stream.
can_load_stream_with_options(stream, load_options)	Determines whether image can be loaded from the specified stream and optionally using the specified loadOptions.
can_load_with_options(file_path, load_options)	Determines whether image can be loaded from the specified file path and optionally using the specified open options.
can_save(options)	Determines whether image can be saved to the specified file format represented by the passed save options.
create(image_options, width, height)	Creates a new image using the specified create options.
create(images)	Creates a new image using the specified images as pages
create(images, dispose_images)	Creates a new image the specified images as pages.
crop(left_shift, right_shift, top_shift, bottom_shift)	Crop image with shifts.
crop(rectangle)	Crop the specified rectangle using this function. Ideal for refining image composition and focusing on specific areas of interest within the image. Improve visual clarity and highlight key details with precise cropping functionality.
get_default_options(args)	Retrieve the default options for your image effortlessly. With this feature, you can quickly access the preset configurations, ensuring seamless integration and optimal performance for your projects. Ideal for streamlining your workflow and achieving consistent results across your images.
get_embedded_images()	Gets the embedded images.
get_file_format(file_path)	Gets the file format.
get_file_format(stream)	Gets the file format.
get_file_format_of_stream(stream)	Gets the file format.
get_fitting_rectangle(rectangle, pixels, width, height)	Gets rectangle which fits the current image.
get_fitting_rectangle(rectangle, width, height)	Gets rectangle which fits the current image.
get_missed_fonts()	Returns the list of fonts which used inside metafile but not found.
get_original_options()	Gets the options based on the original file settings. This can be helpful to keep bit-depth and other parameters of the original image unchanged. For example, if we load a black-white PNG image with 1 bit per pixel and then save it using the DataStreamSupporter.save(file_path) method, the output PNG image with 8-bit per pixel will be produced. To avoid it and save PNG image with 1-bit per pixel, use this method to get corresponding saving options and pass them to the Image.save(file_path, options) method as the second parameter.
get_proportional_height(width, height, new_width)	Gets a proportional height.
get_proportional_width(width, height, new_height)	Gets a proportional width.
get_serialized_stream(image_options, clipping_rectangle, page_number)	Converts to aps.
get_used_fonts()	Retrieve the list of fonts utilized within the metafile with this method. Gain insights into font usage, facilitating efficient management and optimization of font resources for enhanced rendering and display fidelity.
load(file_path)	Loads a new image from the specified file.
load(file_path, load_options)	Loads a new image from the specified file.
load(stream)	Loads a new image from the specified stream.
load(stream, load_options)	Loads a new image from the specified stream.
load_stream(stream)	Loads a new image from the specified stream.
load_stream_with_options(stream, load_options)	Loads a new image from the specified stream.
load_with_options(file_path, load_options)	Loads a new image from the specified file.
remove_background()	Removes the background.
remove_background(settings)	Removes the background.
remove_metadata()	Removes metadata.
resize(new_width, new_height)	Resizes the image. The default ResizeType.NEAREST_NEIGHBOUR_RESAMPLE is used.
resize(new_width, new_height, resize_type)	Resizes the image.
resize(new_width, new_height, settings)	Resizes the image.
resize_by_settings(new_width, new_height, settings)	Resizes the image.
resize_by_type(new_width, new_height, resize_type)	Resizes the image.
resize_canvas(new_rectangle)	Resize the canvas with ease using this function. Perfect for adjusting the overall dimensions of the image without altering its content. Enhance presentation and prepare images for various display sizes effortlessly.
resize_height_proportionally(new_height)	Resizes the height proportionally. The default ResizeType.NEAREST_NEIGHBOUR_RESAMPLE is used.
resize_height_proportionally(new_height, resize_type)	Resizes the height proportionally.
resize_height_proportionally(new_height, settings)	Resizes the height proportionally.
resize_height_proportionally_settings(new_height, settings)	Resizes the height proportionally.
resize_width_proportionally(new_width)	Resizes the width proportionally. The default ResizeType.NEAREST_NEIGHBOUR_RESAMPLE is used.
resize_width_proportionally(new_width, resize_type)	Resizes the width proportionally.
resize_width_proportionally(new_width, settings)	Resizes the width proportionally.
resize_width_proportionally_settings(new_width, settings)	Resizes the width proportionally.
rotate_flip(rotate_flip_type)	Easily rotate, flip, or perform both operations simultaneously on your image using this simple `RotateFlip()` method. Perfect for adjusting orientation and enhancing visual appeal without hassle. Ideal for achieving the desired presentation of your images in any project or application.
save()	Saves the image data to the underlying stream.
save(file_path)	Saves the image to the specified file location.
save(file_path, options)	Saves the object’s data to the specified file location in the specified file format according to save options.
save(file_path, options, bounds_rectangle)	Saves the object’s data to the specified file location in the specified file format according to save options.
save(file_path, over_write)	Saves the object’s data to the specified file location.
save(stream)	Saves the data.
save(stream, options_base)	Saves the image’s data to the specified stream in the specified file format according to save options.
save(stream, options_base, bounds_rectangle)	Saves the image’s data to the specified stream in the specified file format according to save options.
save_to_stream(stream)	Saves the object’s data to the specified stream.
save_to_stream_with_options(stream, options_base)	Saves the image’s data to the specified stream in the specified file format according to save options.
save_to_stream_with_options_rect(stream, options_base, bounds_rectangle)	Saves the image’s data to the specified stream in the specified file format according to save options.
save_with_options(file_path, options)	Saves the object’s data to the specified file location in the specified file format according to save options.
save_with_options_rect(file_path, options, bounds_rectangle)	Saves the object’s data to the specified file location in the specified file format according to save options.
set_palette(palette, update_colors)	Enhance your image’s color palette by setting it with the specified `IColorPalette`. Achieve vivid, vibrant visuals with ease, ensuring your images stand out and captivate viewers. Ideal for optimizing color schemes and achieving the perfect look for your projects.

Constructor: EmfImage()

 EmfImage()

Start working with EMF images by initializing a new instance of the
EmfImage class. Ideal for quickly incorporating EMF images into
your projects with ease and efficiency.

Constructor: EmfImage(width, height)

 EmfImage(width, height)

Create a new instance of the EmfImage class by specifying the width
and height parameters. This constructor simplifies the process of initializing
EMF images with specific dimensions, enhancing the efficiency of your development
workflow.

Parameters:

Parameter	Type	Description
width	int	The width.
height	int	The height.

Method: can_load(file_path) [static]

 can_load(file_path)

Determines whether image can be loaded from the specified file path.

Parameters:

Parameter	Type	Description
file_path	string	The file path.

Returns

Type	Description
bool	true if image can be loaded from the specified file; otherwise, false.

Method: can_load(file_path, load_options) [static]

 can_load(file_path, load_options)

Determines whether image can be loaded from the specified file path and optionally using the specified open options.

Parameters:

Parameter	Type	Description
file_path	string	The file path.
load_options	LoadOptions	The load options.

Returns

Type	Description
bool	true if image can be loaded from the specified file; otherwise, false.

Method: can_load(stream) [static]

 can_load(stream)

Determines whether image can be loaded from the specified stream.

Parameters:

Parameter	Type	Description
stream	_io.BufferedRandom	The stream to load from.

Returns

Type	Description
bool	true if image can be loaded from the specified stream; otherwise, false.

Method: can_load(stream, load_options) [static]

 can_load(stream, load_options)

Determines whether image can be loaded from the specified stream and optionally using the specified loadOptions.

Parameters:

Parameter	Type	Description
stream	_io.BufferedRandom	The stream to load from.
load_options	LoadOptions	The load options.

Returns

Type	Description
bool	true if image can be loaded from the specified stream; otherwise, false.

Method: can_load_stream(stream) [static]

 can_load_stream(stream)

Determines whether image can be loaded from the specified stream.

Parameters:

Parameter	Type	Description
stream	_io.BufferedRandom	The stream to load from.

Returns

Type	Description
bool	true if image can be loaded from the specified stream; otherwise, false.

Method: can_load_stream_with_options(stream, load_options) [static]

 can_load_stream_with_options(stream, load_options)

Determines whether image can be loaded from the specified stream and optionally using the specified loadOptions.

Parameters:

Parameter	Type	Description
stream	_io.BufferedRandom	The stream to load from.
load_options	LoadOptions	The load options.

Returns

Type	Description
bool	true if image can be loaded from the specified stream; otherwise, false.

Method: can_load_with_options(file_path, load_options) [static]

 can_load_with_options(file_path, load_options)

Determines whether image can be loaded from the specified file path and optionally using the specified open options.

Parameters:

Parameter	Type	Description
file_path	string	The file path.
load_options	LoadOptions	The load options.

Returns

Type	Description
bool	true if image can be loaded from the specified file; otherwise, false.

Method: can_save(options)

 can_save(options)

Determines whether image can be saved to the specified file format represented by the passed save options.

Parameters:

Parameter	Type	Description
options	ImageOptionsBase	The save options to use.

Returns

Type	Description
bool	true if image can be saved to the specified file format represented by the passed save options; otherwise, false.

Method: create(image_options, width, height) [static]

 create(image_options, width, height)

Creates a new image using the specified create options.

Parameters:

Parameter	Type	Description
image_options	ImageOptionsBase	The image options.
width	int	The width.
height	int	The height.

Returns

Type	Description
Image	The newly created image.

Method: create(images) [static]

 create(images)

Creates a new image using the specified images as pages

Parameters:

Parameter	Type	Description
images	Image[]	The images.

Returns

Type	Description
Image	The Image as IMultipageImage

Method: create(images, dispose_images) [static]

 create(images, dispose_images)

Creates a new image the specified images as pages.

Parameters:

Parameter	Type	Description
images	Image[]	The images.
dispose_images	bool	if set to true [dispose images].

Returns

Type	Description
Image	The Image as IMultipageImage

Method: crop(left_shift, right_shift, top_shift, bottom_shift)

 crop(left_shift, right_shift, top_shift, bottom_shift)

Crop image with shifts.

Parameters:

Parameter	Type	Description
left_shift	int	The left shift.
right_shift	int	The right shift.
top_shift	int	The top shift.
bottom_shift	int	The bottom shift.

Method: crop(rectangle)

 crop(rectangle)

Crop the specified rectangle using this function. Ideal for refining image
composition and focusing on specific areas of interest within the image. Improve
visual clarity and highlight key details with precise cropping functionality.

Parameters:

Parameter	Type	Description
rectangle	Rectangle	The rectangle.

Method: get_default_options(args)

 get_default_options(args)

Retrieve the default options for your image effortlessly. With this feature, you
can quickly access the preset configurations, ensuring seamless integration and
optimal performance for your projects. Ideal for streamlining your workflow and
achieving consistent results across your images.

Parameters:

Parameter	Type	Description
args	object	The arguments.

Returns

Type	Description
ImageOptionsBase	Default options

Method: get_embedded_images()

 get_embedded_images()

Gets the embedded images.

Returns

Type	Description
EmbeddedImage[]	Array of images

Method: get_file_format(file_path) [static]

 get_file_format(file_path)

Gets the file format.

Parameters:

Parameter	Type	Description
file_path	string	The file path.

Returns

Type	Description
FileFormat	The determined file format.

Method: get_file_format(stream) [static]

 get_file_format(stream)

Gets the file format.

Parameters:

Parameter	Type	Description
stream	_io.BufferedRandom	The stream.

Returns

Type	Description
FileFormat	The determined file format.

Method: get_file_format_of_stream(stream) [static]

 get_file_format_of_stream(stream)

Gets the file format.

Parameters:

Parameter	Type	Description
stream	_io.BufferedRandom	The stream.

Returns

Type	Description
FileFormat	The determined file format.

Method: get_fitting_rectangle(rectangle, pixels, width, height) [static]

 get_fitting_rectangle(rectangle, pixels, width, height)

Gets rectangle which fits the current image.

Parameters:

Parameter	Type	Description
rectangle	Rectangle	The rectangle to get fitting rectangle for.
pixels	int	The 32-bit ARGB pixels.
width	int	The object width.
height	int	The object height.

Returns

Type	Description
Rectangle	The fitting rectangle or exception if no fitting rectangle can be found.

Method: get_fitting_rectangle(rectangle, width, height) [static]

 get_fitting_rectangle(rectangle, width, height)

Gets rectangle which fits the current image.

Parameters:

Parameter	Type	Description
rectangle	Rectangle	The rectangle to get fitting rectangle for.
width	int	The object width.
height	int	The object height.

Returns

Type	Description
Rectangle	The fitting rectangle or exception if no fitting rectangle can be found.

Method: get_missed_fonts()

 get_missed_fonts()

Returns the list of fonts which used inside metafile but not found.

Returns

Type	Description
string	The font list

Method: get_original_options()

 get_original_options()

Gets the options based on the original file settings.
This can be helpful to keep bit-depth and other parameters of the original image unchanged.
For example, if we load a black-white PNG image with 1 bit per pixel and then save it using the
DataStreamSupporter.save(file_path) method, the output PNG image with 8-bit per pixel will be produced.
To avoid it and save PNG image with 1-bit per pixel, use this method to get corresponding saving options and pass them
to the Image.save(file_path, options) method as the second parameter.

Returns

Type	Description
ImageOptionsBase	The options based on the original file settings.

Method: get_proportional_height(width, height, new_width) [static]

 get_proportional_height(width, height, new_width)

Gets a proportional height.

Parameters:

Parameter	Type	Description
width	int	The width.
height	int	The height.
new_width	int	The new width.

Returns

Type	Description
int	The proportional height.

Method: get_proportional_width(width, height, new_height) [static]

 get_proportional_width(width, height, new_height)

Gets a proportional width.

Parameters:

Parameter	Type	Description
width	int	The width.
height	int	The height.
new_height	int	The new height.

Returns

Type	Description
int	The proportional width.

Method: get_serialized_stream(image_options, clipping_rectangle, page_number)

 get_serialized_stream(image_options, clipping_rectangle, page_number)

Converts to aps.

Parameters:

Parameter	Type	Description
image_options	ImageOptionsBase	The image options.
clipping_rectangle	Rectangle	The clipping rectangle.
page_number	int[]	The page number.

Returns

Type	Description
_io.BufferedRandom	The serialized stream

Method: get_used_fonts()

 get_used_fonts()

Retrieve the list of fonts utilized within the metafile with this method. Gain
insights into font usage, facilitating efficient management and optimization of font
resources for enhanced rendering and display fidelity.

Returns

Type	Description
string	The font list

Method: load(file_path) [static]

 load(file_path)

Loads a new image from the specified file.

Parameters:

Parameter	Type	Description
file_path	string	The file path to load image from.

Returns

Type	Description
Image	The loaded image.

Method: load(file_path, load_options) [static]

 load(file_path, load_options)

Loads a new image from the specified file.

Parameters:

Parameter	Type	Description
file_path	string	The file path to load image from.
load_options	LoadOptions	The load options.

Returns

Type	Description
Image	The loaded image.

Method: load(stream) [static]

 load(stream)

Loads a new image from the specified stream.

Parameters:

Parameter	Type	Description
stream	_io.BufferedRandom	The stream to load image from.

Returns

Type	Description
Image	The loaded image.

Method: load(stream, load_options) [static]

 load(stream, load_options)

Loads a new image from the specified stream.

Parameters:

Parameter	Type	Description
stream	_io.BufferedRandom	The stream to load image from.
load_options	LoadOptions	The load options.

Returns

Type	Description
Image	The loaded image.

Method: load_stream(stream) [static]

 load_stream(stream)

Loads a new image from the specified stream.

Parameters:

Parameter	Type	Description
stream	_io.BufferedRandom	The stream to load image from.

Returns

Type	Description
Image	The loaded image.

Method: load_stream_with_options(stream, load_options) [static]

 load_stream_with_options(stream, load_options)

Loads a new image from the specified stream.

Parameters:

Parameter	Type	Description
stream	_io.BufferedRandom	The stream to load image from.
load_options	LoadOptions	The load options.

Returns

Type	Description
Image	The loaded image.

Method: load_with_options(file_path, load_options) [static]

 load_with_options(file_path, load_options)

Loads a new image from the specified file.

Parameters:

Parameter	Type	Description
file_path	string	The file path to load image from.
load_options	LoadOptions	The load options.

Returns

Type	Description
Image	The loaded image.

Method: remove_background(settings)

 remove_background(settings)

Removes the background.

Parameters:

Parameter	Type	Description
settings	RemoveBackgroundSettings	The settings.

Method: resize(new_width, new_height)

 resize(new_width, new_height)

Resizes the image. The default ResizeType.NEAREST_NEIGHBOUR_RESAMPLE is used.

Parameters:

Parameter	Type	Description
new_width	int	The new width.
new_height	int	The new height.

Method: resize(new_width, new_height, resize_type)

 resize(new_width, new_height, resize_type)

Resizes the image.

Parameters:

Parameter	Type	Description
new_width	int	The new width.
new_height	int	The new height.
resize_type	ResizeType	The resize type.

Method: resize(new_width, new_height, settings)

 resize(new_width, new_height, settings)

Resizes the image.

Parameters:

Parameter	Type	Description
new_width	int	The new width.
new_height	int	The new height.
settings	ImageResizeSettings	The resize settings.

Method: resize_by_settings(new_width, new_height, settings)

 resize_by_settings(new_width, new_height, settings)

Resizes the image.

Parameters:

Parameter	Type	Description
new_width	int	The new width.
new_height	int	The new height.
settings	ImageResizeSettings	The resize settings.

Method: resize_by_type(new_width, new_height, resize_type)

 resize_by_type(new_width, new_height, resize_type)

Resizes the image.

Parameters:

Parameter	Type	Description
new_width	int	The new width.
new_height	int	The new height.
resize_type	ResizeType	The resize type.

Method: resize_canvas(new_rectangle)

 resize_canvas(new_rectangle)

Resize the canvas with ease using this function. Perfect for adjusting the overall
dimensions of the image without altering its content. Enhance presentation and
prepare images for various display sizes effortlessly.

Parameters:

Parameter	Type	Description
new_rectangle	Rectangle	The new rectangle.

Method: resize_height_proportionally(new_height)

 resize_height_proportionally(new_height)

Resizes the height proportionally. The default ResizeType.NEAREST_NEIGHBOUR_RESAMPLE is used.

Parameters:

Parameter	Type	Description
new_height	int	The new height.

Method: resize_height_proportionally(new_height, resize_type)

 resize_height_proportionally(new_height, resize_type)

Resizes the height proportionally.

Parameters:

Parameter	Type	Description
new_height	int	The new height.
resize_type	ResizeType	Type of the resize.

Method: resize_height_proportionally(new_height, settings)

 resize_height_proportionally(new_height, settings)

Resizes the height proportionally.

Parameters:

Parameter	Type	Description
new_height	int	The new height.
settings	ImageResizeSettings	The image resize settings.

Method: resize_height_proportionally_settings(new_height, settings)

 resize_height_proportionally_settings(new_height, settings)

Resizes the height proportionally.

Parameters:

Parameter	Type	Description
new_height	int	The new height.
settings	ImageResizeSettings	The image resize settings.

Method: resize_width_proportionally(new_width)

 resize_width_proportionally(new_width)

Resizes the width proportionally. The default ResizeType.NEAREST_NEIGHBOUR_RESAMPLE is used.

Parameters:

Parameter	Type	Description
new_width	int	The new width.

Method: resize_width_proportionally(new_width, resize_type)

 resize_width_proportionally(new_width, resize_type)

Resizes the width proportionally.

Parameters:

Parameter	Type	Description
new_width	int	The new width.
resize_type	ResizeType	Type of the resize.

Method: resize_width_proportionally(new_width, settings)

 resize_width_proportionally(new_width, settings)

Resizes the width proportionally.

Parameters:

Parameter	Type	Description
new_width	int	The new width.
settings	ImageResizeSettings	The image resize settings.

Method: resize_width_proportionally_settings(new_width, settings)

 resize_width_proportionally_settings(new_width, settings)

Resizes the width proportionally.

Parameters:

Parameter	Type	Description
new_width	int	The new width.
settings	ImageResizeSettings	The image resize settings.

Method: rotate_flip(rotate_flip_type)

 rotate_flip(rotate_flip_type)

Easily rotate, flip, or perform both operations simultaneously on your image using
this simple RotateFlip() method. Perfect for adjusting orientation and enhancing
visual appeal without hassle. Ideal for achieving the desired presentation of your
images in any project or application.

Parameters:

Parameter	Type	Description
rotate_flip_type	RotateFlipType	Type of the rotate flip.

Method: save(file_path)

 save(file_path)

Saves the image to the specified file location.

Parameters:

Parameter	Type	Description
file_path	string	The file path to save the image to.

Method: save(file_path, options)

 save(file_path, options)

Saves the object’s data to the specified file location in the specified file format according to save options.

Parameters:

Parameter	Type	Description
file_path	string	The file path.
options	ImageOptionsBase	The options.

Method: save(file_path, options, bounds_rectangle)

 save(file_path, options, bounds_rectangle)

Saves the object’s data to the specified file location in the specified file format according to save options.

Parameters:

Parameter	Type	Description
file_path	string	The file path.
options	ImageOptionsBase	The options.
bounds_rectangle	Rectangle	The destination image bounds rectangle. Set the empty rectangle for use sourse bounds.

Method: save(file_path, over_write)

 save(file_path, over_write)

Saves the object’s data to the specified file location.

Parameters:

Parameter	Type	Description
file_path	string	The file path to save the object’s data to.
over_write	bool	if set to true over write the file contents, otherwise append will occur.

Method: save(stream)

 save(stream)

Saves the data.

Parameters:

Parameter	Type	Description
stream	_io.BufferedRandom	The stream to save data to.

Method: save(stream, options_base)

 save(stream, options_base)

Saves the image’s data to the specified stream in the specified file format according to save options.

Parameters:

Parameter	Type	Description
stream	_io.BufferedRandom	The stream to save the image’s data to.
options_base	ImageOptionsBase	The save options.

Method: save(stream, options_base, bounds_rectangle)

 save(stream, options_base, bounds_rectangle)

Saves the image’s data to the specified stream in the specified file format according to save options.

Parameters:

Parameter	Type	Description
stream	_io.BufferedRandom	The stream to save the image’s data to.
options_base	ImageOptionsBase	The save options.
bounds_rectangle	Rectangle	The destination image bounds rectangle. Set the empty rectangle for use source bounds.

Method: save_to_stream(stream)

 save_to_stream(stream)

Saves the object’s data to the specified stream.

Parameters:

Parameter	Type	Description
stream	_io.BufferedRandom	The stream to save the object’s data to.

Method: save_to_stream_with_options(stream, options_base)

 save_to_stream_with_options(stream, options_base)

Saves the image’s data to the specified stream in the specified file format according to save options.

Parameters:

Parameter	Type	Description
stream	_io.BufferedRandom	The stream to save the image’s data to.
options_base	ImageOptionsBase	The save options.

Method: save_to_stream_with_options_rect(stream, options_base, bounds_rectangle)

 save_to_stream_with_options_rect(stream, options_base, bounds_rectangle)

Saves the image’s data to the specified stream in the specified file format according to save options.

Parameters:

Parameter	Type	Description
stream	_io.BufferedRandom	The stream to save the image’s data to.
options_base	ImageOptionsBase	The save options.
bounds_rectangle	Rectangle	The destination image bounds rectangle. Set the empty rectangle for use source bounds.

Method: save_with_options(file_path, options)

 save_with_options(file_path, options)

Saves the object’s data to the specified file location in the specified file format according to save options.

Parameters:

Parameter	Type	Description
file_path	string	The file path.
options	ImageOptionsBase	The options.

Method: save_with_options_rect(file_path, options, bounds_rectangle)

 save_with_options_rect(file_path, options, bounds_rectangle)

Saves the object’s data to the specified file location in the specified file format according to save options.

Parameters:

Parameter	Type	Description
file_path	string	The file path.
options	ImageOptionsBase	The options.
bounds_rectangle	Rectangle	The destination image bounds rectangle. Set the empty rectangle for use sourse bounds.

Method: set_palette(palette, update_colors)

 set_palette(palette, update_colors)

Enhance your image’s color palette by setting it with the specified
IColorPalette. Achieve vivid, vibrant visuals with ease, ensuring your images
stand out and captivate viewers. Ideal for optimizing color schemes and achieving
the perfect look for your projects.

Parameters:

Parameter	Type	Description
palette	IColorPalette	The palette to set.
update_colors	bool	if set to true colors will be updated according to the new palette; otherwise color indexes remain unchanged. Note that unchanged indexes may crash the image on loading if some indexes have no corresponding palette entries.

MetaImage Class