wxAutoExcel  2.0.0
wxAutoExcel::wxExcelAxis Class Reference

Represents Microsoft Excel Axis object. More...

Inheritance diagram for wxAutoExcel::wxExcelAxis:
wxAutoExcel::wxExcelObject

Public Member Functions

bool Delete ()
 Deletes the object. More...
 
bool Select ()
 Selects the object. More...
 
bool GetAxisBetweenCategories ()
 True if the value axis crosses the category axis between categories. More...
 
void SetAxisBetweenCategories (bool axisBetweenCategories)
 True if the value axis crosses the category axis between categories. More...
 
XlAxisGroup GetAxisGroup ()
 Returns an XlAxisGroup value that represents the type of axis group. More...
 
wxExcelAxisTitle GetAxisTitle ()
 Returns an AxisTitle object that represents the title of the specified axis. More...
 
XlTimeUnit GetBaseUnit ()
 Returns the base unit for the specified category axis. More...
 
void SetBaseUnit (XlTimeUnit baseUnit)
 Sets the base unit for the specified category axis. More...
 
bool GetBaseUnitIsAuto ()
 True if Microsoft Excel chooses appropriate base units for the specified category axis. More...
 
void SetBaseUnitIsAuto (bool baseUnitIsAuto)
 True if Microsoft Excel chooses appropriate base units for the specified category axis. More...
 
wxExcelBorder GetBorder ()
 Returns a Border object that represents the border of the object. More...
 
wxArrayString GetCategoryNames ()
 Returns all the category names for the specified axis, as a text array. More...
 
void SetCategoryNames (wxExcelRange categoryNames)
 Sets all the category names for the specified axis, as a text array. More...
 
XlCategoryType GetCategoryType ()
 Returns the category axis type. More...
 
void SetCategoryType (XlCategoryType categoryType)
 Sets the category axis type. More...
 
long GetCrosses ()
 Returns the point on the specified axis where the other axis crosses. More...
 
void SetCrosses (long crosses)
 Sets the point on the specified axis where the other axis crosses. More...
 
double GetCrossesAt ()
 Returns the point on the value axis where the category axis crosses it. More...
 
void SetCrossesAt (double crossesAt)
 Sets the point on the value axis where the category axis crosses it. More...
 
long GetDisplayUnit ()
 Returns the unit label for the value axis. More...
 
void SetDisplayUnit (long displayUnit)
 Sets the unit label for the value axis. More...
 
double GetDisplayUnitCustom ()
 If the value of the DisplayUnit property is xlCustom, the DisplayUnitCustom property returns or sets the value of the displayed units. More...
 
void SetDisplayUnitCustom (double displayUnitCustom)
 If the value of the DisplayUnit property is xlCustom, the DisplayUnitCustom property returns or sets the value of the displayed units. More...
 
wxExcelDisplayUnitLabel GetDisplayUnitLabel ()
 Returns the DisplayUnitLabel object for the specified axis. More...
 
wxExcelChartFormat GetFormat ()
 Returns the ChartFormat object. More...
 
bool GetHasDisplayUnitLabel ()
 True if the label specified by the DisplayUnit or DisplayUnitCustom property is displayed on the specified axis. More...
 
void SetHasDisplayUnitLabel (bool hasDisplayUnitLabel)
 True if the label specified by the DisplayUnit or DisplayUnitCustom property is displayed on the specified axis. More...
 
bool GetHasMajorGridlines ()
 True if the axis has major gridlines. More...
 
void SetHasMajorGridlines (bool hasMajorGridlines)
 True if the axis has major gridlines. More...
 
bool GetHasMinorGridlines ()
 True if the axis has minor gridlines. More...
 
void SetHasMinorGridlines (bool hasMinorGridlines)
 True if the axis has minor gridlines. More...
 
bool GetHasTitle ()
 True if the axis or chart has a visible title. More...
 
void SetHasTitle (bool hasTitle)
 True if the axis or chart has a visible title. More...
 
double GetHeight ()
 Returns a Double value that represents the height, in points, of the object. More...
 
double GetLeft ()
 Returns a Double value that represents the distance, in points, from the left edge of the object to the left edge of the chart area. More...
 
double GetLogBase ()
 Returns the base of the logarithm when you are using log scales. More...
 
void SetLogBase (double logBase)
 Sets the base of the logarithm when you are using log scales. More...
 
