Worksheet.SparklineGroups Property

Provides access to a collection of sparkline groups in a worksheet.

Namespace: DevExpress.Spreadsheet

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

Declaration

C#

SparklineGroupCollection SparklineGroups { get; }

VB.NET

ReadOnly Property SparklineGroups As SparklineGroupCollection

Property Value

Type	Description
SparklineGroupCollection	A SparklineGroupCollection object that contains all the sparklines in a worksheet.

Remarks

A sparkline is a tiny chart located in the background of a worksheet cell and used to visualize the data variations over time. For example, the image below shows line sparklines that demonstrate changes in quarterly sales for different states (the workbook is opened in Microsoft® Excel®).

To create a new sparkline group (containing one or more sparklines of the same type and sharing identical formatting settings), call the SparklineGroupCollection.Add method, accessible using the Worksheet.SparklineGroups.Add notation (see the example below).

Example

View Example

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)

Related GitHub Examples

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the SparklineGroups property.

Note

The algorithm used to collect these code examples remains a work in progress. Accordingly, the links and snippets below may produce inaccurate results. If you encounter an issue with code examples below, please use the feedback form on this page to report the issue.

C#

spreadsheet-chart-api-examples-t132724/CS/SpreadsheetDocServerChartAPISamples/CodeExamples/SparklineActions.cs#L16

// 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.

VB.NET

spreadsheet-chart-api-examples-t132724/VB/SpreadsheetDocServerChartAPISamples/CodeExamples/SparklineActions.vb#L15

' 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.