com.aspose.cells

com.aspose.cells

Class SparklineGroup

  • java.lang.Object
    • 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.

Property Getters/Setters Summary
booleangetDisplayHidden()
void
setDisplayHidden(booleanvalue)
           Indicates whether to show data in hidden rows and columns.
CellsColorgetFirstPointColor()
void
setFirstPointColor(CellsColor value)
           Gets and sets the color of the first point of data in the sparkline group.
CellsColorgetHighPointColor()
void
setHighPointColor(CellsColor value)
           Gets and sets the color of the highest points of data in the sparkline group.
CellsColorgetHorizontalAxisColor()
void
setHorizontalAxisColor(CellsColor value)
           Gets and sets the color of the horizontal axis in the sparkline group.
java.lang.StringgetHorizontalAxisDateRange()
void
setHorizontalAxisDateRange(java.lang.Stringvalue)
           Represents the range that contains the date values for the sparkline data.
CellsColorgetLastPointColor()
void
setLastPointColor(CellsColor value)
           Gets and sets the color of the last point of data in the sparkline group.
doublegetLineWeight()
void
setLineWeight(doublevalue)
           Gets and sets the line weight in each line sparkline in the sparkline group, in the unit of points.
CellsColorgetLowPointColor()
void
setLowPointColor(CellsColor value)
           Gets and sets the color of the lowest points of data in the sparkline group.
CellsColorgetMarkersColor()
void
setMarkersColor(CellsColor value)
           Gets and sets the color of points in each line sparkline in the sparkline group.
CellsColorgetNegativePointsColor()
void
setNegativePointsColor(CellsColor value)
           Gets and sets the color of the negative values on the sparkline group.
intgetPlotEmptyCellsType()
void
setPlotEmptyCellsType(intvalue)
           Indicates how to plot empty cells. The value of the property is PlotEmptyCellsType integer constant.
booleangetPlotRightToLeft()
void
setPlotRightToLeft(booleanvalue)
           Indicates whether the plot data is right to left.
intgetPresetStyle()
void
setPresetStyle(intvalue)
           Gets and sets the preset style type of the sparkline group. The value of the property is SparklinePresetStyleType integer constant.
CellsColorgetSeriesColor()
void
setSeriesColor(CellsColor value)
           Gets and sets the color of the sparklines in the sparkline group.
booleangetShowFirstPoint()
void
setShowFirstPoint(booleanvalue)
           Indicates whether to highlight the first point of data in the sparkline group.
booleangetShowHighPoint()
void
setShowHighPoint(booleanvalue)
           Indicates whether to highlight the highest points of data in the sparkline group.
booleangetShowHorizontalAxis()
void
setShowHorizontalAxis(booleanvalue)
           Indicates whether to show the sparkline horizontal axis. The horizontal axis appears if the sparkline has data that crosses the zero axis.
booleangetShowLastPoint()
void
setShowLastPoint(booleanvalue)
           Indicates whether to highlight the last point of data in the sparkline group.
booleangetShowLowPoint()
void
setShowLowPoint(booleanvalue)
           Indicates whether to highlight the lowest points of data in the sparkline group.
booleangetShowMarkers()
void
setShowMarkers(booleanvalue)
           Indicates whether to highlight each point in each line sparkline in the sparkline group.
booleangetShowNegativePoints()
void
setShowNegativePoints(booleanvalue)
           Indicates whether to highlight the negative values on the sparkline group with a different color or marker.
SparklineCollectiongetSparklineCollection()
Gets the SparklineCollection object of the sparkline group.
intgetType()
void
setType(intvalue)
           Indicates the sparkline type of the sparkline group. The value of the property is SparklineType integer constant.
doublegetVerticalAxisMaxValue()
void
setVerticalAxisMaxValue(doublevalue)
           Gets and sets the custom maximum value for the vertical axis.
intgetVerticalAxisMaxValueType()
void
setVerticalAxisMaxValueType(intvalue)
           Represents the vertical axis maximum value type. The value of the property is SparklineAxisMinMaxType integer constant.
doublegetVerticalAxisMinValue()
void
setVerticalAxisMinValue(doublevalue)
           Gets and sets the custom minimum value for the vertical axis.
intgetVerticalAxisMinValueType()
void
setVerticalAxisMinValueType(intvalue)
           Represents the vertical axis minimum value type. The value of the property is SparklineAxisMinMaxType integer constant.
 
