SparklineGroupCollection Interface

A collection of the SparklineGroup objects in a worksheet.

Namespace: DevExpress.Spreadsheet

Assembly: DevExpress.Spreadsheet.v19.1.Core.dll

Declaration

C#

public interface SparklineGroupCollection :
    ISimpleCollection<SparklineGroup>,
    IEnumerable<SparklineGroup>,
    IEnumerable,
    ICollection

VB.NET

Public Interface SparklineGroupCollection
    Inherits ISimpleCollection(Of SparklineGroup),
             IEnumerable(Of SparklineGroup),
             IEnumerable,
             ICollection

Related API Members

The following members return SparklineGroupCollection objects:

• Worksheet.SparklineGroups

Remarks

Use the Worksheet.SparklineGroups property to get access to the SparklineGroupCollection collection.

To create a new sparkline group and add it to a worksheet, use the SparklineGroupCollection.Add method.

For details on how to insert sparklines in a worksheet and adjust their settings, refer to the Sparklines section for examples.

Example

Note

A complete sample project is available at https://github.com/DevExpress-Examples/spreadsheet-document-server-chart-api-t132724

SparklineActions.cs

Worksheet worksheet = workbook.Worksheets["SparklineExamples"];
workbook.Worksheets.ActiveWorksheet = worksheet;

// Create a group of line sparklines.
SparklineGroup quarterlyGroup = worksheet.SparklineGroups.Add(worksheet["G4:G6"], worksheet["C4:F4,C5:F5,C6:F6"], SparklineGroupType.Line);
// Add one more sparkline to the existing group.
quarterlyGroup.Sparklines.Add(6, 6, worksheet["C7:F7"]);

// Display a column sparkline in the total cell.
SparklineGroup totalGroup = worksheet.SparklineGroups.Add(worksheet["G8"], worksheet["C8:F8"], SparklineGroupType.Column);

SparklineActions.vb

Dim worksheet As Worksheet = workbook.Worksheets("SparklineExamples")
workbook.Worksheets.ActiveWorksheet = worksheet

' Create a group of line sparklines.
Dim quarterlyGroup As SparklineGroup = worksheet.SparklineGroups.Add(worksheet("G4:G6"), worksheet("C4:F4,C5:F5,C6:F6"), SparklineGroupType.Line)
' Add one more sparkline to the existing group.
quarterlyGroup.Sparklines.Add(6, 6, worksheet("C7:F7"))

' Display a column sparkline in the total cell.
Dim totalGroup As SparklineGroup = worksheet.SparklineGroups.Add(worksheet("G8"), worksheet("C8:F8"), SparklineGroupType.Column)