Aspose::Words::Drawing::Charts::ChartAxis Class Reference

Represents the axis options of the chart. More...

#include "Model/Drawing/Charts/ChartAxis.h"

Inherits IDmlChartTitleHolder, IDmlExtensionListSource, and INumberFormatProvider.

Public Member Functions

Aspose::Words::Drawing::Charts::ChartAxisType get_Type () const
 Returns type of the axis. More...
 
Aspose::Words::Drawing::Charts::AxisCategoryType get_CategoryType ()
 Gets or sets type of the category axis. More...
 
void set_CategoryType (Aspose::Words::Drawing::Charts::AxisCategoryType value)
 Setter for Aspose::Words::Drawing::Charts::ChartAxis::get_CategoryType. More...
 
Aspose::Words::Drawing::Charts::AxisCrosses get_Crosses ()
 Specifies how this axis crosses the perpendicular axis. More...
 
void set_Crosses (Aspose::Words::Drawing::Charts::AxisCrosses value)
 Setter for Aspose::Words::Drawing::Charts::ChartAxis::get_Crosses. More...
 
double get_CrossesAt ()
 Specifies where on the perpendicular axis the axis crosses. More...
 
void set_CrossesAt (double value)
 Setter for Aspose::Words::Drawing::Charts::ChartAxis::get_CrossesAt. More...
 
bool get_ReverseOrder ()
 Returns or sets a flag indicating whether values of axis should be displayed in reverse order, i.e. from max to min. More...
 
void set_ReverseOrder (bool value)
 Setter for Aspose::Words::Drawing::Charts::ChartAxis::get_ReverseOrder. More...
 
Aspose::Words::Drawing::Charts::AxisTickMark get_MajorTickMark ()
 Returns or sets the major tick marks. More...
 
void set_MajorTickMark (Aspose::Words::Drawing::Charts::AxisTickMark value)
 Setter for Aspose::Words::Drawing::Charts::ChartAxis::get_MajorTickMark. More...
 
Aspose::Words::Drawing::Charts::AxisTickMark get_MinorTickMark ()
 Returns or sets the minor tick marks for the axis. More...
 
void set_MinorTickMark (Aspose::Words::Drawing::Charts::AxisTickMark value)
 Setter for Aspose::Words::Drawing::Charts::ChartAxis::get_MinorTickMark. More...
 
Aspose::Words::Drawing::Charts::AxisTickLabelPosition get_TickLabelPosition ()
 Returns or sets the position of the tick labels on the axis. More...
 
void set_TickLabelPosition (Aspose::Words::Drawing::Charts::AxisTickLabelPosition value)
 Setter for Aspose::Words::Drawing::Charts::ChartAxis::get_TickLabelPosition. More...
 
double get_MajorUnit ()
 Returns or sets the distance between major tick marks. More...
 
void set_MajorUnit (double value)
 Setter for Aspose::Words::Drawing::Charts::ChartAxis::get_MajorUnit. More...
 
bool get_MajorUnitIsAuto ()
 Gets or sets a flag indicating whether default distance between major tick marks shall be used. More...
 
void set_MajorUnitIsAuto (bool value)
 Setter for Aspose::Words::Drawing::Charts::ChartAxis::get_MajorUnitIsAuto. More...
 
Aspose::Words::Drawing::Charts::AxisTimeUnit get_MajorUnitScale ()
 Returns or sets the scale value for major tick marks on the time category axis. More...
 
void set_MajorUnitScale (Aspose::Words::Drawing::Charts::AxisTimeUnit value)
 Setter for Aspose::Words::Drawing::Charts::ChartAxis::get_MajorUnitScale. More...
 
double get_MinorUnit ()
 Returns or sets the distance between minor tick marks. More...
 
void set_MinorUnit (double value)
 Setter for Aspose::Words::Drawing::Charts::ChartAxis::get_MinorUnit. More...
 
