SparklineGroup

SparklineGroup class

Sparkline is organized into sparkline group. A SparklineGroup contains a variable number of sparkline items. A sparkline group specifies the type, display settings and axis settings for the sparklines.

class SparklineGroup;

Properties

Property	Type	Description
presetStyle	SparklinePresetStyleType	Gets and sets the preset style type of the sparkline group.
sparklines	SparklineCollection	Readonly. Gets the collection of Sparkline object.
type	SparklineType	Indicates the sparkline type of the sparkline group.
plotEmptyCellsType	PlotEmptyCellsType	Indicates how to plot empty cells.
displayHidden	boolean	Indicates whether to show data in hidden rows and columns.
showHighPoint	boolean	Indicates whether to highlight the highest points of data in the sparkline group.
highPointColor	CellsColor	Gets and sets the color of the highest points of data in the sparkline group.
showLowPoint	boolean	Indicates whether to highlight the lowest points of data in the sparkline group.
lowPointColor	CellsColor	Gets and sets the color of the lowest points of data in the sparkline group.
showNegativePoints	boolean	Indicates whether to highlight the negative values on the sparkline group with a different color or marker.
negativePointsColor	CellsColor	Gets and sets the color of the negative values on the sparkline group.
showFirstPoint	boolean	Indicates whether to highlight the first point of data in the sparkline group.
firstPointColor	CellsColor	Gets and sets the color of the first point of data in the sparkline group.
showLastPoint	boolean	Indicates whether to highlight the last point of data in the sparkline group.
lastPointColor	CellsColor	Gets and sets the color of the last point of data in the sparkline group.
showMarkers	boolean	Indicates whether to highlight each point in each line sparkline in the sparkline group.
markersColor	CellsColor	Gets and sets the color of points in each line sparkline in the sparkline group.
seriesColor	CellsColor	Gets and sets the color of the sparklines in the sparkline group.
plotRightToLeft	boolean	Indicates whether the plot data is right to left.
lineWeight	number	Gets and sets the line weight in each line sparkline in the sparkline group, in the unit of points.
horizontalAxisColor	CellsColor	Gets and sets the color of the horizontal axis in the sparkline group.
showHorizontalAxis	boolean	Indicates whether to show the sparkline horizontal axis. The horizontal axis appears if the sparkline has data that crosses the zero axis.
horizontalAxisDateRange	string	Represents the range that contains the date values for the sparkline data.
verticalAxisMaxValueType	SparklineAxisMinMaxType	Represents the vertical axis maximum value type.
verticalAxisMaxValue	number	Gets and sets the custom maximum value for the vertical axis.
verticalAxisMinValueType	SparklineAxisMinMaxType	Represents the vertical axis minimum value type.
verticalAxisMinValue	number	Gets and sets the custom minimum value for the vertical axis.

Methods

Method	Description
resetRanges(string, boolean, CellArea)	Resets the data range and location range of the sparkline group. This method will clear original sparkline items in the group and creates new sparkline items for the new ranges.

presetStyle

Gets and sets the preset style type of the sparkline group.

presetStyle : SparklinePresetStyleType;

sparklines

Readonly. Gets the collection of Sparkline object.

sparklines : SparklineCollection;

type

Indicates the sparkline type of the sparkline group.

type : SparklineType;

plotEmptyCellsType

Indicates how to plot empty cells.

plotEmptyCellsType : PlotEmptyCellsType;

displayHidden

Indicates whether to show data in hidden rows and columns.

displayHidden : boolean;

showHighPoint

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

showHighPoint : boolean;

highPointColor

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

highPointColor : CellsColor;

showLowPoint

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

showLowPoint : boolean;

lowPointColor

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

lowPointColor : CellsColor;

showNegativePoints

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

showNegativePoints : boolean;

negativePointsColor

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

negativePointsColor : CellsColor;

showFirstPoint

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

showFirstPoint : boolean;

firstPointColor

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

firstPointColor : CellsColor;

showLastPoint

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

showLastPoint : boolean;

lastPointColor

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

lastPointColor : CellsColor;

showMarkers

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

showMarkers : boolean;

markersColor

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

markersColor : CellsColor;

seriesColor

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

seriesColor : CellsColor;

plotRightToLeft

Indicates whether the plot data is right to left.

plotRightToLeft : boolean;

lineWeight

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

lineWeight : number;

horizontalAxisColor

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

horizontalAxisColor : CellsColor;

showHorizontalAxis

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

showHorizontalAxis : boolean;

horizontalAxisDateRange

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

horizontalAxisDateRange : string;

verticalAxisMaxValueType

Represents the vertical axis maximum value type.

verticalAxisMaxValueType : SparklineAxisMinMaxType;

verticalAxisMaxValue

Gets and sets the custom maximum value for the vertical axis.

verticalAxisMaxValue : number;

verticalAxisMinValueType

Represents the vertical axis minimum value type.

verticalAxisMinValueType : SparklineAxisMinMaxType;

verticalAxisMinValue

Gets and sets the custom minimum value for the vertical axis.

verticalAxisMinValue : number;

resetRanges(string, boolean, CellArea)

Resets the data range and location range of the sparkline group. This method will clear original sparkline items in the group and creates new sparkline items for the new ranges.

resetRanges(dataRange: string, isVertical: boolean, locationRange: CellArea) : void;

Parameters:

Parameter	Type	Description
dataRange	string	Specifies the new data range of the sparkline group.
isVertical	boolean	Specifies whether to plot the sparklines from the new data range by row or by column.
locationRange	CellArea	Specifies where the sparklines to be placed.