com.aspose.imaging.fileformats.svg

Class SvgImage

java.lang.Object

com.aspose.imaging.DisposableObject

com.aspose.imaging.DataStreamSupporter

com.aspose.imaging.Image

com.aspose.imaging.VectorImage

com.aspose.imaging.fileformats.svg.SvgImage

All Implemented Interfaces:

IHasMetadata, IObjectWithSizeF, IObjectWithBounds, IHasXmpData, com.aspose.internal.progressmanagement.IProgressEventHandler, com.aspose.internal.progressmanagement.IProgressInformer, com.aspose.ms.System.IDisposable, Closeable, AutoCloseable

public final class SvgImage
extends VectorImage
implements IHasXmpData

Manipulate Scalar Vector Graphics (SVG) image files with our API, utilizing the power of XML-based text format for seamless customization and scalability. Easily load SVG images, rasterize vector elements, and convert to other formats, while controlling compression levels to optimize file size and quality for your projects.

Code example:

This example shows how to load an SVG image from a file stream and rasterize it to PNG.

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

// Load an SVG image from a file stream.
java.io.InputStream stream = new java.io.FileInputStream(dir + "test.svg");
com.aspose.imaging.fileformats.svg.SvgImage svgImage = new com.aspose.imaging.fileformats.svg.SvgImage(stream);
try {
    // In order to rasterize SVG we need to specify rasterization options.
    com.aspose.imaging.imageoptions.SvgRasterizationOptions rasterizationOptions = new com.aspose.imaging.imageoptions.SvgRasterizationOptions();
    com.aspose.imaging.imageoptions.PngOptions saveOptions = new com.aspose.imaging.imageoptions.PngOptions();
    saveOptions.setVectorRasterizationOptions(rasterizationOptions);

    svgImage.save(dir + "test.output.png", saveOptions);
} finally {
    svgImage.dispose();
    stream.close();
}

Constructor Summary

Constructors

Constructor and Description
SvgImage(InputStream stream) Creates a new instance of the SvgImage class, loading the image from the provided stream.
SvgImage(int width, int height) Instantiates a new SvgImage object with the specified width and height.
SvgImage(String path) Instantiates a new object of the SvgImage class, utilizing the specified path to locate and load the image.
SvgImage(SvgOptions svgOptions, int width, int height) Creates a new instance of the SvgImage class with specified SVG options, image width, and height parameters.

Method Summary

Modifier and Type	Method and Description
void	cacheData() Cache the data and guarantee that there will be no further loading of data from the underlying DataStreamSupporter.DataStreamContainer(DataStreamSupporter.getDataStreamContainer()).
void	crop(Rectangle rectangle) Crops the specified rectangle.
int	getBitsPerPixel() Retrieves the bits per pixel count of the image.
long	getFileFormat() Retrieves the file format of the image, providing essential metadata for processing and compatibility checks.
XmpPacketWrapper	getXmpData() Gets XMP data.
boolean	isCached() Retrieves a boolean value indicating whether the object's data is presently cached, eliminating the need for additional data reading operations.
void	resize(int newWidth, int newHeight, int resizeType) Resize the image to fit the specified dimensions while preserving its aspect ratio.
void	rotate(float angle) Rotate image around the center.
void	setPalette(IColorPalette palette, boolean updateColors) Applies a specified palette to the image, enabling customization of color schemes for aesthetic or functional purposes.
void	setXmpData(XmpPacketWrapper value) Sets XMP data.

Methods inherited from class com.aspose.imaging.VectorImage

getDefaultOptions, getEmbeddedImages, getHeight, getHeightF, getSizeF, getWidth, getWidthF, removeBackground, removeBackground, resize, rotateFlip

Methods inherited from class com.aspose.imaging.Image

canLoad, canLoad, canLoad, canLoad, canSave, create, create, create, create, create, create, crop, getBackgroundColor, getBounds, getBufferSizeHint, getContainer, getFileFormat, getFileFormat, getFittingRectangle, getFittingRectangle, getInterruptMonitor, getIProgressEventHandler, getOriginalOptions, getPalette, getProgressEventHandlerInfo, getProportionalHeight, getProportionalWidth, getSerializedStream, getSize, hasBackgroundColor, isAutoAdjustPalette, isUsePalette, load, load, load, load, load, load, removeMetadata, resize, resizeHeightProportionally, resizeHeightProportionally, resizeHeightProportionally, resizeWidthProportionally, resizeWidthProportionally, resizeWidthProportionally, save, save, save, save, save, save, save, save, setAutoAdjustPalette, setBackgroundColor, setBackgroundColor, setBufferSizeHint, setInterruptMonitor, setPalette

Methods inherited from class com.aspose.imaging.DataStreamSupporter

getDataStreamContainer, save, save, save

Methods inherited from class com.aspose.imaging.DisposableObject

close, dispose, getDisposed

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SvgImage

public SvgImage(String path)

Instantiates a new object of the SvgImage class, utilizing the specified path to locate and load the image. This constructor facilitates the creation of SVG image instances from external files, enabling seamless integration into software systems and workflows.

Parameters:

