Package com.grapecity.documents.excel.drawing

Interface IChartGroup

public interface IChartGroup
Represents one or more series plotted in a chart with the same format. The ChartGroup object is a member of the IChartGroups collection.

  • Method Summary

    Modifier and Type
    Method
    Description
    AxisGroup
    getAxisGroup()
    Returns the group for the specified chart group or series.
    long
    getBinsCountValue()
    Gets the number of bins in the histogram chart.
    boolean
    getBinsOverflowEnabled()
    Gets whether a bin for values above the BinsOverflowValue property is enabled.
    double
    getBinsOverflowValue()
    Gets the value above which an overflow bin is displayed.
    BinsType
    getBinsType()
    Gets how the horizontal axis of the histogram chart is formatted.
    boolean
    getBinsUnderflowEnabled()
    Gets whether a bin for values below the BinsUnderflowValue property is enabled.
    double
    getBinsUnderflowValue()
    Gets the value below which an underflow bin is displayed.
    double
    getBinWidthValue()
    Gets the number of points in each range.
    int
    getBubbleScale()
    Gets the scale factor for bubbles in the specified chart group.
    int
    getDoughnutHoleSize()
    Gets the size of the hole in a doughnut chart group.
    IChartBars
    getDownBars()
    Returns the IChartBars object that represents the down bars on a linechart.
    IChartLines
    getDropLines()
    Returns the IChartLines object that represents the drop lines for aseries on a line chart or area chart.
    int
    getFirstSliceAngle()
    Gets the angle of the first pie-chart or doughnut-chart slice in degrees (clockwise from vertical).
    int
    getGapWidth()
    Gets the gap width.
    boolean
    getHasDropLines()
    Gets whether the chart has drop lines (True if the line chart or area chart has drop lines).
    boolean
    getHasHiLoLines()
    Gets whether the line chart has high-low lines (True if the line chart has high-low lines).
    boolean
    getHasSeriesLines()
    Gets whether the chart has series lines (True if a stacked column chart or bar chart has series lines or if a Pie of Pie chart or Bar of Pie chart has connector lines between the two sections).
    boolean
    getHasUpDownBars()
    Gets whether the line chart has up and down bars (True if a line chart has up and down bars).
    IChartLines
    getHiLoLines()
    Returns a IChartLines object that represents thehigh-low lines for a series on a line chart.
    int
    getOverlap()
    Gets how bars and columns are positioned.
    IChart
    getParent()
    Returns the parent object for the specified object.
    int
    getSecondPlotSize()
    Gets the size of the secondary section of either a Pie of Pie chart or a Bar of Pie chart, as a percentage of the size of the primary pie.
    List<ISeries>
    getSeriesCollection()
    Returns an object that represents a collection of all the series (a ISeries collection) in the chart or chart group.
    IChartLines
    getSeriesLines()
    Returns the IChartLines object that represents the series lines for astacked bar chart or a stacked column chart.
    boolean
    getShowNegativeBubbles()
    Gets whether to show negative bubbles (True if negative bubbles are shown for the chart group).
    SizeRepresents
    getSizeRepresents()
    Sets what the bubble size represents on a bubble chart.
    ChartSplitType
    getSplitType()
    Gets the way the two sections of either a Pie of Pie chart or a Bar of Pie chart are split.
    int
    getSplitValue()
    Gets the threshold value separating the two sections of either a Pie of Pie chart or a Bar of Pie chart.
    IChartBars
    getUpBars()
    Returns an IChartBars object that represents the up bars on a linechart.
    boolean
    getVaryByCategories()
    Gets whether to use a different color or pattern for each data marker (True if Microsoft Excel assigns a different color or pattern to each data marker).
    void
    setAxisGroup(AxisGroup value)
    Sets the group for the specified chart group or series.
    void
    setBinsCountValue(long value)
    Sets the number of bins in the histogram chart.
    void
    setBinsOverflowEnabled(boolean value)
    Sets whether a bin for values above the BinsOverflowValue property is enabled.
    void
    setBinsOverflowValue(double value)
    Sets the value above which an overflow bin is displayed.
    void
    setBinsType(BinsType value)
    Sets how the horizontal axis of the histogram chart is formatted.
    void
    setBinsUnderflowEnabled(boolean value)
    Sets whether a bin for values below the BinsUnderflowValue property is enabled.
    void
    setBinsUnderflowValue(double value)
    Sets the value below which an underflow bin is displayed.
    void
    setBinWidthValue(double value)
    Sets the number of points in each range.
    void
    setBubbleScale(int value)
    Sets the scale factor for bubbles in the specified chart group.
    void
    setDoughnutHoleSize(int value)
    Sets the size of the hole in a doughnut chart group.
    void
    setFirstSliceAngle(int value)
    Sets the angle of the first pie-chart or doughnut-chart slice in degrees (clockwise from vertical).
    void
    setGapWidth(int value)
    Sets the gap width.
    void
    setHasDropLines(boolean value)
    Sets whether the chart has drop lines (True if the line chart or area chart has drop lines).
    void
    setHasHiLoLines(boolean value)
    Sets whether the line chart has high-low lines (True if the line chart has high-low lines).
    void
    setHasSeriesLines(boolean value)
    Sets whether the chart has series lines (True if a stacked column chart or bar chart has series lines or if a Pie of Pie chart or Bar of Pie chart has connector lines between the two sections).
    void
    setHasUpDownBars(boolean value)
    Sets whether the line chart has up and down bars (True if a line chart has up and down bars).
    void
    setOverlap(int value)
    Sets how bars and columns are positioned.
    void
    setSecondPlotSize(int value)
    Sets the size of the secondary section of either a Pie of Pie chart or a Bar of Pie chart, as a percentage of the size of the primary pie.
    void
    setShowNegativeBubbles(boolean value)
    Sets whether to show negative bubbles (True if negative bubbles are shown for the chart group).
    void
    setSizeRepresents(SizeRepresents value)
    Gets what the bubble size represents on a bubble chart.
    void
    setSplitType(ChartSplitType value)
    Sets the way the two sections of either a Pie of Pie chart or a Bar of Pie chart are split.
    void
    setSplitValue(int value)
    Sets the threshold value separating the two sections of either a Pie of Pie chart or a Bar of Pie chart.
    void
    setVaryByCategories(boolean value)
    Sets whether to use a different color or pattern for each data marker (True if Microsoft Excel assigns a different color or pattern to each data marker).

  • Method Details

    • getParent

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

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

    • getBubbleScale

      int getBubbleScale()
      Gets the scale factor for bubbles in the specified chart group. Can be an integer value from 0 (zero) to 300, corresponding to a percentage of the default size. Applies only to bubble charts.

    • setBubbleScale

      void setBubbleScale(int value)
      Sets the scale factor for bubbles in the specified chart group. Can be an integer value from 0 (zero) to 300, corresponding to a percentage of the default size. Applies only to bubble charts.

    • getDoughnutHoleSize

      int getDoughnutHoleSize()
      Gets the size of the hole in a doughnut chart group. The hole size is expressed as a percentage of the chart size, between 10 and 90 percent.

    • setDoughnutHoleSize

      void setDoughnutHoleSize(int value)
      Sets the size of the hole in a doughnut chart group. The hole size is expressed as a percentage of the chart size, between 10 and 90 percent.

    • getDownBars

      IChartBars getDownBars()
      Returns the IChartBars object that represents the down bars on a linechart. Applies only to line charts.

    • getDropLines

      IChartLines getDropLines()
      Returns the IChartLines object that represents the drop lines for aseries on a line chart or area chart. Applies only to line charts or area charts.

    • getFirstSliceAngle

      int getFirstSliceAngle()
      Gets the angle of the first pie-chart or doughnut-chart slice in degrees (clockwise from vertical). Applies only to pie, 3-D pie, and doughnut charts.

    • setFirstSliceAngle

      void setFirstSliceAngle(int value)
      Sets the angle of the first pie-chart or doughnut-chart slice in degrees (clockwise from vertical). Applies only to pie, 3-D pie, and doughnut charts.

    • getGapWidth

      int getGapWidth()
      Gets the gap width. Bar and Column charts: Gets or sets the space between bar or column clusters as a percentage of the bar or column width. Pie of Pie and Bar of Pie charts: Gets or sets the space between the primary and secondary sections of the chart.

    • setGapWidth

      void setGapWidth(int value)
      Sets the gap width. Bar and Column charts: Gets or sets the space between bar or column clusters as a percentage of the bar or column width. Pie of Pie and Bar of Pie charts: Gets or sets the space between the primary and secondary sections of the chart.

    • getHasDropLines

      boolean getHasDropLines()
      Gets whether the chart has drop lines (True if the line chart or area chart has drop lines). Applies only to line and area charts.

    • setHasDropLines

      void setHasDropLines(boolean value)
      Sets whether the chart has drop lines (True if the line chart or area chart has drop lines). Applies only to line and area charts.

    • getHasHiLoLines

      boolean getHasHiLoLines()
      Gets whether the line chart has high-low lines (True if the line chart has high-low lines). Applies only to line charts.

    • setHasHiLoLines

      void setHasHiLoLines(boolean value)
      Sets whether the line chart has high-low lines (True if the line chart has high-low lines). Applies only to line charts.

    • getHasSeriesLines

      boolean getHasSeriesLines()
      Gets whether the chart has series lines (True if a stacked column chart or bar chart has series lines or if a Pie of Pie chart or Bar of Pie chart has connector lines between the two sections). Applies only to stacked column charts, bar charts, Pie of Pie charts, or Bar of Pie charts.

    • setHasSeriesLines

      void setHasSeriesLines(boolean value)
      Sets whether the chart has series lines (True if a stacked column chart or bar chart has series lines or if a Pie of Pie chart or Bar of Pie chart has connector lines between the two sections). Applies only to stacked column charts, bar charts, Pie of Pie charts, or Bar of Pie charts.

    • getHasUpDownBars

      boolean getHasUpDownBars()
      Gets whether the line chart has up and down bars (True if a line chart has up and down bars). Applies only to line charts.

    • setHasUpDownBars

      void setHasUpDownBars(boolean value)
      Sets whether the line chart has up and down bars (True if a line chart has up and down bars). Applies only to line charts.

    • getHiLoLines

      IChartLines getHiLoLines()
      Returns a IChartLines object that represents thehigh-low lines for a series on a line chart. Applies only to line charts.

    • getOverlap

      int getOverlap()
      Gets how bars and columns are positioned. Can be a value between –100 and 100. Applies only to 2-D bar and 2-D column charts.

    • setOverlap

      void setOverlap(int value)
      Sets how bars and columns are positioned. Can be a value between –100 and 100. Applies only to 2-D bar and 2-D column charts.

    • getSecondPlotSize

      int getSecondPlotSize()
      Gets the size of the secondary section of either a Pie of Pie chart or a Bar of Pie chart, as a percentage of the size of the primary pie. Can be a value from 5 to 200.

    • setSecondPlotSize

      void setSecondPlotSize(int value)
      Sets the size of the secondary section of either a Pie of Pie chart or a Bar of Pie chart, as a percentage of the size of the primary pie. Can be a value from 5 to 200.

    • getSeriesLines

      IChartLines getSeriesLines()
      Returns the IChartLines object that represents the series lines for astacked bar chart or a stacked column chart. Applies only to stacked bar and stacked column charts.

    • getShowNegativeBubbles

      boolean getShowNegativeBubbles()
      Gets whether to show negative bubbles (True if negative bubbles are shown for the chart group). Valid only for bubble charts.

    • setShowNegativeBubbles

      void setShowNegativeBubbles(boolean value)
      Sets whether to show negative bubbles (True if negative bubbles are shown for the chart group). Valid only for bubble charts.

    • getSizeRepresents

      SizeRepresents getSizeRepresents()
      Sets what the bubble size represents on a bubble chart. Can be either of the following SizeRepresents constants: SizeIsArea or SizeIsWidth.

    • setSizeRepresents

      void setSizeRepresents(SizeRepresents value)
      Gets what the bubble size represents on a bubble chart. Can be either of the following SizeRepresents constants: SizeIsArea or SizeIsWidth.

    • getSplitType

      ChartSplitType getSplitType()
      Gets the way the two sections of either a Pie of Pie chart or a Bar of Pie chart are split.

    • setSplitType

      void setSplitType(ChartSplitType value)
      Sets the way the two sections of either a Pie of Pie chart or a Bar of Pie chart are split.

    • getSplitValue

      int getSplitValue()
      Gets the threshold value separating the two sections of either a Pie of Pie chart or a Bar of Pie chart.

    • setSplitValue

      void setSplitValue(int value)
      Sets the threshold value separating the two sections of either a Pie of Pie chart or a Bar of Pie chart.

    • getUpBars

      IChartBars getUpBars()
      Returns an IChartBars object that represents the up bars on a linechart. Applies only to line charts.

    • getVaryByCategories

      boolean getVaryByCategories()
      Gets whether to use a different color or pattern for each data marker (True if Microsoft Excel assigns a different color or pattern to each data marker). The chart must contain only one series.

    • setVaryByCategories

      void setVaryByCategories(boolean value)
      Sets whether to use a different color or pattern for each data marker (True if Microsoft Excel assigns a different color or pattern to each data marker). The chart must contain only one series.

    • getSeriesCollection

      List<ISeries> getSeriesCollection()
      Returns an object that represents a collection of all the series (a ISeries collection) in the chart or chart group.

    • getBinsType

      BinsType getBinsType()
      Gets how the horizontal axis of the histogram chart is formatted.

    • setBinsType

      void setBinsType(BinsType value)
      Sets how the horizontal axis of the histogram chart is formatted.

    • getBinsCountValue

      long getBinsCountValue()
      Gets the number of bins in the histogram chart.

    • setBinsCountValue

      void setBinsCountValue(long value)
      Sets the number of bins in the histogram chart.

    • getBinsOverflowEnabled

      boolean getBinsOverflowEnabled()
      Gets whether a bin for values above the BinsOverflowValue property is enabled.

    • setBinsOverflowEnabled

      void setBinsOverflowEnabled(boolean value)
      Sets whether a bin for values above the BinsOverflowValue property is enabled.

    • getBinsOverflowValue

      double getBinsOverflowValue()
      Gets the value above which an overflow bin is displayed. It only works if the BinsOverflowEnabled property is True.

    • setBinsOverflowValue

      void setBinsOverflowValue(double value)
      Sets the value above which an overflow bin is displayed. It only works if the BinsOverflowEnabled property is True.

    • getBinsUnderflowEnabled

      boolean getBinsUnderflowEnabled()
      Gets whether a bin for values below the BinsUnderflowValue property is enabled.

    • setBinsUnderflowEnabled

      void setBinsUnderflowEnabled(boolean value)
      Sets whether a bin for values below the BinsUnderflowValue property is enabled.

    • getBinsUnderflowValue

      double getBinsUnderflowValue()
      Gets the value below which an underflow bin is displayed. It only works if the BinsUnderflowEnabled property is True.

    • setBinsUnderflowValue

      void setBinsUnderflowValue(double value)
      Sets the value below which an underflow bin is displayed. It only works if the BinsUnderflowEnabled property is True.

    • getBinWidthValue

      double getBinWidthValue()
      Gets the number of points in each range.

    • setBinWidthValue

      void setBinWidthValue(double value)
      Sets the number of points in each range.