OdgImage

Inheritance: java.lang.Object, com.aspose.imaging.DisposableObject, com.aspose.imaging.DataStreamSupporter, com.aspose.imaging.Image, com.aspose.imaging.VectorImage, com.aspose.imaging.VectorMultipageImage, com.aspose.imaging.fileformats.opendocument.OdImage

public class OdgImage extends OdImage

Manipulate OpenDocument Graphic (ODG) vector image file format with our API, widely used by OpenOffice and LibreOffice Draw applications for storing drawing elements in a vector format. Seamlessly parse documents, access pages, resize and rotate images, ensuring efficient processing and customization of ODG files to meet your specific requirements.

Constructors

Constructor	Description
OdgImage(StreamContainer streamContainer, LoadOptions options)	Start a new creation of the OdgImage class object with the initiation of a fresh instance.
OdgImage(StreamContainer streamContainer)	Crafted for seamless integration into software solutions, the OdgImage constructor initializes a new instance by leveraging a stream container.

Methods

Method	Description
getFileFormat()	Easily retrieve the file format value with this user-friendly property.
getPageExportingAction()	This property allows to effortlessly retrieve or modify the action associated with exporting pages.
setPageExportingAction(PageExportingAction value)	This property allows to effortlessly retrieve or modify the action associated with exporting pages.
getPages()	Retrieving the collection of pages, this property empowers to access the entirety of pages associated with an image.
getDefaultOptions(Object[] args)	This property provides access to the default options associated with an image.
resize(int newWidth, int newHeight, ImageResizeSettings settings)	This method helps developers to resize images programmatically.
resize(int newWidth, int newHeight, int resizeType)	This method facilitates image resizing with precise control over width, height, and resize type parameters.
rotateFlip(int rotateFlipType)	This versatile method apply various transformations to images, including rotation and flipping, to achieve desired orientations and visual effects.

Example: This example loads a multi-page ODG image.

String dir = "c:\\temp\\";

// Using Aspose.Imaging.Image.Load is a unified way to load image.
com.aspose.imaging.fileformats.opendocument.MultiPageImage image = (com.aspose.imaging.fileformats.opendocument.MultiPageImage) com.aspose.imaging.Image.load(dir + "sample.odg");
try {
    // Cast to OdgImage
    com.aspose.imaging.fileformats.opendocument.OdgImage odgImage = (com.aspose.imaging.fileformats.opendocument.OdgImage) image;

    // Get all pages
    com.aspose.imaging.Image[] pages = odgImage.getPages();

    // Do some image processing
} finally {
    image.dispose();
}

Example: The following example shows how to export a FODG (Flat XML ODF Template) image to PDF format.

String dir = "c:\\aspose.imaging\\java\\issues\\1509\\";

String inputFileName = dir + "VariousObjectsMultiPage.fodg";
String outputFileName = inputFileName + ".pdf";

com.aspose.imaging.Image image = com.aspose.imaging.Image.load(inputFileName);
try {
    com.aspose.imaging.imageoptions.OdgRasterizationOptions rasterizationOptions = new com.aspose.imaging.imageoptions.OdgRasterizationOptions();
    rasterizationOptions.setBackgroundColor(com.aspose.imaging.Color.getWhite());
    rasterizationOptions.setPageSize(Size.to_SizeF(image.getSize()));

    com.aspose.imaging.imageoptions.PdfOptions saveOptions = new com.aspose.imaging.imageoptions.PdfOptions();
    saveOptions.setVectorRasterizationOptions(rasterizationOptions);

    image.save(outputFileName, saveOptions);
}
finally {
    image.close();
}

OdgImage(StreamContainer streamContainer, LoadOptions options)

public OdgImage(StreamContainer streamContainer, LoadOptions options)

Start a new creation of the OdgImage class object with the initiation of a fresh instance. Harness the potential of a stream container coupled with load options parameters, maintain a versatile constructor to seamlessly load images. This constructor empowers efficient image handling, offering customizable loading configurations for enhanced adaptability and performance across diverse scenarios.

Parameters:

Parameter	Type	Description
streamContainer	StreamContainer	The stream.
options	LoadOptions	The load options

OdgImage(StreamContainer streamContainer)

public OdgImage(StreamContainer streamContainer)

Crafted for seamless integration into software solutions, the OdgImage constructor initializes a new instance by leveraging a stream container. This method ensures efficient handling of ODG image data within software environments, optimizing resource utilization and facilitating streamlined image processing workflows.

Parameters:

Parameter	Type	Description
streamContainer	StreamContainer	The stream container.

getFileFormat()

public long getFileFormat()

Easily retrieve the file format value with this user-friendly property. Ideal for developers seeking quick access to information about the file format.

Returns: long - a value of file format

getPageExportingAction()

public PageExportingAction getPageExportingAction()

This property allows to effortlessly retrieve or modify the action associated with exporting pages. Through precise manipulation of this property, software solutions gain the flexibility to tailor page exporting behavior according to specific application requirements, ensuring optimal performance and enhanced user experience. Please note that setting this method will automatically release page resources after it is executed. It will be executed just before each page is saved.

Returns: PageExportingAction - The page exporting action.

setPageExportingAction(PageExportingAction value)

public void setPageExportingAction(PageExportingAction value)

Parameters:

Parameter	Type	Description
value	PageExportingAction	The page exporting action.

getPages()

public Image[] getPages()

Retrieving the collection of pages, this property empowers to access the entirety of pages associated with an image. By accessing this property, developers can iterate through individual pages, retrieve specific pages based on their index, or perform batch operations on the entire collection.

Returns: com.aspose.imaging.Image[] - the pages.

getDefaultOptions(Object[] args)

public ImageOptionsBase getDefaultOptions(Object[] args)

This property provides access to the default options associated with an image. By retrieving these options, developers can quickly ascertain the default settings applied to the image, facilitating the creation of new instances or the modification of existing ones based on these presets.

Parameters:

Parameter	Type	Description
args	java.lang.Object[]	The arguments.

Returns: ImageOptionsBase - Default options

resize(int newWidth, int newHeight, ImageResizeSettings settings)

public void resize(int newWidth, int newHeight, ImageResizeSettings settings)

This method helps developers to resize images programmatically. By invoking this function, you can dynamically adjust the dimensions of images, catering to specific requirements or constraints within their applications.

Parameters:

Parameter	Type	Description
newWidth	int	The new width.
newHeight	int	The new height.
settings	ImageResizeSettings	The resize settings.

resize(int newWidth, int newHeight, int resizeType)

public void resize(int newWidth, int newHeight, int resizeType)

This method facilitates image resizing with precise control over width, height, and resize type parameters. You can specify the desired dimensions and choose from different resizing algorithms or types to achieve optimal results based on application’s requirements.

Parameters:

Parameter	Type	Description
newWidth	int	The new width.
newHeight	int	The new height.
resizeType	int	The resize type.

rotateFlip(int rotateFlipType)

public void rotateFlip(int rotateFlipType)

This versatile method apply various transformations to images, including rotation and flipping, to achieve desired orientations and visual effects. With intuitive parameters, you can specify the degree of rotation and the type of flipping (horizontal, vertical, or both) to precisely manipulate the image as needed.

Parameters:

Parameter	Type	Description
rotateFlipType	int	Type of the rotate flip.

OdObject OtgImage