path - The path to load image from and initialize pixel and palette data with.

Throws:

com.aspose.ms.System.ArgumentNullException - path is null.

SvgImage

public SvgImage(InputStream stream)

Creates a new instance of the SvgImage class, loading the image from the provided stream. This constructor enables the direct loading of SVG images from streams, enhancing flexibility and efficiency in handling image resources within software applications.

Parameters:

stream - The stream to load image from and initialize pixel and palette data with.

Throws:

com.aspose.ms.System.ArgumentNullException - stream is null.

Code example:

This example shows how to load an SVG image from a file stream and rasterize it to PNG.

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

// Load an SVG image from a file stream.
java.io.InputStream stream = new java.io.FileInputStream(dir + "test.svg");
com.aspose.imaging.fileformats.svg.SvgImage svgImage = new com.aspose.imaging.fileformats.svg.SvgImage(stream);
try {
    // In order to rasterize SVG we need to specify rasterization options.
    com.aspose.imaging.imageoptions.SvgRasterizationOptions rasterizationOptions = new com.aspose.imaging.imageoptions.SvgRasterizationOptions();
    com.aspose.imaging.imageoptions.PngOptions saveOptions = new com.aspose.imaging.imageoptions.PngOptions();
    saveOptions.setVectorRasterizationOptions(rasterizationOptions);

    svgImage.save(dir + "test.output.png", saveOptions);
} finally {
    svgImage.dispose();
    stream.close();
}

SvgImage

public SvgImage(int width,
                int height)

Instantiates a new SvgImage object with the specified width and height. This constructor allows developers to create SVG images with predefined dimensions, facilitating precise control over the image's size during initialization.

Parameters:

width - The image width.

height - The image height.

SvgImage

public SvgImage(SvgOptions svgOptions,
                int width,
                int height)

Creates a new instance of the SvgImage class with specified SVG options, image width, and height parameters. This constructor enables developers to initialize SVG images with custom options and dimensions, providing flexibility in managing SVG content and layout.

Parameters:

svgOptions - The SVG options.

width - Image width.

height - Image height.

Method Detail

isCached

public boolean isCached()

Retrieves a boolean value indicating whether the object's data is presently cached, eliminating the need for additional data reading operations. This property provides insight into the current caching status, optimizing data retrieval and processing workflows for enhanced performance and efficiency.

Specified by:

isCached in class DataStreamSupporter

Returns:

true if object's data is cached; otherwise, false.

getBitsPerPixel

public int getBitsPerPixel()

Retrieves the bits per pixel count of the image. It's important to note that this parameter is not applicable to vector images, as they are not measured in pixels. This property provides crucial information about the image's color depth, aiding in processing and manipulation tasks.

Specified by:

getBitsPerPixel in class Image

Returns:

The image bits per pixel count.

Throws:

com.aspose.ms.System.NotImplementedException - Invalid for vector images

getFileFormat

public long getFileFormat()

Retrieves the file format of the image, providing essential metadata for processing and compatibility checks. This property is instrumental in determining the appropriate decoding and encoding strategies for handling the image data effectively across different systems and applications.

Overrides:

getFileFormat in class Image

Returns:

file format

See Also:

FileFormat

getXmpData

public XmpPacketWrapper getXmpData()

Gets XMP data.

Specified by:

getXmpData in interface IHasXmpData

Returns:

XMP data.

setXmpData

public void setXmpData(XmpPacketWrapper value)

Sets XMP data.

Specified by:

setXmpData in interface IHasXmpData

Parameters:

value - XMP data.

cacheData

public void cacheData()

Cache the data and guarantee that there will be no further loading of data from the underlying DataStreamSupporter.DataStreamContainer(DataStreamSupporter.getDataStreamContainer()). This optimization enhances performance by eliminating redundant data retrieval operations, especially beneficial in scenarios requiring frequent access to the image data.

Specified by:

cacheData in class DataStreamSupporter

resize

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

Resize the image to fit the specified dimensions while preserving its aspect ratio. This method provides a convenient way to adjust the size of the image without distorting its proportions, ensuring optimal display or storage according to the desired dimensions.

Overrides:

resize in class VectorImage

Parameters:

newWidth - The new width.

newHeight - The new height.

resizeType - The resize type.

Throws:

com.aspose.ms.System.NotImplementedException - this feature is not implemented

See Also:

ResizeType

crop

public void crop(Rectangle rectangle)

Crops the specified rectangle.

Overrides:

crop in class VectorImage

Parameters:

rectangle - The rectangle.

rotate

public void rotate(float angle)

Rotate image around the center.

Overrides:

rotate in class VectorImage

Parameters:

angle - The rotate angle in degrees. Positive values will rotate clockwise.

setPalette

public void setPalette(IColorPalette palette,
                       boolean updateColors)

Applies a specified palette to the image, enabling customization of color schemes for aesthetic or functional purposes. This method provides flexibility in managing color palettes to suit various design or application requirements.

Specified by:

setPalette in class Image

Parameters:

palette - The palette to set.

updateColors - 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.

Throws:

com.aspose.ms.System.NotImplementedException - if not implemented