Home  Products  Purchase  Downloads  Demos  Forums  Blogs  Ticket  Wiki  API  Corporate


com.aspose.cells
Class SparklineGroup

java.lang.Object
  extended by com.aspose.cells.SparklineGroup

public class SparklineGroup
extends java.lang.Object

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.


Method Summary
 Color getFirstPointColor()
          Gets the color of the first point of data in the sparkline group.
 Color getHighPointColor()
          Gets the color of the highest points of data in the sparkline group.
 Color getHorizontalAxisColor()
          Gets the color of the horizontal axis in the sparkline group.
 java.lang.String getHorizontalAxisDateRange()
          Gets the range that contains the date values for the sparkline data.
 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.
 Color getLowPointColor()
          Gets the color of the lowest points of data in the sparkline group.
 Color getMarkersColor()
          Gets the color of points in each line sparkline in the sparkline group.
 Color getNegativePointsColor()
          Gets the color of the negative values on the sparkline group.
 int getPlotEmptyCellsType()
          Gets the type to plot empty cells.
 int getPresetStyle()
          Gets the preset style type of the sparkline group.
 Color getSeriesColor()
          Gets the color of the sparklines in the sparkline group.
 SparklineCollection getSparklineCollection()
          Gets the SparklineCollection object of the sparkline group.
 int getType()
          Gets the sparkline type of the sparkline group.
 double getVerticalAxisMaxValue()
          Gets the custom maximum value for the vertical axis.
 int getVerticalAxisMaxValueType()
          Gets the vertical axis maximum value type.
 double getVerticalAxisMinValue()
          Gets the custom minimum value for the vertical axis.
 int getVerticalAxisMinValueType()
          Gets the vertical axis minimum value type.
 boolean isDisplayHidden()
          Gets whether to show data in hidden rows and columns.
 boolean isPlotRightToLeft()
          Gets whether the plot data is right to left.
 boolean isShowFirstPoint()
          Gets whether to highlight the first point of data in the sparkline group.
 boolean isShowHighPoint()
          Gets whether to highlight the highest points of data in the sparkline group.
 boolean isShowHorizontalAxis()
          Gets whether to show the sparkline horizontal axis.
 boolean isShowLastPoint()
          Gets whether to highlight the last point of data in the sparkline group.
 boolean isShowLowPoint()
          Gets whether to highlight the lowest points of data in the sparkline group.
 boolean isShowMarkers()
          Gets whether to highlight each point in each line sparkline in the sparkline group.
 boolean isShowNegativePoints()
          Gets whether to highlight the negative values on the sparkline group with a different color or marker.
 void resetRanges(java.lang.String dataRange, boolean isVertical, CellArea locationRange)
          Resets the data range and location range of the sparkline group.
 void setDisplayHidden(boolean b)
          Sets whether to show data in hidden rows and columns.
 void setFirstPointColor(Color color)
          Sets the color of the first point of data in the sparkline group.
 void setHighPointColor(Color color)
          Sets the color of the highest points of data in the sparkline group.
 void setHorizontalAxisColor(Color color)
          Sets the color of the horizontal axis in the sparkline group.
 void setHorizontalAxisDateRange(java.lang.String referTo)
          Sets the range that contains the date values for the sparkline data.
 void setLastPointColor(Color color)
          Sets the color of the last point of data in the sparkline group.
 void setLineWeight(double weight)
          Sets the line weight in each line sparkline in the sparkline group, in the unit of points.
 void setLowPointColor(Color color)
          Sets the color of the lowest points of data in the sparkline group.
 void setMarkersColor(Color color)
          Sets the color of points in each line sparkline in the sparkline group.
 void setNegativePointsColor(Color color)
          Sets the color of the negative values on the sparkline group.
 void setPlotEmptyCellsType(int plotEmptyCellsType)
          Sets the type to plot empty cells.
 void setPlotRightToLeft(boolean b)
          Sets whether the plot data is right to left.
 void setPresetStyle(int sparklinePresetStyleType)
          Sets the preset style type of the sparkline group.
 void setSeriesColor(Color color)
          Sets the color of the sparklines in the sparkline group.
 void setShowFirstPoint(boolean b)
          Sets whether to highlight the first point of data in the sparkline group.
 void setShowHighPoint(boolean b)
          Sets whether to highlight the highest points of data in the sparkline group.
 void setShowHorizontalAxis(boolean b)
          Sets whether to show the sparkline horizontal axis.
 void setShowLastPoint(boolean b)
          Sets whether to highlight the last point of data in the sparkline group.
 void setShowLowPoint(boolean b)
          Sets whether to highlight the lowest points of data in the sparkline group.
 void setShowMarkers(boolean b)
          Sets whether to highlight each point in each line sparkline in the sparkline group.
 void setShowNegativePoints(boolean b)
          Sets whether to highlight the negative values on the sparkline group with a different color or marker.
 void setType(int type)
          Sets the sparkline type of the sparkline group.
 void setVerticalAxisMaxValue(double value)
          Sets the custom maximum value for the vertical axis.
 void setVerticalAxisMaxValueType(int type)
          Sets the vertical axis maximum value type.
 void setVerticalAxisMinValue(double value)
          Sets the custom minimum value for the vertical axis.
 void setVerticalAxisMinValueType(int type)
          Sets the vertical axis minimum value type.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Method Detail

