asposecells.api

asposecells.api

Class Sparkline

A sparkline represents a tiny chart or graphic in a worksheet cell that provides a visual representation of data.

Example:

            [C#]
             Workbook book = new Workbook(); 
             Worksheet sheet = book.Worksheets[0];
            
             sheet.Cells["A1"].PutValue(5);
             sheet.Cells["B1"].PutValue(2);
             sheet.Cells["C1"].PutValue(1);
             sheet.Cells["D1"].PutValue(3);
             
             // Define the CellArea
             CellArea ca = new CellArea();
             ca.StartColumn = 4;
             ca.EndColumn = 4;
             ca.StartRow = 0;
             ca.EndRow = 0;
            
             int idx = sheet.SparklineGroupCollection.Add(Aspose.Cells.Charts.SparklineType.Line, sheet.Name + "!A1:D1", false, ca);
            
             SparklineGroup group = sheet.SparklineGroupCollection[idx];
             idx = group.SparklineCollection.Add(sheet.Name + "!A1:D1", 0, 4);
             Sparkline line = group.SparklineCollection[idx];
             Console.WriteLine($"Saprkline data range:{line.DataRange}, row:{line.Row}, column:{line.Column}");
             line.ToImage("output.png", new ImageOrPrintOptions());

Property Getters/Setters Summary
methodgetColumn()
Gets the column index of the sparkline.
methodgetDataRange()
method
setDataRange(value)
           Represents the data range of the sparkline.
methodgetRow()
Gets the row index of the sparkline.
 
Method Summary
methodtoImage(stream, options)
Converts a sparkline to an image.
methodtoImage(fileName, options)
Converts a sparkline to an image.
methodtoImageBytes(options)
Converts a sparkline to an image.
 

    • Property Getters/Setters Detail

      • getDataRange/setDataRange : String 

        String getDataRange() / setDataRange(value)
        Represents the data range of the sparkline.

      • getRow : int 

        int getRow()
        Gets the row index of the sparkline.

      • getColumn : int 

        int getColumn()
        Gets the column index of the sparkline.

    • Method Detail

      • toImage

         toImage(fileName, options)
        Converts a sparkline to an image.
        Parameters:
        fileName: String - The image file name.
        options: ImageOrPrintOptions - The image options

      • toImage

         toImage(stream, options)
        Converts a sparkline to an image.
        Parameters:
        stream: OutputStream - The image stream.
        options: ImageOrPrintOptions - The image options.

      • toImageBytes

         toImageBytes(options)
        Converts a sparkline to an image.
        Parameters:
        options: ImageOrPrintOptions - Addtional image creation options
        Returns:
        A byte array.

        Example:

        import jpype
import asposecells
jpype.startJVM()
from asposecells.api import *

wb = Workbook("sparkline.xlsx")
sparkline = wb.getWorksheets().get(0).getSparklineGroupCollection().get(0).getSparklineCollection().get(0)
imgOptions = ImageOrPrintOptions()
imgOptions.setHorizontalResolution(200)
imgOptions.setVerticalResolution(300)
imgOptions.setImageFormat(ImageFormat.getJpeg())
with open("sparkline.jpeg", "wb") as w:
    content = sparkline.toImageBytes(imgOptions)
    w.write(content)

jpype.shutdownJVM()