GrapeCity.Documents.Excel.ICascadeSparkLine

ICascadeSparkLine Interface

Represents a cascade sparkLine.

A cascade sparkline exposes the data and display settings resolved from a CASCADESPARKLINE formula, including point values, labels, point index, bounds, item types, and colors.

Namespace: GrapeCity.Documents.Excel

Assembly: DS.Documents.Excel.dll

Syntax

public interface ICascadeSparkLine

Public Interface ICascadeSparkLine

Examples

worksheet.Range["A2:B4"].Value = new object[,] {
    {"Salary", 3500},
    {"Bonus", 1200},
    {"Expense", -800}
};
worksheet.Range["C2"].Formula = "=CASCADESPARKLINE(B2:B4,1,A2:A4,,,\"#8CBF64\",\"#D6604D\",FALSE)";
ICascadeSparkLine sparkLine = (ICascadeSparkLine) worksheet.Range["C2"].Value;
double[] points = sparkLine.Points;

Properties

Name	Description
ColorNegative	Returns the color of the first or last negative sparkline box. This color is used for a box whose point value is negative. The default value is `"#D6604D"`.
ColorPositive	Returns the color of the first or last positive sparkline box. This color is used for a box whose point value is positive. The default value is `"#8CBF64"`.
ColorTotal	Returns the color of the total sparkline box. This color represents the color of the last sparkline box when itemTypeRange does not exist, or the color of the resulting sparkline box when itemTypeRange exists. The default value is `null`.
ItemTypes	Returns all item types. The returned item types identify the marker used for each item in the cascade sparkline. The values should be `"-"`, `"+"`, or `"="`. The default value is `null`.
Labels	Returns the labels of the cascade sparkline. The returned array contains the labels associated with the sparkline points. The default value is `null`.
Maximum	Gets the maximum value of the display area. This value defines the upper bound used to display the cascade sparkline. The default value is `null`.
Minimum	Gets the minimum value of the display area. This value defines the lower bound used to display the cascade sparkline. The default value is `null`.
PointIndex	Returns the point index of the cascade sparkline. Represents the points index. The point index is greater than or equal to `1`.
Points	Returns the values of the points. The returned array contains the numeric values represented by the points in the cascade sparkline.
Vertical	Returns whether the cascade sparkline's box direction is vertical or horizontal. A value of `true` indicates that the boxes are displayed vertically, and `false` indicates that they are displayed horizontally. The default value is `false`.