Click or drag to resize

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 Hierarchy
System Object
System.Collections.Generic List ISparklines
Spire.Xls SparklineGroup

Namespace: Spire.Xls
Assembly: Spire.XLS (in Spire.XLS.dll) Version: 15.4.0.0 (15.4.0.5046)
Syntax
Copy 
public class SparklineGroup : List<ISparklines>, 
	ISparklineGroup, IList<ISparklines>, ICollection<ISparklines>, 
	IEnumerable<ISparklines>, IEnumerable

The SparklineGroup type exposes the following members.

Properties
Name Description
Public property Capacity
Gets or sets the total number of elements the internal data structure can hold without resizing.
(Inherited from List ISparklines .)
Public property Count
Gets the number of elements contained in the List T .
(Inherited from List ISparklines .)
Public property EmptyCellsType
Indicates how to display empty cells.
Public property FirstPointColor
Gets and sets the color of the first point of data in the sparkline group.
Public property HighPointColor
Gets and sets the color of the highest points of data in the sparkline group.
Public property HorizontalAxisColor
Gets and sets the color of the horizontal axis in the sparkline group.
Public property HorizontalDateAxisRange
Represents the range that contains the date values for the sparkline data.
Public property IsDisplayHidden
Indicates whether to show data in hidden rows and columns.
Public property IsHorizontalDateAxis
Indicates wheter represents the horizontal axis type as Dateaxis.
Public property Item
Gets the SparklineCollection at the specified index.
Public property LastPointColor
Gets and sets the color of the last point of data in the sparkline group.
Public property LineWeight
Gets and sets the line weight in each line sparkline in the sparkline group, in the unit of points.
Public property LowPointColor
Gets and sets the color of the lowest points of data in the sparkline group.
Public property MarkersColor
Gets and sets the color of points in each line sparkline in the sparkline group.
Public property NegativePointColor
Gets and sets the color of the negative values on the sparkline group.
Public property PlotRightToLeft
Indicates whether the plot data is right to left.
Public property ShowFirstPoint
Indicates whether to highlight the first point of data in the sparkline group.
Public property ShowHighPoint
Indicates whether to highlight the highest points of data in the sparkline group.
Public property ShowHorizontalAxis
Indicates whether to show the sparkline horizontal axis. The horizontal axis appears if the sparkline has data that crosses the zero axis.
Public property ShowLastPoint
Indicates whether to highlight the last point of data in the sparkline group.
Public property ShowLowPoint
Indicates whether to highlight the lowest points of data in the sparkline group.
Public property ShowMarkers
Indicates whether to highlight each point in each line sparkline in the sparkline group.
Public property ShowNegativePoint
Indicates whether to highlight the negative values on the sparkline group with a different color or marker.
Public property SparklineColor
Gets and sets the color of the sparklines in the sparkline group.
Public property SparklineList
Gets the collection of sparklines associated with the current instance.
Public property SparklineType
Indicates the sparkline type of the sparkline group.
Public property VerticalAxisMaxType
Represents the vertical axis maximum value type.
Public property VerticalAxisMaxValue
Gets and sets the custom maximum value for the vertical axis.
Public property VerticalAxisMinValue
Gets and sets the custom minimum value for the vertical axis.
Public property VerticalAxisMinValueType
Represents the vertical axis minimum value type.
Top
Methods
Name Description
Public method Add
Adds a new Sparkline to the collection.
Public method Add(T)
Adds an object to the end of the List T .
(Inherited from List ISparklines .)
Public method AddRange
Adds the elements of the specified collection to the end of the List T .
(Inherited from List ISparklines .)
Public method AsReadOnly
Returns a read-only ReadOnlyCollection T wrapper for the current collection.
(Inherited from List ISparklines .)
Public method BinarySearch(T)
Searches the entire sorted List T for an element using the default comparer and returns the zero-based index of the element.
(Inherited from List ISparklines .)
Public method BinarySearch(T, IComparer T )
Searches the entire sorted List T for an element using the specified comparer and returns the zero-based index of the element.
(Inherited from List ISparklines .)
Public method BinarySearch(Int32, Int32, T, IComparer T )
Searches a range of elements in the sorted List T for an element using the specified comparer and returns the zero-based index of the element.
(Inherited from List ISparklines .)
Public method Clear
Removes all elements from the List T .
(Inherited from List ISparklines .)
Public method Contains
Determines whether an element is in the List T .
(Inherited from List ISparklines .)
Public method ConvertAll TOutput
Converts the elements in the current List T to another type, and returns a list containing the converted elements.
(Inherited from List ISparklines .)
Public method CopyTo( T )
Copies the entire List T to a compatible one-dimensional array, starting at the beginning of the target array.
(Inherited from List ISparklines .)
Public method CopyTo( T , Int32)
Copies the entire List T to a compatible one-dimensional array, starting at the specified index of the target array.
(Inherited from List ISparklines .)
Public method CopyTo(Int32, T , Int32, Int32)
Copies a range of elements from the List T to a compatible one-dimensional array, starting at the specified index of the target array.
(Inherited from List ISparklines .)
Public method Equals
Determines whether the specified object is equal to the current object.
(Inherited from Object .)
Public method Exists
Determines whether the List T contains elements that match the conditions defined by the specified predicate.
(Inherited from List ISparklines .)
Protected method Finalize
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object .)
Public method Find
Searches for an element that matches the conditions defined by the specified predicate, and returns the first occurrence within the entire List T .
(Inherited from List ISparklines .)
Public method FindAll
Retrieves all the elements that match the conditions defined by the specified predicate.
(Inherited from List ISparklines .)
Public method FindIndex(Predicate T )
Searches for an element that matches the conditions defined by the specified predicate, and returns the zero-based index of the first occurrence within the entire List T .
(Inherited from List ISparklines .)
Public method FindIndex(Int32, Predicate T )
Searches for an element that matches the conditions defined by the specified predicate, and returns the zero-based index of the first occurrence within the range of elements in the List T that extends from the specified index to the last element.
(Inherited from List ISparklines .)
Public method FindIndex(Int32, Int32, Predicate T )
Searches for an element that matches the conditions defined by the specified predicate, and returns the zero-based index of the first occurrence within the range of elements in the List T that starts at the specified index and contains the specified number of elements.
(Inherited from List ISparklines .)
Public method FindLast
Searches for an element that matches the conditions defined by the specified predicate, and returns the last occurrence within the entire List T .
(Inherited from List ISparklines .)
Public method FindLastIndex(Predicate T )
Searches for an element that matches the conditions defined by the specified predicate, and returns the zero-based index of the last occurrence within the entire List T .
(Inherited from List ISparklines .)
Public method FindLastIndex(Int32, Predicate T )
Searches for an element that matches the conditions defined by the specified predicate, and returns the zero-based index of the last occurrence within the range of elements in the List T that extends from the first element to the specified index.
(Inherited from List ISparklines .)
Public method FindLastIndex(Int32, Int32, Predicate T )
Searches for an element that matches the conditions defined by the specified predicate, and returns the zero-based index of the last occurrence within the range of elements in the List T that contains the specified number of elements and ends at the specified index.
(Inherited from List ISparklines .)
Public method ForEach
Performs the specified action on each element of the List T .
(Inherited from List ISparklines .)
Public method GetEnumerator
Returns an enumerator that iterates through the List T .
(Inherited from List ISparklines .)
Public method GetHashCode
Serves as the default hash function.
(Inherited from Object .)
Public method GetRange
Creates a shallow copy of a range of elements in the source List T .
(Inherited from List ISparklines .)
Public method GetType
Gets the Type of the current instance.
(Inherited from Object .)
Public method IndexOf(T)
Searches for the specified object and returns the zero-based index of the first occurrence within the entire List T .
(Inherited from List ISparklines .)
Public method IndexOf(T, Int32)
Searches for the specified object and returns the zero-based index of the first occurrence within the range of elements in the List T that extends from the specified index to the last element.
(Inherited from List ISparklines .)
Public method IndexOf(T, Int32, Int32)
Searches for the specified object and returns the zero-based index of the first occurrence within the range of elements in the List T that starts at the specified index and contains the specified number of elements.
(Inherited from List ISparklines .)
Public method Insert
Inserts an element into the List T at the specified index.
(Inherited from List ISparklines .)
Public method InsertRange
Inserts the elements of a collection into the List T at the specified index.
(Inherited from List ISparklines .)
Public method LastIndexOf(T)
Searches for the specified object and returns the zero-based index of the last occurrence within the entire List T .
(Inherited from List ISparklines .)
Public method LastIndexOf(T, Int32)
Searches for the specified object and returns the zero-based index of the last occurrence within the range of elements in the List T that extends from the first element to the specified index.
(Inherited from List ISparklines .)
Public method LastIndexOf(T, Int32, Int32)
Searches for the specified object and returns the zero-based index of the last occurrence within the range of elements in the List T that contains the specified number of elements and ends at the specified index.
(Inherited from List ISparklines .)
Protected method MemberwiseClone
Creates a shallow copy of the current Object .
(Inherited from Object .)
Public method Remove
Removes the first occurrence of a specific object from the List T .
(Inherited from List ISparklines .)
Public method RemoveAll
Removes all the elements that match the conditions defined by the specified predicate.
(Inherited from List ISparklines .)
Public method RemoveAt
Removes the element at the specified index of the List T .
(Inherited from List ISparklines .)
Public method RemoveRange
Removes a range of elements from the List T .
(Inherited from List ISparklines .)
Public method Reverse
Reverses the order of the elements in the entire List T .
(Inherited from List ISparklines .)
Public method Reverse(Int32, Int32)
Reverses the order of the elements in the specified range.
(Inherited from List ISparklines .)
Public method Sort
Sorts the elements in the entire List T using the default comparer.
(Inherited from List ISparklines .)
Public method Sort(IComparer T )
Sorts the elements in the entire List T using the specified comparer.
(Inherited from List ISparklines .)
Public method Sort(Comparison T )
Sorts the elements in the entire List T using the specified Comparison T .
(Inherited from List ISparklines .)
Public method Sort(Int32, Int32, IComparer T )
Sorts the elements in a range of elements in List T using the specified comparer.
(Inherited from List ISparklines .)
Public method ToArray
Copies the elements of the List T to a new array.
(Inherited from List ISparklines .)
Public method ToString
Returns a string that represents the current object.
(Inherited from Object .)
Public method TrimExcess
Sets the capacity to the actual number of elements in the List T , if that number is less than a threshold value.
(Inherited from List ISparklines .)
Public method TrueForAll
Determines whether every element in the List T matches the conditions defined by the specified predicate.
(Inherited from List ISparklines .)
Top
See Also