wxExcelGridlines GetMajorGridlines ()
 Returns a Gridlines object that represents the major gridlines for the specified axis. More...
 
XlTickMark GetMajorTickMark ()
 Returns the type of major tick mark for the specified axis. More...
 
void SetMajorTickMark (XlTickMark majorTickMark)
 Sets the type of major tick mark for the specified axis. More...
 
double GetMajorUnit ()
 Returns the major units for the value axis. More...
 
void SetMajorUnit (double majorUnit)
 Sets the major units for the value axis. More...
 
bool GetMajorUnitIsAuto ()
 True if Microsoft Excel calculates the major units for the value axis. More...
 
void SetMajorUnitIsAuto (bool majorUnitIsAuto)
 True if Microsoft Excel calculates the major units for the value axis. More...
 
XlTimeUnit GetMajorUnitScale ()
 Returns the major unit scale value for the category axis when the CategoryType property is set to xlTimeScale. More...
 
void SetMajorUnitScale (XlTimeUnit majorUnitScale)
 Sets the major unit scale value for the category axis when the CategoryType property is set to xlTimeScale. More...
 
double GetMaximumScale ()
 Returns the maximum value on the value axis. More...
 
void SetMaximumScale (double maximumScale)
 Sets the maximum value on the value axis. More...
 
bool GetMaximumScaleIsAuto ()
 True if Microsoft Excel calculates the maximum value for the value axis. More...
 
void SetMaximumScaleIsAuto (bool maximumScaleIsAuto)
 True if Microsoft Excel calculates the maximum value for the value axis. More...
 
double GetMinimumScale ()
 Returns the minimum value on the value axis. More...
 
void SetMinimumScale (double minimumScale)
 Sets the minimum value on the value axis. More...
 
bool GetMinimumScaleIsAuto ()
 True if Microsoft Excel calculates the minimum value for the value axis. More...
 
void SetMinimumScaleIsAuto (bool minimumScaleIsAuto)
 True if Microsoft Excel calculates the minimum value for the value axis. More...
 
wxExcelGridlines GetMinorGridlines ()
 Returns a Gridlines object that represents the minor gridlines for the specified axis. More...
 
XlTickMark GetMinorTickMark ()
 Returns the type of minor tick mark for the specified axis. More...
 
void SetMinorTickMark (XlTickMark minorTickMark)
 Sets the type of minor tick mark for the specified axis. More...
 
double GetMinorUnit ()
 Returns the minor units on the value axis. More...
 
void SetMinorUnit (double minorUnit)
 Sets the minor units on the value axis. More...
 
bool GetMinorUnitIsAuto ()
 True if Microsoft Excel calculates minor units for the value axis. More...
 
void SetMinorUnitIsAuto (bool minorUnitIsAuto)
 True if Microsoft Excel calculates minor units for the value axis. More...
 
XlTimeUnit GetMinorUnitScale ()
 Returns the minor unit scale value for the category axis when the CategoryType property is set to xlTimeScale. More...
 
void SetMinorUnitScale (XlTimeUnit minorUnitScale)
 Sets the minor unit scale value for the category axis when the CategoryType property is set to xlTimeScale. More...
 
bool GetReversePlotOrder ()
 True if Microsoft Excel plots data points from last to first. More...
 
void SetReversePlotOrder (bool reversePlotOrder)
 True if Microsoft Excel plots data points from last to first. More...
 
XlScaleType GetScaleType ()
 Returns the value axis scale type. More...
 
void SetScaleType (XlScaleType scaleType)
 Sets the value axis scale type. More...
 
XlTickLabelPosition GetTickLabelPosition ()
 Describes the position of tick-mark labels on the specified axis. More...
 
void SetTickLabelPosition (XlTickLabelPosition tickLabelPosition)
 Describes the position of tick-mark labels on the specified axis. More...
 
wxExcelTickLabels GetTickLabels ()
 Returns a TickLabels object that represents the tick-mark labels for the specified axis. More...
 
long GetTickLabelSpacing ()
 Returns the number of categories or series between tick-mark labels. More...
 
void SetTickLabelSpacing (long tickLabelSpacing)
 Sets the number of categories or series between tick-mark labels. More...
 
bool GetTickLabelSpacingIsAuto ()
 Returns whether or not the tick label spacing is automatic. More...
 
void SetTickLabelSpacingIsAuto (bool tickLabelSpacingIsAuto)
 Sets whether or not the tick label spacing is automatic. More...
 
