Class SparklineGroup

Represents a SparklineGroup.The SparklineGroup object is a member of the SparklineGroups collection.The SparklineGroups collection contains all the SparklineGroup objects in a workheet.

Inheritance

System.Object

SparklineGroup

Implements

ISparklineGroup

System.Collections.Generic.IList<ISparklines>

System.Collections.Generic.ICollection<ISparklines>

System.Collections.Generic.IEnumerable<ISparklines>

System.Collections.IEnumerable

Namespace: Syncfusion.XlsIO.Implementation

Assembly: Syncfusion.XlsIO.Base.dll

Syntax

public class SparklineGroup : List<ISparklines>, ISparklineGroup, IList<ISparklines>, ICollection<ISparklines>, IEnumerable<ISparklines>, IEnumerable

Constructors

SparklineGroup(WorkbookImpl)

SparklineGroup implementation

Declaration

public SparklineGroup(WorkbookImpl book)

Parameters

Type	Name	Description
WorkbookImpl	book

Properties

AxisColor

Gets and sets the color of the horizontal axis in the sparkline group.

Declaration

public Color AxisColor { get; set; }

Property Value

Type	Description
System.Drawing.Color	The color of the axis.

DisplayAxis

Indicates whether to show the sparkline horizontal axis. The horizontal axis appears if the sparkline has data that crosses the zero axis.

Declaration

public bool DisplayAxis { get; set; }

Property Value

Type	Description
System.Boolean	true if [display axis]; otherwise, false.

DisplayEmptyCellsAs

Indicates how to display empty cells.

Declaration

public SparklineEmptyCells DisplayEmptyCellsAs { get; set; }

Property Value

Type	Description
SparklineEmptyCells	The DisplayEmptyCellsAs property gets/sets the m_displayEmptyCellsAs data member.

DisplayHiddenRC

Indicates whether to show data in hidden rows and columns.

Declaration

public bool DisplayHiddenRC { get; set; }

Property Value

Type	Description
System.Boolean	true if [display hidden RC]; otherwise, false.

FirstPointColor

Gets and sets the color of the first point of data in the sparkline group.

Declaration

public Color FirstPointColor { get; set; }

Property Value

Type	Description
System.Drawing.Color	The first color of the point.

HighPointColor

Gets and sets the color of the highest points of data in the sparkline group.

Declaration

public Color HighPointColor { get; set; }

Property Value

Type	Description
System.Drawing.Color	The color of the high point.

HorizontalDateAxis

The HorizontalDateAxis property represents the horizontal axis type as Dateaxis.

Declaration

public bool HorizontalDateAxis { get; set; }

Property Value

Type	Description
System.Boolean	true if [horizontal date axis]; otherwise, false.

HorizontalDateAxisRange

Represents the range that contains the date values for the sparkline data.

Declaration

public IRange HorizontalDateAxisRange { get; set; }

Property Value

Type	Description
IRange	The HorizontalDateAxisRange property gets/sets the m_horizontalDateAxisRange data member.

Exceptions

Type	Condition
System.ArgumentOutOfRangeException	ifValue.Rows.Length.Rows.Lengthis not equal to 1 ifvalue.Column.Length.Column.Lengthis not equal to 1 ifHorizontalDateAxisis not true

LastPointColor

Gets and sets the color of the last point of data in the sparkline group.

Declaration

public Color LastPointColor { get; set; }

Property Value

Type	Description
System.Drawing.Color	The last color of the point.

LineWeight

Gets and sets the line weight in each line sparkline in the sparkline group, in the unit of points.

Declaration

public double LineWeight { get; set; }

Property Value

Type	Description
System.Double	The line weight value should be between 0 and 1584.

Exceptions

Type	Condition
System.ArgumentOutOfRangeException	if the value is not between 0 and 1584

LowPointColor

Gets and sets the color of the lowest points of data in the sparkline group.

Declaration

public Color LowPointColor { get; set; }

Property Value

Type	Description
System.Drawing.Color	The color of the low point.

MarkersColor

Gets and sets the color of points in each line sparkline in the sparkline group.

