Package com.grapecity.documents.excel.drawing

Interface ISeries

public interface ISeries
Represents a series in a chart. The Series object is a member of the ISeriesCollection collection.

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    clearFormats()
    Clears the formatting of the object.
    void
    delete()
    Deletes the object.
    AxisGroup
    getAxisGroup()
    Returns the group for the specified chart group or series.
    BarShape
    getBarShape()
    Returns or sets the shape used with the 3-D bar or column chart.
    Double[]
    getBubbleSizes()
    Gets an array that contains the size data for the bubble chart.
    ChartType
    getChartType()
    Gets the chart type.
    IDataLabels
    getDataLabels()
    Returns an object that represents a collection of all the data labels for the series.
    int
    getExplosion()
    Gets the explosion value for a pie-chart or doughnut-chart slice.
    IChartFormat
    getFormat()
    Returns the IChartFormat object.
    String
    getFormula()
    Gets the object's formula in A1-style notation.
    String
    getFormulaR1C1()
    Gets the formula for the object using R1C1-style notation.
    boolean
    getHas3DEffect()
    Gets whether the series has a three-dimensional appearance.
    boolean
    getHasDataLabels()
    Gets whether the series has data labels.
    boolean
    getHasErrorBars()
    Gets whether the series has error bars.
    IColorFormat
    getInvertColor()
    Gets the fill color for negative data points in a series.
    boolean
    getInvertIfNegative()
    Gets whether Microsoft Excel inverts the pattern in the item when it corresponds to a negative number.
    IChartFormat
    getMarkerFormat()
    Returns the IChartFormat for the markers of this series.
    int
    getMarkerSize()
    Gets the data-marker size in points.
    MarkerStyle
    getMarkerStyle()
    Gets the marker style for a point or series in a line chart, scatter chart, or radar chart.
    String
    getName()
    Gets the name of the object.
    IChartGroup
    getParent()
    Returns the parent object for the specified object.
    ParentDataLabelOptions
    getParentDataLabelOption()
    Gets the parent data label option for the specified series within the chart group.
    DrawingPictureType
    getPictureType()
    Gets the way pictures are displayed on a column or bar picture chart.
    double
    getPictureUnit()
    Gets the unit for each picture on the chart if the PictureType property is set to Scale (if not, this property is ignored).
    int
    getPlotOrder()
    Gets the plot order for the selected series within the chart group.
    IPoints
    getPoints()
    Returns an object that represents a collection of all the points in the series.
    boolean
    getQuartileCalculationInclusiveMedian()
    Gets whether the median is included in the calculation if N (the number of values in the data) is odd.
    boolean
    getShowConnectorLines()
    Gets whether to show the connector lines which connect the end of each column to the beginning of the next column.
    boolean
    getShowInnerPoints()
    Gets whether to show the data points that lie between the lower whisker line and the upper whisker line.
    boolean
    getShowMeanLine()
    Gets whether to show the line connecting the means of the boxes in the selected series.
    boolean
    getShowMeanMarkers()
    Gets whether to show the mean marker of the selected series.
    boolean
    getShowOutlierPoints()
    Gets whether to show the outlier points that lie either below the lower whisker line or above the upper whisker line.
    boolean
    getSmooth()
    Gets the curve smoothing setting (True if curve smoothing is turned on for the line chart or scatter chart).
    ITrendlines
    getTrendlines()
    Returns an object that represents a collection of all the trendlines for the series.
    Double[]
    getValues()
    Gets a collection of all the values in the series.
    IErrorBar
    getXErrorBar()
    Gets an ErrorBar object that represents the X direction error bar for the series.
    Object[]
    getXValues()
    Gets an array of x values for a chart series.
    IErrorBar
    getYErrorBar()
    Gets an ErrorBar object that represents the Y direction error bar for the series.
    void
    setAxisGroup(AxisGroup value)
    Sets the group for the specified chart group or series.
    void
    setBarShape(BarShape value)
    Sets the shape used with the 3-D bar or column chart.
    void
    setBubbleSizes(Double[] value)
    Sets an array that contains the size data for the bubble chart.
    void
    setChartType(ChartType value)
    Sets the chart type.
    void
    setExplosion(int value)
    Sets the explosion value for a pie-chart or doughnut-chart slice.
    void
    setFormula(String value)
    Sets the object's formula in A1-style notation.
    void
    setFormulaR1C1(String value)
    Sets the formula for the object using R1C1-style notation.
    void
    setHas3DEffect(boolean value)
    Sets whether the series has a three-dimensional appearance.
    void
    setHasDataLabels(boolean value)
    Sets whether the series has data labels.
    void
    setHasErrorBars(boolean value)
    Sets whether the series has error bars.
    void
    setInvertIfNegative(boolean value)
    Sets whether Microsoft Excel inverts the pattern in the item when it corresponds to a negative number.
    void
    setMarkerSize(int value)
    Sets the data-marker size in points.
    void
    setMarkerStyle(MarkerStyle value)
    Sets the marker style for a point or series in a line chart, scatter chart, or radar chart.
    void
    setName(String value)
    Sets the name of the object.
    void
    setParentDataLabelOption(ParentDataLabelOptions value)
    Sets the parent data label option for the specified series within the chart group.
    void
    setPictureType(DrawingPictureType value)
    Sets the way pictures are displayed on a column or bar picture chart.
    void
    setPictureUnit(double value)
    Sets the unit for each picture on the chart if the PictureType property is set to Scale (if not, this property is ignored).
    void
    setPlotOrder(int value)
    Sets the plot order for the selected series within the chart group.
    void
    setQuartileCalculationInclusiveMedian(boolean value)
    Sets whether the median is included in the calculation if N (the number of values in the data) is odd.
    void
    setShowConnectorLines(boolean value)
    Sets whether to show the connector lines which connect the end of each column to the beginning of the next column.
    void
    setShowInnerPoints(boolean value)
    Sets whether to show the data points that lie between the lower whisker line and the upper whisker line.
    void
    setShowMeanLine(boolean value)
    Sets whether to show the line connecting the means of the boxes in the selected series.
    void
    setShowMeanMarkers(boolean value)
    Sets whether to show the mean marker of the selected series.
    void
    setShowOutlierPoints(boolean value)
    Sets whether to show the outlier points that lie either below the lower whisker line or above the upper whisker line.
    void
    setSmooth(boolean value)
    Sets the curve smoothing setting (True if curve smoothing is turned on for the line chart or scatter chart).
    void
    setValues(Double[] value)
    Sets a collection of all the values in the series.
    void
    setXValues(Object[] value)
    Sets an array of x values for a chart series.

  • Method Details

    • getAxisGroup

      AxisGroup getAxisGroup()
      Returns the group for the specified chart group or series.

    • setAxisGroup

      void setAxisGroup(AxisGroup value)
      Sets the group for the specified chart group or series.

    • getBarShape

      BarShape getBarShape()
      Returns or sets the shape used with the 3-D bar or column chart.

    • setBarShape

      void setBarShape(BarShape value)
      Sets the shape used with the 3-D bar or column chart.

    • getBubbleSizes

      Double[] getBubbleSizes()
      Gets an array that contains the size data for the bubble chart. Applies only to bubble charts.

    • setBubbleSizes

      void setBubbleSizes(Double[] value)
      Sets an array that contains the size data for the bubble chart. Applies only to bubble charts.

    • getChartType

      ChartType getChartType()
      Gets the chart type.

    • setChartType

      void setChartType(ChartType value)
      Sets the chart type.

    • getXErrorBar

      IErrorBar getXErrorBar()
      Gets an ErrorBar object that represents the X direction error bar for the series.

    • getYErrorBar

      IErrorBar getYErrorBar()
      Gets an ErrorBar object that represents the Y direction error bar for the series.

    • getExplosion

      int getExplosion()
      Gets the explosion value for a pie-chart or doughnut-chart slice. Returns 0 (zero) if there is no explosion (the tip of the slice is in the center of the pie).

    • setExplosion

      void setExplosion(int value)
      Sets the explosion value for a pie-chart or doughnut-chart slice. Returns 0 (zero) if there is no explosion (the tip of the slice is in the center of the pie).

    • getFormat

      IChartFormat getFormat()
      Returns the IChartFormat object.

    • getFormula

      String getFormula()
      Gets the object's formula in A1-style notation.

    • setFormula

      void setFormula(String value)
      Sets the object's formula in A1-style notation.

    • getFormulaR1C1

      String getFormulaR1C1()
      Gets the formula for the object using R1C1-style notation.

    • setFormulaR1C1

      void setFormulaR1C1(String value)
      Sets the formula for the object using R1C1-style notation.

    • getHas3DEffect

      boolean getHas3DEffect()
      Gets whether the series has a three-dimensional appearance. Applies only to bubble charts.

    • setHas3DEffect

      void setHas3DEffect(boolean value)
      Sets whether the series has a three-dimensional appearance. Applies only to bubble charts.

    • getHasDataLabels

      boolean getHasDataLabels()
      Gets whether the series has data labels.

    • setHasDataLabels

      void setHasDataLabels(boolean value)
      Sets whether the series has data labels.

    • getHasErrorBars

      boolean getHasErrorBars()
      Gets whether the series has error bars. This property isn’t available for 3-D charts.

    • setHasErrorBars

      void setHasErrorBars(boolean value)
      Sets whether the series has error bars. This property isn’t available for 3-D charts.

    • getInvertColor

      IColorFormat getInvertColor()
      Gets the fill color for negative data points in a series.

    • getInvertIfNegative

      boolean getInvertIfNegative()
      Gets whether Microsoft Excel inverts the pattern in the item when it corresponds to a negative number.

    • setInvertIfNegative

      void setInvertIfNegative(boolean value)
      Sets whether Microsoft Excel inverts the pattern in the item when it corresponds to a negative number.

    • getMarkerFormat

      IChartFormat getMarkerFormat()
      Returns the IChartFormat for the markers of this series.

    • getMarkerSize

      int getMarkerSize()
      Gets the data-marker size in points.

    • setMarkerSize

      void setMarkerSize(int value)
      Sets the data-marker size in points.

    • getMarkerStyle

      MarkerStyle getMarkerStyle()
      Gets the marker style for a point or series in a line chart, scatter chart, or radar chart.

    • setMarkerStyle

      void setMarkerStyle(MarkerStyle value)
      Sets the marker style for a point or series in a line chart, scatter chart, or radar chart.

    • getName

      String getName()
      Gets the name of the object.

    • setName

      void setName(String value)
      Sets the name of the object.

    • getParent

      IChartGroup getParent()
      Returns the parent object for the specified object.

    • getPictureType

      DrawingPictureType getPictureType()
      Gets the way pictures are displayed on a column or bar picture chart.

    • setPictureType

      void setPictureType(DrawingPictureType value)
      Sets the way pictures are displayed on a column or bar picture chart.

    • getPictureUnit

      double getPictureUnit()
      Gets the unit for each picture on the chart if the PictureType property is set to Scale (if not, this property is ignored).

    • setPictureUnit

      void setPictureUnit(double value)
      Sets the unit for each picture on the chart if the PictureType property is set to Scale (if not, this property is ignored).

    • getPlotOrder

      int getPlotOrder()
      Gets the plot order for the selected series within the chart group.

    • setPlotOrder

      void setPlotOrder(int value)
      Sets the plot order for the selected series within the chart group.

    • getSmooth

      boolean getSmooth()
      Gets the curve smoothing setting (True if curve smoothing is turned on for the line chart or scatter chart). Applies only to line and scatter charts.

    • setSmooth

      void setSmooth(boolean value)
      Sets the curve smoothing setting (True if curve smoothing is turned on for the line chart or scatter chart). Applies only to line and scatter charts.

    • getShowInnerPoints

      boolean getShowInnerPoints()
      Gets whether to show the data points that lie between the lower whisker line and the upper whisker line. Valid only for boxwhisker charts.

    • setShowInnerPoints

      void setShowInnerPoints(boolean value)
      Sets whether to show the data points that lie between the lower whisker line and the upper whisker line. Valid only for boxwhisker charts.

    • getShowOutlierPoints

      boolean getShowOutlierPoints()
      Gets whether to show the outlier points that lie either below the lower whisker line or above the upper whisker line. The default value is true. Valid only for boxwhisker charts.

    • setShowOutlierPoints

      void setShowOutlierPoints(boolean value)
      Sets whether to show the outlier points that lie either below the lower whisker line or above the upper whisker line. The default value is true. Valid only for boxwhisker charts.

    • getShowMeanMarkers

      boolean getShowMeanMarkers()
      Gets whether to show the mean marker of the selected series. The default value is true. Valid only for boxwhisker charts.

    • setShowMeanMarkers

      void setShowMeanMarkers(boolean value)
      Sets whether to show the mean marker of the selected series. The default value is true. Valid only for boxwhisker charts.

    • getShowMeanLine

      boolean getShowMeanLine()
      Gets whether to show the line connecting the means of the boxes in the selected series. Valid only for boxwhisker charts.

    • setShowMeanLine

      void setShowMeanLine(boolean value)
      Sets whether to show the line connecting the means of the boxes in the selected series. Valid only for boxwhisker charts.

    • getShowConnectorLines

      boolean getShowConnectorLines()
      Gets whether to show the connector lines which connect the end of each column to the beginning of the next column. The default value is true. Valid only for waterfall charts.

    • setShowConnectorLines

      void setShowConnectorLines(boolean value)
      Sets whether to show the connector lines which connect the end of each column to the beginning of the next column. The default value is true. Valid only for waterfall charts.

    • getQuartileCalculationInclusiveMedian

      boolean getQuartileCalculationInclusiveMedian()
      Gets whether the median is included in the calculation if N (the number of values in the data) is odd. Valid only for boxwhisker charts.

    • setQuartileCalculationInclusiveMedian

      void setQuartileCalculationInclusiveMedian(boolean value)
      Sets whether the median is included in the calculation if N (the number of values in the data) is odd. Valid only for boxwhisker charts.

    • getValues

      Double[] getValues()
      Gets a collection of all the values in the series. This can come from a range on a worksheet or an array of constant values, but not a combination of both.

    • setValues

      void setValues(Double[] value)
      Sets a collection of all the values in the series. This can come from a range on a worksheet or an array of constant values, but not a combination of both.

    • getXValues

      Object[] getXValues()
      Gets an array of x values for a chart series. The XValues property can come from a range on a worksheet or an array of values, but it cannot be a combination of both.

    • setXValues

      void setXValues(Object[] value)
      Sets an array of x values for a chart series. The XValues property can come from a range on a worksheet or an array of values, but it cannot be a combination of both.

    • getParentDataLabelOption

      ParentDataLabelOptions getParentDataLabelOption()
      Gets the parent data label option for the specified series within the chart group.

    • setParentDataLabelOption

      void setParentDataLabelOption(ParentDataLabelOptions value)
      Sets the parent data label option for the specified series within the chart group.

    • getDataLabels

      IDataLabels getDataLabels()
      Returns an object that represents a collection of all the data labels for the series.

    • getPoints

      IPoints getPoints()
      Returns an object that represents a collection of all the points in the series.

    • getTrendlines

      ITrendlines getTrendlines()
      Returns an object that represents a collection of all the trendlines for the series.

    • clearFormats

      void clearFormats()
      Clears the formatting of the object.

    • delete

      void delete()
      Deletes the object.