Method Details

• getParent

  IChart getParent()

  Gets the parent IChart that contains this chart group.

  Use this method to access the chart that owns the current chart group after retrieving the group from IChart.getChartGroups().

  
   worksheet.getRange("A1:B3").setValue(new Object[][] {
       {"Month", "Sales"},
       {"Jan", 100},
       {"Feb", 120}
   });
   IChart chart = worksheet.getShapes().addChart(ChartType.ColumnClustered, 20, 20, 300, 200).getChart();
   chart.getSeriesCollection().add(worksheet.getRange("A1:B3"));
   IChart parent = chart.getChartGroups().get(0).getParent();
   

  Returns:

  The parent IChart of this chart group.

• getAxisGroup

  AxisGroup getAxisGroup()

  Gets the axis group of the chart group.

  The returned AxisGroup value indicates whether the chart group is plotted on the primary axis group or the secondary axis group.

  
   worksheet.getRange("A1:B3").setValue(new Object[][] {
       {"Month", "Sales"},
       {"Jan", 100},
       {"Feb", 120}
   });
   IChart chart = worksheet.getShapes().addChart(ChartType.ColumnClustered, 20, 20, 300, 200).getChart();
   chart.getSeriesCollection().add(worksheet.getRange("A1:B3"));
   IChartGroup chartGroup = chart.getChartGroups().get(0);
   AxisGroup axisGroup = chartGroup.getAxisGroup();
   

  Returns:

  The AxisGroup of the chart group.

• setAxisGroup

  void setAxisGroup(AxisGroup value)

  Sets the axis group of the chart group.

  Use this method to plot the chart group on either the primary axis group or the secondary axis group.

  
   IChart chart = worksheet.getShapes().addChart(ChartType.ColumnClustered, 20, 20, 300, 200).getChart();
   IChartGroup chartGroup = chart.getChartGroups().get(0);
   chartGroup.setAxisGroup(AxisGroup.Secondary);
   AxisGroup axisGroup = chartGroup.getAxisGroup();
   

  Parameters:

  value - The AxisGroup to assign to the chart group.

• getBubbleScale

  int getBubbleScale()

  Gets the scale factor for bubbles in the specified chart group.

  The returned value is an integer from 0 to 300, representing a percentage of the default bubble size. This property applies only to bubble charts.

  
   worksheet.getRange("A1:C4").setValue(new Object[][] {
       {1, 2, 10},
       {2, 3, 20},
       {3, 5, 30},
       {4, 4, 25}
   });
   IChart chart = worksheet.getShapes().addChart(ChartType.Bubble, 20, 20, 300, 200).getChart();
   chart.getSeriesCollection().add(worksheet.getRange("A1:C4"));
   IChartGroup chartGroup = chart.getChartGroups().get(0);
   int bubbleScale = chartGroup.getBubbleScale();
   

  Returns:

  The bubble scale as a percentage of the default bubble size, from 0 to 300.

• setBubbleScale

  void setBubbleScale(int value)

  Sets the scale factor for bubbles in the specified chart group.

  The value must be an integer from 0 to 300, representing a percentage of the default bubble size. This property applies only to bubble charts.

  
   worksheet.getRange("A1:C4").setValue(new Object[][] {
       {1, 2, 10},
       {2, 3, 20},
       {3, 5, 30},
       {4, 4, 25}
   });
   IChart chart = worksheet.getShapes().addChart(ChartType.Bubble, 20, 20, 300, 200).getChart();
   chart.getSeriesCollection().add(worksheet.getRange("A1:C4"));
   IChartGroup chartGroup = chart.getChartGroups().get(0);
   chartGroup.setBubbleScale(0);
   

  Parameters:

  value - The bubble scale as a percentage of the default bubble size, from 0 to 300.

• 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, from 10 to 90.

  
   worksheet.getRange("A1:B4").setValue(new Object[][] {
       {"Category", "Sales"},
       {"North", 10},
       {"South", 20},
       {"West", 15}
   });
   IChart chart = worksheet.getShapes().addChart(ChartType.Doughnut, 20, 20, 300, 200).getChart();
   chart.getSeriesCollection().add(worksheet.getRange("A1:B4"));
   IChartGroup doughnutGroup = chart.getDoughnutGroups().get(0);
   int holeSize = doughnutGroup.getDoughnutHoleSize();
   

  Returns:

  The hole size of the doughnut chart group, expressed as a percentage of the chart size, from 10 to 90.

• 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, from 10 to 90.

  
   worksheet.getRange("A1:B4").setValue(new Object[][] {
       {"Category", "Sales"},
       {"North", 10},
       {"South", 20},
       {"West", 15}
   });
   IChart chart = worksheet.getShapes().addChart(ChartType.Doughnut, 20, 20, 300, 200).getChart();
   chart.getSeriesCollection().add(worksheet.getRange("A1:B4"));
   IChartGroup doughnutGroup = chart.getDoughnutGroups().get(0);
   doughnutGroup.setDoughnutHoleSize(10);
   

  Parameters:

  value - The hole size of the doughnut chart group, expressed as a percentage of the chart size, from 10 to 90.

