wxAutoExcel 2.0.0
Public Member Functions | List of all members
wxAutoExcel::wxExcelSeries Class Reference

Represents Microsoft Excel Series object. More...

#include <wxAutoExcelSeries.h>

Inheritance diagram for wxAutoExcel::wxExcelSeries:
wxAutoExcel::wxExcelObject

Public Member Functions

void ApplyDataLabels (XlDataLabelsType *type=NULL, wxXlTribool legendKey=wxDefaultXlTribool, wxXlTribool autoText=wxDefaultXlTribool, wxXlTribool hasLeaderLines=wxDefaultXlTribool, wxXlTribool showSeriesName=wxDefaultXlTribool, wxXlTribool showCategoryName=wxDefaultXlTribool, wxXlTribool showValue=wxDefaultXlTribool, wxXlTribool showPercentage=wxDefaultXlTribool, wxXlTribool showBubbleSize=wxDefaultXlTribool, const wxString &separator=wxEmptyString)
 Applies data labels to a series. More...
 
bool ClearFormats ()
 Clears the formatting of the object. More...
 
bool Copy ()
 If the series has a picture fill, then this method copies the picture to the Clipboard. More...
 
wxExcelDataLabels DataLabels ()
 Returns an object that represents either a single data label (a DataLabel object) or a collection of all the data labels for the series (a DataLabels collection). More...
 
bool Delete ()
 Deletes the object. More...
 
bool ErrorBar (XlErrorBarDirection direction, XlErrorBarInclude include, XlErrorBarType type, double *amount=NULL, double *minusValues=NULL)
 Applies error bars to the series. More...
 
bool Paste ()
 Pastes a picture from the Clipboard as the marker on the selected series. More...
 
wxExcelPoints Points ()
 Returns an object that represents a single point (a Point object) or a collection of all the points (a Points collection) in the series. More...
 
bool Select ()
 Selects the object. More...
 
wxExcelTrendlines Trendlines ()
 Returns an object that represents a single trendline (a Trendline object) or a collection of all the trendlines (a Trendlines collection) for the series. More...
 
bool GetApplyPictToEnd ()
 True if a picture is applied to the end of the point or all points in the series. More...
 
void SetApplyPictToEnd (bool applyPictToEnd)
 True if a picture is applied to the end of the point or all points in the series. More...
 
bool GetApplyPictToFront ()
 True if a picture is applied to the front of the point or all points in the series. More...
 
void SetApplyPictToFront (bool applyPictToFront)
 True if a picture is applied to the front of the point or all points in the series. More...
 
bool GetApplyPictToSides ()
 True if a picture is applied to the sides of the point or all points in the series. More...
 
void SetApplyPictToSides (bool applyPictToSides)
 True if a picture is applied to the sides of the point or all points in the series. More...
 
XlAxisGroup GetAxisGroup ()
 Returns an XlAxisGroup value that represents the type of axis group. More...
 
void SetAxisGroup (XlAxisGroup group)
 Sets an XlAxisGroup value that represents the type of axis group. More...
 
XlBarShape GetBarShape ()
 Returns the shape used with the 3-D bar or column chart. More...
 
void SetBarShape (XlBarShape barShape)
 Sets the shape used with the 3-D bar or column chart. More...
 
wxString GetBubbleSizes ()
 Returns a string that refers to the worksheet cells containing the x-value, y-value and size data for the bubble chart. More...
 
void SetBubbleSizes (const wxString &bubbleSizes)
 Sets a string that refers to the worksheet cells containing the x-value, y-value and size data for the bubble chart. More...
 
XlChartType GetChartType ()
 Returns the chart type. More...
 
void SetChartType (XlChartType chartType)
 Sets the chart type. More...
 
wxExcelErrorBars GetErrorBars ()
 Returns an ErrorBars object that represents the error bars for the series. More...
 
long GetExplosion ()
 Returns the explosion value for a pie-chart or doughnut-chart slice. More...
 
void SetExplosion (long explosion)
 Sets the explosion value for a pie-chart or doughnut-chart slice. More...
 
wxExcelChartFormat GetFormat ()
 Returns the ChartFormat object. More...
 
wxString GetFormula ()
 Returns a String value that represents the object's formula in A1-style notation and in the language of the macro. More...
 
void SetFormula (const wxString &formula)
 Sets a String value that represents the object's formula in A1-style notation and in the language of the macro. More...
 
wxString GetFormulaLocal ()
 Returns the formula for the object, using A1-style references in the language of the user. More...
 
void SetFormulaLocal (const wxString &formulaLocal)
 Sets the formula for the object, using A1-style references in the language of the user. More...
 
wxString GetFormulaR1C1 ()
 Returns the formula for the object, using R1C1-style notation in the language of the macro. More...
 
