aspose.cells

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
functiongetDisplayHidden()
function
           Indicates whether to show data in hidden rows and columns.
functiongetFirstPointColor()
function
           Gets and sets the color of the first point of data in the sparkline group.
functiongetHighPointColor()
function
           Gets and sets the color of the highest points of data in the sparkline group.
functiongetHorizontalAxisColor()
function
           Gets and sets the color of the horizontal axis in the sparkline group.
functiongetHorizontalAxisDateRange()
function
           Represents the range that contains the date values for the sparkline data.
functiongetLastPointColor()
function
           Gets and sets the color of the last point of data in the sparkline group.
functiongetLineWeight()
function
           Gets and sets the line weight in each line sparkline in the sparkline group, in the unit of points.
functiongetLowPointColor()
function
           Gets and sets the color of the lowest points of data in the sparkline group.
functiongetMarkersColor()
function
           Gets and sets the color of points in each line sparkline in the sparkline group.
functiongetNegativePointsColor()
function
           Gets and sets the color of the negative values on the sparkline group.
functiongetPlotEmptyCellsType()
function
           Indicates how to plot empty cells. The value of the property is PlotEmptyCellsType integer constant.
functiongetPlotRightToLeft()
function
           Indicates whether the plot data is right to left.
functiongetPresetStyle()
function
           Gets and sets the preset style type of the sparkline group. The value of the property is SparklinePresetStyleType integer constant.
functiongetSeriesColor()
function
           Gets and sets the color of the sparklines in the sparkline group.
functiongetShowFirstPoint()
function
           Indicates whether to highlight the first point of data in the sparkline group.
functiongetShowHighPoint()
function
           Indicates whether to highlight the highest points of data in the sparkline group.
functiongetShowHorizontalAxis()
function
           Indicates whether to show the sparkline horizontal axis. The horizontal axis appears if the sparkline has data that crosses the zero axis.
functiongetShowLastPoint()
function
           Indicates whether to highlight the last point of data in the sparkline group.
functiongetShowLowPoint()
function
           Indicates whether to highlight the lowest points of data in the sparkline group.
functiongetShowMarkers()
function
           Indicates whether to highlight each point in each line sparkline in the sparkline group.
functiongetShowNegativePoints()
function
           Indicates whether to highlight the negative values on the sparkline group with a different color or marker.
functiongetSparklineCollection()
Gets the collection of Sparkline object.
functiongetSparklines()
Gets the collection of Sparkline object.
functiongetType()
function
setType(value)
           Indicates the sparkline type of the sparkline group. The value of the property is SparklineType integer constant.
functiongetVerticalAxisMaxValue()
function
           Gets and sets the custom maximum value for the vertical axis.
functiongetVerticalAxisMaxValueType()
function
           Represents the vertical axis maximum value type. The value of the property is SparklineAxisMinMaxType integer constant.
functiongetVerticalAxisMinValue()
function
           Gets and sets the custom minimum value for the vertical axis.
functiongetVerticalAxisMinValueType()
function
           Represents the vertical axis minimum value type. The value of the property is SparklineAxisMinMaxType integer constant.
 
