Represents Microsoft Excel SparklineGroup object. More...

#include <wxAutoExcelSparklineGroups.h>

Inheritance diagram for wxAutoExcel::wxExcelSparklineGroup:

Public Member Functions
void	Delete ()
	Deletes the sparkline group.

void	Modify (wxExcelRange range, const wxString &sourceData)
	Sets the location and the source data for the sparkline group.

void	ModifyDateRange (const wxString &dateRange)
	Sets the date range for the sparkline group.

void	ModifyLocation (wxExcelRange location)
	Sets the associated Range object to modify the location of the sparkline group.

void	ModifySourceData (const wxString &sourceData)
	Sets the range that represents the source data for the sparkline group.

wxExcelSparkAxes	GetAxes ()
	Returns the associated SparkAxes object.

long	GetCount ()
	Returns the number of sparklines in the sparkline group.

wxString	GetDateRange ()
	Gets or sets the date range for the sparkline group.

void	SetDateRange (const wxString &dateRange)
	Gets or sets the date range for the sparkline group.

XlDisplayBlanksAs	GetDisplayBlanksAs ()
	Returns the way that blank cells are plotted on a chart.

void	SetDisplayBlanksAs (XlDisplayBlanksAs displayBlanksAs)
	Sets the way that blank cells are plotted on a chart.

bool	GetDisplayHidden ()
	Specifies if hidden cells are plotted in the sparkline group.

void	SetDisplayHidden (bool displayHidden)
	Specifies if hidden cells are plotted in the sparkline group.

wxExcelSparkline	GetItem (long index)
	Returns a Sparkline object.

double	GetLineWeight ()
	Gets or sets the thickness of the sparklines in the sparkline group.

void	SetLineWeight (double lineWeight)
	Gets or sets the thickness of the sparklines in the sparkline group.

wxExcelRange	GetLocation ()
	Gets or sets the Range object that represents the location of the sparkline group.

void	SetLocation (const wxExcelRange &location)
	Gets or sets the Range object that represents the location of the sparkline group.

XlSparklineRowCol	GetPlotBy ()
	Returns how to plot the sparkline when the data on which it is based is in a square-shaped range.

void	SetPlotBy (XlSparklineRowCol plotBy)
	Sets how to plot the sparkline when the data on which it is based is in a square-shaped range.

wxExcelSparkPoints	GetPoints ()
	Returns the position of the specified node as a coordinate pair.

wxExcelFormatColor	GetSeriesColor ()
	Returns a FormatColor object that represents the main series color for the sparkline group.

wxString	GetSourceData ()
	Returns the range that contains the source data for the sparkline group.

void	SetSourceData (const wxString &sourceData)
	Sets the range that contains the source data for the sparkline group.

XlSparkType	GetType ()
	Gets or sets the type of sparkline for the group.

void	SetType (XlSparkType type)
	Gets or sets the type of sparkline for the group.

virtual wxString	GetAutoExcelObjectName_ () const
	Returns "SparklineGroup".

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.

Detailed Description

Represents Microsoft Excel SparklineGroup object.

Since Excel 2010.

Member Function Documentation

◆ Delete()

void wxAutoExcel::wxExcelSparklineGroup::Delete ( )

Deletes the sparkline group.

MSDN documentation for SparklineGroup.Delete.

◆ Modify()

void wxAutoExcel::wxExcelSparklineGroup::Modify	(	wxExcelRange	range,
		const wxString &	sourceData
	)

Sets the location and the source data for the sparkline group.

MSDN documentation for SparklineGroup.Modify.

◆ ModifyDateRange()

void wxAutoExcel::wxExcelSparklineGroup::ModifyDateRange ( const wxString & dateRange )

Sets the date range for the sparkline group.

MSDN documentation for SparklineGroup.ModifyDateRange.

◆ ModifyLocation()

void wxAutoExcel::wxExcelSparklineGroup::ModifyLocation ( wxExcelRange location )

Sets the associated Range object to modify the location of the sparkline group.

MSDN documentation for SparklineGroup.ModifyLocation.

◆ ModifySourceData()

void wxAutoExcel::wxExcelSparklineGroup::ModifySourceData ( const wxString & sourceData )

Sets the range that represents the source data for the sparkline group.

MSDN documentation for SparklineGroup.ModifySourceData.

◆ GetAxes()

wxExcelSparkAxes wxAutoExcel::wxExcelSparklineGroup::GetAxes ( )

Returns the associated SparkAxes object.

Since Excel 2007.

MSDN documentation for SparklineGroup.Axes.

◆ GetCount()

long wxAutoExcel::wxExcelSparklineGroup::GetCount ( )

Returns the number of sparklines in the sparkline group.

Since Excel 2007.

MSDN documentation for SparklineGroup.Count.

◆ GetDateRange()

wxString wxAutoExcel::wxExcelSparklineGroup::GetDateRange ( )

Gets or sets the date range for the sparkline group.

Since Excel 2007.

MSDN documentation for SparklineGroup.DateRange.

◆ SetDateRange()

void wxAutoExcel::wxExcelSparklineGroup::SetDateRange ( const wxString & dateRange )

Gets or sets the date range for the sparkline group.

Since Excel 2007.

MSDN documentation for SparklineGroup.DateRange.

◆ GetDisplayBlanksAs()

XlDisplayBlanksAs wxAutoExcel::wxExcelSparklineGroup::GetDisplayBlanksAs ( )

Returns the way that blank cells are plotted on a chart.

Can be one of the XlDisplayBlanksAs constants.