• getDownBars

  IChartBars getDownBars()

  Gets the down bars for a line chart group.

  The returned IChartBars object represents the bars drawn for points where one line series decreases relative to another. This property applies only to line charts.

  
   worksheet.getRange("A1:C4").setValue(new Object[][] {
       {"Month", "Planned", "Actual"},
       {"Jan", 10, 14},
       {"Feb", 18, 12},
       {"Mar", 15, 20}
   });
   IChart chart = worksheet.getShapes().addChart(ChartType.Line, 20, 20, 300, 200).getChart();
   chart.getSeriesCollection().add(worksheet.getRange("A1:C4"), RowCol.Columns, true, true);
   IChartGroup chartGroup = chart.getLineGroups().get(0);
   chartGroup.setHasUpDownBars(true);
   IChartBars downBars = chartGroup.getDownBars();
   

  Returns:

  The IChartBars object that represents the down bars on the line chart.

• getDropLines

  IChartLines getDropLines()

  Gets the IChartLines object that represents the drop lines for a series on a line chart or area chart.

  This property applies only to line charts and area charts. Use setHasDropLines(boolean) to show or hide the drop lines before accessing their formatting.

  
   worksheet.getRange("A1:C4").setValue(new Object[][] {
       {"Month", "North", "South"},
       {"Jan", 10, 14},
       {"Feb", 18, 12},
       {"Mar", 15, 20}
   });
   IChart chart = worksheet.getShapes().addChart(ChartType.Line, 20, 20, 300, 200).getChart();
   chart.getSeriesCollection().add(worksheet.getRange("A1:C4"), RowCol.Columns, true, true);
   IChartGroup chartGroup = chart.getLineGroups().get(0);
   chartGroup.setHasDropLines(true);
   IChartLines dropLines = chartGroup.getDropLines();
   dropLines.getFormat().getLine().getColor().setRGB(Color.GetBlue());
   

  Returns:

  The IChartLines object that represents the drop lines for the current chart group.

• getFirstSliceAngle

  int getFirstSliceAngle()

  Gets the angle of the first pie-chart or doughnut-chart slice in degrees.

  The angle is measured clockwise from the vertical direction. This property applies only to pie, 3-D pie, and doughnut charts. Use setFirstSliceAngle(int) to change the starting angle of the first slice.

  
   worksheet.getRange("A1:B3").setValue(new Object[][] {
       {"Category", "Value"}, {"A", 30}, {"B", 70}
   });
   IShape shape = worksheet.getShapes().addChart(ChartType.Doughnut, 20, 20, 300, 200);
   shape.getChart().getSeriesCollection().add(worksheet.getRange("A1:B3"), RowCol.Columns, true, true);
   shape.getChart().getChartGroups().get(0).setFirstSliceAngle(45);
   int angle = shape.getChart().getChartGroups().get(0).getFirstSliceAngle();
   

  Returns:

  The angle of the first slice, in degrees measured clockwise from vertical.

• setFirstSliceAngle

  void setFirstSliceAngle(int value)

  Sets the angle of the first pie-chart or doughnut-chart slice in degrees.

  
   worksheet.getRange("A1:B3").setValue(new Object[][] {
       {"Category", "Value"}, {"A", 30}, {"B", 70}
   });
   IShape shape = worksheet.getShapes().addChart(ChartType.Doughnut, 20, 20, 300, 200);
   shape.getChart().getSeriesCollection().add(worksheet.getRange("A1:B3"), RowCol.Columns, true, true);
   shape.getChart().getChartGroups().get(0).setFirstSliceAngle(45);
   

  Parameters:

  value - The angle of the first slice, in degrees measured clockwise from vertical.

• getGapWidth

  int getGapWidth()

  Gets the gap width for the chart group.

  For bar and column charts, the gap width specifies the space between bar or column clusters as a percentage of the bar or column width. For Pie of Pie and Bar of Pie charts, it specifies the space between the primary and secondary sections of the chart.

  
   worksheet.getRange("A1:B4").setValue(new Object[][] {
       {"Category", "Sales"},
       {"North", 10},
       {"South", 20},
       {"West", 15}
   });
   IChart chart = worksheet.getShapes().addChart(ChartType.ColumnClustered, 20, 20, 300, 200).getChart();
   chart.getSeriesCollection().add(worksheet.getRange("A1:B4"), RowCol.Columns, true, true);
   chart.getChartGroups().get(0).setGapWidth(150);
   int gapWidth = chart.getChartGroups().get(0).getGapWidth();
   

  Returns:

  The gap width of the chart group.

• setGapWidth

  void setGapWidth(int value)

  Sets the gap width for the chart group.

  For bar and column charts, the gap width specifies the space between bar or column clusters as a percentage of the bar or column width. For Pie of Pie and Bar of Pie charts, it specifies the space between the primary and secondary sections of the chart.

  
   worksheet.getRange("A1:B4").setValue(new Object[][] {
       {"Category", "Sales"},
       {"North", 10},
       {"South", 20},
       {"West", 15}
   });
   IChart chart = worksheet.getShapes().addChart(ChartType.ColumnClustered, 20, 20, 300, 200).getChart();
   chart.getSeriesCollection().add(worksheet.getRange("A1:B4"), RowCol.Columns, true, true);
   chart.getChartGroups().get(0).setGapWidth(150);
   

  Parameters:

  value - The gap width of the chart group.

• getHasDropLines

  boolean getHasDropLines()

  Gets whether the chart group has drop lines.

  This property applies only to line charts and area charts. Use setHasDropLines(boolean) to enable or disable drop lines for the current chart group.

  
   worksheet.getRange("A1:C4").setValue(new Object[][] {
       {"Month", "North", "South"},
       {"Jan", 10, 14},
       {"Feb", 18, 12},
       {"Mar", 15, 20}
   });
   IChart chart = worksheet.getShapes().addChart(ChartType.Line, 20, 20, 300, 200).getChart();
   chart.getSeriesCollection().add(worksheet.getRange("A1:C4"), RowCol.Columns, true, true);
   IChartGroup chartGroup = chart.getLineGroups().get(0);
   chartGroup.setHasDropLines(true);
   boolean hasDropLines = chartGroup.getHasDropLines();
   

  Returns:

  true if the chart group has drop lines; otherwise, false.