Declaration

public Color MarkersColor { get; set; }

Property Value

Type	Description
System.Drawing.Color	The color of the markers.

NegativePointColor

Gets and sets the color of the negative values on the sparkline group.

Declaration

public Color NegativePointColor { get; set; }

Property Value

Type	Description
System.Drawing.Color	The color of the negative point.

PlotRightToLeft

Indicates whether the plot data is right to left.

Declaration

public bool PlotRightToLeft { get; set; }

Property Value

Type	Description
System.Boolean	true if [plot right to left]; otherwise, false.

ShowFirstPoint

Indicates whether to highlight the first point of data in the sparkline group.

Declaration

public bool ShowFirstPoint { get; set; }

Property Value

Type	Description
System.Boolean	true if [show first point]; otherwise, false.

ShowHighPoint

Indicates whether to highlight the highest points of data in the sparkline group.

Declaration

public bool ShowHighPoint { get; set; }

Property Value

Type	Description
System.Boolean	true if [show high point]; otherwise, false.

ShowLastPoint

Indicates whether to highlight the last point of data in the sparkline group.

Declaration

public bool ShowLastPoint { get; set; }

Property Value

Type	Description
System.Boolean	true if [show last point]; otherwise, false.

ShowLowPoint

Indicates whether to highlight the lowest points of data in the sparkline group.

Declaration

public bool ShowLowPoint { get; set; }

Property Value

Type	Description
System.Boolean	true if [show low point]; otherwise, false.

ShowMarkers

Indicates whether to highlight each point in each line sparkline in the sparkline group.

Declaration

public bool ShowMarkers { get; set; }

Property Value

Type	Description
System.Boolean	true if [show markers]; otherwise, false.

Exceptions

Type	Condition
System.NotSupportedException	If Sparklinetype is not equal to Line

ShowNegativePoint

Indicates whether to highlight the negative values on the sparkline group with a different color or marker.

Declaration

public bool ShowNegativePoint { get; set; }

Property Value

Type	Description
System.Boolean	true if [show negative point]; otherwise, false.

SparklineColor

Gets and sets the color of the sparklines in the sparkline group.

Declaration

public Color SparklineColor { get; set; }

Property Value

Type	Description
System.Drawing.Color	The color of the sparkline.

SparklineType

Indicates the sparkline type of the sparkline group.

Declaration

public SparklineType SparklineType { get; set; }

Property Value

Type	Description
SparklineType	The SparklineType property gets/sets the m_sparklineType member.

VerticalAxisMaximum

The VerticalAxisMaximum property represents the Vertical Axis maximum options.

Declaration

public ISparklineVerticalAxis VerticalAxisMaximum { get; set; }

Property Value

Type	Description
ISparklineVerticalAxis	The VerticalAxisMaximum property gets/sets the m_verticalMaximum member.

VerticalAxisMinimum

The VerticalAxisMinimum property represents the Vertical Axis minimum options.

Declaration

public ISparklineVerticalAxis VerticalAxisMinimum { get; set; }

Property Value

Type	Description
ISparklineVerticalAxis	The VerticalAxisMinimum property gets/sets the m_verticalMinimum member.

Methods

Add()

Adds Sparklines instance.

Declaration

public ISparklines Add()

Returns

Type	Description
ISparklines	Sparklines object

Examples

This Example Demostrated how to Add the Sparklines

ExcelEngine engine=new ExcelEngine();

IApplication app= engine.Excel;

app.DefaultVersion= ExcelVersion.Excel2010;

IWorkbook wkBook= app.Workbooks.Create(2); 
IWorksheet sheet= wkBook.Worksheets[0];

ISparklineGroup spGroup= sheet.SparklineGroups.Add();        

//It returns the Sparklines object
ISparklines spLines= spGroup.Add();

wkBook.SaveAs("Sample.xlsx");
wkBook.Close();

Implements

ISparklineGroup

System.Collections.Generic.IList<>

System.Collections.Generic.ICollection<>

System.Collections.Generic.IEnumerable<T>

System.Collections.IEnumerable