bool get_MinorUnitIsAuto ()
 Gets or sets a flag indicating whether default distance between minor tick marks shall be used. More...
 
void set_MinorUnitIsAuto (bool value)
 Setter for Aspose::Words::Drawing::Charts::ChartAxis::get_MinorUnitIsAuto. More...
 
Aspose::Words::Drawing::Charts::AxisTimeUnit get_MinorUnitScale ()
 Returns or sets the scale value for minor tick marks on the time category axis. More...
 
void set_MinorUnitScale (Aspose::Words::Drawing::Charts::AxisTimeUnit value)
 Setter for Aspose::Words::Drawing::Charts::ChartAxis::get_MinorUnitScale. More...
 
Aspose::Words::Drawing::Charts::AxisTimeUnit get_BaseTimeUnit ()
 Returns or sets the smallest time unit that is represented on the time category axis. More...
 
void set_BaseTimeUnit (Aspose::Words::Drawing::Charts::AxisTimeUnit value)
 Setter for Aspose::Words::Drawing::Charts::ChartAxis::get_BaseTimeUnit. More...
 
System::SharedPtr< Aspose::Words::Drawing::Charts::ChartNumberFormatget_NumberFormat ()
 Returns a Aspose::Words::Drawing::Charts::ChartNumberFormat object that allows defining number formats for the axis. More...
 
int32_t get_TickLabelOffset ()
 Gets or sets the distance of labels from the axis. More...
 
void set_TickLabelOffset (int32_t value)
 Setter for Aspose::Words::Drawing::Charts::ChartAxis::get_TickLabelOffset. More...
 
System::SharedPtr< Aspose::Words::Drawing::Charts::AxisDisplayUnitget_DisplayUnit ()
 Specifies the scaling value of the display units for the value axis. More...
 
bool get_AxisBetweenCategories ()
 Gets or sets a flag indicating whether the value axis crosses the category axis between categories. More...
 
void set_AxisBetweenCategories (bool value)
 Setter for Aspose::Words::Drawing::Charts::ChartAxis::get_AxisBetweenCategories. More...
 
System::SharedPtr< Aspose::Words::Drawing::Charts::AxisScalingget_Scaling ()
 Provides access to the scaling options of the axis. More...
 
int32_t get_TickLabelSpacing ()
 Gets or sets the interval, at which tick labels are drawn. More...
 
void set_TickLabelSpacing (int32_t value)
 Setter for Aspose::Words::Drawing::Charts::ChartAxis::get_TickLabelSpacing. More...
 
bool get_TickLabelSpacingIsAuto ()
 Gets or sets a flag indicating whether automatic interval of drawing tick labels shall be used. More...
 
void set_TickLabelSpacingIsAuto (bool value)
 Setter for Aspose::Words::Drawing::Charts::ChartAxis::get_TickLabelSpacingIsAuto. More...
 
Aspose::Words::ParagraphAlignment get_TickLabelAlignment ()
 Gets or sets text alignment of axis tick labels. More...
 
void set_TickLabelAlignment (Aspose::Words::ParagraphAlignment value)
 Setter for Aspose::Words::Drawing::Charts::ChartAxis::get_TickLabelAlignment. More...
 
int32_t get_TickMarkSpacing ()
 Gets or sets the interval, at which tick marks are drawn. More...
 
void set_TickMarkSpacing (int32_t value)
 Setter for Aspose::Words::Drawing::Charts::ChartAxis::get_TickMarkSpacing. More...
 
bool get_Hidden ()
 Gets or sets a flag indicating whether this axis is hidden or not. More...
 
void set_Hidden (bool value)
 Setter for Aspose::Words::Drawing::Charts::ChartAxis::get_Hidden. More...
 
System::SharedPtr< Aspose::Words::Drawing::Charts::ChartTitleget_Title ()
 
void set_Title (System::SharedPtr< Aspose::Words::Drawing::Charts::ChartTitle > value)
 
Aspose::Words::Drawing::Charts::Core::SimpleTypes::TitlePosition get_TitlePosition ()
 
