Aspose::Slides::Charts::DataLabel Class Reference

Represents a series labels. More...

Inherits Aspose::Slides::Charts::IDataLabel, and Aspose::Slides::IDOMObject.

Public Member Functions

System::SharedPtr< IChartget_Chart () override
 Returns the parent chart. Read-only IChart. More...
 
bool get_IsVisible () override
 False means that data label is not visible (and so all Show*-flags (ShowValue, ...) are false). Read-only bool. More...
 
System::SharedPtr< ITextFrameget_TextFrameForOverriding () override
 Can contain a rich formatted text. If this property is not null then this formatted text value overrides auto-generated text of data label. Auto-generated text of data label means text that is managed by ShowSeriesName, ShowValue, ... properties and is formatted with the TextFormatManager.TextFormat property. Read-only ITextFrame. More...
 
System::SharedPtr< IChartTextFormatget_TextFormat () override
 Returns text format. Read-only IChartTextFormat. More...
 
float get_X () override
 Returns the x coordinate of a title as a fraction of the width of the chart. Read float. More...
 
void set_X (float value) override
 Sets the x coordinate of a title as a fraction of the width of the chart. Write float. More...
 
float get_Y () override
 Returns the y coordinate of a title as a fraction of the height of the chart. Read float. More...
 
void set_Y (float value) override
 Sets the y coordinate of a title as a fraction of the height of the chart. Write float. More...
 
float get_Width () override
 Returns the width of a title as a fraction of the width of the chart. Read float. More...
 
void set_Width (float value) override
 Sets the width of a title as a fraction of the width of the chart. Write float. More...
 
float get_Height () override
 Returns the height of a title as a fraction of the height of the chart. Read float. More...
 
void set_Height (float value) override
 Sets the height of a title as a fraction of the height of the chart. Write float. More...
 
float get_Right () override
 Right. Read-only float. More...
 
float get_Bottom () override
 Bottom. Read-only float. More...
 
System::SharedPtr< IDataLabelFormatget_DataLabelFormat () override
 Returns data label format. Read-only IDataLabelFormat. More...
 
System::SharedPtr< IChartDataCellget_ValueFromCell () override
 Gets workbook data cell. Applied if IDataLabelFormat::get(set)_ShowLabelValueFromCell property equals true. More...
 
void set_ValueFromCell (System::SharedPtr< IChartDataCell > value) override
 Sets workbook data cell. Applied if IDataLabelFormat::get(set)_ShowLabelValueFromCell property equals true. More...
 
float get_ActualX () override
 Specifies actual x location (left) of the chart element relative to the left top corner of the chart. Call method IChart::ValidateChartLayout before to get actual values. Read float. More...
 
float get_ActualY () override
 Specifies actual top of the chart element relative to the left top corner of the chart. Call method IChart::ValidateChartLayout before to get actual values. Read float. More...
 
float get_ActualWidth () override
 Specifies actual width of the chart element. Call method IChart::ValidateChartLayout before to get actual values. Read float. More...
 
float get_ActualHeight () override
 Specifies actual height of the chart element. Call method IChart::ValidateChartLayout before to get actual values. Read float. More...
 
 DataLabel (System::SharedPtr< IChartDataPoint > parentImmediate)
 Creates a new instance of DataLabel class. More...
 
void Hide () override
 Make data label hidden by setting all Show*-flags (ShowValue, ...) to false state. IsVisible will be false after this. More...
 
System::String GetActualLabelText () override
 Returns actual label text based on DataLabelFormat settings or get_TextFrameForOverriding()->get(set)_Text() value. More...
 
System::SharedPtr< ITextFrameAddTextFrameForOverriding (System::String text) override
 Initialize TextFrameForOverriding with the text in paramener "text". If TextFrameForOverriding is already initialized then simply changes its text. More...
 
- Public Member Functions inherited from System::Object
 Object ()
 Creates object. Initializes all internal data structures. More...
 