resetRanges

public void resetRanges(java.lang.String dataRange,
                        boolean isVertical,
                        CellArea locationRange)
                 throws java.lang.IllegalArgumentException
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.

Parameters:
dataRange - specifies the new data range of the sparkline group.
isVertical - specifies whether to plot the sparklines from the new data range by row or by column.
locationRange - specifies where the sparklines to be placed.
Throws:
java.lang.IllegalArgumentException

getPresetStyle

public int getPresetStyle()
Gets the preset style type of the sparkline group.

See Also:
SparklinePresetStyleType

setPresetStyle

public void setPresetStyle(int sparklinePresetStyleType)
Sets the preset style type of the sparkline group.

Parameters:
sparklinePresetStyleType -
See Also:
SparklinePresetStyleType

getSparklineCollection

public SparklineCollection getSparklineCollection()
Gets the SparklineCollection object of the sparkline group.


getType

public int getType()
Gets the sparkline type of the sparkline group.

See Also:
SparklineType

setType

public void setType(int type)
Sets the sparkline type of the sparkline group.

Parameters:
type -
See Also:
SparklineType

getPlotEmptyCellsType

public int getPlotEmptyCellsType()
Gets the type to plot empty cells.

See Also:
PlotEmptyCellsType

setPlotEmptyCellsType

public void setPlotEmptyCellsType(int plotEmptyCellsType)
Sets the type to plot empty cells.

See Also:
PlotEmptyCellsType

isDisplayHidden

public boolean isDisplayHidden()
Gets whether to show data in hidden rows and columns.


setDisplayHidden

public void setDisplayHidden(boolean b)
Sets whether to show data in hidden rows and columns.

Parameters:
b -

isShowHighPoint

public boolean isShowHighPoint()
Gets whether to highlight the highest points of data in the sparkline group.


setShowHighPoint

public void setShowHighPoint(boolean b)
Sets whether to highlight the highest points of data in the sparkline group.

Parameters:
b -

getHighPointColor

public Color getHighPointColor()
Gets the color of the highest points of data in the sparkline group.


setHighPointColor

public void setHighPointColor(Color color)
Sets the color of the highest points of data in the sparkline group.

Parameters:
color -

isShowLowPoint

public boolean isShowLowPoint()
Gets whether to highlight the lowest points of data in the sparkline group.


setShowLowPoint

public void setShowLowPoint(boolean b)
Sets whether to highlight the lowest points of data in the sparkline group.

Parameters:
b -

getLowPointColor

public Color getLowPointColor()
Gets the color of the lowest points of data in the sparkline group.


setLowPointColor

public void setLowPointColor(Color color)
Sets the color of the lowest points of data in the sparkline group.

Parameters:
color -

isShowNegativePoints

public boolean isShowNegativePoints()
Gets whether to highlight the negative values on the sparkline group with a different color or marker.


setShowNegativePoints

public void setShowNegativePoints(boolean b)
Sets whether to highlight the negative values on the sparkline group with a different color or marker.

Parameters:
b -

getNegativePointsColor

public Color getNegativePointsColor()
Gets the color of the negative values on the sparkline group.


setNegativePointsColor

public void setNegativePointsColor(Color color)
Sets the color of the negative values on the sparkline group.

Parameters:
color -

isShowFirstPoint

public boolean isShowFirstPoint()
Gets whether to highlight the first point of data in the sparkline group.


