| 
    wxAutoExcel 2.0.0
    
   | 
 
Represents Microsoft Excel ChartGroup object. More...
#include <wxAutoExcelChartGroups.h>
  
Public Member Functions | |
| wxExcelCategoryCollection | CategoryCollection () | 
| Returns an object that represents a collection of all of the visible categories (a CategoryCollection collection) in the chart group.   | |
| wxExcelCategoryCollection | FullCategoryCollection () | 
| Returns an object that represents a collection of all of the visible and filtered categories (a CategoryCollection collection) in the chart group.   | |
| wxExcelSeriesCollection | SeriesCollection () | 
| Returns an object that represents either a single series (a Series object) or a collection of all the series (a SeriesCollection collection) in the chart or chart group.   | |
| XlAxisGroup | GetAxisGroup () | 
| Returns an XlAxisGroup value that represents the type of axis group.   | |
| long | GetBinsCountValue () | 
| Specifies the number of bins in the histogram chart.   | |
| void | SetBinsCountValue (long value) | 
| Specifies the number of bins in the histogram chart.   | |
| bool | GetBinsOverflowEnabled () | 
| Specifies whether a bin for values above the BinsOverflowValue is enabled.   | |
| void | SetBinsOverflowEnabled (bool enabled) | 
| Specifies whether a bin for values above the BinsOverflowValue is enabled.   | |
| double | GetBinsOverflowValue () | 
| If an BinsOverflowEnabled is True, specifies the value above which an overflow bin is displayed.   | |
| void | SetBinsOverflowValue (double value) | 
| If an BinsOverflowEnabled is True, specifies the value above which an overflow bin is displayed.   | |
| XlBinsType | GetBinsType () | 
| Specifies how the horizontal axis of the histogram chart is formatted, by bins type.   | |
| void | SetBinsType (XlBinsType type) | 
| Specifies how the horizontal axis of the histogram chart is formatted, by bins type.   | |
| bool | GetBinsUnderflowEnabled () | 
| Specifies whether a bin for values below the BinsUnderflowValue is enabled.   | |
| void | SetBinsUnderflowEnabled (bool enabled) | 
| Specifies whether a bin for values below the BinsUnderflowValue is enabled.   | |
| double | GetBinsUnderflowValue () | 
| If an BinsUnderflowEnabled is True, specifies the value below which an underflow bin is displayed.   | |
| void | SetBinsUnderflowValue (double value) | 
| If an BinsUnderflowEnabled is True, specifies the value below which an underflow bin is displayed.   | |
| double | GetBinWidthValue () | 
| Specifies the number of points in each range.   | |
| void | SetBinWidthValue (double value) | 
| Specifies the number of points in each range.   | |
| long | GetBubbleScale () | 
| Returns the scale factor for bubbles in the specified chart group.   | |
| void | SetBubbleScale (long bubbleScale) | 
| Sets the scale factor for bubbles in the specified chart group.   | |
| long | GetDoughnutHoleSize () | 
| Returns the size of the hole in a doughnut chart group.   | |
| wxExcelDownBars | GetDownBars () | 
| Returns a DownBars object that represents the down bars on a line chart.   | |
| wxExcelDropLines | GetDropLines () | 
| Returns a DropLines object that represents the drop lines for a series on a line chart or area chart.   | |
| long | GetFirstSliceAngle () | 
| Returns the angle of the first pie-chart or doughnut-chart slice, in degrees (clockwise from vertical).   | |
| void | SetFirstSliceAngle (long firstSliceAngle) | 
| Sets the angle of the first pie-chart or doughnut-chart slice, in degrees (clockwise from vertical).   | |
| long | GetGapWidth () | 
| Bar and Column charts: Returns or sets the space between bar or column clusters, as a percentage of the bar or column width.   | |
| void | SetGapWidth (long gapWidth) | 
| Bar and Column charts: Returns or sets the space between bar or column clusters, as a percentage of the bar or column width.   | |
| bool | GetHas3DShading () | 
| True if the chart group has three-dimensional shading.   | |
| void | SetHas3DShading (bool has3DShading) | 
| True if the chart group has three-dimensional shading.   | |
| bool | GetHasDropLines () | 
| True if the line chart or area chart has drop lines.   | |
| void | SetHasDropLines (bool hasDropLines) | 
| True if the line chart or area chart has drop lines.   | |
| bool | GetHasHiLoLines () | 
| True if the line chart has high-low lines.   | |
| void | SetHasHiLoLines (bool hasHiLoLines) | 
| True if the line chart has high-low lines.   | |
| bool | GetHasRadarAxisLabels () | 
| True if a radar chart has axis labels.   | |
| void | SetHasRadarAxisLabels (bool hasRadarAxisLabels) | 
| True if a radar chart has axis labels.   | |
| bool | GetHasSeriesLines () | 
| 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 | SetHasSeriesLines (bool hasSeriesLines) | 
| 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.   | |
| bool | GetHasUpDownBars () | 
| True if a line chart has up and down bars.   | |
| void | SetHasUpDownBars (bool hasUpDownBars) | 
| True if a line chart has up and down bars.   | |
| wxExcelHiLoLines | GetHiLoLines () | 
| Returns a HiLoLines object that represents the high-low lines for a series on a line chart.   | |
| long | GetIndex () | 
| Returns a Long value that represents the index number of the object within the collection of similar objects.   | |
| long | GetOverlap () | 
| Specifies how bars and columns are positioned.   | |
| void | SetOverlap (long overlap) | 
| Specifies how bars and columns are positioned.   | |
| wxExcelTickLabels | GetRadarAxisLabels () | 
| Returns a TickLabels object that represents the radar axis labels for the specified chart group.   | |
| long | GetSecondPlotSize () | 
| Returns 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 | SetSecondPlotSize (long secondPlotSize) | 
| 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.   | |
| wxExcelSeriesLines | GetSeriesLines () | 
| Returns a SeriesLines object that represents the series lines for a 2-D stacked bar, 2-D stacked column, pie of pie, or bar of pie chart.   | |
| bool | GetShowNegativeBubbles () | 
| True if negative bubbles are shown for the chart group.   | |
| void | SetShowNegativeBubbles (bool showNegativeBubbles) | 
| True if negative bubbles are shown for the chart group.   | |
| XlSizeRepresents | GetSizeRepresents () | 
| Returns what the bubble size represents on a bubble chart.   | |
| void | SetSizeRepresents (XlSizeRepresents sizeRepresents) | 
| Sets what the bubble size represents on a bubble chart.   | |
| XlChartSplitType | GetSplitType () | 
| Returns the way the two sections of either a pie of pie chart or a bar of pie chart are split.   | |
| void | SetSplitType (XlChartSplitType splitType) | 
| Sets the way the two sections of either a pie of pie chart or a bar of pie chart are split.   | |
| double | GetSplitValue () | 
| Returns the threshold value separating the two sections of either a pie of pie chart or a bar of pie chart.   | |
| void | SetSplitValue (double splitValue) | 
| Sets the threshold value separating the two sections of either a pie of pie chart or a bar of pie chart.   | |
| wxExcelUpBars | GetUpBars () | 
| Returns an UpBars object that represents the up bars on a line chart.   | |
| bool | GetVaryByCategories () | 
| True if Microsoft Excel assigns a different color or pattern to each data marker.   | |
| void | SetVaryByCategories (bool varyByCategories) | 
| True if Microsoft Excel assigns a different color or pattern to each data marker.   | |
| virtual wxString | GetAutoExcelObjectName_ () const | 
| Returns "ChartGroup".   | |
  Public Member Functions inherited from wxAutoExcel::wxExcelObject | |
