GrapeCity.Documents.Excel.ISparklineGroup

ISparklineGroup Interface

Represents a group of sparklines.

An ISparklineGroup contains the sparklines associated with a location range and provides access to shared group settings such as axes, display options, source data, and sparkline type.

Namespace: GrapeCity.Documents.Excel

Assembly: DS.Documents.Excel.dll

Syntax

public interface ISparklineGroup : IEnumerable

Public Interface ISparklineGroup
    Inherits IEnumerable

Examples

worksheet.Range["A1:C3"].Value = new object[,] {
    {1, 3, 2},
    {2, 4, 1},
    {3, 2, 5}
};
ISparklineGroup group = worksheet.Range["D1:D3"].SparklineGroups.Add(SparkType.Line, "A1:C3");

Properties

Name	Description
Axes	Returns the associated ISparkAxes.
Count	Returns the number of sparklines in the sparkline group. Use this property to determine how many individual sparklines are contained in the group.
DateRange	Gets or sets the date range for the sparkline group. The date range specifies the cells that provide date-axis values for the sparkline group.
DisplayBlanksAs	Gets or sets the way that blank cells are plotted in the sparkline group. Use this property to determine how blank values in the sparkline source data are displayed for the sparkline group.
DisplayHidden	Gets or sets whether hidden cells are plotted in the sparkline group.
this[int]	Gets the ISparkline object at the specified index in the sparkline group. Use this method to access an individual sparkline contained in the group.
LineWeight	Gets or sets the line width of the sparklines in the sparkline group.
Location	Gets or sets the IRange object that represents the location of the sparkline group. The returned range identifies the cells where the sparklines in this group are displayed.
PlotBy	Gets or sets how to plot the sparkline when the data on which it is based is in a square-shaped range. The returned SparklineRowCol value indicates whether the source data is plotted by rows, by columns, or is not treated as a square-shaped range.
Points	Returns the point marker settings for the sparkline group.
SeriesColor	Gets the IFormatColor object that represents the main series color for the sparkline group. Use the returned object to inspect or modify the color applied to the sparkline series.
SourceData	Gets or sets the range that contains the source data for the sparkline group. Use this property to get or set the range reference string that identifies the cells used to generate the sparklines in the group.
Type	Gets or sets the type of sparkline for the group.

Methods

Name	Description
Delete()	Deletes the sparkline group. Use this method to remove the current sparkline group after it has been added to a worksheet range.
FromJson(string)	Generates the sparkline group from a JSON string. Use this method to restore the sparkline group's settings from JSON that was previously generated by ToJson().
ToJson()	Generates a JSON string from the sparkline group. Use this method to serialize the current sparkline group definition so that it can be reused with FromJson(string) or stored for later use.

Name

Description

Delete()

Deletes the sparkline group.

Use this method to remove the current sparkline group after it has been added to a worksheet range.

FromJson(string)

Generates the sparkline group from a JSON string.

Use this method to restore the sparkline group's settings from JSON that was previously generated by ToJson().

ToJson()

Generates a JSON string from the sparkline group.

Use this method to serialize the current sparkline group definition so that it can be reused with FromJson(string) or stored for later use.