System::SharedPtr< Aspose::Words::DocumentBaseget_Document ()
 Returns the Document the title holder belongs. More...
 
bool get_TitleDeleted ()
 
void set_TitleDeleted (bool value)
 
bool get_IsChartTitle ()
 
System::SharedPtr< Aspose::Words::Drawing::Charts::Core::ComplexTypes::DmlChartNumFormat > get_NumFmt_INumberFormatProvider ()
 
void set_NumFmt_INumberFormatProvider (System::SharedPtr< Aspose::Words::Drawing::Charts::Core::ComplexTypes::DmlChartNumFormat > value)
 
System::SharedPtr< Aspose::Collections::StringToObjDictionary< System::SharedPtr< Aspose::Words::Drawing::Core::Dml::DmlExtension > > > get_Extensions ()
 
void set_Extensions (System::SharedPtr< Aspose::Collections::StringToObjDictionary< System::SharedPtr< Aspose::Words::Drawing::Core::Dml::DmlExtension >>> value)
 
System::SharedPtr< Aspose::Words::Drawing::Charts::Core::ComplexTypes::DmlChartTx > GenerateAutoTitle (System::SharedPtr< Aspose::Words::ApsBuilder::Dml::Charts::DmlChartRenderingContext > context)
 

Detailed Description

Represents the axis options of the chart.

Member Function Documentation

◆ GenerateAutoTitle()

System::SharedPtr<Aspose::Words::Drawing::Charts::Core::ComplexTypes::DmlChartTx> Aspose::Words::Drawing::Charts::ChartAxis::GenerateAutoTitle ( System::SharedPtr< Aspose::Words::ApsBuilder::Dml::Charts::DmlChartRenderingContext >  context)

◆ get_AxisBetweenCategories()

bool Aspose::Words::Drawing::Charts::ChartAxis::get_AxisBetweenCategories ( )

Gets or sets a flag indicating whether the value axis crosses the category axis between categories.

The property has effect only for value axes. It is not supported by MS Office 2016 new charts.

◆ get_BaseTimeUnit()

Aspose::Words::Drawing::Charts::AxisTimeUnit Aspose::Words::Drawing::Charts::ChartAxis::get_BaseTimeUnit ( )

Returns or sets the smallest time unit that is represented on the time category axis.

The property has effect only for time category axes.

◆ get_CategoryType()

Aspose::Words::Drawing::Charts::AxisCategoryType Aspose::Words::Drawing::Charts::ChartAxis::get_CategoryType ( )

Gets or sets type of the category axis.

Only text categories (Aspose::Words::Drawing::Charts::AxisCategoryType::Category) are allowed in MS Office 2016 new charts.

◆ get_Crosses()

Aspose::Words::Drawing::Charts::AxisCrosses Aspose::Words::Drawing::Charts::ChartAxis::get_Crosses ( )

Specifies how this axis crosses the perpendicular axis.

Default value is Aspose::Words::Drawing::Charts::AxisCrosses::Automatic.

The property is not supported by MS Office 2016 new charts.

◆ get_CrossesAt()

double Aspose::Words::Drawing::Charts::ChartAxis::get_CrossesAt ( )

Specifies where on the perpendicular axis the axis crosses.

The property has effect only if Aspose::Words::Drawing::Charts::ChartAxis::get_Crosses are set to Aspose::Words::Drawing::Charts::AxisCrosses::Custom. It is not supported by MS Office 2016 new charts.

The units are determined by the type of axis. When the axis is a value axis, the value of the property is a decimal number on the value axis. When the axis is a time category axis, the value is defined as an integer number of days relative to the base date (30/12/1899). For a text category axis, the value is an integer category number, starting with 1 as the first category.

◆ get_DisplayUnit()

System::SharedPtr<Aspose::Words::Drawing::Charts::AxisDisplayUnit> Aspose::Words::Drawing::Charts::ChartAxis::get_DisplayUnit ( )

