VectorRasterizationOptions

Inheritance: java.lang.Object, com.aspose.imaging.DisposableObject, com.aspose.imaging.ImageOptionsBase

public class VectorRasterizationOptions extends ImageOptionsBase

The vector rasterization options. Please note that VectorRasterizationOptions(ImageOptionsBase.getVectorRasterizationOptions/ImageOptionsBase.setVectorRasterizationOptions(VectorRasterizationOptions)) will no longer derive from ImageOptionsBase since Aspose.Imaging 24.12 version.

Constructors

ConstructorDescription
VectorRasterizationOptions()
VectorRasterizationOptions(VectorRasterizationOptions imageOptions)

Methods

MethodDescription
getSmoothingMode()Gets the smoothing mode.
setSmoothingMode(int value)Sets the smoothing mode.
getBorderX()Gets or sets the border X.
setBorderX(float value)Gets or sets the border X.
getBorderY()Gets or sets the border Y.
setBorderY(float value)Gets or sets the border Y.
getCenterDrawing()Gets a value indicating whether center drawing.
setCenterDrawing(boolean value)Sets a value indicating whether center drawing.
getPageHeight()Gets the page height.
setPageHeight(float value)Sets the page height.
getPageSize()Gets the page size.
setPageSize(SizeF value)Sets the page size.
getPageWidth()Gets the page width.
setPageWidth(float value)Sets the page width.
getBackgroundColor()Gets a background color.
setBackgroundColor(Color value)Sets a background color.
getDrawColor()Gets a foreground color.
setDrawColor(Color value)Sets a foreground color.
getTextRenderingHint()Gets the text rendering hint.
setTextRenderingHint(int value)Sets the text rendering hint.
getPositioning()Gets the positioning.
setPositioning(int value)Sets the positioning.
getReplaceTextMapping()Gets the text replace mapping.
setReplaceTextMapping(HashMap<String,String> value)Sets the text replace mapping.
copyTo(VectorRasterizationOptions vectorRasterizationOptions)Copies to.

VectorRasterizationOptions()

public VectorRasterizationOptions()

VectorRasterizationOptions(VectorRasterizationOptions imageOptions)

public VectorRasterizationOptions(VectorRasterizationOptions imageOptions)

Parameters:

ParameterTypeDescription
imageOptionsVectorRasterizationOptions

getSmoothingMode()

public final int getSmoothingMode()

Gets the smoothing mode.

Returns: int - the smoothing mode.

setSmoothingMode(int value)

public final void setSmoothingMode(int value)

Sets the smoothing mode.

Parameters:

ParameterTypeDescription
valueintthe smoothing mode.

Example: This example shows how to load an SVG image from a file and rasterize it to PNG using various options.

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

// Using Aspose.Imaging.Image.Load is a unified way to load image.
com.aspose.imaging.fileformats.svg.SvgImage svgImage = (com.aspose.imaging.fileformats.svg.SvgImage) com.aspose.imaging.Image.load(dir + "test.svg");
try {
    // In order to rasterize SVG we need to specify rasterization options.
    com.aspose.imaging.imageoptions.SvgRasterizationOptions rasterizationOptions = new com.aspose.imaging.imageoptions.SvgRasterizationOptions();

    // Set default color of a background for an image. Default value is white.
    rasterizationOptions.setBackgroundColor(com.aspose.imaging.Color.getGray());

    // Set the page size
    rasterizationOptions.setPageSize(new com.aspose.imaging.SizeF(svgImage.getWidth(), svgImage.getHeight()));

    // Antialiasing is applied to lines and curves and the edges of filled areas.
    rasterizationOptions.setSmoothingMode(com.aspose.imaging.SmoothingMode.AntiAlias);

    // Each character is drawn using its antialiased glyph bitmap without hinting.
    rasterizationOptions.setTextRenderingHint(com.aspose.imaging.TextRenderingHint.AntiAlias);

    // Reduce the image size 10 times, i.e. the output size will be 10% of the original size.
    rasterizationOptions.setScaleX(0.1f);
    rasterizationOptions.setScaleY(0.1f);

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

    // Save to a PNG file
    svgImage.save(dir + "test.output.png", saveOptions);
} finally {
    svgImage.dispose();
}

getBorderX()