long GetTickMarkSpacing ()
 Returns the number of categories or series between tick marks. More...
 
void SetTickMarkSpacing (long tickMarkSpacing)
 Sets the number of categories or series between tick marks. More...
 
double GetTop ()
 Returns a Double value that represents the distance, in points, from the top edge of the object to the top of row 1 (on a worksheet) or the top of the chart area (on a chart). More...
 
XlAxisType GetType ()
 Returns an XlAxisType value that represents the Axis type. More...
 
double GetWidth ()
 Returns a Double value that represents the width, in points, of the object. More...
 
virtual wxString GetAutoExcelObjectName_ () const
 Returns "Axis". More...
 
- Public Member Functions inherited from wxAutoExcel::wxExcelObject
bool IsOk_ () const
 Returns true if the object has a valid dispatch. 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 Axis object.

Member Function Documentation

◆ Delete()

bool wxAutoExcel::wxExcelAxis::Delete ( )

Deletes the object.

MSDN documentation for Axis.Delete.

◆ Select()

bool wxAutoExcel::wxExcelAxis::Select ( )

Selects the object.

MSDN documentation for Axis.Select.

◆ GetAxisBetweenCategories()

bool wxAutoExcel::wxExcelAxis::GetAxisBetweenCategories ( )

True if the value axis crosses the category axis between categories.

MSDN documentation for Axis.AxisBetweenCategories.

◆ SetAxisBetweenCategories()

void wxAutoExcel::wxExcelAxis::SetAxisBetweenCategories ( bool  axisBetweenCategories)

True if the value axis crosses the category axis between categories.

MSDN documentation for Axis.AxisBetweenCategories.

◆ GetAxisGroup()

XlAxisGroup wxAutoExcel::wxExcelAxis::GetAxisGroup ( )

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

MSDN documentation for Axis.AxisGroup.

◆ GetAxisTitle()

wxExcelAxisTitle wxAutoExcel::wxExcelAxis::GetAxisTitle ( )

Returns an AxisTitle object that represents the title of the specified axis.

MSDN documentation for Axis.AxisTitle.

◆ GetBaseUnit()

XlTimeUnit wxAutoExcel::wxExcelAxis::GetBaseUnit ( )

Returns the base unit for the specified category axis.

MSDN documentation for Axis.BaseUnit.

◆ SetBaseUnit()

void wxAutoExcel::wxExcelAxis::SetBaseUnit ( XlTimeUnit  baseUnit)

Sets the base unit for the specified category axis.

MSDN documentation for Axis.BaseUnit.

◆ GetBaseUnitIsAuto()

bool wxAutoExcel::wxExcelAxis::GetBaseUnitIsAuto ( )

True if Microsoft Excel chooses appropriate base units for the specified category axis.

The default value is True.

MSDN documentation for Axis.BaseUnitIsAuto.

◆ SetBaseUnitIsAuto()

void wxAutoExcel::wxExcelAxis::SetBaseUnitIsAuto ( bool  baseUnitIsAuto)

True if Microsoft Excel chooses appropriate base units for the specified category axis.

The default value is True.

MSDN documentation for Axis.BaseUnitIsAuto.

◆ GetBorder()

wxExcelBorder wxAutoExcel::wxExcelAxis::GetBorder ( )

Returns a Border object that represents the border of the object.

MSDN documentation for Axis.Border.

◆ GetCategoryNames()

wxArrayString wxAutoExcel::wxExcelAxis::GetCategoryNames ( )

Returns all the category names for the specified axis, as a text array.

When you set this property, you can set it to either an array or a Range object that contains the category names.

MSDN documentation for Axis.CategoryNames.

◆ SetCategoryNames()

void wxAutoExcel::wxExcelAxis::SetCategoryNames ( wxExcelRange  categoryNames)

Sets all the category names for the specified axis, as a text array.

When you set this property, you can set it to either an array or a Range object that contains the category names.

MSDN documentation for Axis.CategoryNames.

◆ GetCategoryType()

XlCategoryType wxAutoExcel::wxExcelAxis::GetCategoryType ( )

Returns the category axis type.

MSDN documentation for Axis.CategoryType.

◆ SetCategoryType()

void wxAutoExcel::wxExcelAxis::SetCategoryType ( XlCategoryType  categoryType)

Sets the category axis type.