void SetFormulaR1C1 (const wxString &formulaR1C1)
 Sets the formula for the object, using R1C1-style notation in the language of the macro. More...
 
wxString GetFormulaR1C1Local ()
 Returns the formula for the object, using R1C1-style notation in the language of the user. More...
 
void SetFormulaR1C1Local (const wxString &formulaR1C1Local)
 Sets the formula for the object, using R1C1-style notation in the language of the user. More...
 
XlGeoProjectionType GetGeoProjectionType ()
 Specifies the geography projection type for the specified series within the chart group. More...
 
void SetGeoProjectionType (XlGeoProjectionType type)
 Specifies the geography projection type for the specified series within the chart group. More...
 
bool GetHas3DEffect ()
 True if the series has a three-dimensional appearance. More...
 
void SetHas3DEffect (bool has3DEffect)
 True if the series has a three-dimensional appearance. More...
 
bool GetHasDataLabels ()
 True if the series has data labels. More...
 
void SetHasDataLabels (bool hasDataLabels)
 True if the series has data labels. More...
 
bool GetHasErrorBars ()
 True if the series has error bars. More...
 
void SetHasErrorBars (bool hasErrorBars)
 True if the series has error bars. More...
 
bool GetHasLeaderLines ()
 True if the series has leader lines. More...
 
void SetHasLeaderLines (bool hasLeaderLines)
 True if the series has leader lines. More...
 
bool GetInvertIfNegative ()
 True if Microsoft Excel inverts the pattern in the item when it corresponds to a negative number. More...
 
void SetInvertIfNegative (bool invertIfNegative)
 True if Microsoft Excel inverts the pattern in the item when it corresponds to a negative number. More...
 
bool GetIsFiltered ()
 Whether to filter the series out from the chart. More...
 
void SetIsFiltered (bool isFiltered)
 Whether to filter the series out from the chart. More...
 
wxExcelLeaderLines GetLeaderLines ()
 Returns a LeaderLines object that represents the leader lines for the series. More...
 
wxColour GetMarkerBackgroundColor ()
 Sets the marker background color as an RGB value or returns the corresponding color index value. More...
 
void SetMarkerBackgroundColor (const wxColour &markerBackgroundColor)
 Sets the marker background color as an RGB value or returns the corresponding color index value. More...
 
long GetMarkerBackgroundColorIndex ()
 Returns the marker background color as an index into the current color palette, or as one of the following XlColorIndex constants: xlColorIndexAutomatic or xlColorIndexNone. More...
 
void SetMarkerBackgroundColorIndex (long markerBackgroundColorIndex)
 Sets the marker background color as an index into the current color palette, or as one of the following XlColorIndex constants: xlColorIndexAutomatic or xlColorIndexNone. More...
 
wxColour GetMarkerForegroundColor ()
 Sets the marker background color as an RGB value or returns the corresponding color index value. More...
 
void SetMarkerForegroundColor (const wxColour &markerForegroundColor)
 Sets the marker background color as an RGB value or returns the corresponding color index value. More...
 
long GetMarkerForegroundColorIndex ()
 Returns the marker foreground color as an index into the current color palette, or as one of the following XlColorIndex constants: xlColorIndexAutomatic or xlColorIndexNone. More...
 
void SetMarkerForegroundColorIndex (long markerForegroundColorIndex)
 Sets the marker foreground color as an index into the current color palette, or as one of the following XlColorIndex constants: xlColorIndexAutomatic or xlColorIndexNone. More...
 
long GetMarkerSize ()
 Returns the data-marker size, in points. More...
 
void SetMarkerSize (long markerSize)
 Sets the data-marker size, in points. More...
 
XlMarkerStyle GetMarkerStyle ()
 Returns the marker style for a point or series in a line chart, scatter chart, or radar chart. More...
 
void SetMarkerStyle (XlMarkerStyle markerStyle)
 Sets the marker style for a point or series in a line chart, scatter chart, or radar chart. More...
 
wxString GetName ()
 Returns a String value representing the name of the object. More...
 
void SetName (const wxString &name)
 Sets a String value representing the name of the object. More...
 
XlParentDataLabelOptions GetParentDataLabelOption ()
 Specifies the parent data label option (banner, overlapping, or none) for the specified series within the chart group. More...
 
void SetParentDataLabelOption (XlParentDataLabelOptions option)
 Specifies the parent data label option (banner, overlapping, or none) for the specified series within the chart group. More...
 
XlChartPictureType GetPictureType ()
 Returns a XlChartPictureType value that represents the way pictures are displayed on a column or bar picture chart. More...
 
void SetPictureType (XlChartPictureType pictureType)
 Sets a XlChartPictureType value that represents the way pictures are displayed on a column or bar picture chart. More...
 
