com.aspose.diagram

Class SVGSaveOptions

public class SVGSaveOptions 
extends RenderingSaveOptions

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

Constructor Summary
SVGSaveOptions()
Initializes a new instance of this class that can be used to save a document in the SaveFileFormat format.
 
Property Getters/Setters Summary
java.awt.geom.Rectangle2D.FloatgetArea()
Gets or sets the area of the shapes will be saved .
java.lang.StringgetCustomImagePath()
void
setCustomImagePath(java.lang.Stringvalue)
           The user custom path(URL) saved in generated svg file for the image. If not defined by user, Current directory will be used.
java.lang.StringgetDefaultFont()
void
setDefaultFont(java.lang.Stringvalue)
           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.
intgetEmfRenderSetting()
void
           Setting for rendering Emf metafile. The value of the property is EmfRenderSetting integer constant.
booleangetEnlargePage()
void
setEnlargePage(booleanvalue)
           Specifies whether enlarge page .
booleangetExportElementAsRectTag()
void
           Defines whether need exporting rectangle elements as rect tag or not.
booleangetExportGuideShapes()
void
setExportGuideShapes(booleanvalue)
           Defines whether need exporting the guide shapes or not.
booleangetExportHiddenPage()
void
setExportHiddenPage(booleanvalue)
           Defines whether need exporting the hidden page or not.
booleanisExportComments()
void
setExportComments(booleanvalue)
           Defines whether need exporting the comments or not.
booleanisExportScaleInMatrix()
void
           Defines whether need export scale in matrix or not.
booleanisSavingImageSeparately()
void
           Defines whether Saving Image Separately.
intgetPageIndex()
void
setPageIndex(intvalue)
           Gets or sets the 0-based index of the page to render. Default is 0.
PageSizegetPageSize()
void
           Gets or sets the page size for the generated images. Can be PageSize or null.
intgetQuality()
void
setQuality(intvalue)
           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
intgetSaveFormat()
void
setSaveFormat(intvalue)
           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.
ShapeCollectiongetShapes()
void
           Gets or sets shapes to render. Default count is 0.
booleangetSVGFitToViewPort()
void
setSVGFitToViewPort(booleanvalue)
           if this property is true, the generated svg will fit to view port.
IWarningCallbackgetWarningCallback()
void
           Gets or sets warning callback.
 

    • Constructor Detail

      • SVGSaveOptions

        public SVGSaveOptions()
                       throws java.lang.Exception
        Initializes a new instance of this class that can be used to save a document in the SaveFileFormat format.
    • Property Getters/Setters Detail

      • getPageIndex/setPageIndex

        public int getPageIndex() / public void setPageIndex(int value)
        
        Gets or sets the 0-based index of the page to render. Default is 0.
      • getExportHiddenPage/setExportHiddenPage

        public boolean getExportHiddenPage() / public void setExportHiddenPage(boolean value)
        
        Defines whether need exporting the hidden page or not. Default value is true.
      • getQuality/setQuality

        public int getQuality() / public void setQuality(int value)
        
        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.
      • getSVGFitToViewPort/setSVGFitToViewPort

        public boolean getSVGFitToViewPort() / public void setSVGFitToViewPort(boolean value)
        
        if this property is true, the generated svg will fit to view port.
      • getExportElementAsRectTag/setExportElementAsRectTag

        public boolean getExportElementAsRectTag() / public void setExportElementAsRectTag(boolean value)
        
        Defines whether need exporting rectangle elements as rect tag or not. Default value is false.
      • isExportScaleInMatrix/setExportScaleInMatrix

        public boolean isExportScaleInMatrix() / public void setExportScaleInMatrix(boolean value)
        
        Defines whether need export scale in matrix or not. Default value is true.
      • isSavingImageSeparately/setSavingImageSeparately

        public boolean isSavingImageSeparately() / public void setSavingImageSeparately(boolean value)
        
        Defines whether Saving Image Separately.
      • getCustomImagePath/setCustomImagePath

        public java.lang.String getCustomImagePath() / public void setCustomImagePath(java.lang.String value)
        
        The user custom path(URL) saved in generated svg file for the image. If not defined by user, Current directory will be used.
      • getPageSize/setPageSize

        public PageSize getPageSize() / public void setPageSize(PageSize 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

        public ShapeCollection getShapes() / public void setShapes(ShapeCollection value)
        
        Gets or sets shapes to render. Default count is 0.
      • getArea

        public java.awt.geom.Rectangle2D.Float 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

        public boolean getExportGuideShapes() / public void setExportGuideShapes(boolean value)
        
        Defines whether need exporting the guide shapes or not. Default value is true.
      • isExportComments/setExportComments

        public boolean isExportComments() / public void setExportComments(boolean value)
        
        Defines whether need exporting the comments or not. Default value is false.
      • getEnlargePage/setEnlargePage

        public boolean getEnlargePage() / public void setEnlargePage(boolean value)
        
        Specifies whether enlarge page . If true - enlarge page. If false - not enlarge page. The default value is true.
      • getEmfRenderSetting/setEmfRenderSetting

        public int getEmfRenderSetting() / public void setEmfRenderSetting(int value)
        
        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 #Error Cref: !:EmfRenderSetting.EmfPlusPrefer is set, then EMF+ records will be parsed , otherwise only EMF records will be parsed. Default value is #Error Cref: !:EmfRenderSetting.EmfOnly.
      • getSaveFormat/setSaveFormat

        public int getSaveFormat() / public void setSaveFormat(int value)
        
        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.
      • getDefaultFont/setDefaultFont

        public java.lang.String getDefaultFont() / public void setDefaultFont(java.lang.String 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

        public IWarningCallback getWarningCallback() / public void setWarningCallback(IWarningCallback value)
        
        Gets or sets warning callback.