MSDN documentation for Axis.CategoryType.

◆ GetCrosses()

long wxAutoExcel::wxExcelAxis::GetCrosses ( )

Returns the point on the specified axis where the other axis crosses.

MSDN documentation for Axis.Crosses.

◆ SetCrosses()

void wxAutoExcel::wxExcelAxis::SetCrosses ( long  crosses)

Sets the point on the specified axis where the other axis crosses.

MSDN documentation for Axis.Crosses.

◆ GetCrossesAt()

double wxAutoExcel::wxExcelAxis::GetCrossesAt ( )

Returns the point on the value axis where the category axis crosses it.

Applies only to the value axis.

MSDN documentation for Axis.CrossesAt.

◆ SetCrossesAt()

void wxAutoExcel::wxExcelAxis::SetCrossesAt ( double  crossesAt)

Sets the point on the value axis where the category axis crosses it.

Applies only to the value axis.

MSDN documentation for Axis.CrossesAt.

◆ GetDisplayUnit()

long wxAutoExcel::wxExcelAxis::GetDisplayUnit ( )

Returns the unit label for the value axis.

Can be XlDisplayUnit, xlCustom, or xlNone.

MSDN documentation for Axis.DisplayUnit.

◆ SetDisplayUnit()

void wxAutoExcel::wxExcelAxis::SetDisplayUnit ( long  displayUnit)

Sets the unit label for the value axis.

Can be XlDisplayUnit, xlCustom, or xlNone.

MSDN documentation for Axis.DisplayUnit.

◆ GetDisplayUnitCustom()

double wxAutoExcel::wxExcelAxis::GetDisplayUnitCustom ( )

If the value of the DisplayUnit property is xlCustom, the DisplayUnitCustom property returns or sets the value of the displayed units.

The value must be from 0 through 10E307. Read/write Double.

MSDN documentation for Axis.DisplayUnitCustom.

◆ SetDisplayUnitCustom()

void wxAutoExcel::wxExcelAxis::SetDisplayUnitCustom ( double  displayUnitCustom)

If the value of the DisplayUnit property is xlCustom, the DisplayUnitCustom property returns or sets the value of the displayed units.

The value must be from 0 through 10E307. Read/write Double.

MSDN documentation for Axis.DisplayUnitCustom.

◆ GetDisplayUnitLabel()

wxExcelDisplayUnitLabel wxAutoExcel::wxExcelAxis::GetDisplayUnitLabel ( )

Returns the DisplayUnitLabel object for the specified axis.

Returns null if the HasDisplayUnitLabel property is set to False.

MSDN documentation for Axis.DisplayUnitLabel.

◆ GetFormat()

wxExcelChartFormat wxAutoExcel::wxExcelAxis::GetFormat ( )

Returns the ChartFormat object.

Since Excel 2007.

MSDN documentation for Axis.Format.

◆ GetHasDisplayUnitLabel()

bool wxAutoExcel::wxExcelAxis::GetHasDisplayUnitLabel ( )

True if the label specified by the DisplayUnit or DisplayUnitCustom property is displayed on the specified axis.

The default value is True.

MSDN documentation for Axis.HasDisplayUnitLabel.

◆ SetHasDisplayUnitLabel()

void wxAutoExcel::wxExcelAxis::SetHasDisplayUnitLabel ( bool  hasDisplayUnitLabel)

True if the label specified by the DisplayUnit or DisplayUnitCustom property is displayed on the specified axis.

The default value is True.

MSDN documentation for Axis.HasDisplayUnitLabel.

◆ GetHasMajorGridlines()

bool wxAutoExcel::wxExcelAxis::GetHasMajorGridlines ( )

True if the axis has major gridlines.

Only axes in the primary axis group can have gridlines.

MSDN documentation for Axis.HasMajorGridlines.

◆ SetHasMajorGridlines()

void wxAutoExcel::wxExcelAxis::SetHasMajorGridlines ( bool  hasMajorGridlines)

True if the axis has major gridlines.

Only axes in the primary axis group can have gridlines.

MSDN documentation for Axis.HasMajorGridlines.

◆ GetHasMinorGridlines()

bool wxAutoExcel::wxExcelAxis::GetHasMinorGridlines ( )

True if the axis has minor gridlines.

Only axes in the primary axis group can have gridlines.

MSDN documentation for Axis.HasMinorGridlines.

