aspose.diagram
Class ImageSaveOptions

Allows to specify additional options when rendering diagram pages to images.

Example:

var aspose = aspose || {};
aspose.diagram = require("aspose.diagram");

diagram = new aspose.diagram.Diagram("VisioSaveOptions.vsdx");

options = new aspose.diagram.ImageSaveOptions(aspose.diagram.SaveFileFormat.JPEG);
// specify the quality level to use during compositing.
options.setCompositingQuality(aspose.diagram.CompositingQuality.HIGH_QUALITY);

// sets the brightness for the the generated images.
// this property has effect only when saving to raster image formats.
// The default value is 0.5. The value must be in the range between 0
// and 1.
options.setImageBrightness(1.0);

// value or the font is not installed locally, they may appear as a
// block,
// set the DefaultFont such as MingLiu or MS Gothic to show these
// characters.
options.setDefaultFont("MS Gothic");
// sets the number of pages to render in image.
options.setPageCount(2);
// sets the 0-based index of the first page to render. Default is 0.
options.setPageIndex(0);

// set page size
pgSize = new aspose.diagram.PageSize(aspose.diagram.PaperSizeFormat.A_1);
options.setPageSize(pgSize);
// discard saving background pages of the Visio diagram
options.setSaveForegroundPagesOnly(true);

// sets the color mode for the generated images.
options.setImageColorMode(aspose.diagram.ImageColorMode.BLACK_AND_WHITE);

// sets the contrast for the generated images.
// this property has effect only when saving to raster image formats.
// the default value is 0.5. The value must be in the range between 0
// and 1.
options.setImageContrast(1.0);

// specify the algorithm that is used when images are scaled or rotated.
// this property has effect only when saving to raster image formats.
options.setInterpolationMode(aspose.diagram.InterpolationMode.NEAREST_NEIGHBOR);

// the value may vary from 0 to 100 where 0 means worst quality,
// but maximum compression and 100 means best quality but minimum
// compression.
// the default value is 95.
options.setJpegQuality(100);

// set a value specifying how pixels are offset during rendering.
options.setPixelOffsetMode(aspose.diagram.PixelOffsetMode.HIGH_SPEED);

// sets the resolution for the generated images, in dots per inch. The
// default value is 96.
options.setResolution(2.0);

// sets the zoom factor for the generated images.
// the default value is 1.0. The value must be greater than 0.
options.setScale(1.0);

// specify whether smoothing (antialiasing) is applied to lines
// and curves and the edges of filled areas.
options.setSmoothingMode(aspose.diagram.SmoothingMode.HIGH_QUALITY);
// sets the type of compression to apply when saving generated images to
// the TIFF format.
options.setTiffCompression(aspose.diagram.TiffCompression.CCITT_3);

// save in any supported file format
diagram.save("out-UseImageSaveOptions.jpeg", options);

Constructor Summary
ImageSaveOptions(saveFormat)
           Initializes a new instance of this class that can be used to save rendered images in the SaveFileFormat, SaveFileFormat, SaveFileFormat, SaveFileFormat or SaveFileFormat format.
 
Property Getters/Setters Summary
functiongetArea()
           Gets or sets the area of the shapes will be saved .
functiongetCompositingQuality()
functionsetCompositingQuality(value)
           Specifies the quality level to use during compositing. The value of the property is CompositingQuality integer constant.
functiongetDefaultFont()
functionsetDefaultFont(value)
           When characters in the diagram are unicode and not be set with correct font value or the font is not installed locally, they may appear as block in pdf, image or XPS. Set the DefaultFont such as MingLiu or MS Gothic to show these characters.
functiongetEnlargePage()
functionsetEnlargePage(value)
           Specifies whether enlarge page .
functiongetExportGuideShapes()
functionsetExportGuideShapes(value)
           Defines whether need exporting the guide shapes or not.
functiongetExportHiddenPage()
functionsetExportHiddenPage(value)
           Defines whether need exporting the hidden page or not.
functiongetImageBrightness()
functionsetImageBrightness(value)
           Gets or sets the brightness for the the generated images.
functiongetImageColorMode()
functionsetImageColorMode(value)
           Gets or sets the color mode for the generated images. The value of the property is ImageColorMode integer constant.
functiongetImageContrast()
functionsetImageContrast(value)
           Gets or sets the contrast for the generated images.
functiongetInterpolationMode()
functionsetInterpolationMode(value)
           Specifies the algorithm that is used when images are scaled or rotated. The value of the property is InterpolationMode integer constant.
functionisExportComments()
functionsetExportComments(value)
           Defines whether need exporting the comments or not.
functiongetJpegQuality()
functionsetJpegQuality(value)
           Gets or sets a value determining the quality of the generated JPEG images.
functiongetPageCount()
functionsetPageCount(value)
           Gets or sets the number of pages to render when saving to a multipage TIFF file. Default is MaxValue which means all pages of the diagram will be rendered.
functiongetPageIndex()
functionsetPageIndex(value)
           Gets or sets the 0-based index of the first page to render. Default is 0.