• setHasDropLines

  void setHasDropLines(boolean value)

  Sets whether the chart group has drop lines.

  
   worksheet.getRange("A1:C4").setValue(new Object[][] {
       {"Month", "North", "South"},
       {"Jan", 10, 14},
       {"Feb", 18, 12},
       {"Mar", 15, 20}
   });
   IChart chart = worksheet.getShapes().addChart(ChartType.Line, 20, 20, 300, 200).getChart();
   chart.getSeriesCollection().add(worksheet.getRange("A1:C4"), RowCol.Columns, true, true);
   IChartGroup chartGroup = chart.getLineGroups().get(0);
   chartGroup.setHasDropLines(true);
   

  Parameters:

  value - true if the chart group has drop lines; otherwise, false.

• getHasHiLoLines

  boolean getHasHiLoLines()

  Gets whether the line chart has high-low lines.

  This property applies only to line charts. Use setHasHiLoLines(boolean) to show or hide high-low lines for the current chart group.

  
   worksheet.getRange("A1:C4").setValue(new Object[][] {
       {"Month", "Series 1", "Series 2"},
       {"Jan", 10, 14},
       {"Feb", 18, 12},
       {"Mar", 15, 20}
   });
   IChart chart = worksheet.getShapes().addChart(ChartType.Line, 20, 20, 300, 200).getChart();
   chart.getSeriesCollection().add(worksheet.getRange("A1:C4"), RowCol.Columns, true, true);
   IChartGroup chartGroup = chart.getLineGroups().get(0);
   chartGroup.setHasHiLoLines(true);
   boolean hasHiLoLines = chartGroup.getHasHiLoLines();
   

  Returns:

  true if the line chart has high-low lines; otherwise, false.

• setHasHiLoLines

  void setHasHiLoLines(boolean value)

  Sets whether the line chart has high-low lines.

  
   worksheet.getRange("A1:C4").setValue(new Object[][] {
       {"Month", "Series 1", "Series 2"},
       {"Jan", 10, 14},
       {"Feb", 18, 12},
       {"Mar", 15, 20}
   });
   IChart chart = worksheet.getShapes().addChart(ChartType.Line, 20, 20, 300, 200).getChart();
   chart.getSeriesCollection().add(worksheet.getRange("A1:C4"), RowCol.Columns, true, true);
   IChartGroup chartGroup = chart.getLineGroups().get(0);
   chartGroup.setHasHiLoLines(true);
   

  Parameters:

  value - true if the line chart has high-low lines; otherwise, false.

• getHasSeriesLines

  boolean getHasSeriesLines()

  Gets whether the chart group has series lines.

  Returns true if a stacked column chart or bar chart displays series lines, or if a Pie of Pie chart or Bar of Pie chart displays connector lines between the two sections. This property applies only to stacked column charts, bar charts, Pie of Pie charts, and Bar of Pie charts.

  
   worksheet.getRange("A1:B3").setValue(new Object[][] {
       {"Category", "Value"},
       {"A", 30},
       {"B", 70}
   });
   IChart chart = worksheet.getShapes().addChart(ChartType.BarOfPie, 20, 20, 300, 200).getChart();
   chart.getSeriesCollection().add(worksheet.getRange("A1:B3"));
   chart.getChartGroups().get(0).setHasSeriesLines(true);
   boolean hasSeriesLines = chart.getChartGroups().get(0).getHasSeriesLines();
   

  Returns:

  true if the chart group has series lines or connector lines; otherwise, false.

• setHasSeriesLines

  void setHasSeriesLines(boolean value)

  Sets whether the chart group has series lines.

  Set value to true to display series lines for a stacked column chart or bar chart, or connector lines between the two sections of a Pie of Pie chart or Bar of Pie chart. This property applies only to stacked column charts, bar charts, Pie of Pie charts, and Bar of Pie charts.

  
   worksheet.getRange("A1:B3").setValue(new Object[][] {
       {"Category", "Value"},
       {"A", 30},
       {"B", 70}
   });
   IChart chart = worksheet.getShapes().addChart(ChartType.BarOfPie, 20, 20, 300, 200).getChart();
   chart.getSeriesCollection().add(worksheet.getRange("A1:B3"));
   chart.getChartGroups().get(0).setHasSeriesLines(true);
   

  Parameters:

  value - true if the chart group has series lines or connector lines; otherwise, false.

• getHasUpDownBars

  boolean getHasUpDownBars()

  Gets whether the line chart has up and down bars.

  This property applies only to line charts. Use setHasUpDownBars(boolean) to show or hide up and down bars for the current chart group before accessing related formatting through getUpBars() or getDownBars().

  
   worksheet.getRange("A1:C4").setValue(new Object[][] {
       {"Month", "Series 1", "Series 2"},
       {"Jan", 10, 14},
       {"Feb", 18, 12},
       {"Mar", 15, 20}
   });
   IChart chart = worksheet.getShapes().addChart(ChartType.Line, 20, 20, 300, 200).getChart();
   chart.getSeriesCollection().add(worksheet.getRange("A1:C4"), RowCol.Columns, true, true);
   IChartGroup chartGroup = chart.getLineGroups().get(0);
   chartGroup.setHasUpDownBars(true);
   boolean hasUpDownBars = chartGroup.getHasUpDownBars();
   

  Returns:

  true if the line chart has up and down bars; otherwise, false.