◆ SetHasMinorGridlines()

void wxAutoExcel::wxExcelAxis::SetHasMinorGridlines ( bool  hasMinorGridlines)

True if the axis has minor gridlines.

Only axes in the primary axis group can have gridlines.

MSDN documentation for Axis.HasMinorGridlines.

◆ GetHasTitle()

bool wxAutoExcel::wxExcelAxis::GetHasTitle ( )

True if the axis or chart has a visible title.

MSDN documentation for Axis.HasTitle.

◆ SetHasTitle()

void wxAutoExcel::wxExcelAxis::SetHasTitle ( bool  hasTitle)

True if the axis or chart has a visible title.

MSDN documentation for Axis.HasTitle.

◆ GetHeight()

double wxAutoExcel::wxExcelAxis::GetHeight ( )

Returns a Double value that represents the height, in points, of the object.

MSDN documentation for Axis.Height.

◆ GetLeft()

double wxAutoExcel::wxExcelAxis::GetLeft ( )

Returns a Double value that represents the distance, in points, from the left edge of the object to the left edge of the chart area.

MSDN documentation for Axis.Left.

◆ GetLogBase()

double wxAutoExcel::wxExcelAxis::GetLogBase ( )

Returns the base of the logarithm when you are using log scales.

Since Excel 2007.

MSDN documentation for Axis.LogBase.

◆ SetLogBase()

void wxAutoExcel::wxExcelAxis::SetLogBase ( double  logBase)

Sets the base of the logarithm when you are using log scales.

Since Excel 2007.

MSDN documentation for Axis.LogBase.

◆ GetMajorGridlines()

wxExcelGridlines wxAutoExcel::wxExcelAxis::GetMajorGridlines ( )

Returns a Gridlines object that represents the major gridlines for the specified axis.

Only axes in the primary axis group can have gridlines.

MSDN documentation for Axis.MajorGridlines.

◆ GetMajorTickMark()

XlTickMark wxAutoExcel::wxExcelAxis::GetMajorTickMark ( )

Returns the type of major tick mark for the specified axis.

Read/write XlTickMark.

MSDN documentation for Axis.MajorTickMark.

◆ SetMajorTickMark()

void wxAutoExcel::wxExcelAxis::SetMajorTickMark ( XlTickMark  majorTickMark)

Sets the type of major tick mark for the specified axis.

Read/write XlTickMark.

MSDN documentation for Axis.MajorTickMark.

◆ GetMajorUnit()

double wxAutoExcel::wxExcelAxis::GetMajorUnit ( )

Returns the major units for the value axis.

Read/write Double.

MSDN documentation for Axis.MajorUnit.

◆ SetMajorUnit()

void wxAutoExcel::wxExcelAxis::SetMajorUnit ( double  majorUnit)

Sets the major units for the value axis.

Read/write Double.

MSDN documentation for Axis.MajorUnit.

◆ GetMajorUnitIsAuto()

bool wxAutoExcel::wxExcelAxis::GetMajorUnitIsAuto ( )

True if Microsoft Excel calculates the major units for the value axis.

MSDN documentation for Axis.MajorUnitIsAuto.

◆ SetMajorUnitIsAuto()

void wxAutoExcel::wxExcelAxis::SetMajorUnitIsAuto ( bool  majorUnitIsAuto)

True if Microsoft Excel calculates the major units for the value axis.

MSDN documentation for Axis.MajorUnitIsAuto.

◆ GetMajorUnitScale()

XlTimeUnit wxAutoExcel::wxExcelAxis::GetMajorUnitScale ( )

Returns the major unit scale value for the category axis when the CategoryType property is set to xlTimeScale.

Read/write XlTimeUnit.

MSDN documentation for Axis.MajorUnitScale.

◆ SetMajorUnitScale()

void wxAutoExcel::wxExcelAxis::SetMajorUnitScale ( XlTimeUnit  majorUnitScale)

Sets the major unit scale value for the category axis when the CategoryType property is set to xlTimeScale.

Read/write XlTimeUnit.

MSDN documentation for Axis.MajorUnitScale.

◆ GetMaximumScale()

double wxAutoExcel::wxExcelAxis::GetMaximumScale ( )

Returns the maximum value on the value axis.

Read/write Double.

MSDN documentation for Axis.MaximumScale.

◆ SetMaximumScale()

void wxAutoExcel::wxExcelAxis::SetMaximumScale ( double  maximumScale)

