com.spire.xls
Class SparklineGroup

java.lang.Object
  java.util.AbstractCollection<E>
      java.util.AbstractList<E>
          java.util.ArrayList<ISparklines>
              com.spire.xls.SparklineGroup

All Implemented Interfaces:

ISparklineGroup, java.lang.Iterable<ISparklines>, java.util.Collection<ISparklines>, java.util.List<ISparklines>

public class SparklineGroup
extends java.util.ArrayList<ISparklines>
implements ISparklineGroup

Represents a sparkline group.The sparkline group object is a member of the sparkline groups collection.The sparkline groups collection contains all the sparkline group objects in a workheet.

See Also:

Serialized Form

Constructor Summary

SparklineGroup(XlsWorksheet sheet)

Method Summary

SparklineCollection	add()
SparklineCollection	get(int index)
SparklineEmptyCells	getEmptyCellsType() Indicates how to display empty cells.
java.awt.Color	getFirstPointColor() Gets the color of the first point of data in the sparkline group.
java.awt.Color	getHighPointColor() Gets the color of the highest points of data in the sparkline group.
java.awt.Color	getHorizontalAxisColor() Gets the color of the horizontal axis in the sparkline group.
CellRange	getHorizontalDateAxisRange() Represents the range that contains the date values for the sparkline data.
java.awt.Color	getLastPointColor() Gets the color of the last point of data in the sparkline group.
double	getLineWeight() Gets the line weight in each line sparkline in the sparkline group, in the unit of points.
java.awt.Color	getLowPointColor() Gets the color of the lowest points of data in the sparkline group.
java.awt.Color	getMarkersColor() Gets the color of points in each line sparkline in the sparkline group.
java.awt.Color	getNegativePointColor() Gets the color of the negative values on the sparkline group.
boolean	getPlotRightToLeft() Indicates whether the plot data is right to left.
boolean	getShowFirstPoint() Indicates whether to highlight the first point of data in the sparkline group.
boolean	getShowHighPoint() Indicates whether to highlight the highest points of data in the sparkline group.
boolean	getShowHorizontalAxis() Indicates whether to show the sparkline horizontal axis.
boolean	getShowLastPoint() Indicates whether to highlight the last point of data in the sparkline group.
boolean	getShowLowPoint() Indicates whether to highlight the lowest points of data in the sparkline group.
boolean	getShowMarkers() Indicates whether to highlight each point in each line sparkline in the sparkline group.
boolean	getShowNegativePoint() Indicates whether to highlight the negative values on the sparkline group with a different color or marker.
java.awt.Color	getSparklineColor() Gets the color of the sparklines in the sparkline group.
SparklineType	getSparklineType() Indicates the sparkline type of the sparkline group.
SpartlineVerticalAxisType	getVerticalAxisMaxType() Represents the vertical axis maximum value type.
double	getVerticalAxisMaxValue() Gets the custom maximum value for the vertical axis.
double	getVerticalAxisMinValue() Gets and sets the custom minimum value for the vertical axis.
SpartlineVerticalAxisType	getVerticalAxisMinValueType() Represents the vertical axis minimum value type.
boolean	isDisplayHidden() Indicates whether to show data in hidden rows and columns.
void	isDisplayHidden(boolean value) Indicates whether to show data in hidden rows and columns.
boolean	isHorizontalDateAxis() Indicates wheter represents the horizontal axis type as dateaxis.
void	isHorizontalDateAxis(boolean value) Indicates wheter represents the horizontal axis type as dateaxis.
void	setEmptyCellsType(SparklineEmptyCells sparklineEmptyCells) Indicates how to display empty cells.
void	setFirstPointColor(com.spire.ms.System.Drawing.Color value) Sets the color of the first point of data in the sparkline group.
void	setHighPointColor(com.spire.ms.System.Drawing.Color value) Sets the color of the highest points of data in the sparkline group.
void	setHorizontalAxisColor(com.spire.ms.System.Drawing.Color value) Sets the color of the horizontal axis in the sparkline group.
void	setHorizontalDateAxisRange(CellRange value) Represents the range that contains the date values for the sparkline data.
void	setLastPointColor(com.spire.ms.System.Drawing.Color value) Sets the color of the last point of data in the sparkline group.
void	setLineWeight(double value) Sets the line weight in each line sparkline in the sparkline group, in the unit of points.
void	setLowPointColor(com.spire.ms.System.Drawing.Color value) Sets the color of the lowest points of data in the sparkline group.
void	setMarkersColor(com.spire.ms.System.Drawing.Color value) Sets the color of points in each line sparkline in the sparkline group.
void	setNegativePointColor(com.spire.ms.System.Drawing.Color value) Sets the color of the negative values on the sparkline group.
void	setPlotRightToLeft(boolean bool) Sets whether the plot data is right to left.
void	setShowFirstPoint(boolean bool) Sets whether to highlight the first point of data in the sparkline group.
void	setShowHighPoint(boolean value) Sets whether to highlight the highest points of data in the sparkline group.
void	setShowHorizontalAxis(boolean value) Sets whether to show the sparkline horizontal axis.
void	setShowLastPoint(boolean value) Sets whether to highlight the last point of data in the sparkline group.
void	setShowLowPoint(boolean value) Sets whether to highlight the lowest points of data in the sparkline group.
void	setShowMarkers(boolean value) Sets whether to highlight each point in each line sparkline in the sparkline group.
void	setShowNegativePoint(boolean value) Sets whether to highlight the negative values on the sparkline group with a different color or marker.
void	setSparklineColor(java.awt.Color color) Sets the color of the sparklines in the sparkline group.
void	setSparklineType(SparklineType value) Sets the sparkline type of the sparkline group.
void	setVerticalAxisMaxType(SpartlineVerticalAxisType value) Sets the vertical axis maximum value type.
void	setVerticalAxisMaxValue(double value) Sets the custom maximum value for the vertical axis.
void	setVerticalAxisMinValue(double value) Sets the custom minimum value for the vertical axis.
void	setVerticalAxisMinValueType(SpartlineVerticalAxisType value) Represents the vertical axis minimum value type.