• setHasUpDownBars

  void setHasUpDownBars(boolean value)

  Sets whether the line chart has up and down bars.

  
   worksheet.getRange("A1:C4").setValue(new Object[][] {
       {"Month", "Series 1", "Series 2"},
       {"Jan", 10, 14},
       {"Feb", 18, 12},
       {"Mar", 15, 20}
   });
   IChart chart = worksheet.getShapes().addChart(ChartType.Line, 20, 20, 300, 200).getChart();
   chart.getSeriesCollection().add(worksheet.getRange("A1:C4"), RowCol.Columns, true, true);
   IChartGroup chartGroup = chart.getLineGroups().get(0);
   chartGroup.setHasUpDownBars(true);
   

  Parameters:

  value - true if the line chart has up and down bars; otherwise, false.

• getHiLoLines

  IChartLines getHiLoLines()

  Gets the IChartLines object that represents the high-low lines for a series on a line chart.

  This property applies only to line charts. Use setHasHiLoLines(boolean) to show or hide the high-low lines before accessing their formatting.

  
   worksheet.getRange("A1:C4").setValue(new Object[][] {
       {"Month", "Series 1", "Series 2"},
       {"Jan", 10, 14},
       {"Feb", 18, 12},
       {"Mar", 15, 20}
   });
   IChart chart = worksheet.getShapes().addChart(ChartType.Line, 20, 20, 300, 200).getChart();
   chart.getSeriesCollection().add(worksheet.getRange("A1:C4"), RowCol.Columns, true, true);
   IChartGroup chartGroup = chart.getLineGroups().get(0);
   chartGroup.setHasHiLoLines(true);
   IChartLines hiLoLines = chartGroup.getHiLoLines();
   hiLoLines.getFormat().getLine().getColor().setRGB(Color.GetRed());
   

  Returns:

  The IChartLines object that represents the high-low lines for the current chart group. Returns null if high-low lines are not enabled.

• getOverlap

  int getOverlap()

  Gets how bars and columns are positioned in the chart group.

  The returned value can be between -100 and 100. This property applies only to 2-D bar charts and 2-D column charts.

  
   worksheet.getRange("A1:C4").setValue(new Object[][] {
       {"Month", "Sales", "Target"},
       {"Jan", 10, 12},
       {"Feb", 14, 11},
       {"Mar", 16, 15}
   });
   IChart chart = worksheet.getShapes().addChart(ChartType.ColumnClustered, 20, 20, 300, 200).getChart();
   chart.getSeriesCollection().add(worksheet.getRange("A1:C4"), RowCol.Columns, true, true);
   IChartGroup chartGroup = chart.getColumnGroups().get(0);
   int overlap = chartGroup.getOverlap();
   

  Returns:

  An integer that specifies how bars and columns are positioned in the chart group.

• setOverlap

  void setOverlap(int value)

  Sets how bars and columns are positioned in the chart group.

  The value can be between -100 and 100. This property applies only to 2-D bar charts and 2-D column charts.

  
   worksheet.getRange("A1:C4").setValue(new Object[][] {
       {"Month", "Sales", "Target"},
       {"Jan", 10, 12},
       {"Feb", 14, 11},
       {"Mar", 16, 15}
   });
   IChart chart = worksheet.getShapes().addChart(ChartType.ColumnClustered, 20, 20, 300, 200).getChart();
   chart.getSeriesCollection().add(worksheet.getRange("A1:C4"), RowCol.Columns, true, true);
   IChartGroup chartGroup = chart.getColumnGroups().get(0);
   chartGroup.setOverlap(0);
   

  Parameters:

  value - An integer that specifies how bars and columns are positioned in the chart group.

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

  This property applies to Pie of Pie charts and Bar of Pie charts. The returned value is between 5 and 200.

  
   worksheet.getRange("A1:B4").setValue(new Object[][] {
       {"Name", "Sales"},
       {"East", 35},
       {"West", 25},
       {"North", 40}
   });
   IChart chart = worksheet.getShapes().addChart(ChartType.BarOfPie, 20, 20, 300, 200).getChart();
   chart.getSeriesCollection().add(worksheet.getRange("A1:B4"), RowCol.Columns, true, true);
   IChartGroup chartGroup = chart.getChartGroups().get(0);
   int secondPlotSize = chartGroup.getSecondPlotSize();
   

  Returns:

  The size of the secondary section as a percentage of the size of the primary pie.

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

  This property applies to Pie of Pie charts and Bar of Pie charts. The value must be between 5 and 200.

  
   worksheet.getRange("A1:B4").setValue(new Object[][] {
       {"Name", "Sales"},
       {"East", 35},
       {"West", 25},
       {"North", 40}
   });
   IChart chart = worksheet.getShapes().addChart(ChartType.BarOfPie, 20, 20, 300, 200).getChart();
   chart.getSeriesCollection().add(worksheet.getRange("A1:B4"), RowCol.Columns, true, true);
   IChartGroup chartGroup = chart.getChartGroups().get(0);
   chartGroup.setSecondPlotSize(75);
   

  Parameters:

  value - The size of the secondary section as a percentage of the size of the primary pie.

