aspose.cells

aspose.cells

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
functiongetColumn()
Gets the column index of the sparkline.
functiongetDataRange()
function
setDataRange(value)
           Represents the data range of the sparkline.
functiongetRow()
Gets the row index of the sparkline.
 
Method Summary
functiontoImage(stream, options)
Converts a sparkline to an image.
functiontoImage(fileName, options)
Converts a sparkline to an image.
 

    • Property Getters/Setters Detail

      • getDataRange/setDataRange : String 

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

      • getRow : Number 

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

      • getColumn : Number 

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

    • Method Detail

      • toImage

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

      • toImage

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