| bool | IsOk_ () const | 
| Returns true if the object has a valid dispatch.   | |
| wxString | GetAutomationObjectName_ (bool stripUnderscores=false) const | 
| Returns object name as provided by IDispatch->GetTypeInfo()->GetDocumentation(MEMBERID_NIL, &name, NULL, NULL, NULL).   | |
| wxSharedPtr< wxAutomationObject > | GetAutomationObject_ () | 
| Returns the underlying wxAutomationObject.   | |
| operator bool () const | |
| Returns true if the object has a valid dispatch and its last automation call (if any), i.e.   | |
| WXLCID | GetAutomationLCID_ () const | 
| Returns the locale identifier used in automation calls.   | |
| bool | SetAutomationLCID_ (WXLCID lcid) | 
| Sets the locale identifier to be used in automation calls.   | |
| bool | GetPropertyAndMethodNames_ (wxArrayString &propertyNames, wxArrayString &methodNames, bool includeHidden=false) | 
| Returns lists of property and method names the automation interface exposes.   | |
| bool | GetUnimplementedObject_ (const wxString &name, wxAutomationObject &object) | 
| Helper function for receiving an automation object not implemented in wxAutoExcel, see FAQ on how to use.   | |
Additional Inherited Members | |
  Public Types inherited from wxAutoExcel::wxExcelObject | |