long GetPictureUnit ()
 Returns the unit for each picture on the chart if the PictureType property is set to xlStackScale (if not, this property is ignored). More...
 
void SetPictureUnit (long pictureUnit)
 Sets the unit for each picture on the chart if the PictureType property is set to xlStackScale (if not, this property is ignored). More...
 
double GetPictureUnit2 ()
 Returns the unit for each picture on the chart if the PictureType property is set to xlStackScale (if not, this property is ignored). More...
 
void SetPictureUnit2 (double pictureUnit2)
 Sets the unit for each picture on the chart if the PictureType property is set to xlStackScale (if not, this property is ignored). More...
 
long GetPlotOrder ()
 Returns the plot order for the selected series within the chart group. More...
 
void SetPlotOrder (long plotOrder)
 Sets the plot order for the selected series within the chart group. More...
 
bool GetQuartileCalculationInclusiveMedian ()
 True if the series uses an inclusive median quartile calculation method. More...
 
void SetQuartileCalculationInclusiveMedian (bool value)
 True if the series uses an inclusive median quartile calculation method. More...
 
XlRegionLabelOptions GetRegionLabelOptions ()
 Specifies the region labelling behavior for the specified series within the chart group. More...
 
void SetRegionLabelOptions (XlRegionLabelOptions options)
 Specifies the region labelling behavior for the specified series within the chart group. More...
 
bool GetShadow ()
 Returns a Boolean value that determines if the object has a shadow. More...
 
void SetShadow (bool shadow)
 Sets a Boolean value that determines if the object has a shadow. More...
 
bool GetSmooth ()
 True if curve smoothing is turned on for the line chart or scatter chart. More...
 
void SetSmooth (bool smooth)
 True if curve smoothing is turned on for the line chart or scatter chart. More...
 
long GetType ()
 Returns a Long value that represents the series type. More...
 
void SetType (long type)
 Sets a Long value that represents the series type. More...
 
bool GetValues (wxExcelRange &rangeValues, wxVariant &variantValues)
 After calling GetValues(), first check if the result is true. More...
 
void SetValues (wxExcelRange values)
 Sets a Variant value that represents a collection of all the values in the series. More...
 
bool GetXValues (wxExcelRange &rangeValues, wxVariant &variantValues)
 After calling GetXValues(), first check if the result is true. More...
 
void SetXValues (wxExcelRange values)
 Sets an array of x values for a chart series. More...
 
virtual wxString GetAutoExcelObjectName_ () const
 Returns "Series". More...
 
- Public Member Functions inherited from wxAutoExcel::wxExcelObject
bool IsOk_ () const
 Returns true if the object has a valid dispatch. More...
 
virtual wxString GetAutoExcelObjectName_ () const
 Returns "Object". More...
 
wxString GetAutomationObjectName_ (bool stripUnderscores=false) const
 Returns object name as provided by IDispatch->GetTypeInfo()->GetDocumentation(MEMBERID_NIL, &name, NULL, NULL, NULL). More...
 
wxSharedPtr< wxAutomationObject > GetAutomationObject_ ()
 Returns the underlying wxAutomationObject. More...
 
 operator bool () const
 Returns true if the object has a valid dispatch and its last automation call (if any), i.e. More...
 
WXLCID GetAutomationLCID_ () const
 Returns the locale identifier used in automation calls. More...
 
bool SetAutomationLCID_ (WXLCID lcid)
 Sets the locale identifier to be used in automation calls. More...
 
bool GetPropertyAndMethodNames_ (wxArrayString &propertyNames, wxArrayString &methodNames, bool includeHidden=false)
 Returns lists of property and method names the automation interface exposes. More...
 
bool GetUnimplementedObject_ (const wxString &name, wxAutomationObject &object)
 Helper function for receiving an automation object not implemented in wxAutoExcel, see FAQ on how to use. More...
 

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. More...
 
static void SetErrorMode_ (unsigned mode)
 Sets the error mode as the combination of wxExcelObject::ErrorFlags. More...
 
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. More...
 

Detailed Description

Represents Microsoft Excel Series object.

Member Function Documentation

◆ ApplyDataLabels()

void wxAutoExcel::wxExcelSeries::ApplyDataLabels ( XlDataLabelsType type = NULL,
wxXlTribool  legendKey = wxDefaultXlTribool,
wxXlTribool  autoText = wxDefaultXlTribool,
wxXlTribool  hasLeaderLines = wxDefaultXlTribool,
wxXlTribool  showSeriesName = wxDefaultXlTribool,
wxXlTribool  showCategoryName = wxDefaultXlTribool,
wxXlTribool  showValue = wxDefaultXlTribool,
wxXlTribool  showPercentage = wxDefaultXlTribool,
wxXlTribool  showBubbleSize = wxDefaultXlTribool,
const wxString &  separator = wxEmptyString 
)

