Class SvgImageOptions

SvgImageOptions class

Options for generating Svg image.

public class SvgImageOptions : ImageOrPrintOptions

Constructors

NameDescription
SvgImageOptions()Ctor.

Properties

NameDescription
AllColumnsInOnePagePerSheet { get; set; }If AllColumnsInOnePagePerSheet is true , all column content of one sheet will output to only one page in result. The width of paper size of pagesetup will be invalid, and the other settings of pagesetup will still take effect.(Inherited from ImageOrPrintOptions.)
ChartImageType { get; set; }(Obsolete.) Indicate the chart imagetype when converting. default value: PNG.(Inherited from ImageOrPrintOptions.)
CheckWorkbookDefaultFont { get; set; }When characters in the Excel are Unicode and not be set with correct font in cell style, They may appear as block in pdf,image. Set this to true to try to use workbook’s default font to show these characters first.(Inherited from ImageOrPrintOptions.)
CssPrefix { get; set; }Gets and sets the prefix of the css name in svg,the default value is empty string.
CustomPrintPageEventHandler { get; set; }Client can special output to printer when print each page using this EventHandler(Inherited from ImageOrPrintOptions.)
CustomQueryPageSettingsEventHandler { get; set; }Client can control page setting of printer when print each page using this EventHandler(Inherited from ImageOrPrintOptions.)
CustomRenderSettings { get; set; }Gets or sets custom settings during rendering.(Inherited from ImageOrPrintOptions.)
DefaultEditLanguage { get; set; }Gets or sets default edit language.(Inherited from ImageOrPrintOptions.)
DefaultFont { get; set; }When characters in the Excel are Unicode and not be set with correct font in cell style, They may appear as block in pdf,image. Set the DefaultFont such as MingLiu or MS Gothic to show these characters. If this property is not set, Aspose.Cells will use system default font to show these unicode characters.(Inherited from ImageOrPrintOptions.)
DrawObjectEventHandler { get; set; }Implements this interface to get DrawObject and Bound when rendering.(Inherited from ImageOrPrintOptions.)
EmbeddedFontType { get; set; }Gets or sets the type of font that embedded in Svg.
EmbededImageNameInSvg { get; set; }(Obsolete.) Indicate the filename of embedded image in svg. This should be full path with directory like “c:\xpsEmbedded”(Inherited from ImageOrPrintOptions.)
EmfRenderSetting { get; set; }Setting for rendering Emf metafiles in source file.(Inherited from ImageOrPrintOptions.)
EmfType { get; set; }Gets or sets an EmfType that specifies the format of the Metafile.. The default value is EmfPlusDual.(Inherited from ImageOrPrintOptions.)
FitToViewPort { get; set; }if this property is true, the generated svg will fit to view port.
GridlineColor { get; set; }Gets or sets gridline colr.(Inherited from ImageOrPrintOptions.)
GridlineType { get; set; }Gets or sets gridline type.(Inherited from ImageOrPrintOptions.)
HorizontalResolution { get; set; }Gets or sets the horizontal resolution for generated images, in dots per inch.(Inherited from ImageOrPrintOptions.)
override ImageType { get; set; }Gets or sets the format of the generated images. default value: PNG.
IsCellAutoFit { get; set; }(Obsolete.) Indicates whether the width and height of the cells is automatically fitted by cell value. The default value is false.(Inherited from ImageOrPrintOptions.)
IsFontSubstitutionCharGranularity { get; set; }Indicates whether to only substitute the font of character when the cell font is not compatibility for it.(Inherited from ImageOrPrintOptions.)
IsOptimized { get; set; }Indicates whether to optimize the output elements.(Inherited from ImageOrPrintOptions.)
OnePagePerSheet { get; set; }If OnePagePerSheet is true , all content of one sheet will output to only one page in result. The paper size of pagesetup will be invalid, and the other settings of pagesetup will still take effect.(Inherited from ImageOrPrintOptions.)
OnlyArea { get; set; }If this property is true , one Area will be output, and no scale will take effect.(Inherited from ImageOrPrintOptions.)
OutputBlankPageWhenNothingToPrint { get; set; }Indicates whether to output a blank page when there is nothing to print.(Inherited from ImageOrPrintOptions.)
PageCount { get; set; }Gets or sets the number of pages to save.(Inherited from ImageOrPrintOptions.)
PageIndex { get; set; }Gets or sets the 0-based index of the first page to save.(Inherited from ImageOrPrintOptions.)
PageSavingCallback { get; set; }Control/Indicate progress of page saving process.(Inherited from ImageOrPrintOptions.)
PixelFormat { get; set; }Gets or sets the pixel format for the generated images.(Inherited from ImageOrPrintOptions.)
PrintingPage { get; set; }Indicates which pages will not be printed.(Inherited from ImageOrPrintOptions.)
PrintWithStatusDialog { get; set; }If PrintWithStatusDialog = true , there will be a dialog that shows current print status. else no such dialog will show.(Inherited from ImageOrPrintOptions.)
Quality { get; set; }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(Inherited from ImageOrPrintOptions.)
SaveFormat { get; set; }(Obsolete.) Gets or sets the output file format type Support Tiff/XPS(Inherited from ImageOrPrintOptions.)
SheetSet { get; set; }Gets or sets the sheets to render. Default is all visible sheets in the workbook: Visible.(Inherited from ImageOrPrintOptions.)
SmoothingMode { get; set; }Specifies whether smoothing (antialiasing) is applied to lines and curves and the edges of filled areas. The default value is SmoothingMode.None(Inherited from ImageOrPrintOptions.)
SvgCssPrefix { get; set; }(Obsolete.) Gets and sets the prefix of the css name in svg,the default value is empty string.(Inherited from ImageOrPrintOptions.)
SVGFitToViewPort { get; set; }(Obsolete.) if this property is true, the generated svg will fit to view port.(Inherited from ImageOrPrintOptions.)
TextCrossType { get; set; }Gets or sets displaying text type when the text width is larger than cell width.(Inherited from ImageOrPrintOptions.)
TextRenderingHint { get; set; }Specifies the quality of text rendering. The default value is TextRenderingHint.SystemDefault(Inherited from ImageOrPrintOptions.)
TiffBinarizationMethod { get; set; }Gets or sets method used while converting images to 1 bpp format when ImageType is Tiff and TiffCompression is equal to Ccitt3 or Ccitt4.(Inherited from ImageOrPrintOptions.)
TiffColorDepth { get; set; }Gets or sets bit depth to apply only when saving pages to the Tiff format.(Inherited from ImageOrPrintOptions.)
TiffCompression { get; set; }Gets or sets the type of compression to apply only when saving pages to the Tiff format.(Inherited from ImageOrPrintOptions.)
Transparent { get; set; }Indicates if the background of generated image should be transparent.(Inherited from ImageOrPrintOptions.)
VerticalResolution { get; set; }Gets or sets the vertical resolution for generated images, in dots per inch.(Inherited from ImageOrPrintOptions.)
WarningCallback { get; set; }Gets or sets warning callback.(Inherited from ImageOrPrintOptions.)