| enum | ErrorFlags {  Err_DoNothing = 0 , Err_LogOnInvalidDispatch = 1 , Err_AssertOnInvalidDispatch = 1 << 1 , Err_ThrowOnInvalidDispatch = 1 << 2 , Err_LogOnInvalidArgument = 1 << 3 , Err_AssertOnInvalidArgument = 1 << 4 , Err_ThrowOnInvalidArgument = 1 << 5 , Err_LogOnFailedInvoke = 1 << 6 , Err_AssertOnFailedInvoke = 1 << 7 , Err_ThrowOnFailedInvoke = 1 << 8 , Err_LogOnInvalidReturnType = 1 << 9 , Err_AssertOnInvalidReturnType = 1 << 10 , Err_ThrowOnInvalidReturnType = 1 << 11 , Err_LogOnOtherError = 1 << 12 , Err_AssertOnOtherError = 1 << 13 , Err_ThrowOnOtherError = 1 << 14 }  | 
| Flags affecting the behaviour of wxExcelObject and its descendants when an error occurs during accessing an Excel object property or calling its method.  More... | |
  Static Public Member Functions inherited from wxAutoExcel::wxExcelObject | |
| static unsigned | GetErrorMode_ () | 
| Sets the error mode to the combination of wxExcelObject::ErrorFlags.   | |
| static void | SetErrorMode_ (unsigned mode) | 
| Sets the error mode as the combination of wxExcelObject::ErrorFlags.   | |
| static bool | GetUnimplementedCollectionItem_ (wxAutomationObject &collection, const long index, wxAutomationObject &item, bool asProperty) | 
| Helper function for obtaining an item from MS Excel collection not implemented in wxAutoExcel, see FAQ on how to use.   | |
Represents Microsoft Excel ChartGroup object.
| wxExcelCategoryCollection wxAutoExcel::wxExcelChartGroup::CategoryCollection | ( | ) | 
Returns an object that represents a collection of all of the visible categories (a CategoryCollection collection) in the chart group.
| wxExcelCategoryCollection wxAutoExcel::wxExcelChartGroup::FullCategoryCollection | ( | ) | 
Returns an object that represents a collection of all of the visible and filtered categories (a CategoryCollection collection) in the chart group.
| wxExcelSeriesCollection wxAutoExcel::wxExcelChartGroup::SeriesCollection | ( | ) | 
Returns an object that represents either a single series (a Series object) or a collection of all the series (a SeriesCollection collection) in the chart or chart group.
| XlAxisGroup wxAutoExcel::wxExcelChartGroup::GetAxisGroup | ( | ) | 
Returns an XlAxisGroup value that represents the type of axis group.
| long wxAutoExcel::wxExcelChartGroup::GetBinsCountValue | ( | ) | 
Specifies the number of bins in the histogram chart.
Since Excel 2016.
| void wxAutoExcel::wxExcelChartGroup::SetBinsCountValue | ( | long | value | ) | 
Specifies the number of bins in the histogram chart.
Since Excel 2016.
| bool wxAutoExcel::wxExcelChartGroup::GetBinsOverflowEnabled | ( | ) | 
Specifies whether a bin for values above the BinsOverflowValue is enabled.
Since Excel 2016.
| void wxAutoExcel::wxExcelChartGroup::SetBinsOverflowEnabled | ( | bool | enabled | ) | 
Specifies whether a bin for values above the BinsOverflowValue is enabled.
Since Excel 2016.
| double wxAutoExcel::wxExcelChartGroup::GetBinsOverflowValue | ( | ) | 
If an BinsOverflowEnabled is True, specifies the value above which an overflow bin is displayed.
Since Excel 2016.
| void wxAutoExcel::wxExcelChartGroup::SetBinsOverflowValue | ( | double | value | ) | 
If an BinsOverflowEnabled is True, specifies the value above which an overflow bin is displayed.
Since Excel 2016.
| XlBinsType wxAutoExcel::wxExcelChartGroup::GetBinsType | ( | ) | 
Specifies how the horizontal axis of the histogram chart is formatted, by bins type.
Since Excel 2016.
| void wxAutoExcel::wxExcelChartGroup::SetBinsType | ( | XlBinsType | type | ) | 
Specifies how the horizontal axis of the histogram chart is formatted, by bins type.
Since Excel 2016.
| bool wxAutoExcel::wxExcelChartGroup::GetBinsUnderflowEnabled | ( | ) | 
Specifies whether a bin for values below the BinsUnderflowValue is enabled.
Since Excel 2016.
| void wxAutoExcel::wxExcelChartGroup::SetBinsUnderflowEnabled | ( | bool | enabled | ) | 
Specifies whether a bin for values below the BinsUnderflowValue is enabled.
Since Excel 2016.
| double wxAutoExcel::wxExcelChartGroup::GetBinsUnderflowValue | ( | ) | 
If an BinsUnderflowEnabled is True, specifies the value below which an underflow bin is displayed.
Since Excel 2016.
| void wxAutoExcel::wxExcelChartGroup::SetBinsUnderflowValue | ( | double | value | ) | 
If an BinsUnderflowEnabled is True, specifies the value below which an underflow bin is displayed.
Since Excel 2016.
| double wxAutoExcel::wxExcelChartGroup::GetBinWidthValue | ( | ) | 
Specifies the number of points in each range.
Since Excel 2016.
| void wxAutoExcel::wxExcelChartGroup::SetBinWidthValue | ( | double | value | ) | 
Specifies the number of points in each range.
Since Excel 2016.
| long wxAutoExcel::wxExcelChartGroup::GetBubbleScale | ( | ) | 
Returns 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.
| void wxAutoExcel::wxExcelChartGroup::SetBubbleScale | ( | long | bubbleScale | ) | 
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.
| long wxAutoExcel::wxExcelChartGroup::GetDoughnutHoleSize | ( | ) | 
Returns 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.
| wxExcelDownBars wxAutoExcel::wxExcelChartGroup::GetDownBars | ( | ) | 
Returns a DownBars object that represents the down bars on a line chart.
Applies only to line charts.
| wxExcelDropLines wxAutoExcel::wxExcelChartGroup::GetDropLines | ( | ) | 
Returns a DropLines object that represents the drop lines for a series on a line chart or area chart.
Applies only to line charts or area charts.
| long wxAutoExcel::wxExcelChartGroup::GetFirstSliceAngle | ( | ) | 
Returns 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. Can be a value from 0 through 360.
| void wxAutoExcel::wxExcelChartGroup::SetFirstSliceAngle | ( | long | firstSliceAngle | ) | 
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. Can be a value from 0 through 360.
| long wxAutoExcel::wxExcelChartGroup::GetGapWidth | ( | ) | 
Bar and Column charts: Returns 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: Returns or sets the space between the primary and secondary sections of the chart.
| void wxAutoExcel::wxExcelChartGroup::SetGapWidth | ( | long | gapWidth | ) | 
Bar and Column charts: Returns 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: Returns or sets the space between the primary and secondary sections of the chart.
| bool wxAutoExcel::wxExcelChartGroup::GetHas3DShading | ( | ) | 
True if the chart group has three-dimensional shading.
This property only applies to surface charts and will return a run-time error if you try to set it to a non-surface chart.
| void wxAutoExcel::wxExcelChartGroup::SetHas3DShading | ( | bool | has3DShading | ) | 
True if the chart group has three-dimensional shading.
This property only applies to surface charts and will return a run-time error if you try to set it to a non-surface chart.
| bool wxAutoExcel::wxExcelChartGroup::GetHasDropLines | ( | ) | 
True if the line chart or area chart has drop lines.
Applies only to line and area charts.
| void wxAutoExcel::wxExcelChartGroup::SetHasDropLines | ( | bool | hasDropLines | ) | 
True if the line chart or area chart has drop lines.
Applies only to line and area charts.
| bool wxAutoExcel::wxExcelChartGroup::GetHasHiLoLines | ( | ) | 
True if the line chart has high-low lines.
Applies only to line charts.
| void wxAutoExcel::wxExcelChartGroup::SetHasHiLoLines | ( | bool | hasHiLoLines | ) | 
True if the line chart has high-low lines.
Applies only to line charts.
| bool wxAutoExcel::wxExcelChartGroup::GetHasRadarAxisLabels | ( | ) | 
True if a radar chart has axis labels.
Applies only to radar charts.
| void wxAutoExcel::wxExcelChartGroup::SetHasRadarAxisLabels | ( | bool | hasRadarAxisLabels | ) | 
True if a radar chart has axis labels.
Applies only to radar charts.
| bool wxAutoExcel::wxExcelChartGroup::GetHasSeriesLines | ( | ) | 
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 2-D stacked bar, 2-D stacked column, pie of pie, or bar of pie charts.
| void wxAutoExcel::wxExcelChartGroup::SetHasSeriesLines | ( | bool | hasSeriesLines | ) | 
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 2-D stacked bar, 2-D stacked column, pie of pie, or bar of pie charts.
| bool wxAutoExcel::wxExcelChartGroup::GetHasUpDownBars | ( | ) | 
True if a line chart has up and down bars.
Applies only to line charts.
| void wxAutoExcel::wxExcelChartGroup::SetHasUpDownBars | ( | bool | hasUpDownBars | ) | 
True if a line chart has up and down bars.
Applies only to line charts.
| wxExcelHiLoLines wxAutoExcel::wxExcelChartGroup::GetHiLoLines | ( | ) | 
Returns a HiLoLines object that represents the high-low lines for a series on a line chart.
Applies only to line charts.
| long wxAutoExcel::wxExcelChartGroup::GetIndex | ( | ) | 
Returns a Long value that represents the index number of the object within the collection of similar objects.
| long wxAutoExcel::wxExcelChartGroup::GetOverlap | ( | ) | 
Specifies 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.
| void wxAutoExcel::wxExcelChartGroup::SetOverlap | ( | long | overlap | ) | 
Specifies 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.
| wxExcelTickLabels wxAutoExcel::wxExcelChartGroup::GetRadarAxisLabels | ( | ) | 
Returns a TickLabels object that represents the radar axis labels for the specified chart group.
| long wxAutoExcel::wxExcelChartGroup::GetSecondPlotSize | ( | ) | 
Returns 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.
| void wxAutoExcel::wxExcelChartGroup::SetSecondPlotSize | ( | long | secondPlotSize | ) | 
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.
| wxExcelSeriesLines wxAutoExcel::wxExcelChartGroup::GetSeriesLines | ( | ) | 
Returns a SeriesLines object that represents the series lines for a 2-D stacked bar, 2-D stacked column, pie of pie, or bar of pie chart.
| bool wxAutoExcel::wxExcelChartGroup::GetShowNegativeBubbles | ( | ) | 
True if negative bubbles are shown for the chart group.
Valid only for bubble charts.
| void wxAutoExcel::wxExcelChartGroup::SetShowNegativeBubbles | ( | bool | showNegativeBubbles | ) | 
True if negative bubbles are shown for the chart group.
Valid only for bubble charts.
| XlSizeRepresents wxAutoExcel::wxExcelChartGroup::GetSizeRepresents | ( | ) | 
Returns what the bubble size represents on a bubble chart.
Can be either of the following XlSizeRepresents constants: xlSizeIsArea or xlSizeIsWidth.
| void wxAutoExcel::wxExcelChartGroup::SetSizeRepresents | ( | XlSizeRepresents | sizeRepresents | ) | 
Sets what the bubble size represents on a bubble chart.
Can be either of the following XlSizeRepresents constants: xlSizeIsArea or xlSizeIsWidth.
| XlChartSplitType wxAutoExcel::wxExcelChartGroup::GetSplitType | ( | ) | 
Returns the way the two sections of either a pie of pie chart or a bar of pie chart are split.
Read/write XlChartSplitType.
| void wxAutoExcel::wxExcelChartGroup::SetSplitType | ( | XlChartSplitType | splitType | ) | 
Sets the way the two sections of either a pie of pie chart or a bar of pie chart are split.
Read/write XlChartSplitType.
| double wxAutoExcel::wxExcelChartGroup::GetSplitValue | ( | ) | 
Returns the threshold value separating the two sections of either a pie of pie chart or a bar of pie chart.
Read/write Variant.
| void wxAutoExcel::wxExcelChartGroup::SetSplitValue | ( | double | splitValue | ) | 
Sets the threshold value separating the two sections of either a pie of pie chart or a bar of pie chart.
Read/write Variant.
| wxExcelUpBars wxAutoExcel::wxExcelChartGroup::GetUpBars | ( | ) | 
Returns an UpBars object that represents the up bars on a line chart.
Applies only to line charts.
| bool wxAutoExcel::wxExcelChartGroup::GetVaryByCategories | ( | ) | 
True if Microsoft Excel assigns a different color or pattern to each data marker.
The chart must contain only one series.
| void wxAutoExcel::wxExcelChartGroup::SetVaryByCategories | ( | bool | varyByCategories | ) | 
True if Microsoft Excel assigns a different color or pattern to each data marker.
The chart must contain only one series.
      
  | 
  inlinevirtual | 
Returns "ChartGroup".
Reimplemented from wxAutoExcel::wxExcelObject.