Method Summary
functionresetRanges(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 : Number 

        function getPresetStyle() / function setPresetStyle(value)
        
        Gets and sets the preset style type of the sparkline group. The value of the property is SparklinePresetStyleType integer constant.
      • getSparklineCollection : SparklineCollection 

        function getSparklineCollection()
        
        Gets the collection of Sparkline object. NOTE: This member is now obsolete. Instead, please use SparklineGroup.Sparklines property. This property will be removed 12 months later since November 2022. Aspose apologizes for any inconvenience you may have experienced.
      • getType/setType : Number 

        function getType() / function setType(value)
        
        Indicates the sparkline type of the sparkline group. The value of the property is SparklineType integer constant.
      • getPlotEmptyCellsType/setPlotEmptyCellsType : Number 

        function getPlotEmptyCellsType() / function setPlotEmptyCellsType(value)
        
        Indicates how to plot empty cells. The value of the property is PlotEmptyCellsType integer constant.
      • getDisplayHidden/setDisplayHidden : boolean 

        function getDisplayHidden() / function setDisplayHidden(value)
        
        Indicates whether to show data in hidden rows and columns.
      • getShowHighPoint/setShowHighPoint : boolean 

        function getShowHighPoint() / function setShowHighPoint(value)
        
        Indicates whether to highlight the highest points of data in the sparkline group.
      • getHighPointColor/setHighPointColor : CellsColor 

        function getHighPointColor() / function setHighPointColor(value)
        
        Gets and sets the color of the highest points of data in the sparkline group.
      • getShowLowPoint/setShowLowPoint : boolean 

        function getShowLowPoint() / function setShowLowPoint(value)
        
        Indicates whether to highlight the lowest points of data in the sparkline group.
      • getLowPointColor/setLowPointColor : CellsColor 

        function getLowPointColor() / function setLowPointColor(value)
        
        Gets and sets the color of the lowest points of data in the sparkline group.
      • getShowNegativePoints/setShowNegativePoints : boolean 

        function getShowNegativePoints() / function setShowNegativePoints(value)
        
        Indicates whether to highlight the negative values on the sparkline group with a different color or marker.
      • getNegativePointsColor/setNegativePointsColor : CellsColor 

        function getNegativePointsColor() / function setNegativePointsColor(value)
        
        Gets and sets the color of the negative values on the sparkline group.
      • getShowFirstPoint/setShowFirstPoint : boolean 

        function getShowFirstPoint() / function setShowFirstPoint(value)
        
        Indicates whether to highlight the first point of data in the sparkline group.
      • getFirstPointColor/setFirstPointColor : CellsColor 

        function getFirstPointColor() / function setFirstPointColor(value)
        
        Gets and sets the color of the first point of data in the sparkline group.
      • getShowLastPoint/setShowLastPoint : boolean 

        function getShowLastPoint() / function setShowLastPoint(value)
        
        Indicates whether to highlight the last point of data in the sparkline group.
      • getLastPointColor/setLastPointColor : CellsColor 

        function getLastPointColor() / function setLastPointColor(value)
        
        Gets and sets the color of the last point of data in the sparkline group.
      • getShowMarkers/setShowMarkers : boolean 

        function getShowMarkers() / function setShowMarkers(value)
        
        Indicates whether to highlight each point in each line sparkline in the sparkline group.
      • getMarkersColor/setMarkersColor : CellsColor 

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

        function getSeriesColor() / function setSeriesColor(value)
        
        Gets and sets the color of the sparklines in the sparkline group.
      • getPlotRightToLeft/setPlotRightToLeft : boolean 

        function getPlotRightToLeft() / function setPlotRightToLeft(value)
        
        Indicates whether the plot data is right to left.
      • getLineWeight/setLineWeight : Number 

        function getLineWeight() / function setLineWeight(value)
        
        Gets and sets the line weight in each line sparkline in the sparkline group, in the unit of points.
      • getHorizontalAxisColor/setHorizontalAxisColor : CellsColor 

        function getHorizontalAxisColor() / function setHorizontalAxisColor(value)
        
        Gets and sets the color of the horizontal axis in the sparkline group.
      • getShowHorizontalAxis/setShowHorizontalAxis : boolean 

        function getShowHorizontalAxis() / function 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 

        function getHorizontalAxisDateRange() / function setHorizontalAxisDateRange(value)
        
        Represents the range that contains the date values for the sparkline data.
      • getVerticalAxisMaxValueType/setVerticalAxisMaxValueType : Number 

        function getVerticalAxisMaxValueType() / function setVerticalAxisMaxValueType(value)
        
        Represents the vertical axis maximum value type. The value of the property is SparklineAxisMinMaxType integer constant.
      • getVerticalAxisMaxValue/setVerticalAxisMaxValue : Number 

        function getVerticalAxisMaxValue() / function setVerticalAxisMaxValue(value)
        
        Gets and sets the custom maximum value for the vertical axis.
      • getVerticalAxisMinValueType/setVerticalAxisMinValueType : Number 

        function getVerticalAxisMinValueType() / function setVerticalAxisMinValueType(value)
        
        Represents the vertical axis minimum value type. The value of the property is SparklineAxisMinMaxType integer constant.
      • getVerticalAxisMinValue/setVerticalAxisMinValue : Number 

        function getVerticalAxisMinValue() / function setVerticalAxisMinValue(value)
        
        Gets and sets the custom minimum value for the vertical axis.
    • Method Detail

      • resetRanges

        function 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.