• getSeriesLines

  IChartLines getSeriesLines()

  Gets the IChartLines object that represents the series lines for the chart group.

  Series lines connect the data values from each series in a stacked bar chart or stacked column chart. This member applies only to stacked bar and stacked column charts. Returns null if series lines are not enabled for the chart group.

  
   worksheet.getRange("A1:C4").setValue(new Object[][] {
       {"Month", "North", "South"},
       {"Jan", 10, 14},
       {"Feb", 18, 12},
       {"Mar", 15, 20}
   });
   IChart chart = worksheet.getShapes().addChart(ChartType.ColumnStacked, 20, 20, 300, 200).getChart();
   chart.getSeriesCollection().add(worksheet.getRange("A1:C4"), RowCol.Columns, true, true);
   IChartGroup chartGroup = chart.getChartGroups().get(0);
   chartGroup.setHasSeriesLines(true);
   IChartLines seriesLines = chartGroup.getSeriesLines();
   seriesLines.getFormat().getLine().getColor().setRGB(Color.GetBlue());
   

  Returns:

  The IChartLines object for the chart group's series lines, or null if series lines are not shown.

• getShowNegativeBubbles

  boolean getShowNegativeBubbles()

  Gets whether negative bubbles are shown for the chart group.

  This property is valid only for bubble charts.

  
   IChart chart = worksheet.getShapes().addChart(ChartType.Bubble, 20, 20, 300, 200).getChart();
   IChartGroup chartGroup = chart.getChartGroups().get(0);
   chartGroup.setShowNegativeBubbles(true);
   boolean showNegativeBubbles = chartGroup.getShowNegativeBubbles();
   

  Returns:

  true if negative bubbles are shown for the chart group; otherwise, false.

• setShowNegativeBubbles

  void setShowNegativeBubbles(boolean value)

  Sets whether negative bubbles are shown for the chart group.

  This property is valid only for bubble charts.

  
   IChart chart = worksheet.getShapes().addChart(ChartType.Bubble, 20, 20, 300, 200).getChart();
   IChartGroup chartGroup = chart.getChartGroups().get(0);
   chartGroup.setShowNegativeBubbles(true);
   

  Parameters:

  value - true if negative bubbles are shown for the chart group; otherwise, false.

• getSizeRepresents

  SizeRepresents getSizeRepresents()

  Gets what the bubble size represents on a bubble chart.

  The returned value indicates whether bubble sizes are interpreted as SizeRepresents.SizeIsArea or SizeRepresents.SizeIsWidth.

  
   IChart chart = worksheet.getShapes().addChart(ChartType.Bubble, 20, 20, 300, 200).getChart();
   IChartGroup chartGroup = chart.getChartGroups().get(0);
   chartGroup.setSizeRepresents(SizeRepresents.SizeIsWidth);
   SizeRepresents sizeRepresents = chartGroup.getSizeRepresents();
   

  Returns:

  A SizeRepresents value that specifies whether bubble sizes represent area or width.

• setSizeRepresents

  void setSizeRepresents(SizeRepresents value)

  Sets what the bubble size represents on a bubble chart.

  Use this method to specify whether bubble sizes are interpreted as SizeRepresents.SizeIsArea or SizeRepresents.SizeIsWidth.

  
   IChart chart = worksheet.getShapes().addChart(ChartType.Bubble, 20, 20, 300, 200).getChart();
   IChartGroup chartGroup = chart.getChartGroups().get(0);
   chartGroup.setSizeRepresents(SizeRepresents.SizeIsWidth);
   

  Parameters:

  value - A SizeRepresents value that specifies whether bubble sizes represent area or width.

• getSplitType

  ChartSplitType getSplitType()

  Gets the way the two sections of either a Pie of Pie chart or a Bar of Pie chart are split.

  Use this method to determine which split rule is currently applied to the chart group.

  
   worksheet.getRange("A1:B6").setValue(new Object[][]{
       {"Category", "Value"},
       {"North", 45},
       {"South", 12},
       {"East", 18},
       {"West", 8},
       {"Other", 5}
   });
   IChart chart = worksheet.getShapes().addChart(ChartType.PieOfPie, 20, 20, 300, 200).getChart();
   chart.getSeriesCollection().add(worksheet.getRange("A1:B6"), RowCol.Columns, true, true);
   IChartGroup chartGroup = chart.getChartGroups().get(0);
   chartGroup.setSplitType(ChartSplitType.SplitByValue);
   ChartSplitType splitType = chartGroup.getSplitType();
   

  Returns:

  The split rule that determines how the primary and secondary sections are separated in a Pie of Pie chart or Bar of Pie chart.

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

  Use this method to control how data points are moved to the second plot. For example, the second plot can be split by position, value, percent value, or a custom split. The threshold used by some split modes can be configured with setSplitValue(int).

  
   worksheet.getRange("A1:B6").setValue(new Object[][]{
       {"Category", "Value"},
       {"North", 45},
       {"South", 12},
       {"East", 18},
       {"West", 8},
       {"Other", 5}
   });
   IChart chart = worksheet.getShapes().addChart(ChartType.BarOfPie, 20, 20, 300, 200).getChart();
   chart.getSeriesCollection().add(worksheet.getRange("A1:B6"), RowCol.Columns, true, true);
   IChartGroup chartGroup = chart.getChartGroups().get(0);
   chartGroup.setSplitType(ChartSplitType.SplitByPercentValue);
   

  Parameters:

  value - The split type that determines how the two sections are divided.

