SparklineGroup Class
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
System.Collections.IList
System.Collections.ICollection
System.Collections.Generic.IReadOnlyCollection<
ISparklines>
System.Collections.IEnumerable
Inherited Members
System.Collections.Generic.List<Syncfusion.XlsIO.ISparklines>.Add(Syncfusion.XlsIO.ISparklines)
System.Collections.Generic.List<Syncfusion.XlsIO.ISparklines>.AddRange(System.Collections.Generic.IEnumerable<Syncfusion.XlsIO.ISparklines>)
System.Collections.Generic.List<Syncfusion.XlsIO.ISparklines>.AsReadOnly()
System.Collections.Generic.List<Syncfusion.XlsIO.ISparklines>.BinarySearch(Syncfusion.XlsIO.ISparklines)
System.Collections.Generic.List<Syncfusion.XlsIO.ISparklines>.BinarySearch(Syncfusion.XlsIO.ISparklines, System.Collections.Generic.IComparer<Syncfusion.XlsIO.ISparklines>)
System.Collections.Generic.List<Syncfusion.XlsIO.ISparklines>.BinarySearch(System.Int32, System.Int32, Syncfusion.XlsIO.ISparklines, System.Collections.Generic.IComparer<Syncfusion.XlsIO.ISparklines>)
System.Collections.Generic.List<Syncfusion.XlsIO.ISparklines>.Capacity
System.Collections.Generic.List<Syncfusion.XlsIO.ISparklines>.Clear()
System.Collections.Generic.List<Syncfusion.XlsIO.ISparklines>.Contains(Syncfusion.XlsIO.ISparklines)
System.Collections.Generic.List<Syncfusion.XlsIO.ISparklines>.ConvertAll<TOutput>(System.Converter<Syncfusion.XlsIO.ISparklines, TOutput>)
System.Collections.Generic.List<Syncfusion.XlsIO.ISparklines>.CopyTo(Syncfusion.XlsIO.ISparklines[])
System.Collections.Generic.List<Syncfusion.XlsIO.ISparklines>.CopyTo(Syncfusion.XlsIO.ISparklines[], System.Int32)
System.Collections.Generic.List<Syncfusion.XlsIO.ISparklines>.CopyTo(System.Int32, Syncfusion.XlsIO.ISparklines[], System.Int32, System.Int32)
System.Collections.Generic.List<Syncfusion.XlsIO.ISparklines>.Count
System.Collections.Generic.List<Syncfusion.XlsIO.ISparklines>.Exists(System.Predicate<Syncfusion.XlsIO.ISparklines>)
System.Collections.Generic.List<Syncfusion.XlsIO.ISparklines>.Find(System.Predicate<Syncfusion.XlsIO.ISparklines>)
System.Collections.Generic.List<Syncfusion.XlsIO.ISparklines>.FindAll(System.Predicate<Syncfusion.XlsIO.ISparklines>)
System.Collections.Generic.List<Syncfusion.XlsIO.ISparklines>.FindIndex(System.Int32, System.Int32, System.Predicate<Syncfusion.XlsIO.ISparklines>)
System.Collections.Generic.List<Syncfusion.XlsIO.ISparklines>.FindIndex(System.Int32, System.Predicate<Syncfusion.XlsIO.ISparklines>)
System.Collections.Generic.List<Syncfusion.XlsIO.ISparklines>.FindIndex(System.Predicate<Syncfusion.XlsIO.ISparklines>)
System.Collections.Generic.List<Syncfusion.XlsIO.ISparklines>.FindLast(System.Predicate<Syncfusion.XlsIO.ISparklines>)
System.Collections.Generic.List<Syncfusion.XlsIO.ISparklines>.FindLastIndex(System.Int32, System.Int32, System.Predicate<Syncfusion.XlsIO.ISparklines>)
System.Collections.Generic.List<Syncfusion.XlsIO.ISparklines>.FindLastIndex(System.Int32, System.Predicate<Syncfusion.XlsIO.ISparklines>)
System.Collections.Generic.List<Syncfusion.XlsIO.ISparklines>.FindLastIndex(System.Predicate<Syncfusion.XlsIO.ISparklines>)
System.Collections.Generic.List<Syncfusion.XlsIO.ISparklines>.ForEach(System.Action<Syncfusion.XlsIO.ISparklines>)
System.Collections.Generic.List<Syncfusion.XlsIO.ISparklines>.GetEnumerator()
System.Collections.Generic.List<Syncfusion.XlsIO.ISparklines>.GetRange(System.Int32, System.Int32)
System.Collections.Generic.List<Syncfusion.XlsIO.ISparklines>.IndexOf(Syncfusion.XlsIO.ISparklines)
System.Collections.Generic.List<Syncfusion.XlsIO.ISparklines>.IndexOf(Syncfusion.XlsIO.ISparklines, System.Int32)
System.Collections.Generic.List<Syncfusion.XlsIO.ISparklines>.IndexOf(Syncfusion.XlsIO.ISparklines, System.Int32, System.Int32)
System.Collections.Generic.List<Syncfusion.XlsIO.ISparklines>.Insert(System.Int32, Syncfusion.XlsIO.ISparklines)
System.Collections.Generic.List<Syncfusion.XlsIO.ISparklines>.InsertRange(System.Int32, System.Collections.Generic.IEnumerable<Syncfusion.XlsIO.ISparklines>)
System.Collections.Generic.List<Syncfusion.XlsIO.ISparklines>.Item[System.Int32]
System.Collections.Generic.List<Syncfusion.XlsIO.ISparklines>.LastIndexOf(Syncfusion.XlsIO.ISparklines)
System.Collections.Generic.List<Syncfusion.XlsIO.ISparklines>.LastIndexOf(Syncfusion.XlsIO.ISparklines, System.Int32)
System.Collections.Generic.List<Syncfusion.XlsIO.ISparklines>.LastIndexOf(Syncfusion.XlsIO.ISparklines, System.Int32, System.Int32)
System.Collections.Generic.List<Syncfusion.XlsIO.ISparklines>.Remove(Syncfusion.XlsIO.ISparklines)
System.Collections.Generic.List<Syncfusion.XlsIO.ISparklines>.RemoveAll(System.Predicate<Syncfusion.XlsIO.ISparklines>)
System.Collections.Generic.List<Syncfusion.XlsIO.ISparklines>.RemoveAt(System.Int32)
System.Collections.Generic.List<Syncfusion.XlsIO.ISparklines>.RemoveRange(System.Int32, System.Int32)
System.Collections.Generic.List<Syncfusion.XlsIO.ISparklines>.Reverse()
System.Collections.Generic.List<Syncfusion.XlsIO.ISparklines>.Reverse(System.Int32, System.Int32)
System.Collections.Generic.List<Syncfusion.XlsIO.ISparklines>.Sort()
System.Collections.Generic.List<Syncfusion.XlsIO.ISparklines>.Sort(System.Collections.Generic.IComparer<Syncfusion.XlsIO.ISparklines>)
System.Collections.Generic.List<Syncfusion.XlsIO.ISparklines>.Sort(System.Comparison<Syncfusion.XlsIO.ISparklines>)
System.Collections.Generic.List<Syncfusion.XlsIO.ISparklines>.Sort(System.Int32, System.Int32, System.Collections.Generic.IComparer<Syncfusion.XlsIO.ISparklines>)
System.Collections.Generic.List<Syncfusion.XlsIO.ISparklines>.System.Collections.Generic.ICollection<Syncfusion.XlsIO.ISparklines>.IsReadOnly
System.Collections.Generic.List<Syncfusion.XlsIO.ISparklines>.System.Collections.Generic.IEnumerable<Syncfusion.XlsIO.ISparklines>.GetEnumerator()
System.Collections.Generic.List<Syncfusion.XlsIO.ISparklines>.System.Collections.ICollection.CopyTo(System.Array, System.Int32)
System.Collections.Generic.List<Syncfusion.XlsIO.ISparklines>.System.Collections.ICollection.IsSynchronized
System.Collections.Generic.List<Syncfusion.XlsIO.ISparklines>.System.Collections.ICollection.SyncRoot
System.Collections.Generic.List<Syncfusion.XlsIO.ISparklines>.System.Collections.IEnumerable.GetEnumerator()
System.Collections.Generic.List<Syncfusion.XlsIO.ISparklines>.System.Collections.IList.Add(System.Object)
System.Collections.Generic.List<Syncfusion.XlsIO.ISparklines>.System.Collections.IList.Contains(System.Object)
System.Collections.Generic.List<Syncfusion.XlsIO.ISparklines>.System.Collections.IList.get_Item(System.Int32)
System.Collections.Generic.List<Syncfusion.XlsIO.ISparklines>.System.Collections.IList.IndexOf(System.Object)
System.Collections.Generic.List<Syncfusion.XlsIO.ISparklines>.System.Collections.IList.Insert(System.Int32, System.Object)
System.Collections.Generic.List<Syncfusion.XlsIO.ISparklines>.System.Collections.IList.IsFixedSize
System.Collections.Generic.List<Syncfusion.XlsIO.ISparklines>.System.Collections.IList.IsReadOnly
System.Collections.Generic.List<Syncfusion.XlsIO.ISparklines>.System.Collections.IList.Item[System.Int32]
System.Collections.Generic.List<Syncfusion.XlsIO.ISparklines>.System.Collections.IList.Remove(System.Object)
System.Collections.Generic.List<Syncfusion.XlsIO.ISparklines>.System.Collections.IList.set_Item(System.Int32, System.Object)
System.Collections.Generic.List<Syncfusion.XlsIO.ISparklines>.ToArray()
System.Collections.Generic.List<Syncfusion.XlsIO.ISparklines>.TrimExcess()
System.Collections.Generic.List<Syncfusion.XlsIO.ISparklines>.TrueForAll(System.Predicate<Syncfusion.XlsIO.ISparklines>)
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.ToString()
Assembly: Syncfusion.XlsIO.Base.dll
Syntax
public class SparklineGroup : List<ISparklines>, IList, ICollection, IReadOnlyList<ISparklines>, IReadOnlyCollection<ISparklines>, ISparklineGroup, IList<ISparklines>, ICollection<ISparklines>, IEnumerable<ISparklines>, IEnumerable
Constructors
SparklineGroup(WorkbookImpl)
SparklineGroup implementation
Declaration
public SparklineGroup(WorkbookImpl book)
Parameters
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
Returns
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
System.Collections.IList
System.Collections.ICollection
System.Collections.Generic.IReadOnlyList<T>
System.Collections.Generic.IReadOnlyCollection<T>
System.Collections.Generic.IList<T>
System.Collections.Generic.ICollection<T>
System.Collections.Generic.IEnumerable<T>
System.Collections.IEnumerable