setShowFirstPoint

public void setShowFirstPoint(boolean b)
Sets whether to highlight the first point of data in the sparkline group.

Parameters:
b -

getFirstPointColor

public Color getFirstPointColor()
Gets the color of the first point of data in the sparkline group.


setFirstPointColor

public void setFirstPointColor(Color color)
Sets the color of the first point of data in the sparkline group.

Parameters:
color -

isShowLastPoint

public boolean isShowLastPoint()
Gets whether to highlight the last point of data in the sparkline group.


setShowLastPoint

public void setShowLastPoint(boolean b)
Sets whether to highlight the last point of data in the sparkline group.

Parameters:
b -

getLastPointColor

public Color getLastPointColor()
Gets the color of the last point of data in the sparkline group.


setLastPointColor

public void setLastPointColor(Color color)
Sets the color of the last point of data in the sparkline group.

Parameters:
color -

isShowMarkers

public boolean isShowMarkers()
Gets whether to highlight each point in each line sparkline in the sparkline group.


setShowMarkers

public void setShowMarkers(boolean b)
Sets whether to highlight each point in each line sparkline in the sparkline group.

Parameters:
b -

getMarkersColor

public Color getMarkersColor()
Gets the color of points in each line sparkline in the sparkline group.


setMarkersColor

public void setMarkersColor(Color color)
Sets the color of points in each line sparkline in the sparkline group.

Parameters:
color -

getSeriesColor

public Color getSeriesColor()
Gets the color of the sparklines in the sparkline group.


setSeriesColor

public void setSeriesColor(Color color)
Sets the color of the sparklines in the sparkline group.

Parameters:
color -

isPlotRightToLeft

public boolean isPlotRightToLeft()
Gets whether the plot data is right to left.


setPlotRightToLeft

public void setPlotRightToLeft(boolean b)
Sets whether the plot data is right to left.

Parameters:
b -

getLineWeight

public double getLineWeight()
Gets the line weight in each line sparkline in the sparkline group, in the unit of points.


setLineWeight

public void setLineWeight(double weight)
                   throws java.lang.IllegalArgumentException
Sets the line weight in each line sparkline in the sparkline group, in the unit of points.

Parameters:
weight -
Throws:
java.lang.IllegalArgumentException

getHorizontalAxisColor

public Color getHorizontalAxisColor()
Gets the color of the horizontal axis in the sparkline group.


setHorizontalAxisColor

public void setHorizontalAxisColor(Color color)
Sets the color of the horizontal axis in the sparkline group.

Parameters:
color -

isShowHorizontalAxis

public boolean isShowHorizontalAxis()
Gets whether to show the sparkline horizontal axis. The horizontal axis appears if the sparkline has data that crosses the zero axis.


setShowHorizontalAxis

public void setShowHorizontalAxis(boolean b)
Sets whether to show the sparkline horizontal axis. The horizontal axis appears if the sparkline has data that crosses the zero axis.

Parameters:
b -

getHorizontalAxisDateRange

public java.lang.String getHorizontalAxisDateRange()
Gets the range that contains the date values for the sparkline data.


setHorizontalAxisDateRange

public void setHorizontalAxisDateRange(java.lang.String referTo)
Sets the range that contains the date values for the sparkline data.

Parameters:
referTo -

getVerticalAxisMaxValueType

public int getVerticalAxisMaxValueType()
Gets the vertical axis maximum value type.

See Also:
SparklineAxisMinMaxType

setVerticalAxisMaxValueType

public void setVerticalAxisMaxValueType(int type)
Sets the vertical axis maximum value type.

Parameters:
type -
See Also:
SparklineAxisMinMaxType

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.

Parameters:
value -

getVerticalAxisMinValueType

public int getVerticalAxisMinValueType()
Gets the vertical axis minimum value type.

See Also:
SparklineAxisMinMaxType

setVerticalAxisMinValueType

public void setVerticalAxisMinValueType(int type)
Sets the vertical axis minimum value type.

Parameters:
type -
See Also:
SparklineAxisMinMaxType

getVerticalAxisMinValue

public double getVerticalAxisMinValue()
Gets the custom minimum value for the vertical axis.


setVerticalAxisMinValue

public void setVerticalAxisMinValue(double value)
Sets the custom minimum value for the vertical axis.

Parameters:
value -