Sets the maximum value on the value axis.

Read/write Double.

MSDN documentation for Axis.MaximumScale.

◆ GetMaximumScaleIsAuto()

bool wxAutoExcel::wxExcelAxis::GetMaximumScaleIsAuto ( )

True if Microsoft Excel calculates the maximum value for the value axis.

MSDN documentation for Axis.MaximumScaleIsAuto.

◆ SetMaximumScaleIsAuto()

void wxAutoExcel::wxExcelAxis::SetMaximumScaleIsAuto ( bool  maximumScaleIsAuto)

True if Microsoft Excel calculates the maximum value for the value axis.

MSDN documentation for Axis.MaximumScaleIsAuto.

◆ GetMinimumScale()

double wxAutoExcel::wxExcelAxis::GetMinimumScale ( )

Returns the minimum value on the value axis.

Read/write Double.

MSDN documentation for Axis.MinimumScale.

◆ SetMinimumScale()

void wxAutoExcel::wxExcelAxis::SetMinimumScale ( double  minimumScale)

Sets the minimum value on the value axis.

Read/write Double.

MSDN documentation for Axis.MinimumScale.

◆ GetMinimumScaleIsAuto()

bool wxAutoExcel::wxExcelAxis::GetMinimumScaleIsAuto ( )

True if Microsoft Excel calculates the minimum value for the value axis.

MSDN documentation for Axis.MinimumScaleIsAuto.

◆ SetMinimumScaleIsAuto()

void wxAutoExcel::wxExcelAxis::SetMinimumScaleIsAuto ( bool  minimumScaleIsAuto)

True if Microsoft Excel calculates the minimum value for the value axis.

MSDN documentation for Axis.MinimumScaleIsAuto.

◆ GetMinorGridlines()

wxExcelGridlines wxAutoExcel::wxExcelAxis::GetMinorGridlines ( )

Returns a Gridlines object that represents the minor gridlines for the specified axis.

Only axes in the primary axis group can have gridlines.

MSDN documentation for Axis.MinorGridlines.

◆ GetMinorTickMark()

XlTickMark wxAutoExcel::wxExcelAxis::GetMinorTickMark ( )

Returns the type of minor tick mark for the specified axis.

Read/write XlTickMark.

MSDN documentation for Axis.MinorTickMark.

◆ SetMinorTickMark()

void wxAutoExcel::wxExcelAxis::SetMinorTickMark ( XlTickMark  minorTickMark)

Sets the type of minor tick mark for the specified axis.

Read/write XlTickMark.

MSDN documentation for Axis.MinorTickMark.

◆ GetMinorUnit()

double wxAutoExcel::wxExcelAxis::GetMinorUnit ( )

Returns the minor units on the value axis.

Read/write Double.

MSDN documentation for Axis.MinorUnit.

◆ SetMinorUnit()

void wxAutoExcel::wxExcelAxis::SetMinorUnit ( double  minorUnit)

Sets the minor units on the value axis.

Read/write Double.

MSDN documentation for Axis.MinorUnit.

◆ GetMinorUnitIsAuto()

bool wxAutoExcel::wxExcelAxis::GetMinorUnitIsAuto ( )

True if Microsoft Excel calculates minor units for the value axis.

MSDN documentation for Axis.MinorUnitIsAuto.

◆ SetMinorUnitIsAuto()

void wxAutoExcel::wxExcelAxis::SetMinorUnitIsAuto ( bool  minorUnitIsAuto)

True if Microsoft Excel calculates minor units for the value axis.

MSDN documentation for Axis.MinorUnitIsAuto.

◆ GetMinorUnitScale()

XlTimeUnit wxAutoExcel::wxExcelAxis::GetMinorUnitScale ( )

Returns the minor unit scale value for the category axis when the CategoryType property is set to xlTimeScale.

Read/write XlTimeUnit.

MSDN documentation for Axis.MinorUnitScale.

◆ SetMinorUnitScale()

void wxAutoExcel::wxExcelAxis::SetMinorUnitScale ( XlTimeUnit  minorUnitScale)

Sets the minor unit scale value for the category axis when the CategoryType property is set to xlTimeScale.

Read/write XlTimeUnit.

MSDN documentation for Axis.MinorUnitScale.

◆ GetReversePlotOrder()

bool wxAutoExcel::wxExcelAxis::GetReversePlotOrder ( )