virtual ~Object ()
 Destroys object. Frees all internal data structures. More...
 
 Object (Object const &x)
 Copy constructor. Doesn't copy anything, really, just initializes new object and enables copy constructing subclasses. More...
 
Objectoperator= (Object const &x)
 Assignment operator. Doesn't copy anything, really, just initializes new object and enables copy constructing subclasses. More...
 
ObjectSharedRefAdded ()
 Increments shared reference count. Shouldn't be called directly; instead, use smart pointers or ThisProtector. More...
 
int SharedRefRemovedSafe ()
 Decrements and returns shared reference count. Shouldn't be called directly; instead, use smart pointers or ThisProtector. More...
 
int RemovedSharedRefs (int count)
 Decreases shared reference count by specified value. More...
 
Detail::SmartPtrCounter * WeakRefAdded ()
 Increments weak reference count. Shouldn't be called directly; instead, use smart pointers or ThisProtector. More...
 
void WeakRefRemoved ()
 Decrements weak reference count. Shouldn't be called directly; instead, use smart pointers or ThisProtector. More...
 
Detail::SmartPtrCounter * GetCounter ()
 Gets reference counter data structure associated with the object. More...
 
int SharedCount () const
 Gets current value of shared reference counter. More...
 
void Lock ()
 Implements C# lock() statement locking. Call directly or use LockContext sentry object. More...
 
void Unlock ()
 Implements C# lock() statement unlocking. Call directly or use LockContext sentry object. More...
 
virtual bool Equals (ptr obj)
 Compares objects using C# Object.Equals semantics. More...
 
virtual int32_t GetHashCode () const
 Analog of C# Object.GetHashCode() method. Enables hashing of custom objects. More...
 
virtual String ToString () const
 Analog of C# Object.ToString() method. Enables converting custom objects to string. More...
 
virtual ptr MemberwiseClone () const
 Analog of C# Object.MemberwiseClone() method. Enables cloning custom types. More...
 
virtual const TypeInfoGetType () const
 Gets actual type of object. Analog of C# System.Object.GetType() call. More...
 
virtual bool Is (const TypeInfo &targetType) const
 Check if object represents an instance of type described by targetType. Analog of C# 'is' operator. More...
 
virtual void SetTemplateWeakPtr (uint32_t argument)
 Set n'th template argument a weak pointer (rather than shared). Allows switching pointers in containers to weak mode. More...
 
virtual bool FastCast (const Details::FastRttiBase &helper, void **out_ptr) const
 For internal purposes only. More...
 
template<>
bool ReferenceEquals (String const &str, std::nullptr_t)
 Specialization of Object::ReferenceEquals for case of string and nullptr. More...
 
template<>
bool ReferenceEquals (String const &str1, String const &str2)
 Specialization of Object::ReferenceEquals for case of strings. More...
 

Protected Member Functions

virtual ~DataLabel ()
 

Additional Inherited Members

- Public Types inherited from System::Object
typedef SmartPtr< Objectptr
 Alias for smart pointer type. More...
 
- Static Public Member Functions inherited from System::Object
static bool ReferenceEquals (ptr const &objA, ptr const &objB)
 Compares objects by reference. More...
 
template<typename T >
static std::enable_if<!IsSmartPtr< T >::value, bool >::type ReferenceEquals (T const &objA, T const &objB)
 Compares objects by reference. More...
 
template<typename T >
static std::enable_if<!IsSmartPtr< T >::value, bool >::type ReferenceEquals (T const &objA, std::nullptr_t)
 Reference-compares value type object with nullptr. More...
 
template<typename T1 , typename T2 >
static std::enable_if< IsSmartPtr< T1 >::value &&IsSmartPtr< T2 >::value, bool >::type Equals (T1 const &objA, T2 const &objB)
 Compares reference type objects in C# style. More...
 
template<typename T1 , typename T2 >
static std::enable_if<!IsSmartPtr< T1 >::value &&!IsSmartPtr< T2 >::value, bool >::type Equals (T1 const &objA, T2 const &objB)
 Compares value type objects in C# style. More...
 