Specifies the scaling value of the display units for the value axis.

The property has effect only for value axes.

◆ get_Document()

System::SharedPtr<Aspose::Words::DocumentBase> Aspose::Words::Drawing::Charts::ChartAxis::get_Document ( )

Returns the Document the title holder belongs.

◆ get_Extensions()

System::SharedPtr<Aspose::Collections::StringToObjDictionary<System::SharedPtr<Aspose::Words::Drawing::Core::Dml::DmlExtension> > > Aspose::Words::Drawing::Charts::ChartAxis::get_Extensions ( )

◆ get_Hidden()

bool Aspose::Words::Drawing::Charts::ChartAxis::get_Hidden ( )

Gets or sets a flag indicating whether this axis is hidden or not.

Default value is false.

◆ get_IsChartTitle()

bool Aspose::Words::Drawing::Charts::ChartAxis::get_IsChartTitle ( )

◆ get_MajorTickMark()

Aspose::Words::Drawing::Charts::AxisTickMark Aspose::Words::Drawing::Charts::ChartAxis::get_MajorTickMark ( )

Returns or sets the major tick marks.

◆ get_MajorUnit()

double Aspose::Words::Drawing::Charts::ChartAxis::get_MajorUnit ( )

Returns or sets the distance between major tick marks.

Valid range of a value is greater than zero. The property has effect for time category and value axes.

Setting this property sets the Aspose::Words::Drawing::Charts::ChartAxis::get_MajorUnitIsAuto property to false.

◆ get_MajorUnitIsAuto()

bool Aspose::Words::Drawing::Charts::ChartAxis::get_MajorUnitIsAuto ( )

Gets or sets a flag indicating whether default distance between major tick marks shall be used.

The property has effect for time category and value axes.

◆ get_MajorUnitScale()

Aspose::Words::Drawing::Charts::AxisTimeUnit Aspose::Words::Drawing::Charts::ChartAxis::get_MajorUnitScale ( )

Returns or sets the scale value for major tick marks on the time category axis.

The property has effect only for time category axes.

◆ get_MinorTickMark()

Aspose::Words::Drawing::Charts::AxisTickMark Aspose::Words::Drawing::Charts::ChartAxis::get_MinorTickMark ( )

Returns or sets the minor tick marks for the axis.

◆ get_MinorUnit()

double Aspose::Words::Drawing::Charts::ChartAxis::get_MinorUnit ( )

Returns or sets the distance between minor tick marks.

Valid range of a value is greater than zero. The property has effect for time category and value axes.

Setting this property sets the Aspose::Words::Drawing::Charts::ChartAxis::get_MinorUnitIsAuto property to false.

◆ get_MinorUnitIsAuto()

bool Aspose::Words::Drawing::Charts::ChartAxis::get_MinorUnitIsAuto ( )

Gets or sets a flag indicating whether default distance between minor tick marks shall be used.

The property has effect for time category and value axes.

◆ get_MinorUnitScale()

Aspose::Words::Drawing::Charts::AxisTimeUnit Aspose::Words::Drawing::Charts::ChartAxis::get_MinorUnitScale ( )

Returns or sets the scale value for minor tick marks on the time category axis.

The property has effect only for time category axes.

◆ get_NumberFormat()

System::SharedPtr<Aspose::Words::Drawing::Charts::ChartNumberFormat> Aspose::Words::Drawing::Charts::ChartAxis::get_NumberFormat ( )

Returns a Aspose::Words::Drawing::Charts::ChartNumberFormat object that allows defining number formats for the axis.

◆ get_NumFmt_INumberFormatProvider()

System::SharedPtr<Aspose::Words::Drawing::Charts::Core::ComplexTypes::DmlChartNumFormat> Aspose::Words::Drawing::Charts::ChartAxis::get_NumFmt_INumberFormatProvider ( )

◆ get_ReverseOrder()