Applies data labels to a series.

MSDN documentation for Series.ApplyDataLabels.

◆ ClearFormats()

bool wxAutoExcel::wxExcelSeries::ClearFormats ( )

Clears the formatting of the object.

MSDN documentation for Series.ClearFormats.

◆ Copy()

bool wxAutoExcel::wxExcelSeries::Copy ( )

If the series has a picture fill, then this method copies the picture to the Clipboard.

MSDN documentation for Series.Copy.

◆ DataLabels()

wxExcelDataLabels wxAutoExcel::wxExcelSeries::DataLabels ( )

Returns an object that represents either a single data label (a DataLabel object) or a collection of all the data labels for the series (a DataLabels collection).

MSDN documentation for Series.DataLabels.

◆ Delete()

bool wxAutoExcel::wxExcelSeries::Delete ( )

◆ ErrorBar()

bool wxAutoExcel::wxExcelSeries::ErrorBar ( XlErrorBarDirection  direction,
XlErrorBarInclude  include,
XlErrorBarType  type,
double *  amount = NULL,
double *  minusValues = NULL 
)

Applies error bars to the series.

Variant.

MSDN documentation for Series.ErrorBar.

◆ Paste()

bool wxAutoExcel::wxExcelSeries::Paste ( )

Pastes a picture from the Clipboard as the marker on the selected series.

MSDN documentation for Series.Paste.

◆ Points()

wxExcelPoints wxAutoExcel::wxExcelSeries::Points ( )

Returns an object that represents a single point (a Point object) or a collection of all the points (a Points collection) in the series.

Read-only

MSDN documentation for Series.Points.

◆ Select()

bool wxAutoExcel::wxExcelSeries::Select ( )

◆ Trendlines()

wxExcelTrendlines wxAutoExcel::wxExcelSeries::Trendlines ( )

Returns an object that represents a single trendline (a Trendline object) or a collection of all the trendlines (a Trendlines collection) for the series.

MSDN documentation for Series.Trendlines.

◆ GetApplyPictToEnd()

bool wxAutoExcel::wxExcelSeries::GetApplyPictToEnd ( )

True if a picture is applied to the end of the point or all points in the series.

MSDN documentation for Series.ApplyPictToEnd.

◆ SetApplyPictToEnd()

void wxAutoExcel::wxExcelSeries::SetApplyPictToEnd ( bool  applyPictToEnd)

True if a picture is applied to the end of the point or all points in the series.

MSDN documentation for Series.ApplyPictToEnd.

◆ GetApplyPictToFront()

bool wxAutoExcel::wxExcelSeries::GetApplyPictToFront ( )

True if a picture is applied to the front of the point or all points in the series.

MSDN documentation for Series.ApplyPictToFront.

◆ SetApplyPictToFront()

void wxAutoExcel::wxExcelSeries::SetApplyPictToFront ( bool  applyPictToFront)

True if a picture is applied to the front of the point or all points in the series.

MSDN documentation for Series.ApplyPictToFront.

◆ GetApplyPictToSides()

bool wxAutoExcel::wxExcelSeries::GetApplyPictToSides ( )

True if a picture is applied to the sides of the point or all points in the series.

MSDN documentation for Series.ApplyPictToSides.

◆ SetApplyPictToSides()

void wxAutoExcel::wxExcelSeries::SetApplyPictToSides ( bool  applyPictToSides)

True if a picture is applied to the sides of the point or all points in the series.

MSDN documentation for Series.ApplyPictToSides.

◆ GetAxisGroup()

XlAxisGroup wxAutoExcel::wxExcelSeries::GetAxisGroup ( )

Returns an XlAxisGroup value that represents the type of axis group.

MSDN documentation for Series.AxisGroup.

◆ SetAxisGroup()

void wxAutoExcel::wxExcelSeries::SetAxisGroup ( XlAxisGroup  group)

Sets an XlAxisGroup value that represents the type of axis group.

MSDN documentation for Series.AxisGroup.

◆ GetBarShape()

XlBarShape wxAutoExcel::wxExcelSeries::GetBarShape ( )

Returns the shape used with the 3-D bar or column chart.

Read/write XlBarShape.

MSDN documentation for Series.BarShape.

◆ SetBarShape()

void wxAutoExcel::wxExcelSeries::SetBarShape ( XlBarShape  barShape)

Sets the shape used with the 3-D bar or column chart.

Read/write XlBarShape.

MSDN documentation for Series.BarShape.

◆ GetBubbleSizes()

wxString wxAutoExcel::wxExcelSeries::GetBubbleSizes ( )

