SparklineGroupCollection.Add

Add(SparklineType)

Adds an SparklineGroup with a Sparkline to the collection.

public int Add(SparklineType type)
ParameterTypeDescription
typeSparklineTypeSpecifies the type of the Sparkline group.

Return Value

SparklineGroup object index.

Examples

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

    public class SparklineGroupCollectionMethodAddWithSparklineTypeDemo
    {
        public static void Run()
        {
            // Create a new workbook
            Workbook workbook = new Workbook();
            Worksheet worksheet = workbook.Worksheets[0];

            // Add sample data for sparklines
            worksheet.Cells["A1"].PutValue(5);
            worksheet.Cells["A2"].PutValue(3);
            worksheet.Cells["A3"].PutValue(7);
            worksheet.Cells["A4"].PutValue(2);
            worksheet.Cells["A5"].PutValue(9);

            try
            {
                // Get the sparkline group collection
                SparklineGroupCollection sparklineGroups = worksheet.SparklineGroups;

                // Call the Add method with SparklineType parameter
                int index = sparklineGroups.Add(SparklineType.Line);

                // Configure the sparkline group
                SparklineGroup group = sparklineGroups[index];
                group.Sparklines.Add("A1:A5", 5, 0);

                Console.WriteLine("Sparkline group added successfully with type: Line");
            }
            catch (Exception ex)
            {
                Console.WriteLine($"Error executing Add method: {ex.Message}");
            }

            // Save the result
            workbook.Save("SparklineGroupCollectionMethodAddWithSparklineTypeDemo.xlsx");
        }
    }
}

See Also

Add(SparklineType, string, bool, CellArea)

Adds an SparklineGroup with some Sparkline to the collection.

public int Add(SparklineType type, string dataRange, bool isVertical, CellArea locationRange)
ParameterTypeDescription
typeSparklineTypeSpecifies the type of the Sparkline group.
dataRangeStringSpecifies the data range of the sparkline group.
isVerticalBooleanSpecifies whether to plot the sparklines from the data range by row or by column.
locationRangeCellAreaSpecifies where the sparklines to be placed.

Return Value

SparklineGroup object index.

Remarks

This method will create sparklines too. If isVertical is true, the number of rows in dataRange and locationRange must be same. If isVertical is false, the number of columns in dataRange and locationRange must be same.

Examples

using System;
using Aspose.Cells;
using Aspose.Cells.Charts;

namespace AsposeCellsExamples
{
    public class SparklineGroupCollectionMethodAddWithSparklineTypeStringBooleanCellDemo
    {
        public static void Run()
        {
            Workbook workbook = new Workbook();
            Worksheet sheet = workbook.Worksheets[0];
            
            // Add sample data for sparklines
            sheet.Cells["A1"].PutValue(5);
            sheet.Cells["B1"].PutValue(3);
            sheet.Cells["C1"].PutValue(8);
            
            // Add sparkline group with specified parameters
            sheet.SparklineGroups.Add(
                SparklineType.Line, 
                "A1:C1", 
                false, 
                CellArea.CreateCellArea("D1", "D1")
            );
            
            workbook.Save("output.xlsx");
        }
    }
}

See Also