static const TypeInfoType ()
 Implements C# typeof(System.Object) construct. More...
 
template<>
bool Equals (float const &objA, float const &objB)
 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. More...
 
template<>
bool Equals (double const &objA, double const &objB)
 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. More...
 

Detailed Description

Represents a series labels.

Constructor & Destructor Documentation

◆ DataLabel()

Aspose::Slides::Charts::DataLabel::DataLabel ( System::SharedPtr< IChartDataPoint parentImmediate)

Creates a new instance of DataLabel class.

Parameters
parentImmediateParent ChartDataPoint.

◆ ~DataLabel()

virtual Aspose::Slides::Charts::DataLabel::~DataLabel ( )
protectedvirtual

Member Function Documentation

◆ AddTextFrameForOverriding()

System::SharedPtr<ITextFrame> Aspose::Slides::Charts::DataLabel::AddTextFrameForOverriding ( System::String  text)
overridevirtual

Initialize TextFrameForOverriding with the text in paramener "text". If TextFrameForOverriding is already initialized then simply changes its text.

Parameters
textText for a new TextFrameForOverriding.

Implements Aspose::Slides::Charts::IOverridableText.

◆ get_ActualHeight()

float Aspose::Slides::Charts::DataLabel::get_ActualHeight ( )
overridevirtual

Specifies actual height of the chart element. Call method IChart::ValidateChartLayout before to get actual values. Read float.

Implements Aspose::Slides::Charts::IActualLayout.

◆ get_ActualWidth()

float Aspose::Slides::Charts::DataLabel::get_ActualWidth ( )
overridevirtual

Specifies actual width of the chart element. Call method IChart::ValidateChartLayout before to get actual values. Read float.

Implements Aspose::Slides::Charts::IActualLayout.

◆ get_ActualX()

float Aspose::Slides::Charts::DataLabel::get_ActualX ( )
overridevirtual

Specifies actual x location (left) of the chart element relative to the left top corner of the chart. Call method IChart::ValidateChartLayout before to get actual values. Read float.

Implements Aspose::Slides::Charts::IActualLayout.

◆ get_ActualY()

float Aspose::Slides::Charts::DataLabel::get_ActualY ( )
overridevirtual

Specifies actual top of the chart element relative to the left top corner of the chart. Call method IChart::ValidateChartLayout before to get actual values. Read float.

Implements Aspose::Slides::Charts::IActualLayout.

◆ get_Bottom()

float Aspose::Slides::Charts::DataLabel::get_Bottom ( )
overridevirtual

Bottom. Read-only float.

Implements Aspose::Slides::Charts::ILayoutable.

◆ get_Chart()

System::SharedPtr<IChart> Aspose::Slides::Charts::DataLabel::get_Chart ( )
overridevirtual

Returns the parent chart. Read-only IChart.

Implements Aspose::Slides::Charts::IChartComponent.

◆ get_DataLabelFormat()

System::SharedPtr<IDataLabelFormat> Aspose::Slides::Charts::DataLabel::get_DataLabelFormat ( )
overridevirtual

Returns data label format. Read-only IDataLabelFormat.

Implements Aspose::Slides::Charts::IDataLabel.

◆ get_Height()

float Aspose::Slides::Charts::DataLabel::get_Height ( )
overridevirtual

Returns the height of a title as a fraction of the height of the chart. Read float.

Implements Aspose::Slides::Charts::ILayoutable.

◆ get_IsVisible()

bool Aspose::Slides::Charts::DataLabel::get_IsVisible ( )
overridevirtual

False means that data label is not visible (and so all Show*-flags (ShowValue, ...) are false). Read-only bool.

If data label is visible you can make it hidden with Hide() method. But if data label is not visible (IsVisible is false) you can make data label visible with setting Show*-flags (ShowValue, ...) to true state.

Implements Aspose::Slides::Charts::IDataLabel.

◆ get_Right()

float Aspose::Slides::Charts::DataLabel::get_Right ( )
overridevirtual

Right. Read-only float.