Constructor Detail

SparklineGroup

public SparklineGroup(XlsWorksheet sheet)

Method Detail

getShowHorizontalAxis

public boolean getShowHorizontalAxis()

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

Specified by:

getShowHorizontalAxis in interface ISparklineGroup

setShowHorizontalAxis

public void setShowHorizontalAxis(boolean value)

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

Specified by:

setShowHorizontalAxis in interface ISparklineGroup

isDisplayHidden

public boolean isDisplayHidden()

Indicates whether to show data in hidden rows and columns.

Specified by:

isDisplayHidden in interface ISparklineGroup

isDisplayHidden

public void isDisplayHidden(boolean value)

Indicates whether to show data in hidden rows and columns.

Specified by:

isDisplayHidden in interface ISparklineGroup

getPlotRightToLeft

public boolean getPlotRightToLeft()

Indicates whether the plot data is right to left.

Specified by:

getPlotRightToLeft in interface ISparklineGroup

Returns:

True if [plot right to left]; otherwise, false.

setPlotRightToLeft

public void setPlotRightToLeft(boolean bool)

Sets whether the plot data is right to left.

Specified by:

setPlotRightToLeft in interface ISparklineGroup

Parameters:

bool - True if [plot right to left]; otherwise, false.

getShowFirstPoint

public boolean getShowFirstPoint()

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

Specified by:

getShowFirstPoint in interface ISparklineGroup

setShowFirstPoint

public void setShowFirstPoint(boolean bool)

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

Specified by:

setShowFirstPoint in interface ISparklineGroup

getShowLastPoint

public boolean getShowLastPoint()

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

Specified by:

getShowLastPoint in interface ISparklineGroup

setShowLastPoint

public void setShowLastPoint(boolean value)

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

Specified by:

setShowLastPoint in interface ISparklineGroup

getShowLowPoint

public boolean getShowLowPoint()

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

Specified by:

getShowLowPoint in interface ISparklineGroup

setShowLowPoint

public void setShowLowPoint(boolean value)

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

Specified by:

setShowLowPoint in interface ISparklineGroup

getShowHighPoint

public boolean getShowHighPoint()

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

Specified by:

getShowHighPoint in interface ISparklineGroup

setShowHighPoint

public void setShowHighPoint(boolean value)

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

Specified by:

setShowHighPoint in interface ISparklineGroup

getShowNegativePoint

public boolean getShowNegativePoint()

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

Specified by:

getShowNegativePoint in interface ISparklineGroup

setShowNegativePoint

public void setShowNegativePoint(boolean value)

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

Specified by:

setShowNegativePoint in interface ISparklineGroup

getShowMarkers

public boolean getShowMarkers()

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

Specified by:

getShowMarkers in interface ISparklineGroup

setShowMarkers

public void setShowMarkers(boolean value)

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

Specified by:

setShowMarkers in interface ISparklineGroup

getVerticalAxisMaxValue

public double getVerticalAxisMaxValue()

Gets the custom maximum value for the vertical axis.

setVerticalAxisMaxValue

public void setVerticalAxisMaxValue(double value)

Sets the custom maximum value for the vertical axis.

getVerticalAxisMaxType

public SpartlineVerticalAxisType getVerticalAxisMaxType()

Represents the vertical axis maximum value type.

setVerticalAxisMaxType

public void setVerticalAxisMaxType(SpartlineVerticalAxisType value)

Sets the vertical axis maximum value type.

getVerticalAxisMinValue

public double getVerticalAxisMinValue()

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

setVerticalAxisMinValue

public void setVerticalAxisMinValue(double value)

Sets the custom minimum value for the vertical axis.

getVerticalAxisMinValueType

public SpartlineVerticalAxisType getVerticalAxisMinValueType()

Represents the vertical axis minimum value type.