Returns a string that refers to the worksheet cells containing the x-value, y-value and size data for the bubble chart.

When you return the cell reference, it will return a string describing the cells in A1-style notation. To set the size data for the bubble chart, you must use R1C1-style notation. Applies only to bubble charts. Read/write Variant.

MSDN documentation for Series.BubbleSizes.

◆ SetBubbleSizes()

void wxAutoExcel::wxExcelSeries::SetBubbleSizes ( const wxString &  bubbleSizes)

Sets a string that refers to the worksheet cells containing the x-value, y-value and size data for the bubble chart.

When you return the cell reference, it will return a string describing the cells in A1-style notation. To set the size data for the bubble chart, you must use R1C1-style notation. Applies only to bubble charts. Read/write Variant.

MSDN documentation for Series.BubbleSizes.

◆ GetChartType()

XlChartType wxAutoExcel::wxExcelSeries::GetChartType ( )

Returns the chart type.

Read/write XlChartType.

MSDN documentation for Series.ChartType.

◆ SetChartType()

void wxAutoExcel::wxExcelSeries::SetChartType ( XlChartType  chartType)

Sets the chart type.

Read/write XlChartType.

MSDN documentation for Series.ChartType.

◆ GetErrorBars()

wxExcelErrorBars wxAutoExcel::wxExcelSeries::GetErrorBars ( )

Returns an ErrorBars object that represents the error bars for the series.

MSDN documentation for Series.ErrorBars.

◆ GetExplosion()

long wxAutoExcel::wxExcelSeries::GetExplosion ( )

Returns the explosion value for a pie-chart or doughnut-chart slice.

Returns 0 (zero) if there's no explosion (the tip of the slice is in the center of the pie).

MSDN documentation for Series.Explosion.

◆ SetExplosion()

void wxAutoExcel::wxExcelSeries::SetExplosion ( long  explosion)

Sets the explosion value for a pie-chart or doughnut-chart slice.

Returns 0 (zero) if there's no explosion (the tip of the slice is in the center of the pie).

MSDN documentation for Series.Explosion.

◆ GetFormat()

wxExcelChartFormat wxAutoExcel::wxExcelSeries::GetFormat ( )

Returns the ChartFormat object.

Since Excel 2007.

MSDN documentation for Series.Format.

◆ GetFormula()

wxString wxAutoExcel::wxExcelSeries::GetFormula ( )

Returns a String value that represents the object's formula in A1-style notation and in the language of the macro.

MSDN documentation for Series.Formula.

◆ SetFormula()

void wxAutoExcel::wxExcelSeries::SetFormula ( const wxString &  formula)

Sets a String value that represents the object's formula in A1-style notation and in the language of the macro.

MSDN documentation for Series.Formula.

◆ GetFormulaLocal()

wxString wxAutoExcel::wxExcelSeries::GetFormulaLocal ( )

Returns the formula for the object, using A1-style references in the language of the user.

MSDN documentation for Series.FormulaLocal.

◆ SetFormulaLocal()

void wxAutoExcel::wxExcelSeries::SetFormulaLocal ( const wxString &  formulaLocal)

Sets the formula for the object, using A1-style references in the language of the user.

MSDN documentation for Series.FormulaLocal.

◆ GetFormulaR1C1()

wxString wxAutoExcel::wxExcelSeries::GetFormulaR1C1 ( )

Returns the formula for the object, using R1C1-style notation in the language of the macro.

MSDN documentation for Series.FormulaR1C1.

◆ SetFormulaR1C1()

void wxAutoExcel::wxExcelSeries::SetFormulaR1C1 ( const wxString &  formulaR1C1)

Sets the formula for the object, using R1C1-style notation in the language of the macro.

MSDN documentation for Series.FormulaR1C1.

◆ GetFormulaR1C1Local()

wxString wxAutoExcel::wxExcelSeries::GetFormulaR1C1Local ( )

Returns the formula for the object, using R1C1-style notation in the language of the user.

MSDN documentation for Series.FormulaR1C1Local.

◆ SetFormulaR1C1Local()

void wxAutoExcel::wxExcelSeries::SetFormulaR1C1Local ( const wxString &  formulaR1C1Local)

Sets the formula for the object, using R1C1-style notation in the language of the user.

MSDN documentation for Series.FormulaR1C1Local.

◆ GetGeoProjectionType()

XlGeoProjectionType wxAutoExcel::wxExcelSeries::GetGeoProjectionType ( )

Specifies the geography projection type for the specified series within the chart group.

Excel VBA documentation for Series.GeoProjectionType

◆ SetGeoProjectionType()

void wxAutoExcel::wxExcelSeries::SetGeoProjectionType ( XlGeoProjectionType  type)

Specifies the geography projection type for the specified series within the chart group.

