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;

Methods

Method	Description
getPresetStyle()	Gets and sets the preset style type of the sparkline group.
setPresetStyle(SparklinePresetStyleType)	Gets and sets the preset style type of the sparkline group.
getSparklines()	Gets the collection of Sparkline object.
getType()	Indicates the sparkline type of the sparkline group.
setType(SparklineType)	Indicates the sparkline type of the sparkline group.
getPlotEmptyCellsType()	Indicates how to plot empty cells.
setPlotEmptyCellsType(PlotEmptyCellsType)	Indicates how to plot empty cells.
getDisplayHidden()	Indicates whether to show data in hidden rows and columns.
setDisplayHidden(boolean)	Indicates whether to show data in hidden rows and columns.
getShowHighPoint()	Indicates whether to highlight the highest points of data in the sparkline group.
setShowHighPoint(boolean)	Indicates whether to highlight the highest points of data in the sparkline group.
getHighPointColor()	Gets and sets the color of the highest points of data in the sparkline group.
setHighPointColor(CellsColor)	Gets and sets the color of the highest points of data in the sparkline group.
getShowLowPoint()	Indicates whether to highlight the lowest points of data in the sparkline group.
setShowLowPoint(boolean)	Indicates whether to highlight the lowest points of data in the sparkline group.
getLowPointColor()	Gets and sets the color of the lowest points of data in the sparkline group.
setLowPointColor(CellsColor)	Gets and sets the color of the lowest points of data in the sparkline group.
getShowNegativePoints()	Indicates whether to highlight the negative values on the sparkline group with a different color or marker.
setShowNegativePoints(boolean)	Indicates whether to highlight the negative values on the sparkline group with a different color or marker.
getNegativePointsColor()	Gets and sets the color of the negative values on the sparkline group.
setNegativePointsColor(CellsColor)	Gets and sets the color of the negative values on the sparkline group.
getShowFirstPoint()	Indicates whether to highlight the first point of data in the sparkline group.
setShowFirstPoint(boolean)	Indicates whether to highlight the first point of data in the sparkline group.
getFirstPointColor()	Gets and sets the color of the first point of data in the sparkline group.
setFirstPointColor(CellsColor)	Gets and sets the color of the first point of data in the sparkline group.
getShowLastPoint()	Indicates whether to highlight the last point of data in the sparkline group.
setShowLastPoint(boolean)	Indicates whether to highlight the last point of data in the sparkline group.
getLastPointColor()	Gets and sets the color of the last point of data in the sparkline group.
setLastPointColor(CellsColor)	Gets and sets the color of the last point of data in the sparkline group.
getShowMarkers()	Indicates whether to highlight each point in each line sparkline in the sparkline group.
setShowMarkers(boolean)	Indicates whether to highlight each point in each line sparkline in the sparkline group.
getMarkersColor()	Gets and sets the color of points in each line sparkline in the sparkline group.
setMarkersColor(CellsColor)	Gets and sets the color of points in each line sparkline in the sparkline group.
getSeriesColor()	Gets and sets the color of the sparklines in the sparkline group.
setSeriesColor(CellsColor)	Gets and sets the color of the sparklines in the sparkline group.
getPlotRightToLeft()	Indicates whether the plot data is right to left.
setPlotRightToLeft(boolean)	Indicates whether the plot data is right to left.
getLineWeight()	Gets and sets the line weight in each line sparkline in the sparkline group, in the unit of points.
setLineWeight(number)	Gets and sets the line weight in each line sparkline in the sparkline group, in the unit of points.
getHorizontalAxisColor()	Gets and sets the color of the horizontal axis in the sparkline group.
setHorizontalAxisColor(CellsColor)	Gets and sets the color of the horizontal axis in the sparkline group.
getShowHorizontalAxis()	Indicates whether to show the sparkline horizontal axis. The horizontal axis appears if the sparkline has data that crosses the zero axis.
setShowHorizontalAxis(boolean)	Indicates whether to show the sparkline horizontal axis. The horizontal axis appears if the sparkline has data that crosses the zero axis.
getHorizontalAxisDateRange()	Represents the range that contains the date values for the sparkline data.
setHorizontalAxisDateRange(string)	Represents the range that contains the date values for the sparkline data.
getVerticalAxisMaxValueType()	Represents the vertical axis maximum value type.
setVerticalAxisMaxValueType(SparklineAxisMinMaxType)	Represents the vertical axis maximum value type.
getVerticalAxisMaxValue()	Gets and sets the custom maximum value for the vertical axis.
setVerticalAxisMaxValue(number)	Gets and sets the custom maximum value for the vertical axis.
getVerticalAxisMinValueType()	Represents the vertical axis minimum value type.
setVerticalAxisMinValueType(SparklineAxisMinMaxType)	Represents the vertical axis minimum value type.
getVerticalAxisMinValue()	Gets and sets the custom minimum value for the vertical axis.
setVerticalAxisMinValue(number)	Gets and sets the custom minimum value for the vertical axis.
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.