Method Summary
voidresetRanges(java.lang.String dataRange, boolean isVertical, CellArea locationRange)
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.
 

    • Property Getters/Setters Detail

      • getPresetStyle/setPresetStyle

        public int getPresetStyle() / public void setPresetStyle(int value)
        Gets and sets the preset style type of the sparkline group. The value of the property is SparklinePresetStyleType integer constant.

      • getSparklineCollection

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

      • getType/setType

        public int getType() / public void setType(int value)
        Indicates the sparkline type of the sparkline group. The value of the property is SparklineType integer constant.

      • getPlotEmptyCellsType/setPlotEmptyCellsType

        public int getPlotEmptyCellsType() / public void setPlotEmptyCellsType(int value)
        Indicates how to plot empty cells. The value of the property is PlotEmptyCellsType integer constant.

      • getDisplayHidden/setDisplayHidden

        public boolean getDisplayHidden() / public void setDisplayHidden(boolean value)
        Indicates whether to show data in hidden rows and columns.

      • getShowHighPoint/setShowHighPoint

        public boolean getShowHighPoint() / public void setShowHighPoint(boolean value)
        Indicates whether to highlight the highest points of data in the sparkline group.

      • getHighPointColor/setHighPointColor

        public CellsColor getHighPointColor() / public void setHighPointColor(CellsColor value)
        Gets and sets the color of the highest points of data in the sparkline group.

      • getShowLowPoint/setShowLowPoint

        public boolean getShowLowPoint() / public void setShowLowPoint(boolean value)
        Indicates whether to highlight the lowest points of data in the sparkline group.

      • getLowPointColor/setLowPointColor

        public CellsColor getLowPointColor() / public void setLowPointColor(CellsColor value)
        Gets and sets the color of the lowest points of data in the sparkline group.

      • getShowNegativePoints/setShowNegativePoints

        public boolean getShowNegativePoints() / public void setShowNegativePoints(boolean value)
        Indicates whether to highlight the negative values on the sparkline group with a different color or marker.

      • getNegativePointsColor/setNegativePointsColor

        public CellsColor getNegativePointsColor() / public void setNegativePointsColor(CellsColor value)
        Gets and sets the color of the negative values on the sparkline group.

      • getShowFirstPoint/setShowFirstPoint

        public boolean getShowFirstPoint() / public void setShowFirstPoint(boolean value)
        Indicates whether to highlight the first point of data in the sparkline group.

      • getFirstPointColor/setFirstPointColor

        public CellsColor getFirstPointColor() / public void setFirstPointColor(CellsColor value)
        Gets and sets the color of the first point of data in the sparkline group.

      • getShowLastPoint/setShowLastPoint

        public boolean getShowLastPoint() / public void setShowLastPoint(boolean value)
        Indicates whether to highlight the last point of data in the sparkline group.

      • getLastPointColor/setLastPointColor

        public CellsColor getLastPointColor() / public void setLastPointColor(CellsColor value)
        Gets and sets the color of the last point of data in the sparkline group.

      • getShowMarkers/setShowMarkers

        public boolean getShowMarkers() / public void setShowMarkers(boolean value)
        Indicates whether to highlight each point in each line sparkline in the sparkline group.

      • getMarkersColor/setMarkersColor

        public CellsColor getMarkersColor() / public void setMarkersColor(CellsColor value)
        Gets and sets the color of points in each line sparkline in the sparkline group.

      • getSeriesColor/setSeriesColor

        public CellsColor getSeriesColor() / public void setSeriesColor(CellsColor value)
        Gets and sets the color of the sparklines in the sparkline group.

      • getPlotRightToLeft/setPlotRightToLeft

        public boolean getPlotRightToLeft() / public void setPlotRightToLeft(boolean value)
        Indicates whether the plot data is right to left.

      • getLineWeight/setLineWeight

        public double getLineWeight() / public void setLineWeight(double value)
        Gets and sets the line weight in each line sparkline in the sparkline group, in the unit of points.

      • getHorizontalAxisColor/setHorizontalAxisColor

        public CellsColor getHorizontalAxisColor() / public void setHorizontalAxisColor(CellsColor value)
        Gets and sets the color of the horizontal axis in the sparkline group.

      • getShowHorizontalAxis/setShowHorizontalAxis

        public boolean getShowHorizontalAxis() / public void setShowHorizontalAxis(boolean value)
        Indicates whether to show the sparkline horizontal axis. The horizontal axis appears if the sparkline has data that crosses the zero axis.

      • getHorizontalAxisDateRange/setHorizontalAxisDateRange

        public java.lang.String getHorizontalAxisDateRange() / public void setHorizontalAxisDateRange(java.lang.String value)
        Represents the range that contains the date values for the sparkline data.

      • getVerticalAxisMaxValueType/setVerticalAxisMaxValueType

        public int getVerticalAxisMaxValueType() / public void setVerticalAxisMaxValueType(int value)
        Represents the vertical axis maximum value type. The value of the property is SparklineAxisMinMaxType integer constant.

      • getVerticalAxisMaxValue/setVerticalAxisMaxValue

        public double getVerticalAxisMaxValue() / public void setVerticalAxisMaxValue(double value)
        Gets and sets the custom maximum value for the vertical axis.

      • getVerticalAxisMinValueType/setVerticalAxisMinValueType

        public int getVerticalAxisMinValueType() / public void setVerticalAxisMinValueType(int value)
        Represents the vertical axis minimum value type. The value of the property is SparklineAxisMinMaxType integer constant.

      • getVerticalAxisMinValue/setVerticalAxisMinValue

        public double getVerticalAxisMinValue() / public void setVerticalAxisMinValue(double value)
        Gets and sets the custom minimum value for the vertical axis.

    setPresetStyle

    public voidsetPresetStyle(intvalue)
    Gets and sets the preset style type of the sparkline group. The value of the property is SparklinePresetStyleType integer constant.

    setType

    public voidsetType(intvalue)
    Indicates the sparkline type of the sparkline group. The value of the property is SparklineType integer constant.

    setPlotEmptyCellsType

    public voidsetPlotEmptyCellsType(intvalue)
    Indicates how to plot empty cells. The value of the property is PlotEmptyCellsType integer constant.

    setDisplayHidden

    public voidsetDisplayHidden(booleanvalue)
    Indicates whether to show data in hidden rows and columns.

    setShowHighPoint

    public voidsetShowHighPoint(booleanvalue)
    Indicates whether to highlight the highest points of data in the sparkline group.

    setHighPointColor

    public voidsetHighPointColor(CellsColor value)
    Gets and sets the color of the highest points of data in the sparkline group.

    setShowLowPoint

    public voidsetShowLowPoint(booleanvalue)
    Indicates whether to highlight the lowest points of data in the sparkline group.

    setLowPointColor

    public voidsetLowPointColor(CellsColor value)
    Gets and sets the color of the lowest points of data in the sparkline group.

    setShowNegativePoints

    public voidsetShowNegativePoints(booleanvalue)
    Indicates whether to highlight the negative values on the sparkline group with a different color or marker.

    setNegativePointsColor

    public voidsetNegativePointsColor(CellsColor value)
    Gets and sets the color of the negative values on the sparkline group.

    setShowFirstPoint

    public voidsetShowFirstPoint(booleanvalue)
    Indicates whether to highlight the first point of data in the sparkline group.

    setFirstPointColor

    public voidsetFirstPointColor(CellsColor value)
    Gets and sets the color of the first point of data in the sparkline group.

    setShowLastPoint

    public voidsetShowLastPoint(booleanvalue)
    Indicates whether to highlight the last point of data in the sparkline group.

    setLastPointColor

    public voidsetLastPointColor(CellsColor value)
    Gets and sets the color of the last point of data in the sparkline group.

    setShowMarkers

    public voidsetShowMarkers(booleanvalue)
    Indicates whether to highlight each point in each line sparkline in the sparkline group.

    setMarkersColor

    public voidsetMarkersColor(CellsColor value)
    Gets and sets the color of points in each line sparkline in the sparkline group.

    setSeriesColor

    public voidsetSeriesColor(CellsColor value)
    Gets and sets the color of the sparklines in the sparkline group.

    setPlotRightToLeft

    public voidsetPlotRightToLeft(booleanvalue)
    Indicates whether the plot data is right to left.

    setLineWeight

    public voidsetLineWeight(doublevalue)
    Gets and sets the line weight in each line sparkline in the sparkline group, in the unit of points.

    setHorizontalAxisColor

    public voidsetHorizontalAxisColor(CellsColor value)
    Gets and sets the color of the horizontal axis in the sparkline group.

    setShowHorizontalAxis

    public voidsetShowHorizontalAxis(booleanvalue)
    Indicates whether to show the sparkline horizontal axis. The horizontal axis appears if the sparkline has data that crosses the zero axis.

    setHorizontalAxisDateRange

    public voidsetHorizontalAxisDateRange(java.lang.Stringvalue)
    Represents the range that contains the date values for the sparkline data.

    setVerticalAxisMaxValueType

    public voidsetVerticalAxisMaxValueType(intvalue)
    Represents the vertical axis maximum value type. The value of the property is SparklineAxisMinMaxType integer constant.

    setVerticalAxisMaxValue

    public voidsetVerticalAxisMaxValue(doublevalue)
    Gets and sets the custom maximum value for the vertical axis.

    setVerticalAxisMinValueType

    public voidsetVerticalAxisMinValueType(intvalue)
    Represents the vertical axis minimum value type. The value of the property is SparklineAxisMinMaxType integer constant.

    setVerticalAxisMinValue

    public voidsetVerticalAxisMinValue(doublevalue)
    Gets and sets the custom minimum value for the vertical axis.

    • Method Detail

      • resetRanges

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