Aspose::Cells::Charts::ILegend Class Referenceabstract

Encapsulates the object that represents the chart legend. More...

Inherits Aspose::Cells::Charts::IChartFrame.

Public Member Functions

virtual Aspose::Cells::Charts::LegendPositionType GetPosition ()=0
 Gets the legend position type. More...
 
virtual void SetPosition (Aspose::Cells::Charts::LegendPositionType value)=0
 Sets the legend position type. More...
 
virtual intrusive_ptr< Aspose::Cells::Charts::ILegendEntryCollectionGetILegendEntries ()=0
 Gets a collection of all the LegendEntry objects in the specified chart legend. Setting the legend entries of the surface chart is not supported. So it will return null if the chart type is surface chart type. More...
 
virtual bool IsOverLay ()=0
 Gets whether other chart elements shall be allowed to overlap this chart element. More...
 
virtual void SetOverLay (bool value)=0
 Sets whether other chart elements shall be allowed to overlap this chart element. More...
 
- Public Member Functions inherited from Aspose::Cells::Charts::IChartFrame
virtual bool IsInnerMode ()=0
 Indicates whether the size of the plot area size includes the tick marks, and the axis labels. False specifies that the size shall determine the size of the plot area, the tick marks, and the axis labels. More...
 
virtual void SetInnerMode (bool value)=0
 Indicates whether the size of the plot area size includes the tick marks, and the axis labels. False specifies that the size shall determine the size of the plot area, the tick marks, and the axis labels. More...
 
virtual intrusive_ptr< Aspose::Cells::Drawing::ILineGetBorderILine ()=0
 Gets the border More...
 
virtual intrusive_ptr< Aspose::Cells::Drawing::IAreaGetIArea ()=0
 Gets the area More...
 
virtual intrusive_ptr< Aspose::Cells::IFontGetTextIFont ()=0
 Gets a IFont object of the specified ChartFrame object. More...
 
virtual intrusive_ptr< Aspose::Cells::IFontGetIFont ()=0
 Gets a IFont object of the specified ChartFrame object. More...
 
virtual bool GetAutoScaleFont ()=0
 True if the text in the object changes font size when the object size changes. The default value is True. More...
 
virtual void SetAutoScaleFont (bool value)=0
 True if the text in the object changes font size when the object size changes. The default value is True. More...
 
virtual Aspose::Cells::Charts::BackgroundMode GetBackgroundMode ()=0
 Gets the display mode of the background More...
 
virtual void SetBackgroundMode (Aspose::Cells::Charts::BackgroundMode value)=0
 Sets the display mode of the background More...
 
virtual Aspose::Cells::Charts::BackgroundMode GetBackground ()=0
 Gets the display mode of the background More...
 
virtual void SetBackground (Aspose::Cells::Charts::BackgroundMode value)=0
 Sets the display mode of the background More...
 
virtual bool IsAutomaticSize ()=0
 Indicates whether the chart frame is automatic sized. More...
 
virtual void SetAutomaticSize (bool value)=0
 Indicates whether the chart frame is automatic sized. More...
 
virtual Aspose::Cells::Systems::Int32 GetX ()=0
 Gets the x coordinate of the upper left corner in units of 1/4000 of the chart area. More...
 
virtual void SetX (Aspose::Cells::Systems::Int32 value)=0
 Sets the x coordinate of the upper left corner in units of 1/4000 of the chart area. More...
 
virtual Aspose::Cells::Systems::Int32 GetY ()=0
 Gets the y coordinate of the upper left corner in units of 1/4000 of the chart area.
More...
 
virtual void SetY (Aspose::Cells::Systems::Int32 value)=0
 Sets the y coordinate of the upper left corner in units of 1/4000 of the chart area.
More...
 
virtual Aspose::Cells::Systems::Int32 GetHeight ()=0
 Gets the height of frame in units of 1/4000 of the chart area. More...
 
virtual void SetHeight (Aspose::Cells::Systems::Int32 value)=0
 Sets the height of frame in units of 1/4000 of the chart area. More...
 
virtual Aspose::Cells::Systems::Int32 GetWidth ()=0
 Gets the width of frame in units of 1/4000 of the chart area. More...
 
virtual void SetWidth (Aspose::Cells::Systems::Int32 value)=0
 Sets the width of frame in units of 1/4000 of the chart area. More...
 
virtual bool GetShadow ()=0
 True if the frame has a shadow. More...
 
virtual void SetShadow (bool value)=0
 True if the frame has a shadow. More...
 
virtual intrusive_ptr< Aspose::Cells::Drawing::IShapePropertyCollectionGetIShapeProperties ()=0
 Gets the IShapePropertyCollection object. More...
 
virtual bool IsDefaultPosBeSet ()=0
 Indicates whether default position(DefaultX, DefaultY, DefaultWidth and DefaultHeight) are set. More...
 
virtual Aspose::Cells::Systems::Int32 GetDefaultX ()=0
 Represents x of default position More...
 
virtual Aspose::Cells::Systems::Int32 GetDefaultY ()=0
 Represents y of default position More...
 
virtual Aspose::Cells::Systems::Int32 GetDefaultWidth ()=0
 Represents width of default position More...
 
virtual Aspose::Cells::Systems::Int32 GetDefaultHeight ()=0
 Represents height of default position More...
 
virtual void SetPositionAuto ()=0
 Set position of the frame to automatic More...
 

Detailed Description

Encapsulates the object that represents the chart legend.

Member Function Documentation

◆ GetILegendEntries()

virtual intrusive_ptr<Aspose::Cells::Charts::ILegendEntryCollection> Aspose::Cells::Charts::ILegend::GetILegendEntries ( )
pure virtual

Gets a collection of all the LegendEntry objects in the specified chart legend. Setting the legend entries of the surface chart is not supported. So it will return null if the chart type is surface chart type.

◆ GetPosition()

virtual Aspose::Cells::Charts::LegendPositionType Aspose::Cells::Charts::ILegend::GetPosition ( )
pure virtual

Gets the legend position type.


Default position is right.
If the legend is at left or right side of the chart, setting Legend.X property will not take effect.
If the legend is at top or bottom side of the chart, setting Legend.Y property will not take effect.

◆ IsOverLay()

virtual bool Aspose::Cells::Charts::ILegend::IsOverLay ( )
pure virtual

Gets whether other chart elements shall be allowed to overlap this chart element.

◆ SetOverLay()

virtual void Aspose::Cells::Charts::ILegend::SetOverLay ( bool  value)
pure virtual

Sets whether other chart elements shall be allowed to overlap this chart element.

◆ SetPosition()

virtual void Aspose::Cells::Charts::ILegend::SetPosition ( Aspose::Cells::Charts::LegendPositionType  value)
pure virtual

Sets the legend position type.


Default position is right.
If the legend is at left or right side of the chart, setting Legend.X property will not take effect.
If the legend is at top or bottom side of the chart, setting Legend.Y property will not take effect.