Excel VBA documentation for Series.GeoProjectionType

◆ GetHas3DEffect()

bool wxAutoExcel::wxExcelSeries::GetHas3DEffect ( )

True if the series has a three-dimensional appearance.

MSDN documentation for Series.Has3DEffect.

◆ SetHas3DEffect()

void wxAutoExcel::wxExcelSeries::SetHas3DEffect ( bool  has3DEffect)

True if the series has a three-dimensional appearance.

MSDN documentation for Series.Has3DEffect.

◆ GetHasDataLabels()

bool wxAutoExcel::wxExcelSeries::GetHasDataLabels ( )

True if the series has data labels.

MSDN documentation for Series.HasDataLabels.

◆ SetHasDataLabels()

void wxAutoExcel::wxExcelSeries::SetHasDataLabels ( bool  hasDataLabels)

True if the series has data labels.

MSDN documentation for Series.HasDataLabels.

◆ GetHasErrorBars()

bool wxAutoExcel::wxExcelSeries::GetHasErrorBars ( )

True if the series has error bars.

This property isnít available for 3-D charts.

MSDN documentation for Series.HasErrorBars.

◆ SetHasErrorBars()

void wxAutoExcel::wxExcelSeries::SetHasErrorBars ( bool  hasErrorBars)

True if the series has error bars.

This property isnít available for 3-D charts.

MSDN documentation for Series.HasErrorBars.

◆ GetHasLeaderLines()

bool wxAutoExcel::wxExcelSeries::GetHasLeaderLines ( )

True if the series has leader lines.

MSDN documentation for Series.HasLeaderLines.

◆ SetHasLeaderLines()

void wxAutoExcel::wxExcelSeries::SetHasLeaderLines ( bool  hasLeaderLines)

True if the series has leader lines.

MSDN documentation for Series.HasLeaderLines.

◆ GetInvertIfNegative()

bool wxAutoExcel::wxExcelSeries::GetInvertIfNegative ( )

True if Microsoft Excel inverts the pattern in the item when it corresponds to a negative number.

MSDN documentation for Series.InvertIfNegative.

◆ SetInvertIfNegative()

void wxAutoExcel::wxExcelSeries::SetInvertIfNegative ( bool  invertIfNegative)

True if Microsoft Excel inverts the pattern in the item when it corresponds to a negative number.

MSDN documentation for Series.InvertIfNegative.

◆ GetIsFiltered()

bool wxAutoExcel::wxExcelSeries::GetIsFiltered ( )

Whether to filter the series out from the chart.

Excel VBA documentation for Series.IsFiltered

◆ SetIsFiltered()

void wxAutoExcel::wxExcelSeries::SetIsFiltered ( bool  isFiltered)

Whether to filter the series out from the chart.

Excel VBA documentation for Series.IsFiltered

◆ GetLeaderLines()

wxExcelLeaderLines wxAutoExcel::wxExcelSeries::GetLeaderLines ( )

Returns a LeaderLines object that represents the leader lines for the series.

MSDN documentation for Series.LeaderLines.

◆ GetMarkerBackgroundColor()

wxColour wxAutoExcel::wxExcelSeries::GetMarkerBackgroundColor ( )

Sets the marker background color as an RGB value or returns the corresponding color index value.

Applies only to line, scatter, and radar charts.

MSDN documentation for Series.MarkerBackgroundColor.

◆ SetMarkerBackgroundColor()

void wxAutoExcel::wxExcelSeries::SetMarkerBackgroundColor ( const wxColour &  markerBackgroundColor)

Sets the marker background color as an RGB value or returns the corresponding color index value.

Applies only to line, scatter, and radar charts.

MSDN documentation for Series.MarkerBackgroundColor.

◆ GetMarkerBackgroundColorIndex()

long wxAutoExcel::wxExcelSeries::GetMarkerBackgroundColorIndex ( )

Returns the marker background color as an index into the current color palette, or as one of the following XlColorIndex constants: xlColorIndexAutomatic or xlColorIndexNone.

Applies only to line, scatter, and radar charts.

MSDN documentation for Series.MarkerBackgroundColorIndex.

◆ SetMarkerBackgroundColorIndex()

void wxAutoExcel::wxExcelSeries::SetMarkerBackgroundColorIndex ( long  markerBackgroundColorIndex)

Sets the marker background color as an index into the current color palette, or as one of the following XlColorIndex constants: xlColorIndexAutomatic or xlColorIndexNone.

Applies only to line, scatter, and radar charts.

MSDN documentation for Series.MarkerBackgroundColorIndex.

◆ GetMarkerForegroundColor()

wxColour wxAutoExcel::wxExcelSeries::GetMarkerForegroundColor ( )