functiongetPageSize()
functionsetPageSize(value)
           Gets or sets the page size for the generated images. Can be PageSize or null.
functiongetPixelOffsetMode()
functionsetPixelOffsetMode(value)
           Gets or set a value specifying how pixels are offset during rendering. The value of the property is PixelOffsetMode integer constant.
functiongetResolution()
functionsetResolution(value)
           Gets or sets the resolution for the generated images, in dots per inch.
functiongetSameAsPdfConversionArea()
functionsetSameAsPdfConversionArea(value)
           Specifies whether saving area same as pdf .
functiongetSaveForegroundPagesOnly()
functionsetSaveForegroundPagesOnly(value)
           Specifies whether all pages will be saved in image or only foreground.
functiongetSaveFormat()
functionsetSaveFormat(value)
           Specifies the format in which the rendered diagram pages will be saved if this save options object is used. Can be SaveFileFormat, SaveFileFormat, SaveFileFormat, SaveFileFormat or SaveFileFormat. The value of the property is SaveFileFormat integer constant.
functiongetScale()
functionsetScale(value)
           Gets or sets the zoom factor for the generated images.
functiongetShapes()
functionsetShapes(value)
           Gets or sets shapes to render. Default count is 0.
functiongetSmoothingMode()
functionsetSmoothingMode(value)
           Specifies whether smoothing (antialiasing) is applied to lines and curves and the edges of filled areas. The value of the property is SmoothingMode integer constant.
functiongetTiffCompression()
functionsetTiffCompression(value)
           Gets or sets the type of compression to apply when saving generated images to the TIFF format. The value of the property is TiffCompression integer constant.
functiongetWarningCallback()
functionsetWarningCallback(value)
           Gets or sets warning callback.
 

Constructor Detail

ImageSaveOptions

function ImageSaveOptions(saveFormat)
Initializes a new instance of this class that can be used to save rendered images in the SaveFileFormat, SaveFileFormat, SaveFileFormat, SaveFileFormat or SaveFileFormat format.
Parameters:
saveFormat: Number - A SaveFileFormat value. Can be SaveFileFormat, SaveFileFormat, SaveFileFormat, SaveFileFormat or SaveFileFormat.

Property Getters/Setters Detail

getImageBrightness/setImageBrightness : Number 

function getImageBrightness() / function setImageBrightness(value)
Gets or sets the brightness for the the generated images. This property has effect only when saving to raster image formats. The default value is 0.5. The value must be in the range between 0 and 1.

getImageColorMode/setImageColorMode : Number 

function getImageColorMode() / function setImageColorMode(value)
Gets or sets the color mode for the generated images. The value of the property is ImageColorMode integer constant. This property has effect only when saving to raster image formats. The default value is ImageColorMode.

getImageContrast/setImageContrast : Number 

function getImageContrast() / function setImageContrast(value)
Gets or sets the contrast for the generated images. This property has effect only when saving to raster image formats. The default value is 0.5. The value must be in the range between 0 and 1.

getJpegQuality/setJpegQuality : Number 

function getJpegQuality() / function setJpegQuality(value)
Gets or sets a value determining the quality of the generated JPEG images. Has effect only when saving to JPEG. Use this property to get or set the quality of generated images when saving in JPEG format. The value may vary from 0 to 100 where 0 means worst quality but maximum compression and 100 means best quality but minimum compression. The default value is 95.

getPageCount/setPageCount : Number 

function getPageCount() / function setPageCount(value)
Gets or sets the number of pages to render when saving to a multipage TIFF file. Default is MaxValue which means all pages of the diagram will be rendered.

getPageIndex/setPageIndex : Number 

function getPageIndex() / function setPageIndex(value)
Gets or sets the 0-based index of the first page to render. Default is 0.

Example:

var aspose = aspose || {};
aspose.diagram = require("aspose.diagram");

diagram = new aspose.diagram.Diagram("ExportPageToImage.vsd");

// Save diagram as PNG
options = new aspose.diagram.ImageSaveOptions(aspose.diagram.SaveFileFormat.PNG);

// Save one page only, by page index
options.setPageIndex(0);

// Save resultant Image file
diagram.save("out-ExportPageToImage.png", options);

getExportHiddenPage/setExportHiddenPage : boolean 

function getExportHiddenPage() / function setExportHiddenPage(value)
Defines whether need exporting the hidden page or not. Default value is true.

getResolution/setResolution : Number 

function getResolution() / function setResolution(value)
Gets or sets the resolution for the generated images, in dots per inch. This property has effect only when saving to raster image formats. The default value is 96.

getSaveFormat/setSaveFormat : Number 

function getSaveFormat() / function setSaveFormat(value)
Specifies the format in which the rendered diagram pages will be saved if this save options object is used. Can be SaveFileFormat, SaveFileFormat, SaveFileFormat, SaveFileFormat or SaveFileFormat. The value of the property is SaveFileFormat integer constant.

getScale/setScale : Number 

function getScale() / function setScale(value)
Gets or sets the zoom factor for the generated images. The default value is 1.0. The value must be greater than 0.

getTiffCompression/setTiffCompression : Number 

