Legend

Legend class

Represents chart’s legend properties.

class Legend : public Aspose::Slides::DomObject<System::SharedPtr<Aspose::Slides::Charts::Chart>>,
               public Aspose::Slides::Charts::ILegend

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.
float get_Bottom() overrideBottom. Read-only float.
System::SharedPtr<IChart> get_Chart() overrideReturns the chart. Read-only IChart.
System::SharedPtr<ILegendEntryCollection> get_Entries() overrideGets legend entries. Read-only ILegendEntryCollection.
System::SharedPtr<ILegendEntryProperties> get_Entry(int32_t) overrideGet properties of legend entry corresponding to data point in chart at the specified index. In case of chart types: bar-of-pie, exploded pie, exploded pie 3D, pie, pie 3D, pie-of-pie, data point is taken from first series.
System::SharedPtr<IFormat> get_Format() overrideReturns the format of a legend. Read-only IFormat.
float get_Height() overrideReturns the height of a legend as a fraction of the height of the chart. Read float.
bool get_Overlay() overrideDetermines whether other chart elements shall be allowed to overlap legend. Read bool.
LegendPositionType get_Position() overrideSpecifies the position of the legend on a chart. Non-NaN values of X, Y, Width, Heigt properties override effect of this property. Read LegendPositionType.
float get_Right() overrideRight. Read-only float.
System::SharedPtr<IChartTextFormat> get_TextFormat() overrideText format. Read-only IChartTextFormat.
float get_Width() overrideReturns the width of a legend as a fraction of the width of the chart. Read float.
float get_X() overrideReturns the x coordinate of a legend as a fraction of the width of the chart. Read float.
float get_Y() overrideReturns the y coordinate of a legend as a fraction of the height of the chart. Read float.
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_Height(float) overrideSets the height of a legend as a fraction of the height of the chart. Write float.
void set_Overlay(bool) overrideDetermines whether other chart elements shall be allowed to overlap legend. Write bool.
void set_Position(LegendPositionType) overrideSpecifies the position of the legend on a chart. Non-NaN values of X, Y, Width, Heigt properties override effect of this property. Write LegendPositionType.
void set_Width(float) overrideSets the width of a legend as a fraction of the width of the chart. Write float.
void set_X(float) overrideSets the x coordinate of a legend as a fraction of the width of the chart. Write float.
void set_Y(float) overrideSets the y coordinate of a legend as a fraction of the height of the chart. Write float.
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