Sets the marker background color as an RGB value or returns the corresponding color index value.

Applies only to line, scatter, and radar charts.

MSDN documentation for Series.MarkerForegroundColor.

◆ SetMarkerForegroundColor()

void wxAutoExcel::wxExcelSeries::SetMarkerForegroundColor ( const wxColour &  markerForegroundColor)

Sets the marker background color as an RGB value or returns the corresponding color index value.

Applies only to line, scatter, and radar charts.

MSDN documentation for Series.MarkerForegroundColor.

◆ GetMarkerForegroundColorIndex()

long wxAutoExcel::wxExcelSeries::GetMarkerForegroundColorIndex ( )

Returns the marker foreground color as an index into the current color palette, or as one of the following XlColorIndex constants: xlColorIndexAutomatic or xlColorIndexNone.

Applies only to line, scatter, and radar charts.

MSDN documentation for Series.MarkerForegroundColorIndex.

◆ SetMarkerForegroundColorIndex()

void wxAutoExcel::wxExcelSeries::SetMarkerForegroundColorIndex ( long  markerForegroundColorIndex)

Sets the marker foreground color as an index into the current color palette, or as one of the following XlColorIndex constants: xlColorIndexAutomatic or xlColorIndexNone.

Applies only to line, scatter, and radar charts.

MSDN documentation for Series.MarkerForegroundColorIndex.

◆ GetMarkerSize()

long wxAutoExcel::wxExcelSeries::GetMarkerSize ( )

Returns the data-marker size, in points.

Can be a value from 2 through 72.

MSDN documentation for Series.MarkerSize.

◆ SetMarkerSize()

void wxAutoExcel::wxExcelSeries::SetMarkerSize ( long  markerSize)

Sets the data-marker size, in points.

Can be a value from 2 through 72.

MSDN documentation for Series.MarkerSize.

◆ GetMarkerStyle()

XlMarkerStyle wxAutoExcel::wxExcelSeries::GetMarkerStyle ( )

Returns the marker style for a point or series in a line chart, scatter chart, or radar chart.

Read/write XlMarkerStyle.

MSDN documentation for Series.MarkerStyle.

◆ SetMarkerStyle()

void wxAutoExcel::wxExcelSeries::SetMarkerStyle ( XlMarkerStyle  markerStyle)

Sets the marker style for a point or series in a line chart, scatter chart, or radar chart.

Read/write XlMarkerStyle.

MSDN documentation for Series.MarkerStyle.

◆ GetName()

wxString wxAutoExcel::wxExcelSeries::GetName ( )

Returns a String value representing the name of the object.

MSDN documentation for Series.Name.

◆ SetName()

void wxAutoExcel::wxExcelSeries::SetName ( const wxString &  name)

Sets a String value representing the name of the object.

MSDN documentation for Series.Name.

◆ GetParentDataLabelOption()

XlParentDataLabelOptions wxAutoExcel::wxExcelSeries::GetParentDataLabelOption ( )

Specifies the parent data label option (banner, overlapping, or none) for the specified series within the chart group.

Since Excel 2016.

MSDN documentation for Series.ParentDataLabelOption.

◆ SetParentDataLabelOption()

void wxAutoExcel::wxExcelSeries::SetParentDataLabelOption ( XlParentDataLabelOptions  option)

Specifies the parent data label option (banner, overlapping, or none) for the specified series within the chart group.

Since Excel 2016.

MSDN documentation for Series.ParentDataLabelOption.

◆ GetPictureType()

XlChartPictureType wxAutoExcel::wxExcelSeries::GetPictureType ( )

Returns a XlChartPictureType value that represents the way pictures are displayed on a column or bar picture chart.

MSDN documentation for Series.PictureType.

◆ SetPictureType()

void wxAutoExcel::wxExcelSeries::SetPictureType ( XlChartPictureType  pictureType)

Sets a XlChartPictureType value that represents the way pictures are displayed on a column or bar picture chart.

MSDN documentation for Series.PictureType.

◆ GetPictureUnit()

long wxAutoExcel::wxExcelSeries::GetPictureUnit ( )

Returns the unit for each picture on the chart if the PictureType property is set to xlStackScale (if not, this property is ignored).

[MSDN documentation for Series.PictureUnit]().

◆ SetPictureUnit()

void wxAutoExcel::wxExcelSeries::SetPictureUnit ( long  pictureUnit)

Sets the unit for each picture on the chart if the PictureType property is set to xlStackScale (if not, this property is ignored).

[MSDN documentation for Series.PictureUnit]().

◆ GetPictureUnit2()

double wxAutoExcel::wxExcelSeries::GetPictureUnit2 ( )

Returns the unit for each picture on the chart if the PictureType property is set to xlStackScale (if not, this property is ignored).