• getSplitValue

  int getSplitValue()

  Gets the threshold value that separates the two sections of a Pie of Pie chart or a Bar of Pie chart.

  This property applies to Pie of Pie charts and Bar of Pie charts. The meaning of the returned value depends on the current split mode configured by getSplitType().

  
   IChart chart = worksheet.getShapes().addChart(ChartType.BarOfPie, 20, 20, 300, 200).getChart();
   IChartGroup chartGroup = chart.getChartGroups().get(0);
   chartGroup.setSplitValue(4);
   int splitValue = chartGroup.getSplitValue();
   

  Returns:

  The threshold value that separates the two chart sections.

• setSplitValue

  void setSplitValue(int value)

  Sets the threshold value that separates the two sections of a Pie of Pie chart or a Bar of Pie chart.

  This property applies to Pie of Pie charts and Bar of Pie charts. The meaning of the value depends on the current split mode configured by getSplitType().

  
   IChart chart = worksheet.getShapes().addChart(ChartType.BarOfPie, 20, 20, 300, 200).getChart();
   IChartGroup chartGroup = chart.getChartGroups().get(0);
   chartGroup.setSplitValue(4);
   

  Parameters:

  value - The threshold value that separates the two chart sections.

• getUpBars

  IChartBars getUpBars()

  Gets the up bars for a line chart group.

  Up bars connect points where the last series in the chart group has a higher value than the first series. This property applies only to line charts.

  
   worksheet.getRange("A1:C4").setValue(new Object[][] {
       {"Month", "Planned", "Actual"},
       {"Jan", 10, 14},
       {"Feb", 18, 12},
       {"Mar", 15, 20}
   });
   IChart chart = worksheet.getShapes().addChart(ChartType.Line, 20, 20, 300, 200).getChart();
   chart.getSeriesCollection().add(worksheet.getRange("A1:C4"), RowCol.Columns, true, true);
   IChartGroup chartGroup = chart.getChartGroups().get(0);
   chartGroup.setHasUpDownBars(true);
   IChartBars upBars = chartGroup.getUpBars();
   

  Returns:

  The IChartBars object that represents the up bars in the chart group.

• getVaryByCategories

  boolean getVaryByCategories()

  Gets whether the chart group uses a different color or pattern for each data marker.

  If this property is true, Microsoft Excel assigns a different color or pattern to each data marker. The chart must contain only one series.

  
   IChart chart = worksheet.getShapes().addChart(ChartType.ColumnClustered, 20, 20, 300, 200).getChart();
   IChartGroup chartGroup = chart.getChartGroups().get(0);
   chartGroup.setVaryByCategories(true);
   boolean varyByCategories = chartGroup.getVaryByCategories();
   

  Returns:

  true if the chart group uses a different color or pattern for each data marker; otherwise, false.

• setVaryByCategories

  void setVaryByCategories(boolean value)

  Sets whether the chart group uses a different color or pattern for each data marker.

  If this property is true, Microsoft Excel assigns a different color or pattern to each data marker. The chart must contain only one series.

  
   IChart chart = worksheet.getShapes().addChart(ChartType.ColumnClustered, 20, 20, 300, 200).getChart();
   IChartGroup chartGroup = chart.getChartGroups().get(0);
   chartGroup.setVaryByCategories(true);
   

  Parameters:

  value - true if the chart group uses a different color or pattern for each data marker; otherwise, false.

• getSeriesCollection

  List<ISeries> getSeriesCollection()

  Gets the collection of all series in the chart or chart group.

  Use the returned list to access the ISeries objects that belong to the current chart group.

  
   worksheet.getRange("A1:C4").setValue(new Object[][] {
       {"Month", "Sales", "Target"},
       {"Jan", 10, 12},
       {"Feb", 20, 18},
       {"Mar", 15, 16}
   });
   IChart chart = worksheet.getShapes().addChart(ChartType.ColumnClustered, 20, 20, 300, 200).getChart();
   chart.getSeriesCollection().add(worksheet.getRange("B1:C4"));
   chart.getSeriesCollection().get(1).setChartType(ChartType.Line);
   IChartGroup chartGroup = chart.getChartGroups().get(0);
   List<ISeries> seriesCollection = chartGroup.getSeriesCollection();
   

  Returns:

  The list of all ISeries objects in the chart or chart group.

• getBinsType

  BinsType getBinsType()

  Gets how the horizontal axis of the histogram chart is formatted.

  Use this method to read the current binning mode for a histogram chart group, such as automatic, bin count, bin size, or categorical binning.

  
   worksheet.getRange("A1:A6").setValue(new Object[][] {
       {"Score"},
       {10},
       {12},
       {15},
       {18},
       {22}
   });
   IChart chart = worksheet.getShapes().addChart(ChartType.Histogram, 20, 20, 300, 200).getChart();
   chart.getSeriesCollection().add(worksheet.getRange("A1:A6"));
   IChartGroup chartGroup = chart.getChartGroups().get(0);
   chartGroup.setBinsType(BinsType.BinsTypeBinCount);
   BinsType binsType = chartGroup.getBinsType();
   

  Returns:

  The BinsType that specifies how the horizontal axis of the histogram chart is formatted.