getPresetStyle()

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

getPresetStyle() : SparklinePresetStyleType;

Returns

SparklinePresetStyleType

setPresetStyle(SparklinePresetStyleType)

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

setPresetStyle(value: SparklinePresetStyleType) : void;

Parameters:

Parameter	Type	Description
value	SparklinePresetStyleType	The value to set.

getSparklines()

Gets the collection of Sparkline object.

getSparklines() : SparklineCollection;

Returns

SparklineCollection

getType()

Indicates the sparkline type of the sparkline group.

getType() : SparklineType;

Returns

SparklineType

setType(SparklineType)

Indicates the sparkline type of the sparkline group.

setType(value: SparklineType) : void;

Parameters:

Parameter	Type	Description
value	SparklineType	The value to set.

getPlotEmptyCellsType()

Indicates how to plot empty cells.

getPlotEmptyCellsType() : PlotEmptyCellsType;

Returns

PlotEmptyCellsType

setPlotEmptyCellsType(PlotEmptyCellsType)

Indicates how to plot empty cells.

setPlotEmptyCellsType(value: PlotEmptyCellsType) : void;

Parameters:

Parameter	Type	Description
value	PlotEmptyCellsType	The value to set.

getDisplayHidden()

Indicates whether to show data in hidden rows and columns.

getDisplayHidden() : boolean;

setDisplayHidden(boolean)

Indicates whether to show data in hidden rows and columns.

setDisplayHidden(value: boolean) : void;

Parameters:

Parameter	Type	Description
value	boolean	The value to set.

getShowHighPoint()

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

getShowHighPoint() : boolean;

setShowHighPoint(boolean)

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

setShowHighPoint(value: boolean) : void;

Parameters:

Parameter	Type	Description
value	boolean	The value to set.

getHighPointColor()

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

getHighPointColor() : CellsColor;

Returns

CellsColor

setHighPointColor(CellsColor)

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

setHighPointColor(value: CellsColor) : void;

Parameters:

Parameter	Type	Description
value	CellsColor	The value to set.

getShowLowPoint()

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

getShowLowPoint() : boolean;

setShowLowPoint(boolean)

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

setShowLowPoint(value: boolean) : void;

Parameters:

Parameter	Type	Description
value	boolean	The value to set.

getLowPointColor()

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

getLowPointColor() : CellsColor;

Returns

CellsColor

setLowPointColor(CellsColor)

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

setLowPointColor(value: CellsColor) : void;

Parameters:

Parameter	Type	Description
value	CellsColor	The value to set.

getShowNegativePoints()

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

getShowNegativePoints() : boolean;

setShowNegativePoints(boolean)

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

setShowNegativePoints(value: boolean) : void;

Parameters:

Parameter	Type	Description
value	boolean	The value to set.

getNegativePointsColor()

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

getNegativePointsColor() : CellsColor;

Returns

CellsColor

setNegativePointsColor(CellsColor)

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

setNegativePointsColor(value: CellsColor) : void;

Parameters:

Parameter	Type	Description
value	CellsColor	The value to set.

getShowFirstPoint()

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

getShowFirstPoint() : boolean;

setShowFirstPoint(boolean)

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

setShowFirstPoint(value: boolean) : void;

Parameters:

Parameter	Type	Description
value	boolean	The value to set.

getFirstPointColor()

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

getFirstPointColor() : CellsColor;

Returns

CellsColor

setFirstPointColor(CellsColor)

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