Since Excel 2007.

MSDN documentation for Series.PictureUnit2.

◆ SetPictureUnit2()

void wxAutoExcel::wxExcelSeries::SetPictureUnit2 ( double  pictureUnit2)

Sets the unit for each picture on the chart if the PictureType property is set to xlStackScale (if not, this property is ignored).

Since Excel 2007.

MSDN documentation for Series.PictureUnit2.

◆ GetPlotOrder()

long wxAutoExcel::wxExcelSeries::GetPlotOrder ( )

Returns the plot order for the selected series within the chart group.

MSDN documentation for Series.PlotOrder.

◆ SetPlotOrder()

void wxAutoExcel::wxExcelSeries::SetPlotOrder ( long  plotOrder)

Sets the plot order for the selected series within the chart group.

MSDN documentation for Series.PlotOrder.

◆ GetQuartileCalculationInclusiveMedian()

bool wxAutoExcel::wxExcelSeries::GetQuartileCalculationInclusiveMedian ( )

True if the series uses an inclusive median quartile calculation method.

Since Excel 2016.

MSDN documentation for Series.QuartileCalculationInclusiveMedian.

◆ SetQuartileCalculationInclusiveMedian()

void wxAutoExcel::wxExcelSeries::SetQuartileCalculationInclusiveMedian ( bool  value)

True if the series uses an inclusive median quartile calculation method.

Since Excel 2016.

MSDN documentation for Series.QuartileCalculationInclusiveMedian.

◆ GetRegionLabelOptions()

XlRegionLabelOptions wxAutoExcel::wxExcelSeries::GetRegionLabelOptions ( )

Specifies the region labelling behavior for the specified series within the chart group.

Excel VBA documentation for Series.RegionLabelOptions

◆ SetRegionLabelOptions()

void wxAutoExcel::wxExcelSeries::SetRegionLabelOptions ( XlRegionLabelOptions  options)

Specifies the region labelling behavior for the specified series within the chart group.

Excel VBA documentation for Series.RegionLabelOptions

◆ GetShadow()

bool wxAutoExcel::wxExcelSeries::GetShadow ( )

Returns a Boolean value that determines if the object has a shadow.

MSDN documentation for Series.Shadow.

◆ SetShadow()

void wxAutoExcel::wxExcelSeries::SetShadow ( bool  shadow)

Sets a Boolean value that determines if the object has a shadow.

MSDN documentation for Series.Shadow.

◆ GetSmooth()

bool wxAutoExcel::wxExcelSeries::GetSmooth ( )

True if curve smoothing is turned on for the line chart or scatter chart.

Applies only to line and scatter charts.

MSDN documentation for Series.Smooth.

◆ SetSmooth()

void wxAutoExcel::wxExcelSeries::SetSmooth ( bool  smooth)

True if curve smoothing is turned on for the line chart or scatter chart.

Applies only to line and scatter charts.

MSDN documentation for Series.Smooth.

◆ GetType()

long wxAutoExcel::wxExcelSeries::GetType ( )

Returns a Long value that represents the series type.

MSDN documentation for Series.Type.

◆ SetType()

void wxAutoExcel::wxExcelSeries::SetType ( long  type)

Sets a Long value that represents the series type.

MSDN documentation for Series.Type.

◆ GetValues()

bool wxAutoExcel::wxExcelSeries::GetValues ( wxExcelRange rangeValues,
wxVariant &  variantValues 
)

After calling GetValues(), first check if the result is true.

If it is then if rangeValues.IsOk_() is true, the values are stored in that Range, else values were copied into variantValues.

MSDN documentation for Series.Values.

◆ SetValues()

void wxAutoExcel::wxExcelSeries::SetValues ( wxExcelRange  values)

Sets a Variant value that represents a collection of all the values in the series.

MSDN documentation for Series.Values.

◆ GetXValues()

bool wxAutoExcel::wxExcelSeries::GetXValues ( wxExcelRange rangeValues,
wxVariant &  variantValues 
)

After calling GetXValues(), first check if the result is true.

If it is then if rangeValues.IsOk_() is true, the values are stored in that Range, else values were copied into variantValues.

MSDN documentation for Series.XValues.

◆ SetXValues()

void wxAutoExcel::wxExcelSeries::SetXValues ( wxExcelRange  values)

Sets an array of x values for a chart series.

The XValues property can be set to a range on a worksheet or to an array of values, but it cannot be a combination of both. Read/write Variant.

MSDN documentation for Series.XValues.

◆ GetAutoExcelObjectName_()

virtual wxString wxAutoExcel::wxExcelSeries::GetAutoExcelObjectName_ ( ) const
inlinevirtual

Returns "Series".

Reimplemented from wxAutoExcel::wxExcelObject.