public float getBorderX()

Gets or sets the border X.

Returns: float - The border X.

setBorderX(float value)

public void setBorderX(float value)

Gets or sets the border X.

Parameters:

ParameterTypeDescription
valuefloatThe border X.

getBorderY()

public float getBorderY()

Gets or sets the border Y.

Returns: float - The border Y.

setBorderY(float value)

public void setBorderY(float value)

Gets or sets the border Y.

Parameters:

ParameterTypeDescription
valuefloatThe border Y.

getCenterDrawing()

public boolean getCenterDrawing()

Gets a value indicating whether center drawing.

Returns: boolean - a value indicating whether center drawing.

setCenterDrawing(boolean value)

public void setCenterDrawing(boolean value)

Sets a value indicating whether center drawing.

Parameters:

ParameterTypeDescription
valuebooleana value indicating whether center drawing.

getPageHeight()

public float getPageHeight()

Gets the page height.

Returns: float - the page height.

setPageHeight(float value)

public void setPageHeight(float value)

Sets the page height.

Parameters:

ParameterTypeDescription
valuefloatthe page height.

getPageSize()

public SizeF getPageSize()

Gets the page size.

Returns: SizeF - the page size.

setPageSize(SizeF value)

public void setPageSize(SizeF value)

Sets the page size.

Parameters:

ParameterTypeDescription
valueSizeFthe page size.

Example: This example shows how to load a EMF image from a file and convert it to SVG using EmfRasterizationOptions.

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

// Using Aspose.Imaging.Image.Load is a unified way to load all types of images including EMF.
com.aspose.imaging.fileformats.emf.EmfImage emfImage = (com.aspose.imaging.fileformats.emf.EmfImage) com.aspose.imaging.Image.load(dir + "test.emf");
try {
    com.aspose.imaging.imageoptions.SvgOptions saveOptions = new com.aspose.imaging.imageoptions.SvgOptions();

    // Text will be converted to shapes.
    saveOptions.setTextAsShapes(true);

    com.aspose.imaging.imageoptions.EmfRasterizationOptions rasterizationOptions = new com.aspose.imaging.imageoptions.EmfRasterizationOptions();

    // The background color of the drawing surface.
    rasterizationOptions.setBackgroundColor(com.aspose.imaging.Color.getWhiteSmoke());

    // The page size.
    rasterizationOptions.setPageSize(new com.aspose.imaging.SizeF(emfImage.getWidth(), emfImage.getHeight()));

    // If embedded emf exists, then render emf; otherwise render wmf.
    rasterizationOptions.setRenderMode(com.aspose.imaging.fileformats.emf.EmfRenderMode.Auto);

    // Set the horizontal margin
    rasterizationOptions.setBorderX(50);

    // Set the vertical margin
    rasterizationOptions.setBorderY(50);

    saveOptions.setVectorRasterizationOptions(rasterizationOptions);

    emfImage.save(dir + "test.output.svg", saveOptions);
} finally {
    emfImage.dispose();
}

getPageWidth()

public float getPageWidth()

Gets the page width.

Returns: float - the page width.

setPageWidth(float value)

public void setPageWidth(float value)

Sets the page width.

Parameters:

ParameterTypeDescription
valuefloatthe page width.

getBackgroundColor()

public Color getBackgroundColor()

Gets a background color.

Returns: Color - a background color.

setBackgroundColor(Color value)

public void setBackgroundColor(Color value)

Sets a background color.

Parameters:

ParameterTypeDescription
valueColora background color.

Example: This example shows how to load a EMF image from a file and convert it to SVG using EmfRasterizationOptions.

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