setFirstPointColor(value: CellsColor) : void;

Parameters:

Parameter	Type	Description
value	CellsColor	The value to set.

getShowLastPoint()

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

getShowLastPoint() : boolean;

setShowLastPoint(boolean)

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

setShowLastPoint(value: boolean) : void;

Parameters:

Parameter	Type	Description
value	boolean	The value to set.

getLastPointColor()

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

getLastPointColor() : CellsColor;

Returns

CellsColor

setLastPointColor(CellsColor)

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

setLastPointColor(value: CellsColor) : void;

Parameters:

Parameter	Type	Description
value	CellsColor	The value to set.

getShowMarkers()

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

getShowMarkers() : boolean;

setShowMarkers(boolean)

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

setShowMarkers(value: boolean) : void;

Parameters:

Parameter	Type	Description
value	boolean	The value to set.

getMarkersColor()

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

getMarkersColor() : CellsColor;

Returns

CellsColor

setMarkersColor(CellsColor)

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

setMarkersColor(value: CellsColor) : void;

Parameters:

Parameter	Type	Description
value	CellsColor	The value to set.

getSeriesColor()

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

getSeriesColor() : CellsColor;

Returns

CellsColor

setSeriesColor(CellsColor)

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

setSeriesColor(value: CellsColor) : void;

Parameters:

Parameter	Type	Description
value	CellsColor	The value to set.

getPlotRightToLeft()

Indicates whether the plot data is right to left.

getPlotRightToLeft() : boolean;

setPlotRightToLeft(boolean)

Indicates whether the plot data is right to left.

setPlotRightToLeft(value: boolean) : void;

Parameters:

Parameter	Type	Description
value	boolean	The value to set.

getLineWeight()

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

getLineWeight() : number;

setLineWeight(number)

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

setLineWeight(value: number) : void;

Parameters:

Parameter	Type	Description
value	number	The value to set.

getHorizontalAxisColor()

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

getHorizontalAxisColor() : CellsColor;

Returns

CellsColor

setHorizontalAxisColor(CellsColor)

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

setHorizontalAxisColor(value: CellsColor) : void;

Parameters:

Parameter	Type	Description
value	CellsColor	The value to set.

getShowHorizontalAxis()

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

getShowHorizontalAxis() : boolean;

setShowHorizontalAxis(boolean)

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

setShowHorizontalAxis(value: boolean) : void;

Parameters:

Parameter	Type	Description
value	boolean	The value to set.

getHorizontalAxisDateRange()

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

getHorizontalAxisDateRange() : string;

setHorizontalAxisDateRange(string)

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

setHorizontalAxisDateRange(value: string) : void;

Parameters:

Parameter	Type	Description
value	string	The value to set.

getVerticalAxisMaxValueType()

Represents the vertical axis maximum value type.

getVerticalAxisMaxValueType() : SparklineAxisMinMaxType;

Returns

SparklineAxisMinMaxType

setVerticalAxisMaxValueType(SparklineAxisMinMaxType)

Represents the vertical axis maximum value type.

setVerticalAxisMaxValueType(value: SparklineAxisMinMaxType) : void;

Parameters:

Parameter	Type	Description
value	SparklineAxisMinMaxType	The value to set.

getVerticalAxisMaxValue()

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

getVerticalAxisMaxValue() : number;

setVerticalAxisMaxValue(number)

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

setVerticalAxisMaxValue(value: number) : void;

Parameters:

Parameter	Type	Description
value	number	The value to set.

getVerticalAxisMinValueType()

Represents the vertical axis minimum value type.

getVerticalAxisMinValueType() : SparklineAxisMinMaxType;

Returns

SparklineAxisMinMaxType

setVerticalAxisMinValueType(SparklineAxisMinMaxType)

Represents the vertical axis minimum value type.

setVerticalAxisMinValueType(value: SparklineAxisMinMaxType) : void;

Parameters:

Parameter	Type	Description
value	SparklineAxisMinMaxType	The value to set.

getVerticalAxisMinValue()

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

getVerticalAxisMinValue() : number;

setVerticalAxisMinValue(number)

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

setVerticalAxisMinValue(value: number) : void;

Parameters:

Parameter	Type	Description
value	number	The value to set.

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.