bool Aspose::Words::Drawing::Charts::ChartAxis::get_ReverseOrder ( )

Returns or sets a flag indicating whether values of axis should be displayed in reverse order, i.e. from max to min.

The property is not supported by MS Office 2016 new charts. Default value is false.

◆ get_Scaling()

System::SharedPtr<Aspose::Words::Drawing::Charts::AxisScaling> Aspose::Words::Drawing::Charts::ChartAxis::get_Scaling ( )

Provides access to the scaling options of the axis.

◆ get_TickLabelAlignment()

Aspose::Words::ParagraphAlignment Aspose::Words::Drawing::Charts::ChartAxis::get_TickLabelAlignment ( )

Gets or sets text alignment of axis tick labels.

This property has effect only for multi-line labels.

Default value is Aspose::Words::ParagraphAlignment::Center.

.

◆ get_TickLabelOffset()

int32_t Aspose::Words::Drawing::Charts::ChartAxis::get_TickLabelOffset ( )

Gets or sets the distance of labels from the axis.

The property represents a percentage of the default label offset.

Valid range is from 0 to 1000 percent inclusive. Default value is 100%.

The property has effect only for category axes. It is not supported by MS Office 2016 new charts.

◆ get_TickLabelPosition()

Aspose::Words::Drawing::Charts::AxisTickLabelPosition Aspose::Words::Drawing::Charts::ChartAxis::get_TickLabelPosition ( )

Returns or sets the position of the tick labels on the axis.

The property is not supported by MS Office 2016 new charts.

◆ get_TickLabelSpacing()

int32_t Aspose::Words::Drawing::Charts::ChartAxis::get_TickLabelSpacing ( )

Gets or sets the interval, at which tick labels are drawn.

The property has effect for text category and series axes. It is not supported by MS Office 2016 new charts. Valid range of a value is greater than or equal to 1.

Setting this property sets the Aspose::Words::Drawing::Charts::ChartAxis::get_TickLabelSpacingIsAuto property to false.

◆ get_TickLabelSpacingIsAuto()

bool Aspose::Words::Drawing::Charts::ChartAxis::get_TickLabelSpacingIsAuto ( )

Gets or sets a flag indicating whether automatic interval of drawing tick labels shall be used.

Default value is true.

The property has effect for text category and series axes. It is not supported by MS Office 2016 new charts.

◆ get_TickMarkSpacing()

int32_t Aspose::Words::Drawing::Charts::ChartAxis::get_TickMarkSpacing ( )

Gets or sets the interval, at which tick marks are drawn.

The property has effect for text category and series axes. It is not supported by MS Office 2016 new charts.

Valid range of a value is greater than or equal to 1.

◆ get_Title()

System::SharedPtr<Aspose::Words::Drawing::Charts::ChartTitle> Aspose::Words::Drawing::Charts::ChartAxis::get_Title ( )

◆ get_TitleDeleted()

bool Aspose::Words::Drawing::Charts::ChartAxis::get_TitleDeleted ( )

◆ get_TitlePosition()

Aspose::Words::Drawing::Charts::Core::SimpleTypes::TitlePosition Aspose::Words::Drawing::Charts::ChartAxis::get_TitlePosition ( )

◆ get_Type()

Aspose::Words::Drawing::Charts::ChartAxisType Aspose::Words::Drawing::Charts::ChartAxis::get_Type ( ) const

Returns type of the axis.

◆ set_AxisBetweenCategories()

void Aspose::Words::Drawing::Charts::ChartAxis::set_AxisBetweenCategories ( bool  value)

◆ set_BaseTimeUnit()

void Aspose::Words::Drawing::Charts::ChartAxis::set_BaseTimeUnit ( Aspose::Words::Drawing::Charts::AxisTimeUnit  value)

◆ set_CategoryType()

void Aspose::Words::Drawing::Charts::ChartAxis::set_CategoryType ( Aspose::Words::Drawing::Charts::AxisCategoryType  value)

