SVGSaveOptions
Source: aspose.
Allows to specify additional options when rendering diagram pages to SVG.
Methods
new SVGSaveOptions()
Initializes a new instance of this class that can be used to save a document in the SaveFileFormat format.
Example
var aspose = aspose || {};
aspose.diagram = require("aspose.diagram");
diagram = new aspose.diagram.Diagram("VisioSaveOptions.vsdx");
options = new aspose.diagram.SVGSaveOptions();
// 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 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);
diagram.save("out-UseSVGSaveOptions.svg", options);
Methods
getCustomImagePath()
The user custom path(URL) saved in generated svg file for the image. If not defined by user, Current directory will be used.
getDefaultFont()
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.
getEmfRenderSetting()
Setting for rendering Emf metafile. The value of the property is EmfRenderSetting integer constant. EMF metafiles identified as "EMF+ Dual" can contain both EMF+ records and EMF records. Either type of record can be used to render the image, only EMF+ records, or only EMF records. When EmfPlusPrefer is set, then EMF+ records will be parsed , otherwise only EMF records will be parsed. Default value is EmfOnly"/>.
getEnlargePage()
Specifies whether enlarge page . If true - enlarge page. If false - not enlarge page. The default value is true.
getExportElementAsRectTag()
Defines whether need exporting rectangle elements as rect tag or not. Default value is false.
getExportGuideShapes()
Defines whether need exporting the guide shapes or not. Default value is true.
getExportHiddenPage()
Defines whether need exporting the hidden page or not. Default value is true.
getPageIndex()
Gets or sets the 0-based index of the page to render. Default is 0.
getPageSize()
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.
getQuality()
Gets or sets a value determining the quality of the generated images to apply only when saving pages to the Jpeg format. The default value is 100 Has effect only when saving to JPEG. The value must be between 0 and 100. The default value is 100.
getSaveFormat()
Specifies the format in which the document will be saved if this save options object is used. The value of the property is SaveFileFormat integer constant.
getShapes()
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);
getSVGFitToViewPort()
if this property is true, the generated svg will fit to view port.
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 SVG save options
options = new aspose.diagram.SVGSaveOptions();
// set export option of hidden Visio pages
options.setExportHiddenPage(false);
// Set SVG fit to view port
options.setSVGFitToViewPort(true);
// Set export element as Rectangle
options.setExportElementAsRectTag(true);
diagram.save("out-ExportOfHiddenVisioPagesToSVG.svg", options);
getWarningCallback()
Gets or sets warning callback.
isExportComments()
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);
isExportScaleInMatrix()
Defines whether need export scale in matrix or not. Default value is true.
isSavingCustomLinePattern()
Defines whether Saving custom line pattern.
isSavingImageSeparately()
Defines whether Saving Image Separately.
setCustomImagePath()
The user custom path(URL) saved in generated svg file for the image. If not defined by user, Current directory will be used.
setDefaultFont()
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.
setEmfRenderSetting()
Setting for rendering Emf metafile. The value of the property is EmfRenderSetting integer constant. EMF metafiles identified as "EMF+ Dual" can contain both EMF+ records and EMF records. Either type of record can be used to render the image, only EMF+ records, or only EMF records. When EmfPlusPrefer is set, then EMF+ records will be parsed , otherwise only EMF records will be parsed. Default value is EmfOnly"/>.
setEnlargePage()
Specifies whether enlarge page . If true - enlarge page. If false - not enlarge page. The default value is true.
setExportComments()
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);
setExportElementAsRectTag()
Defines whether need exporting rectangle elements as rect tag or not. Default value is false.
setExportGuideShapes()
Defines whether need exporting the guide shapes or not. Default value is true.
setExportHiddenPage()
Defines whether need exporting the hidden page or not. Default value is true.
setExportScaleInMatrix()
Defines whether need export scale in matrix or not. Default value is true.
setPageIndex()
Gets or sets the 0-based index of the page to render. Default is 0.
setPageSize()
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.
setQuality()
Gets or sets a value determining the quality of the generated images to apply only when saving pages to the Jpeg format. The default value is 100 Has effect only when saving to JPEG. The value must be between 0 and 100. The default value is 100.
setSaveFormat()
Specifies the format in which the document will be saved if this save options object is used. The value of the property is SaveFileFormat integer constant.
setSavingCustomLinePattern()
Defines whether Saving custom line pattern.
setSavingImageSeparately()
Defines whether Saving Image Separately.
setShapes()
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);
setSVGFitToViewPort()
if this property is true, the generated svg will fit to view port.
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 SVG save options
options = new aspose.diagram.SVGSaveOptions();
// set export option of hidden Visio pages
options.setExportHiddenPage(false);
// Set SVG fit to view port
options.setSVGFitToViewPort(true);
// Set export element as Rectangle
options.setExportElementAsRectTag(true);
diagram.save("out-ExportOfHiddenVisioPagesToSVG.svg", options);
setWarningCallback()
Gets or sets warning callback.