• setBinsType

  void setBinsType(BinsType value)

  Sets how the horizontal axis bins are configured for a histogram chart.

  Use this method to control whether the chart groups values automatically, by bin count, by bin size, manually, or by category.

  
   worksheet.getRange("A1:A6").setValue(new Object[][] {
       {12},
       {18},
       {25},
       {31},
       {44},
       {52}
   });
   IChart chart = worksheet.getShapes().addChart(ChartType.Histogram, 20, 20, 300, 200).getChart();
   chart.getSeriesCollection().add(worksheet.getRange("A1:A6"));
   IChartGroup chartGroup = chart.getChartGroups().get(0);
   chartGroup.setBinsType(BinsType.BinsTypeBinCount);
   

  Parameters:

  value - The binning mode for the horizontal axis. This value determines how histogram bins are calculated.

• getBinsCountValue

  long getBinsCountValue()

  Gets the number of bins in the histogram chart.

  Use this method to read the current bin count configured for a histogram chart group.

  
   worksheet.getRange("A1:A6").setValue(new Object[][] {
       {"Score"},
       {10},
       {12},
       {15},
       {18},
       {22}
   });
   IChart chart = worksheet.getShapes().addChart(ChartType.Histogram, 20, 20, 300, 200).getChart();
   chart.getSeriesCollection().add(worksheet.getRange("A1:A6"));
   IChartGroup chartGroup = chart.getChartGroups().get(0);
   chartGroup.setBinsType(BinsType.BinsTypeBinCount);
   chartGroup.setBinsCountValue(4);
   long binsCount = chartGroup.getBinsCountValue();
   

  Returns:

  The number of bins in the histogram chart.

• setBinsCountValue

  void setBinsCountValue(long value)

  Sets the number of bins in the histogram chart.

  Use this method to set the bin count configured for a histogram chart group.

  
   worksheet.getRange("A1:A6").setValue(new Object[][] {
       {"Score"},
       {10},
       {12},
       {15},
       {18},
       {22}
   });
   IChart chart = worksheet.getShapes().addChart(ChartType.Histogram, 20, 20, 300, 200).getChart();
   chart.getSeriesCollection().add(worksheet.getRange("A1:A6"));
   IChartGroup chartGroup = chart.getChartGroups().get(0);
   chartGroup.setBinsType(BinsType.BinsTypeBinCount);
   chartGroup.setBinsCountValue(4);
   

  Parameters:

  value - The number of bins in the histogram chart.

• getBinsOverflowEnabled

  boolean getBinsOverflowEnabled()

  Gets whether a bin for values above the getBinsOverflowValue() property is enabled.

  This property applies to histogram charts and indicates whether values greater than the overflow threshold are grouped into a separate overflow bin.

  
   worksheet.getRange("A1:A6").setValue(new Object[][] {
       {"Score"},
       {10},
       {12},
       {15},
       {18},
       {22}
   });
   IChart chart = worksheet.getShapes().addChart(ChartType.Histogram, 20, 20, 300, 200).getChart();
   chart.getSeriesCollection().add(worksheet.getRange("A1:A6"));
   IChartGroup chartGroup = chart.getChartGroups().get(0);
   chartGroup.setBinsOverflowValue(20);
   chartGroup.setBinsOverflowEnabled(true);
   boolean overflowEnabled = chartGroup.getBinsOverflowEnabled();
   

  Returns:

  true if the overflow bin is enabled; otherwise, false.

• setBinsOverflowEnabled

  void setBinsOverflowEnabled(boolean value)

  Sets whether a bin for values above the getBinsOverflowValue() property is enabled.

  Set value to true to group values greater than the overflow threshold into a separate overflow bin, or false to disable the overflow bin.

  
   worksheet.getRange("A1:A6").setValue(new Object[][] {
       {"Score"},
       {10},
       {12},
       {15},
       {18},
       {22}
   });
   IChart chart = worksheet.getShapes().addChart(ChartType.Histogram, 20, 20, 300, 200).getChart();
   chart.getSeriesCollection().add(worksheet.getRange("A1:A6"));
   IChartGroup chartGroup = chart.getChartGroups().get(0);
   chartGroup.setBinsOverflowValue(20);
   chartGroup.setBinsOverflowEnabled(true);
   

  Parameters:

  value - true if the overflow bin is enabled; otherwise, false.

• getBinsOverflowValue

  double getBinsOverflowValue()

  Gets the value above which an overflow bin is displayed.

  This property applies when getBinsOverflowEnabled() returns true.

  
   worksheet.getRange("A1:A6").setValue(new Object[][] {
       {"Score"},
       {10},
       {12},
       {15},
       {18},
       {22}
   });
   IChart chart = worksheet.getShapes().addChart(ChartType.Histogram, 20, 20, 300, 200).getChart();
   chart.getSeriesCollection().add(worksheet.getRange("A1:A6"));
   IChartGroup chartGroup = chart.getChartGroups().get(0);
   chartGroup.setBinsOverflowEnabled(true);
   chartGroup.setBinsOverflowValue(20.0);
   double overflowValue = chartGroup.getBinsOverflowValue();
   

  Returns:

  The threshold value above which an overflow bin is displayed.

• setBinsOverflowValue

  void setBinsOverflowValue(double value)

  Sets the value above which an overflow bin is displayed.

  This property applies when getBinsOverflowEnabled() returns true.

  
   worksheet.getRange("A1:A6").setValue(new Object[][] {
       {"Score"},
       {10},
       {12},
       {15},
       {18},
       {22}
   });
   IChart chart = worksheet.getShapes().addChart(ChartType.Histogram, 20, 20, 300, 200).getChart();
   chart.getSeriesCollection().add(worksheet.getRange("A1:A6"));
   IChartGroup chartGroup = chart.getChartGroups().get(0);
   chartGroup.setBinsOverflowEnabled(true);
   chartGroup.setBinsOverflowValue(20.0);
   

  Parameters:

  value - The threshold value above which an overflow bin is displayed.