// Using Aspose.Imaging.Image.Load is a unified way to load all types of images including EMF.
com.aspose.imaging.fileformats.emf.EmfImage emfImage = (com.aspose.imaging.fileformats.emf.EmfImage) com.aspose.imaging.Image.load(dir + "test.emf");
try {
    com.aspose.imaging.imageoptions.SvgOptions saveOptions = new com.aspose.imaging.imageoptions.SvgOptions();

    // Text will be converted to shapes.
    saveOptions.setTextAsShapes(true);

    com.aspose.imaging.imageoptions.EmfRasterizationOptions rasterizationOptions = new com.aspose.imaging.imageoptions.EmfRasterizationOptions();

    // The background color of the drawing surface.
    rasterizationOptions.setBackgroundColor(com.aspose.imaging.Color.getWhiteSmoke());

    // The page size.
    rasterizationOptions.setPageSize(new com.aspose.imaging.SizeF(emfImage.getWidth(), emfImage.getHeight()));

    // If embedded emf exists, then render emf; otherwise render wmf.
    rasterizationOptions.setRenderMode(com.aspose.imaging.fileformats.emf.EmfRenderMode.Auto);

    // Set the horizontal margin
    rasterizationOptions.setBorderX(50);

    // Set the vertical margin
    rasterizationOptions.setBorderY(50);

    saveOptions.setVectorRasterizationOptions(rasterizationOptions);

    emfImage.save(dir + "test.output.svg", saveOptions);
} finally {
    emfImage.dispose();
}

getDrawColor()

public Color getDrawColor()

Gets a foreground color.

Returns: Color - a foreground color.

setDrawColor(Color value)

public void setDrawColor(Color value)

Sets a foreground color.

Parameters:

ParameterTypeDescription
valueColora foreground color.

getTextRenderingHint()

public final int getTextRenderingHint()

Gets the text rendering hint.

Value: The text rendering hint.

Returns: int - the text rendering hint.

setTextRenderingHint(int value)

public final void setTextRenderingHint(int value)

Sets the text rendering hint.

Value: The text rendering hint.

Parameters:

ParameterTypeDescription
valueintthe text rendering hint.

Example: This example shows how to load an SVG image from a file and rasterize it to PNG using various options.

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

// Using Aspose.Imaging.Image.Load is a unified way to load image.
com.aspose.imaging.fileformats.svg.SvgImage svgImage = (com.aspose.imaging.fileformats.svg.SvgImage) com.aspose.imaging.Image.load(dir + "test.svg");
try {
    // In order to rasterize SVG we need to specify rasterization options.
    com.aspose.imaging.imageoptions.SvgRasterizationOptions rasterizationOptions = new com.aspose.imaging.imageoptions.SvgRasterizationOptions();

    // Set default color of a background for an image. Default value is white.
    rasterizationOptions.setBackgroundColor(com.aspose.imaging.Color.getGray());

    // Set the page size
    rasterizationOptions.setPageSize(new com.aspose.imaging.SizeF(svgImage.getWidth(), svgImage.getHeight()));

    // Antialiasing is applied to lines and curves and the edges of filled areas.
    rasterizationOptions.setSmoothingMode(com.aspose.imaging.SmoothingMode.AntiAlias);

    // Each character is drawn using its antialiased glyph bitmap without hinting.
    rasterizationOptions.setTextRenderingHint(com.aspose.imaging.TextRenderingHint.AntiAlias);

    // Reduce the image size 10 times, i.e. the output size will be 10% of the original size.
    rasterizationOptions.setScaleX(0.1f);
    rasterizationOptions.setScaleY(0.1f);

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

    // Save to a PNG file
    svgImage.save(dir + "test.output.png", saveOptions);
} finally {
    svgImage.dispose();
}

getPositioning()

public final int getPositioning()

Gets the positioning.

Value: The positioning.

Returns: int - the positioning.

setPositioning(int value)

public final void setPositioning(int value)

Sets the positioning.

Value: The positioning.

Parameters:

ParameterTypeDescription
valueintthe positioning.

getReplaceTextMapping()

public final HashMap<String,String> getReplaceTextMapping()

Gets the text replace mapping.

Value: The text replace mapping.

Returns: java.util.HashMap<java.lang.String,java.lang.String> - the text replace mapping.

setReplaceTextMapping(HashMap<String,String> value)

public final void setReplaceTextMapping(HashMap<String,String> value)

Sets the text replace mapping.

Value: The text replace mapping.

Parameters:

ParameterTypeDescription
valuejava.util.HashMap<java.lang.String,java.lang.String>the text replace mapping.

copyTo(VectorRasterizationOptions vectorRasterizationOptions)

public final void copyTo(VectorRasterizationOptions vectorRasterizationOptions)

Copies to.

Parameters:

ParameterTypeDescription
vectorRasterizationOptionsVectorRasterizationOptionsThe vector rasterization options.