Implements Aspose::Slides::Charts::ILayoutable.

◆ get_TextFormat()

System::SharedPtr<IChartTextFormat> Aspose::Slides::Charts::DataLabel::get_TextFormat ( )
overridevirtual

Returns text format. Read-only IChartTextFormat.

Implements Aspose::Slides::Charts::IFormattedTextContainer.

◆ get_TextFrameForOverriding()

System::SharedPtr<ITextFrame> Aspose::Slides::Charts::DataLabel::get_TextFrameForOverriding ( )
overridevirtual

Can contain a rich formatted text. If this property is not null then this formatted text value overrides auto-generated text of data label. Auto-generated text of data label means text that is managed by ShowSeriesName, ShowValue, ... properties and is formatted with the TextFormatManager.TextFormat property. Read-only ITextFrame.

Implements Aspose::Slides::Charts::IOverridableText.

◆ get_ValueFromCell()

System::SharedPtr<IChartDataCell> Aspose::Slides::Charts::DataLabel::get_ValueFromCell ( )
overridevirtual

Gets workbook data cell. Applied if IDataLabelFormat::get(set)_ShowLabelValueFromCell property equals true.

Implements Aspose::Slides::Charts::IDataLabel.

◆ get_Width()

float Aspose::Slides::Charts::DataLabel::get_Width ( )
overridevirtual

Returns the width of a title as a fraction of the width of the chart. Read float.

Implements Aspose::Slides::Charts::ILayoutable.

◆ get_X()

float Aspose::Slides::Charts::DataLabel::get_X ( )
overridevirtual

Returns the x coordinate of a title as a fraction of the width of the chart. Read float.

Implements Aspose::Slides::Charts::ILayoutable.

◆ get_Y()

float Aspose::Slides::Charts::DataLabel::get_Y ( )
overridevirtual

Returns the y coordinate of a title as a fraction of the height of the chart. Read float.

Implements Aspose::Slides::Charts::ILayoutable.

◆ GetActualLabelText()

System::String Aspose::Slides::Charts::DataLabel::GetActualLabelText ( )
overridevirtual

Returns actual label text based on DataLabelFormat settings or get_TextFrameForOverriding()->get(set)_Text() value.

Returns

Implements Aspose::Slides::Charts::IDataLabel.

◆ Hide()

void Aspose::Slides::Charts::DataLabel::Hide ( )
overridevirtual

Make data label hidden by setting all Show*-flags (ShowValue, ...) to false state. IsVisible will be false after this.

If data label is not visible (IsVisible is false) you can make data label visible with setting Show*-flags (ShowValue, ...) to true state.

Implements Aspose::Slides::Charts::IDataLabel.

◆ set_Height()

void Aspose::Slides::Charts::DataLabel::set_Height ( float  value)
overridevirtual

Sets the height of a title as a fraction of the height of the chart. Write float.

Implements Aspose::Slides::Charts::ILayoutable.

◆ set_ValueFromCell()

void Aspose::Slides::Charts::DataLabel::set_ValueFromCell ( System::SharedPtr< IChartDataCell value)
overridevirtual

Sets workbook data cell. Applied if IDataLabelFormat::get(set)_ShowLabelValueFromCell property equals true.

Implements Aspose::Slides::Charts::IDataLabel.

◆ set_Width()

void Aspose::Slides::Charts::DataLabel::set_Width ( float  value)
overridevirtual

Sets the width of a title as a fraction of the width of the chart. Write float.

Implements Aspose::Slides::Charts::ILayoutable.

◆ set_X()

void Aspose::Slides::Charts::DataLabel::set_X ( float  value)
overridevirtual

Sets the x coordinate of a title as a fraction of the width of the chart. Write float.

Implements Aspose::Slides::Charts::ILayoutable.

◆ set_Y()

void Aspose::Slides::Charts::DataLabel::set_Y ( float  value)
overridevirtual

Sets the y coordinate of a title as a fraction of the height of the chart. Write float.

Implements Aspose::Slides::Charts::ILayoutable.