True if Microsoft Excel plots data points from last to first.

MSDN documentation for Axis.ReversePlotOrder.

◆ SetReversePlotOrder()

void wxAutoExcel::wxExcelAxis::SetReversePlotOrder ( bool  reversePlotOrder)

True if Microsoft Excel plots data points from last to first.

MSDN documentation for Axis.ReversePlotOrder.

◆ GetScaleType()

XlScaleType wxAutoExcel::wxExcelAxis::GetScaleType ( )

Returns the value axis scale type.

Read/write XlScaleType.

MSDN documentation for Axis.ScaleType.

◆ SetScaleType()

void wxAutoExcel::wxExcelAxis::SetScaleType ( XlScaleType  scaleType)

Sets the value axis scale type.

Read/write XlScaleType.

MSDN documentation for Axis.ScaleType.

◆ GetTickLabelPosition()

XlTickLabelPosition wxAutoExcel::wxExcelAxis::GetTickLabelPosition ( )

Describes the position of tick-mark labels on the specified axis.

Read/write XlTickLabelPosition.

MSDN documentation for Axis.TickLabelPosition.

◆ SetTickLabelPosition()

void wxAutoExcel::wxExcelAxis::SetTickLabelPosition ( XlTickLabelPosition  tickLabelPosition)

Describes the position of tick-mark labels on the specified axis.

Read/write XlTickLabelPosition.

MSDN documentation for Axis.TickLabelPosition.

◆ GetTickLabels()

wxExcelTickLabels wxAutoExcel::wxExcelAxis::GetTickLabels ( )

Returns a TickLabels object that represents the tick-mark labels for the specified axis.

MSDN documentation for Axis.TickLabels.

◆ GetTickLabelSpacing()

long wxAutoExcel::wxExcelAxis::GetTickLabelSpacing ( )

Returns the number of categories or series between tick-mark labels.

Applies only to category and series axes. Can be a value from 1 through 31999.

MSDN documentation for Axis.TickLabelSpacing.

◆ SetTickLabelSpacing()

void wxAutoExcel::wxExcelAxis::SetTickLabelSpacing ( long  tickLabelSpacing)

Sets the number of categories or series between tick-mark labels.

Applies only to category and series axes. Can be a value from 1 through 31999.

MSDN documentation for Axis.TickLabelSpacing.

◆ GetTickLabelSpacingIsAuto()

bool wxAutoExcel::wxExcelAxis::GetTickLabelSpacingIsAuto ( )

Returns whether or not the tick label spacing is automatic.

Since Excel 2007.

MSDN documentation for Axis.TickLabelSpacingIsAuto.

◆ SetTickLabelSpacingIsAuto()

void wxAutoExcel::wxExcelAxis::SetTickLabelSpacingIsAuto ( bool  tickLabelSpacingIsAuto)

Sets whether or not the tick label spacing is automatic.

Since Excel 2007.

MSDN documentation for Axis.TickLabelSpacingIsAuto.

◆ GetTickMarkSpacing()

long wxAutoExcel::wxExcelAxis::GetTickMarkSpacing ( )

Returns the number of categories or series between tick marks.

Applies only to category and series axes. Can be a value from 1 through 31999.

MSDN documentation for Axis.TickMarkSpacing.

◆ SetTickMarkSpacing()

void wxAutoExcel::wxExcelAxis::SetTickMarkSpacing ( long  tickMarkSpacing)

Sets the number of categories or series between tick marks.

Applies only to category and series axes. Can be a value from 1 through 31999.

MSDN documentation for Axis.TickMarkSpacing.

◆ GetTop()

double wxAutoExcel::wxExcelAxis::GetTop ( )

Returns a Double value that represents the distance, in points, from the top edge of the object to the top of row 1 (on a worksheet) or the top of the chart area (on a chart).

MSDN documentation for Axis.Top.

◆ GetType()

XlAxisType wxAutoExcel::wxExcelAxis::GetType ( )

Returns an XlAxisType value that represents the Axis type.

MSDN documentation for Axis.Type.

◆ GetWidth()

double wxAutoExcel::wxExcelAxis::GetWidth ( )

Returns a Double value that represents the width, in points, of the object.

MSDN documentation for Axis.Width.

◆ GetAutoExcelObjectName_()

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

Returns "Axis".

Reimplemented from wxAutoExcel::wxExcelObject.