function getTiffCompression() / function setTiffCompression(value)
Gets or sets the type of compression to apply when saving generated images to the TIFF format. The value of the property is TiffCompression integer constant. Has effect only when saving to TIFF. The default value is TiffCompression.

getSaveForegroundPagesOnly/setSaveForegroundPagesOnly : boolean 

function getSaveForegroundPagesOnly() / function setSaveForegroundPagesOnly(value)
Specifies whether all pages will be saved in image or only foreground. If true - rendered only foreground pages(with background if present). If false - rendered foreground pages(with background if present) after that empty background pages. Can return true only when PageCount > 1. The default value is false.

getSameAsPdfConversionArea/setSameAsPdfConversionArea : boolean 

function getSameAsPdfConversionArea() / function setSameAsPdfConversionArea(value)
Specifies whether saving area same as pdf . If true - rendered area same as pdf. If false - rendered area default. The default value is false.

getPixelOffsetMode/setPixelOffsetMode : Number 

function getPixelOffsetMode() / function setPixelOffsetMode(value)
Gets or set a value specifying how pixels are offset during rendering. The value of the property is PixelOffsetMode integer constant. This property has effect only when saving to raster image formats. The default value is PixelOffsetMode.

getSmoothingMode/setSmoothingMode : Number 

function getSmoothingMode() / function setSmoothingMode(value)
Specifies whether smoothing (antialiasing) is applied to lines and curves and the edges of filled areas. The value of the property is SmoothingMode integer constant. This property has effect only when saving to raster image formats. The default value is SmoothingMode.

getCompositingQuality/setCompositingQuality : Number 

function getCompositingQuality() / function setCompositingQuality(value)
Specifies the quality level to use during compositing. The value of the property is CompositingQuality integer constant. This property has effect only when saving to raster image formats. The default value is CompositingQuality.

getInterpolationMode/setInterpolationMode : Number 

function getInterpolationMode() / function setInterpolationMode(value)
Specifies the algorithm that is used when images are scaled or rotated. The value of the property is InterpolationMode integer constant. This property has effect only when saving to raster image formats. The default value is InterpolationMode.

getPageSize/setPageSize : PageSize 

function getPageSize() / function setPageSize(value)
Gets or sets the page size for the generated images. Can be PageSize or null. The default value is null. If PageSize is null then page size for generated image is obtained from source diagram.

getShapes/setShapes : ShapeCollection 

function getShapes() / function setShapes(value)
Gets or sets shapes to render. Default count is 0.

Example:

var aspose = aspose || {};
aspose.diagram = require("aspose.diagram");

diagram = new aspose.diagram.Diagram("LoadSaveConvert.vsdx");

// create an instance SVG save options class
options = new aspose.diagram.SVGSaveOptions();
shapes = options.getShapes();

// get shapes by page index and shape ID, and then add in the shape collection object
shapes.add(diagram.getPages().get(0).getShapes().getShape(1));
shapes.add(diagram.getPages().get(0).getShapes().getShape(2));

// save Visio drawing
diagram.save("out-SelectiveShapes_out.svg", options);

getArea : Float 

function getArea()
Gets or sets the area of the shapes will be saved . This property has effect only when saving to raster image formats.

getExportGuideShapes/setExportGuideShapes : boolean 

function getExportGuideShapes() / function setExportGuideShapes(value)
Defines whether need exporting the guide shapes or not. Default value is true.

isExportComments/setExportComments : boolean 

function isExportComments() / function setExportComments(value)
Defines whether need exporting the comments or not. Default value is false.

Example:

var aspose = aspose || {};
aspose.diagram = require("aspose.diagram");

diagram = new aspose.diagram.Diagram("Pages.vsdx");
// get a particular page
page = diagram.getPages().getPage("Flow 2");
// set Visio page visiblity
page.getPageSheet().getPageProps().getUIVisibility().setValue(aspose.diagram.BOOL.TRUE);

// initialize Image save options
options = new aspose.diagram.ImageSaveOptions(aspose.diagram.SaveFileFormat.JPEG);
// set export option of hidden Visio pages
options.setExportHiddenPage(false);
// set export option of comments
options.setExportComments(false);

diagram.save("out-ExportOfHiddenVisioPagesToImage.jpeg", options);

getEnlargePage/setEnlargePage : boolean 

function getEnlargePage() / function setEnlargePage(value)
Specifies whether enlarge page . If true - enlarge page. If false - not enlarge page. The default value is true.

getDefaultFont/setDefaultFont : String 

function getDefaultFont() / function setDefaultFont(value)
When characters in the diagram are unicode and not be set with correct font value or the font is not installed locally, they may appear as block in pdf, image or XPS. Set the DefaultFont such as MingLiu or MS Gothic to show these characters.

getWarningCallback/setWarningCallback : IWarningCallback 

function getWarningCallback() / function setWarningCallback(value)
Gets or sets warning callback.

See Also:
          Aspose.Cells Documentation - the home page for the Aspose.Cellss Product Documentation.
          Aspose.Cells Support Forum - our preferred method of support.