Methods

NameDescription
SetDesiredSize(int, int)(Obsolete.) Sets desired width and height of image.(Inherited from ImageOrPrintOptions.)
SetDesiredSize(int, int, bool)Sets desired width and height of image.(Inherited from ImageOrPrintOptions.)

Examples

namespace AsposeCellsExamples
{
    using Aspose.Cells;
    using Aspose.Cells.Charts;
    using Aspose.Cells.Drawing;
    using Aspose.Cells.Rendering;
    using System;

    public class RenderingClassSvgImageOptionsDemo
    {
        public static void Run()
        {
            // Create a new workbook and access first worksheet
            Workbook workbook = new Workbook();
            Worksheet worksheet = workbook.Worksheets[0];
            
            // Populate sample data for chart
            worksheet.Cells["A1"].PutValue("Q1");
            worksheet.Cells["A2"].PutValue(12000);
            worksheet.Cells["A3"].PutValue(16500);
            worksheet.Cells["B1"].PutValue("Q2");
            worksheet.Cells["B2"].PutValue(25500);
            worksheet.Cells["B3"].PutValue(10800);

            // Create a column chart
            int chartIndex = worksheet.Charts.Add(ChartType.Column, 5, 0, 20, 8);
            Chart chart = worksheet.Charts[chartIndex];
            chart.NSeries.Add("A2:B3", true);
            chart.NSeries.CategoryData = "A1:B1";

            // Initialize SVG image options
            SvgImageOptions svgOptions = new SvgImageOptions();
            
            // Configure SVG rendering options
            svgOptions.FitToViewPort = true;
            svgOptions.CssPrefix = "chart-";
            svgOptions.EmbeddedFontType = SvgEmbeddedFontType.Woff;
            svgOptions.ImageType = ImageType.Svg;

            // Set print quality and resolution
            svgOptions.PrintWithStatusDialog = true;
            svgOptions.HorizontalResolution = 300;
            svgOptions.VerticalResolution = 300;

            // Render chart to SVG with configured options
            chart.ToImage("chart_output.svg", svgOptions);

            // Demonstrate workbook save integration
            workbook.Save("SvgRenderingDemo.xlsx");
        }
    }
}

See Also