Axis

Axis class

Encapsulates the object that represents a chart’s axis.

class Axis : public Aspose::Slides::DomObject<System::SharedPtr<Aspose::Slides::Charts::AxesManager>>,
             public Aspose::Slides::Charts::IAxis

Methods

MethodDescription
virtual bool Equals(ptr)Compares objects using C# Object.Equals semantics.
static std::enable_if<IsSmartPtr<T1>::value&&IsSmartPtr<T2>::value, bool>::type Equals(T1 const&, T2 const&)Compares reference type objects in C# style.
static std::enable_if<!IsSmartPtr<T1>::value&&!IsSmartPtr<T2>::value, bool>::type Equals(T1 const&, T2 const&)Compares value type objects in C# style.
static bool Equals(float const&, float const&)Emulates C#-style floating point comparison where two NaNs are considered equal even though according to IEC 60559:1989 NaN is not equal to any value, including NaN.
static bool Equals(double const&, double const&)Emulates C#-style floating point comparison where two NaNs are considered equal even though according to IEC 60559:1989 NaN is not equal to any value, including NaN.
virtual bool FastCast(const Details::FastRttiBase&, void **) constFor internal purposes only.
double get_ActualMajorUnit() overrideSpecifies actual major unit of the axis. Call method IChart::ValidateChartLayout previously to get actual value.
TimeUnitType get_ActualMajorUnitScale() overrideSpecifies actual major unit scale of the axis. Call method IChart::ValidateChartLayout previously to get actual value.
double get_ActualMaxValue() overrideSpecifies actual maximum value on the axis. Call method IChart::ValidateChartLayout previously to get actual value.
double get_ActualMinorUnit() overrideSpecifies actual minor unit of the axis. Call method IChart::ValidateChartLayout previously to get actual value.
TimeUnitType get_ActualMinorUnitScale() overrideSpecifies actual minor unit scale of the axis. Call method IChart::ValidateChartLayout previously to get actual value.
double get_ActualMinValue() overrideSpecifies actual minimum value on the axis. Call method IChart::ValidateChartLayout previously to get actual value.
AxisAggregationType get_AggregationType() overrideRepresents aggregation type of category axis (binning). Applied to category. Used with Histogram or HistogramPareto series only.
bool get_AxisBetweenCategories() overrideRepresents if the value axis crosses the category axis between categories. This property applies only to category axes, and it doesn’t apply to 3-D charts. Read bool.
TimeUnitType get_BaseUnitScale() overrideSpecifies the smallest time unit that is represented on the date axis. Read TimeUnitType.
double get_BinWidth() overrideSpecifies bin width when AggregationType property value setted to AxisAggregationType::ByBinWidth. Applied to category axes. Used with Histogram or HistogramPareto series only.
Aspose::Slides::Charts::CategoryAxisType get_CategoryAxisType() overrideSpecifies the type of the category axis. Read Charts::CategoryAxisType.
System::SharedPtr<IChart> get_Chart() overrideReturns the parent chart. Read-only IChart.
float get_CrossAt() overrideRepresents the point on the axis where the perpendicular axis crosses it. Read float.
CrossesType get_CrossType() overrideRepresents the CrossType on the specified axis where the other axis crosses. Read CrossesType.
DisplayUnitType get_DisplayUnit() overrideSpecifies the scaling value of the display units for the value axis. Read DisplayUnitType.
System::SharedPtr<IAxisFormat> get_Format() overrideRepresents format of axis. Read-only IAxisFormat.
bool get_HasTitle() overrideDetermines whether a axis has a visible title. Read bool.
bool get_IsAutomaticMajorUnit() overrideIndicates whether the major unit of the axis is automatically assigned. Read bool.
bool get_IsAutomaticMaxValue() overrideIndicates whether the max value is automatically assigned. Read bool.
bool get_IsAutomaticMinorUnit() overrideIndicates whether the minor unit of the axis is automatically assigned. Read bool.
bool get_IsAutomaticMinValue() overrideIndicates whether the min value is automatically assigned. Read bool.
bool get_IsAutomaticOverflowBin() overrideSpecifies automatic overflow bin value. If false: use OverflowBin property.
bool get_IsAutomaticTickLabelSpacing() overrideSpecifies automatic tick label spacing value. If false: use TickLabelSpacing property. Read bool.
bool get_IsAutomaticTickMarksSpacing() overrideSpecifies automatic tick marks spacing value. If false: use TickMarksSpacing property. Read bool.
bool get_IsAutomaticUnderflowBin() overrideSpecifies automatic underflow bin value. If false: use UnderflowBin property.
bool get_IsLogarithmic() overrideRepresents if the value axis scale type is logarithmic or not. Read bool.
bool get_IsNumberFormatLinkedToSource() overrideIndicates whether the format is linked source data. Read bool.
bool get_IsOverflowBin() overrideSpecifies if overflow bin applied. Use IsAutomaticOverflowBin and OverflowBin to adjust overflow bin value.
bool get_IsPlotOrderReversed() overrideRepresents if MS PowerPoint plots data points from last to first. Read bool.
bool get_IsUnderflowBin() overrideSpecifies if underflow bin applied. Use IsAutomaticUnderflowBin and UnderflowBin to adjust underflow bin value.
bool get_IsVisible() overrideRepresents if the axis is visible. Read bool.
uint16_t get_LabelOffset() overrideSpecifies the distance of labels from the axis. Applied to category or date axis. Value must be between 0% and 1000%. Read uint16_t.
double get_LogBase() overrideRepresents the logarithmic base. Default value is 10. Read double.
System::SharedPtr<IChartLinesFormat> get_MajorGridLinesFormat() overrideRepresents major gridlines format on a chart axis. Read-only IChartLinesFormat.
TickMarkType get_MajorTickMark() overrideRepresents the type of major tick mark for the specified axis. Read TickMarkType.
double get_MajorUnit() overrideRepresents the major units for the date or value axis. Read double.
TimeUnitType get_MajorUnitScale() overrideRepresents the major unit scale for the date axis. Read TimeUnitType.
double get_MaxValue() overrideRepresents the maximum value on the value axis. Read double.
System::SharedPtr<IChartLinesFormat> get_MinorGridLinesFormat() overrideRepresents minor gridlines format on a chart axis. Read-only IChartLinesFormat.
TickMarkType get_MinorTickMark() overrideRepresents the type of minor tick mark for the specified axis. Read TickMarkType.
double get_MinorUnit() overrideRepresents the minor units for the date or value axis. Read double.
TimeUnitType get_MinorUnitScale() overrideRepresents the major unit scale for the date axis. Read TimeUnitType.
double get_MinValue() overrideRepresents the minimum value on the value axis. Read double.
System::String get_NumberFormat() overrideRepresents the format string for the Axis Labels. Read System::String.
uint32_t get_NumberOfBins() overrideSpecifies number of bins when AggregationType property value setted to AxisAggregationType::ByNumberOfBins. Applied to category axes. Used with Histogram or HistogramPareto series only.
double get_OverflowBin() overrideSpecifies overflow bin custom value. Applied when IsAutomaticOverflowBin property setted to false and IsOverflowBin property equals true.
AxisPositionType get_Position() overrideRepresents position of axis. Read AxisPositionType.
bool get_ShowMajorGridLines() overrideTo hide major gridline set get_MajorGridLinesFormat()->get_Line()->get_FillFormat()->get(set)_FillType() to FillType::NoFill. Read-only bool.
bool get_ShowMinorGridLines() overrideTo hide minor gridline set get_MinorGridLinesFormat()->get_Line()->get_FillFormat()->get(set)_FillType() to FillType::NoFill. Read-only bool.
System::SharedPtr<IChartTextFormat> get_TextFormat() overrideRepresents format of text. Read-only IChartTextFormat.
TickLabelPositionType get_TickLabelPosition() overrideRepresents the position of tick-mark labels on the specified axis. Read TickLabelPositionType.
float get_TickLabelRotationAngle() overrideRepresents the rotation angle of tick labels. Read float.
uint32_t get_TickLabelSpacing() overrideSpecifies how many tick labels to skip between label that is drawn. Applied to category or series axis. Read uint32_t.
uint32_t get_TickMarksSpacing() overrideSpecifies how many tick marks shall be skipped before the next one shall be drawn. Applied to category or series axis. Read uint16_t.
System::SharedPtr<IChartTitle> get_Title() overrideGets the axis’ title. Read-only IChartTitle.
double get_UnderflowBin() overrideSpecifies underflow bin custom value. Applied when IsAutomaticUnderflowBin property setted to false and IsUnderflowBin property equals true.
Detail::SmartPtrCounter * GetCounter()Gets reference counter data structure associated with the object.
virtual int32_t GetHashCode() constAnalog of C# Object.GetHashCode() method. Enables hashing of custom objects.
virtual const TypeInfo& GetType() constGets actual type of object. Analog of C# System.Object.GetType() call.
virtual bool Is(const TypeInfo&) constCheck if object represents an instance of type described by targetType. Analog of C# ‘is’ operator.
void Lock()Implements C# lock() statement locking. Call directly or use LockContext sentry object.
virtual ptr MemberwiseClone() constAnalog of C# Object.MemberwiseClone() method. Enables cloning custom types.
Object()Creates object. Initializes all internal data structures.
Object(Object const&)Copy constructor. Doesn’t copy anything, really, just initializes new object and enables copy constructing subclasses.
Object& operator=(Object const&)Assignment operator. Doesn’t copy anything, really, just initializes new object and enables copy constructing subclasses.
static bool ReferenceEquals(ptr const&, ptr const&)Compares objects by reference.
static std::enable_if<!IsSmartPtr<T>::value, bool>::type ReferenceEquals(T const&, T const&)Compares objects by reference.
static std::enable_if<!IsSmartPtr<T>::value, bool>::type ReferenceEquals(T const&, std::nullptr_t)Reference-compares value type object with nullptr.
bool ReferenceEquals(String const&, std::nullptr_t)Specialization of Object::ReferenceEquals for case of string and nullptr.
bool ReferenceEquals(String const&, String const&)Specialization of Object::ReferenceEquals for case of strings.
int RemovedSharedRefs(int)Decreases shared reference count by specified value.
void set_AggregationType(AxisAggregationType) overrideRepresents aggregation type of category axis (binning). Applied to category. Used with Histogram or HistogramPareto series only.
void set_AxisBetweenCategories(bool) overrideRepresents if the value axis crosses the category axis between categories. This property applies only to category axes, and it doesn’t apply to 3-D charts. Write bool.
void set_BaseUnitScale(TimeUnitType) overrideSpecifies the smallest time unit that is represented on the date axis. Write TimeUnitType.
void set_BinWidth(double) overrideSpecifies bin width when AggregationType property value setted to AxisAggregationType::ByBinWidth. Applied to category axes. Used with Histogram or HistogramPareto series only.
void set_CategoryAxisType(Aspose::Slides::Charts::CategoryAxisType) overrideSpecifies the type of the category axis. Write Charts::CategoryAxisType.
void set_CrossAt(float) overrideRepresents the point on the axis where the perpendicular axis crosses it. Write float.
void set_CrossType(CrossesType) overrideRepresents the CrossType on the specified axis where the other axis crosses. Write CrossesType.
void set_DisplayUnit(DisplayUnitType) overrideSpecifies the scaling value of the display units for the value axis. Write DisplayUnitType.
void set_HasTitle(bool) overrideDetermines whether a axis has a visible title. Write bool.
void set_IsAutomaticMajorUnit(bool) overrideIndicates whether the major unit of the axis is automatically assigned. Write bool.
void set_IsAutomaticMaxValue(bool) overrideIndicates whether the max value is automatically assigned. Write bool.
void set_IsAutomaticMinorUnit(bool) overrideIndicates whether the minor unit of the axis is automatically assigned. Write bool.
void set_IsAutomaticMinValue(bool) overrideIndicates whether the min value is automatically assigned. Write bool.
void set_IsAutomaticOverflowBin(bool) overrideSpecifies automatic overflow bin value. If false: use OverflowBin property.
void set_IsAutomaticTickLabelSpacing(bool) overrideSpecifies automatic tick label spacing value. If false: use TickLabelSpacing property. Write bool.
void set_IsAutomaticTickMarksSpacing(bool) overrideSpecifies automatic tick marks spacing value. If false: use TickMarksSpacing property. Write bool.
void set_IsAutomaticUnderflowBin(bool) overrideSpecifies automatic underflow bin value. If false: use UnderflowBin property.
void set_IsLogarithmic(bool) overrideRepresents if the value axis scale type is logarithmic or not. Write bool.
void set_IsNumberFormatLinkedToSource(bool) overrideIndicates whether the format is linked source data. Write bool.
void set_IsOverflowBin(bool) overrideSpecifies if overflow bin applied. Use IsAutomaticOverflowBin and OverflowBin to adjust overflow bin value.
void set_IsPlotOrderReversed(bool) overrideRepresents if MS PowerPoint plots data points from last to first. Write bool.
void set_IsUnderflowBin(bool) overrideSpecifies if underflow bin applied. Use IsAutomaticUnderflowBin and UnderflowBin to adjust underflow bin value.
void set_IsVisible(bool) overrideRepresents if the axis is visible. Write bool.
void set_LabelOffset(uint16_t) overrideSpecifies the distance of labels from the axis. Applied to category or date axis. Value must be between 0% and 1000%. Write uint16_t.
void set_LogBase(double) overrideRepresents the logarithmic base. Default value is 10. Write double.
void set_MajorTickMark(TickMarkType) overrideRepresents the type of major tick mark for the specified axis. Write TickMarkType.
void set_MajorUnit(double) overrideRepresents the major units for the date or value axis. Write double.
void set_MajorUnitScale(TimeUnitType) overrideRepresents the major unit scale for the date axis. Write TimeUnitType.
void set_MaxValue(double) overrideRepresents the maximum value on the value axis. Write double.
void set_MinorTickMark(TickMarkType) overrideRepresents the type of minor tick mark for the specified axis. Write TickMarkType.
void set_MinorUnit(double) overrideRepresents the minor units for the date or value axis. Write double.
void set_MinorUnitScale(TimeUnitType) overrideRepresents the major unit scale for the date axis. Write TimeUnitType.
void set_MinValue(double) overrideRepresents the minimum value on the value axis. Write double.
void set_NumberFormat(System::String) overrideRepresents the format string for the Axis Labels. Write System::String.
void set_NumberOfBins(uint32_t) overrideSpecifies number of bins when AggregationType property value setted to AxisAggregationType::ByNumberOfBins. Applied to category axes. Used with Histogram or HistogramPareto series only.
void set_OverflowBin(double) overrideSpecifies overflow bin custom value. Applied when IsAutomaticOverflowBin property setted to false and IsOverflowBin property equals true.
void set_Position(AxisPositionType) overrideRepresents position of axis. Write AxisPositionType.
void set_TickLabelPosition(TickLabelPositionType) overrideRepresents the position of tick-mark labels on the specified axis. Write TickLabelPositionType.
void set_TickLabelRotationAngle(float) overrideRepresents the rotation angle of tick labels. Write float.
void set_TickLabelSpacing(uint32_t) overrideSpecifies how many tick labels to skip between label that is drawn. Applied to category or series axis. Write uint32_t.
void set_TickMarksSpacing(uint32_t) overrideSpecifies how many tick marks shall be skipped before the next one shall be drawn. Applied to category or series axis. Write uint16_t.
void set_UnderflowBin(double) overrideSpecifies underflow bin custom value. Applied when IsAutomaticUnderflowBin property setted to false and IsUnderflowBin property equals true.
void SetCategoryAxisTypeAutomatically() overrideSets IAxis::get(set)_CategoryAxisType property with a value that is automatically determined based on axis data.
void SetTemplateWeakPtr(uint32_t) overrideSet n’th template argument a weak pointer (rather than shared). Allows switching pointers in containers to weak mode.
int SharedCount() constGets current value of shared reference counter.
Object * SharedRefAdded()Increments shared reference count. Shouldn’t be called directly; instead, use smart pointers or ThisProtector.
int SharedRefRemovedSafe()Decrements and returns shared reference count. Shouldn’t be called directly; instead, use smart pointers or ThisProtector.
virtual String ToString() constAnalog of C# Object.ToString() method. Enables converting custom objects to string.
static const TypeInfo& Type()Implements C# typeof(System.Object) construct.
void Unlock()Implements C# lock() statement unlocking. Call directly or use LockContext sentry object.
Detail::SmartPtrCounter * WeakRefAdded()Increments weak reference count. Shouldn’t be called directly; instead, use smart pointers or ThisProtector.
void WeakRefRemoved()Decrements weak reference count. Shouldn’t be called directly; instead, use smart pointers or ThisProtector.
virtual ~Object()Destroys object. Frees all internal data structures.

See Also