◆ set_Crosses()

void Aspose::Words::Drawing::Charts::ChartAxis::set_Crosses ( Aspose::Words::Drawing::Charts::AxisCrosses  value)

◆ set_CrossesAt()

void Aspose::Words::Drawing::Charts::ChartAxis::set_CrossesAt ( double  value)

◆ set_Extensions()

void Aspose::Words::Drawing::Charts::ChartAxis::set_Extensions ( System::SharedPtr< Aspose::Collections::StringToObjDictionary< System::SharedPtr< Aspose::Words::Drawing::Core::Dml::DmlExtension >>>  value)

◆ set_Hidden()

void Aspose::Words::Drawing::Charts::ChartAxis::set_Hidden ( bool  value)

◆ set_MajorTickMark()

void Aspose::Words::Drawing::Charts::ChartAxis::set_MajorTickMark ( Aspose::Words::Drawing::Charts::AxisTickMark  value)

◆ set_MajorUnit()

void Aspose::Words::Drawing::Charts::ChartAxis::set_MajorUnit ( double  value)

◆ set_MajorUnitIsAuto()

void Aspose::Words::Drawing::Charts::ChartAxis::set_MajorUnitIsAuto ( bool  value)

◆ set_MajorUnitScale()

void Aspose::Words::Drawing::Charts::ChartAxis::set_MajorUnitScale ( Aspose::Words::Drawing::Charts::AxisTimeUnit  value)

◆ set_MinorTickMark()

void Aspose::Words::Drawing::Charts::ChartAxis::set_MinorTickMark ( Aspose::Words::Drawing::Charts::AxisTickMark  value)

◆ set_MinorUnit()

void Aspose::Words::Drawing::Charts::ChartAxis::set_MinorUnit ( double  value)

◆ set_MinorUnitIsAuto()

void Aspose::Words::Drawing::Charts::ChartAxis::set_MinorUnitIsAuto ( bool  value)

◆ set_MinorUnitScale()

void Aspose::Words::Drawing::Charts::ChartAxis::set_MinorUnitScale ( Aspose::Words::Drawing::Charts::AxisTimeUnit  value)

◆ set_NumFmt_INumberFormatProvider()

void Aspose::Words::Drawing::Charts::ChartAxis::set_NumFmt_INumberFormatProvider ( System::SharedPtr< Aspose::Words::Drawing::Charts::Core::ComplexTypes::DmlChartNumFormat >  value)

◆ set_ReverseOrder()

void Aspose::Words::Drawing::Charts::ChartAxis::set_ReverseOrder ( bool  value)

◆ set_TickLabelAlignment()

void Aspose::Words::Drawing::Charts::ChartAxis::set_TickLabelAlignment ( Aspose::Words::ParagraphAlignment  value)

◆ set_TickLabelOffset()

void Aspose::Words::Drawing::Charts::ChartAxis::set_TickLabelOffset ( int32_t  value)

◆ set_TickLabelPosition()

void Aspose::Words::Drawing::Charts::ChartAxis::set_TickLabelPosition ( Aspose::Words::Drawing::Charts::AxisTickLabelPosition  value)

◆ set_TickLabelSpacing()

void Aspose::Words::Drawing::Charts::ChartAxis::set_TickLabelSpacing ( int32_t  value)

◆ set_TickLabelSpacingIsAuto()

void Aspose::Words::Drawing::Charts::ChartAxis::set_TickLabelSpacingIsAuto ( bool  value)

◆ set_TickMarkSpacing()

void Aspose::Words::Drawing::Charts::ChartAxis::set_TickMarkSpacing ( int32_t  value)

◆ set_Title()

void Aspose::Words::Drawing::Charts::ChartAxis::set_Title ( System::SharedPtr< Aspose::Words::Drawing::Charts::ChartTitle value)

◆ set_TitleDeleted()

void Aspose::Words::Drawing::Charts::ChartAxis::set_TitleDeleted ( bool  value)