[MSDN documentation for SparklineGroup.DisplayBlanksAs]().

◆ SetDisplayBlanksAs()

void wxAutoExcel::wxExcelSparklineGroup::SetDisplayBlanksAs ( XlDisplayBlanksAs displayBlanksAs )

Sets the way that blank cells are plotted on a chart.

Can be one of the XlDisplayBlanksAs constants.

[MSDN documentation for SparklineGroup.DisplayBlanksAs]().

◆ GetDisplayHidden()

bool wxAutoExcel::wxExcelSparklineGroup::GetDisplayHidden ( )

Specifies if hidden cells are plotted in the sparkline group.

Since Excel 2007.

MSDN documentation for SparklineGroup.DisplayHidden.

◆ SetDisplayHidden()

void wxAutoExcel::wxExcelSparklineGroup::SetDisplayHidden ( bool displayHidden )

Specifies if hidden cells are plotted in the sparkline group.

Since Excel 2007.

MSDN documentation for SparklineGroup.DisplayHidden.

◆ GetItem()

wxExcelSparkline wxAutoExcel::wxExcelSparklineGroup::GetItem ( long index )

Returns a Sparkline object.

Read-only Since Excel 2007.

MSDN documentation for SparklineGroup.Item.

◆ GetLineWeight()

double wxAutoExcel::wxExcelSparklineGroup::GetLineWeight ( )

Gets or sets the thickness of the sparklines in the sparkline group.

Since Excel 2007.

MSDN documentation for SparklineGroup.LineWeight.

◆ SetLineWeight()

void wxAutoExcel::wxExcelSparklineGroup::SetLineWeight ( double lineWeight )

Gets or sets the thickness of the sparklines in the sparkline group.

Since Excel 2007.

MSDN documentation for SparklineGroup.LineWeight.

◆ GetLocation()

wxExcelRange wxAutoExcel::wxExcelSparklineGroup::GetLocation ( )

Gets or sets the Range object that represents the location of the sparkline group.

Since Excel 2007.

MSDN documentation for SparklineGroup.Location.

◆ SetLocation()

void wxAutoExcel::wxExcelSparklineGroup::SetLocation ( const wxExcelRange & location )

Gets or sets the Range object that represents the location of the sparkline group.

Since Excel 2007.

MSDN documentation for SparklineGroup.Location.

◆ GetPlotBy()

XlSparklineRowCol wxAutoExcel::wxExcelSparklineGroup::GetPlotBy ( )

Returns how to plot the sparkline when the data on which it is based is in a square-shaped range.

Since Excel 2007.

MSDN documentation for SparklineGroup.PlotBy.

◆ SetPlotBy()

void wxAutoExcel::wxExcelSparklineGroup::SetPlotBy ( XlSparklineRowCol plotBy )

Sets how to plot the sparkline when the data on which it is based is in a square-shaped range.

Since Excel 2007.

MSDN documentation for SparklineGroup.PlotBy.

◆ GetPoints()

wxExcelSparkPoints wxAutoExcel::wxExcelSparklineGroup::GetPoints ( )

Returns the position of the specified node as a coordinate pair.

Each coordinate is expressed in points. Since Excel 2007.

MSDN documentation for SparklineGroup.Points.

◆ GetSeriesColor()

wxExcelFormatColor wxAutoExcel::wxExcelSparklineGroup::GetSeriesColor ( )

Returns a FormatColor object that represents the main series color for the sparkline group.

Since Excel 2007.

MSDN documentation for SparklineGroup.SeriesColor.

◆ GetSourceData()

wxString wxAutoExcel::wxExcelSparklineGroup::GetSourceData ( )

Returns the range that contains the source data for the sparkline group.

Since Excel 2007.

MSDN documentation for SparklineGroup.SourceData.

◆ SetSourceData()

void wxAutoExcel::wxExcelSparklineGroup::SetSourceData ( const wxString & sourceData )

Sets the range that contains the source data for the sparkline group.

Since Excel 2007.

MSDN documentation for SparklineGroup.SourceData.

◆ GetType()

XlSparkType wxAutoExcel::wxExcelSparklineGroup::GetType ( )

Gets or sets the type of sparkline for the group.

Since Excel 2007.

MSDN documentation for SparklineGroup.Type.

◆ SetType()

void wxAutoExcel::wxExcelSparklineGroup::SetType ( XlSparkType type )

Gets or sets the type of sparkline for the group.

Since Excel 2007.

MSDN documentation for SparklineGroup.Type.

◆ GetAutoExcelObjectName_()

virtual wxString wxAutoExcel::wxExcelSparklineGroup::GetAutoExcelObjectName_ ( ) const

inlinevirtual

Returns "SparklineGroup".

Reimplemented from wxAutoExcel::wxExcelObject.

Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ Delete()

◆ Modify()

◆ ModifyDateRange()

◆ ModifyLocation()

◆ ModifySourceData()

◆ GetAxes()

◆ GetCount()

◆ GetDateRange()

◆ SetDateRange()

◆ GetDisplayBlanksAs()

◆ SetDisplayBlanksAs()

◆ GetDisplayHidden()

◆ SetDisplayHidden()

◆ GetItem()

◆ GetLineWeight()

◆ SetLineWeight()

◆ GetLocation()

◆ SetLocation()

◆ GetPlotBy()

◆ SetPlotBy()

◆ GetPoints()

◆ GetSeriesColor()

◆ GetSourceData()

◆ SetSourceData()

◆ GetType()

◆ SetType()

◆ GetAutoExcelObjectName_()