• getBinsUnderflowEnabled

  boolean getBinsUnderflowEnabled()

  Gets whether a bin for values below the getBinsUnderflowValue() property is enabled.

  This property applies to histogram charts and indicates whether values less than the underflow threshold are grouped into a separate underflow bin.

  
   worksheet.getRange("A1:A6").setValue(new Object[][] {
       {"Score"},
       {8},
       {10},
       {12},
       {18},
       {24}
   });
   IChart chart = worksheet.getShapes().addChart(ChartType.Histogram, 20, 20, 300, 200).getChart();
   chart.getSeriesCollection().add(worksheet.getRange("A1:A6"));
   IChartGroup chartGroup = chart.getChartGroups().get(0);
   chartGroup.setBinsUnderflowEnabled(true);
   chartGroup.setBinsUnderflowValue(10.0);
   boolean underflowEnabled = chartGroup.getBinsUnderflowEnabled();
   

  Returns:

  true if the underflow bin is enabled; otherwise, false.

• setBinsUnderflowEnabled

  void setBinsUnderflowEnabled(boolean value)

  Sets whether a bin for values below the getBinsUnderflowValue() property is enabled.

  Set value to true to group values less than the underflow threshold into a separate underflow bin, or false to disable the underflow bin.

  
   worksheet.getRange("A1:A6").setValue(new Object[][] {
       {"Score"},
       {8},
       {10},
       {12},
       {18},
       {24}
   });
   IChart chart = worksheet.getShapes().addChart(ChartType.Histogram, 20, 20, 300, 200).getChart();
   chart.getSeriesCollection().add(worksheet.getRange("A1:A6"));
   IChartGroup chartGroup = chart.getChartGroups().get(0);
   chartGroup.setBinsUnderflowValue(10.0);
   chartGroup.setBinsUnderflowEnabled(true);
   

  Parameters:

  value - true if the underflow bin is enabled; otherwise, false.

• getBinsUnderflowValue

  double getBinsUnderflowValue()

  Gets the threshold value below which an underflow bin is displayed.

  This property applies to histogram charts and is used when the underflow bin is enabled through setBinsUnderflowEnabled(boolean).

  
   worksheet.getRange("A1:A6").setValue(new Object[][] {
       {"Score"},
       {8},
       {10},
       {12},
       {18},
       {24}
   });
   IChart chart = worksheet.getShapes().addChart(ChartType.Histogram, 20, 20, 300, 200).getChart();
   chart.getSeriesCollection().add(worksheet.getRange("A1:A6"));
   IChartGroup chartGroup = chart.getChartGroups().get(0);
   chartGroup.setBinsUnderflowEnabled(true);
   chartGroup.setBinsUnderflowValue(10.0);
   double underflowValue = chartGroup.getBinsUnderflowValue();
   

  Returns:

  The threshold value below which an underflow bin is displayed.

• setBinsUnderflowValue

  void setBinsUnderflowValue(double value)

  Sets the threshold value below which an underflow bin is displayed.

  This property applies to histogram charts and is used when the underflow bin is enabled through setBinsUnderflowEnabled(boolean).

  
   worksheet.getRange("A1:A6").setValue(new Object[][] {
       {"Score"},
       {8},
       {10},
       {12},
       {18},
       {24}
   });
   IChart chart = worksheet.getShapes().addChart(ChartType.Histogram, 20, 20, 300, 200).getChart();
   chart.getSeriesCollection().add(worksheet.getRange("A1:A6"));
   IChartGroup chartGroup = chart.getChartGroups().get(0);
   chartGroup.setBinsUnderflowEnabled(true);
   chartGroup.setBinsUnderflowValue(10.0);
   

  Parameters:

  value - The threshold value below which an underflow bin is displayed.

• getBinWidthValue

  double getBinWidthValue()

  Gets the number of points in each range.

  Use this method to read the current range size configured for a histogram chart group.

  
   worksheet.getRange("A1:A6").setValue(new Object[][] {
       {"Score"},
       {10},
       {12},
       {15},
       {18},
       {22}
   });
   IChart chart = worksheet.getShapes().addChart(ChartType.Histogram, 20, 20, 300, 200).getChart();
   chart.getSeriesCollection().add(worksheet.getRange("A1:A6"));
   IChartGroup chartGroup = chart.getChartGroups().get(0);
   chartGroup.setBinsType(BinsType.BinsTypeBinSize);
   chartGroup.setBinWidthValue(3.0);
   double binWidth = chartGroup.getBinWidthValue();
   

  Returns:

  The number of points in each range.

• setBinWidthValue

  void setBinWidthValue(double value)

  Sets the number of points in each range.

  Use this method to set the range size configured for a histogram chart group.

  
   worksheet.getRange("A1:A6").setValue(new Object[][] {
       {"Score"},
       {10},
       {12},
       {15},
       {18},
       {22}
   });
   IChart chart = worksheet.getShapes().addChart(ChartType.Histogram, 20, 20, 300, 200).getChart();
   chart.getSeriesCollection().add(worksheet.getRange("A1:A6"));
   IChartGroup chartGroup = chart.getChartGroups().get(0);
   chartGroup.setBinsType(BinsType.BinsTypeBinSize);
   chartGroup.setBinWidthValue(2.0);
   

  Parameters:

  value - The number of points in each range.