asposecells.api
Class SparklineGroup

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
methodgetDisplayHidden()
methodsetDisplayHidden(value)
           Indicates whether to show data in hidden rows and columns.
methodgetFirstPointColor()
methodsetFirstPointColor(value)
           Gets and sets the color of the first point of data in the sparkline group.
methodgetHighPointColor()
methodsetHighPointColor(value)
           Gets and sets the color of the highest points of data in the sparkline group.
methodgetHorizontalAxisColor()
methodsetHorizontalAxisColor(value)
           Gets and sets the color of the horizontal axis in the sparkline group.
methodgetHorizontalAxisDateRange()
methodsetHorizontalAxisDateRange(value)
           Represents the range that contains the date values for the sparkline data.
methodgetLastPointColor()
methodsetLastPointColor(value)
           Gets and sets the color of the last point of data in the sparkline group.
methodgetLineWeight()
methodsetLineWeight(value)
           Gets and sets the line weight in each line sparkline in the sparkline group, in the unit of points.
methodgetLowPointColor()
methodsetLowPointColor(value)
           Gets and sets the color of the lowest points of data in the sparkline group.
methodgetMarkersColor()
methodsetMarkersColor(value)
           Gets and sets the color of points in each line sparkline in the sparkline group.
methodgetNegativePointsColor()
methodsetNegativePointsColor(value)
           Gets and sets the color of the negative values on the sparkline group.
methodgetPlotEmptyCellsType()
methodsetPlotEmptyCellsType(value)
           Indicates how to plot empty cells. The value of the property is PlotEmptyCellsType integer constant.
methodgetPlotRightToLeft()
methodsetPlotRightToLeft(value)
           Indicates whether the plot data is right to left.
methodgetPresetStyle()
methodsetPresetStyle(value)
           Gets and sets the preset style type of the sparkline group. The value of the property is SparklinePresetStyleType integer constant.
methodgetSeriesColor()
methodsetSeriesColor(value)
           Gets and sets the color of the sparklines in the sparkline group.
methodgetShowFirstPoint()
methodsetShowFirstPoint(value)
           Indicates whether to highlight the first point of data in the sparkline group.
methodgetShowHighPoint()
methodsetShowHighPoint(value)
           Indicates whether to highlight the highest points of data in the sparkline group.
methodgetShowHorizontalAxis()
methodsetShowHorizontalAxis(value)
           Indicates whether to show the sparkline horizontal axis. The horizontal axis appears if the sparkline has data that crosses the zero axis.
methodgetShowLastPoint()
methodsetShowLastPoint(value)
           Indicates whether to highlight the last point of data in the sparkline group.
methodgetShowLowPoint()
methodsetShowLowPoint(value)
           Indicates whether to highlight the lowest points of data in the sparkline group.
methodgetShowMarkers()
methodsetShowMarkers(value)
           Indicates whether to highlight each point in each line sparkline in the sparkline group.
methodgetShowNegativePoints()
methodsetShowNegativePoints(value)
           Indicates whether to highlight the negative values on the sparkline group with a different color or marker.
methodgetSparklineCollection()
           Gets the SparklineCollection object of the sparkline group.
methodgetType()
methodsetType(value)
           Indicates the sparkline type of the sparkline group. The value of the property is SparklineType integer constant.
methodgetVerticalAxisMaxValue()
methodsetVerticalAxisMaxValue(value)
           Gets and sets the custom maximum value for the vertical axis.
methodgetVerticalAxisMaxValueType()
methodsetVerticalAxisMaxValueType(value)
           Represents the vertical axis maximum value type. The value of the property is SparklineAxisMinMaxType integer constant.
methodgetVerticalAxisMinValue()
methodsetVerticalAxisMinValue(value)
           Gets and sets the custom minimum value for the vertical axis.
methodgetVerticalAxisMinValueType()
methodsetVerticalAxisMinValueType(value)
           Represents the vertical axis minimum value type. The value of the property is SparklineAxisMinMaxType integer constant.
 
Method Summary
methodresetRanges(dataRange, isVertical, 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 : int 

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

getSparklineCollection : SparklineCollection 

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

getType/setType : int 

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

getPlotEmptyCellsType/setPlotEmptyCellsType : int 

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

getDisplayHidden/setDisplayHidden : boolean 

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

getShowHighPoint/setShowHighPoint : boolean 

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

getHighPointColor/setHighPointColor : CellsColor 

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

getShowLowPoint/setShowLowPoint : boolean 

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

getLowPointColor/setLowPointColor : CellsColor 

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

getShowNegativePoints/setShowNegativePoints : boolean 

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

getNegativePointsColor/setNegativePointsColor : CellsColor 

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

getShowFirstPoint/setShowFirstPoint : boolean 

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

getFirstPointColor/setFirstPointColor : CellsColor 

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

getShowLastPoint/setShowLastPoint : boolean 

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

getLastPointColor/setLastPointColor : CellsColor 

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

getShowMarkers/setShowMarkers : boolean 

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

getMarkersColor/setMarkersColor : CellsColor 

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

getSeriesColor/setSeriesColor : CellsColor 

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

getPlotRightToLeft/setPlotRightToLeft : boolean 

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

getLineWeight/setLineWeight : float 

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

getHorizontalAxisColor/setHorizontalAxisColor : CellsColor 

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

getShowHorizontalAxis/setShowHorizontalAxis : boolean 

boolean getShowHorizontalAxis() / setShowHorizontalAxis(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 : String 

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

getVerticalAxisMaxValueType/setVerticalAxisMaxValueType : int 

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

getVerticalAxisMaxValue/setVerticalAxisMaxValue : float 

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

getVerticalAxisMinValueType/setVerticalAxisMinValueType : int 

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

getVerticalAxisMinValue/setVerticalAxisMinValue : float 

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

Method Detail

resetRanges

 resetRanges(dataRange, isVertical, 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: 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.

See Also:
          Aspose.Cells Documentation - the home page for the Aspose.Cellss Product Documentation.
          Aspose.Cells Support Forum - our preferred method of support.