setVerticalAxisMinValueType

public void setVerticalAxisMinValueType(SpartlineVerticalAxisType value)

Represents the vertical axis minimum value type.

getSparklineType

public SparklineType getSparklineType()

Indicates the sparkline type of the sparkline group.

Specified by:

getSparklineType in interface ISparklineGroup

setSparklineType

public void setSparklineType(SparklineType value)

Sets the sparkline type of the sparkline group.

Specified by:

setSparklineType in interface ISparklineGroup

isHorizontalDateAxis

public boolean isHorizontalDateAxis()

Indicates wheter represents the horizontal axis type as dateaxis.

Specified by:

isHorizontalDateAxis in interface ISparklineGroup

isHorizontalDateAxis

public void isHorizontalDateAxis(boolean value)

Indicates wheter represents the horizontal axis type as dateaxis.

Specified by:

isHorizontalDateAxis in interface ISparklineGroup

getEmptyCellsType

public SparklineEmptyCells getEmptyCellsType()

Indicates how to display empty cells.

Specified by:

getEmptyCellsType in interface ISparklineGroup

setEmptyCellsType

public void setEmptyCellsType(SparklineEmptyCells sparklineEmptyCells)

Indicates how to display empty cells.

Specified by:

setEmptyCellsType in interface ISparklineGroup

getHorizontalDateAxisRange

public CellRange getHorizontalDateAxisRange()

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

Specified by:

getHorizontalDateAxisRange in interface ISparklineGroup

setHorizontalDateAxisRange

public void setHorizontalDateAxisRange(CellRange value)

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

Specified by:

setHorizontalDateAxisRange in interface ISparklineGroup

getHorizontalAxisColor

public java.awt.Color getHorizontalAxisColor()

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

Specified by:

getHorizontalAxisColor in interface ISparklineGroup

setHorizontalAxisColor

public void setHorizontalAxisColor(com.spire.ms.System.Drawing.Color value)

Sets the color of the horizontal axis in the sparkline group.

Specified by:

setHorizontalAxisColor in interface ISparklineGroup

getFirstPointColor

public java.awt.Color getFirstPointColor()

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

Specified by:

getFirstPointColor in interface ISparklineGroup

setFirstPointColor

public void setFirstPointColor(com.spire.ms.System.Drawing.Color value)

Sets the color of the first point of data in the sparkline group.

Specified by:

setFirstPointColor in interface ISparklineGroup

getHighPointColor

public java.awt.Color getHighPointColor()

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

Specified by:

getHighPointColor in interface ISparklineGroup

setHighPointColor

public void setHighPointColor(com.spire.ms.System.Drawing.Color value)

Sets the color of the highest points of data in the sparkline group.

Specified by:

setHighPointColor in interface ISparklineGroup

getLastPointColor

public java.awt.Color getLastPointColor()

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

Specified by:

getLastPointColor in interface ISparklineGroup

setLastPointColor

public void setLastPointColor(com.spire.ms.System.Drawing.Color value)

Sets the color of the last point of data in the sparkline group.

Specified by:

setLastPointColor in interface ISparklineGroup

getLineWeight

public double getLineWeight()

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

Specified by:

getLineWeight in interface ISparklineGroup

setLineWeight

public void setLineWeight(double value)

Sets the line weight in each line sparkline in the sparkline group, in the unit of points.

Specified by:

setLineWeight in interface ISparklineGroup

getLowPointColor

public java.awt.Color getLowPointColor()

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

Specified by:

getLowPointColor in interface ISparklineGroup

setLowPointColor

public void setLowPointColor(com.spire.ms.System.Drawing.Color value)

Sets the color of the lowest points of data in the sparkline group.

Specified by:

setLowPointColor in interface ISparklineGroup

getMarkersColor

public java.awt.Color getMarkersColor()

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

Specified by:

getMarkersColor in interface ISparklineGroup

setMarkersColor

public void setMarkersColor(com.spire.ms.System.Drawing.Color value)

Sets the color of points in each line sparkline in the sparkline group.

Specified by:

setMarkersColor in interface ISparklineGroup

getNegativePointColor

public java.awt.Color getNegativePointColor()

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

Specified by:

getNegativePointColor in interface ISparklineGroup

setNegativePointColor

public void setNegativePointColor(com.spire.ms.System.Drawing.Color value)

Sets the color of the negative values on the sparkline group.

Specified by:

setNegativePointColor in interface ISparklineGroup

getSparklineColor

public java.awt.Color getSparklineColor()

Gets the color of the sparklines in the sparkline group.

Specified by:

getSparklineColor in interface ISparklineGroup

setSparklineColor

public void setSparklineColor(java.awt.Color color)

Sets the color of the sparklines in the sparkline group.

Specified by:

setSparklineColor in interface ISparklineGroup

add

public SparklineCollection add()

Specified by:

add in interface ISparklineGroup

get

public SparklineCollection get(int index)

Overrides:

get in class java.util.ArrayList<ISparklines>