Click or drag to resize

ChartLegend Class

Represents the legend of a chart, providing information about the data series displayed in the chart.
Inheritance Hierarchy
System Object
Spire.Xls.Core.Spreadsheet XlsObject
Spire.Xls.Core.Spreadsheet.Charts XlsChartLegend
Spire.Xls.Charts ChartLegend

Namespace: Spire.Xls.Charts
Assembly: Spire.XLS (in Spire.XLS.dll) Version: 15.4.0.0 (15.4.0.5046)
Syntax
Copy 
public class ChartLegend : XlsChartLegend

The ChartLegend type exposes the following members.

Properties
Name Description
Public property AutoPosition
Automatic positioning .
(Inherited from XlsChartLegend .)
Public property AutoPositionX
X positioning is automatic.
(Inherited from XlsChartLegend .)
Public property AutoPositionY
Y positioning is automatic.
(Inherited from XlsChartLegend .)
Public property FrameFormat
Gets or sets the frame format of the chart.
(Inherited from XlsChartLegend .)
Public property HasDataTable
True if chart contains data table.
(Inherited from XlsChartLegend .)
Public property Height
Y-size. 1/4000 of chart plot. IsHMode Shall set to True
(Inherited from XlsChartLegend .)
Public property IncludeInLayout
Show legend without overlapping. Default is True.
(Inherited from XlsChartLegend .)
Public property InnerLayoutTarget
Gets or sets a value indicating whether the layout target is located inside the current control.
(Inherited from XlsChartLegend .)
Public property IsHMode
false value Specifies that the Height shall be interpreted as the Bottom of the chart element..
(Inherited from XlsChartLegend .)
Public property IsVerticalLegend
Indicates whether if vertical legend.
(Inherited from XlsChartLegend .)
Public property IsWMode
false value Specifies that the Width shall be interpreted as the Right of the chart element..
(Inherited from XlsChartLegend .)
Public property IsXMode
true value Specifies that the X shall be interpreted as the Left of the chart element..
(Inherited from XlsChartLegend .)
Public property IsYMode
true value Specifies that the Y shall be interpreted as the Top of the chart element..
(Inherited from XlsChartLegend .)
Public property LegendEntries
Represents legend entries collection. Read only.
Public property Parent
Reference to Parent object. Read-only.
(Inherited from XlsObject .)
Public property Position
Legend position type.
(Inherited from XlsChartLegend .)
Protected property ReferenceCount
Get quantity of instance references.
(Inherited from XlsObject .)
Public property TextArea
Return text area of legend.
Public property Width
X-size. 1/4000 of chart plot. IsWMode Shall set to True
(Inherited from XlsChartLegend .)
Public property X
X-position of upper-left corner. 1/4000 of chart plot. IsXMode Shall set to True
(Inherited from XlsChartLegend .)
Public property Y
Y-position of upper-left corner. 1/4000 of chart plot. IsYMode Shall set to True
(Inherited from XlsChartLegend .)
Top
Methods
Name Description
Protected method AddReference
Increase the quantity of reference. User must use this method when new wrapper on object is created or reference on object stored.
(Inherited from XlsObject .)
Protected method CheckDisposed
Checks whether object was disposed and throws exception if it was.
(Inherited from XlsObject .)
Public method Clear
Clears chart legend.
(Inherited from XlsChartLegend .)
Public method Clone
Clones current object.
(Inherited from XlsChartLegend .)
Public method Delete
Deletes chart legend.
(Inherited from XlsChartLegend .)
Public method Dispose
Dispose object and free resources.
(Inherited from XlsObject .)
Public method Equals
Determines whether the specified object is equal to the current object.
(Inherited from Object .)
Protected method Finalize
Destructor. Call dispose method of current object.
(Inherited from XlsObject .)
Protected method FindParent(Type)
This method is used to find parent with specific type.
(Inherited from XlsObject .)
Protected method FindParent( Type )
Find parent of object.
(Inherited from XlsObject .)
Protected method FindParent(Type, Boolean)
This method is used to find parent with specific type.
(Inherited from XlsObject .)
Protected method FindParents
Finds parent objects.
(Inherited from XlsObject .)
Public method GetHashCode
Serves as the default hash function.
(Inherited from Object .)
Public method GetType
Gets the Type of the current instance.
(Inherited from Object .)
Protected method MemberwiseClone
Creates a shallow copy of the current Object .
(Inherited from Object .)
Protected method OnDispose
Method which can be overriden by users to take any specific actions when object is disposed.
(Inherited from XlsObject .)
Protected method ReleaseReference
Decrease quantity of Reference. User must call this method when freeing resources.
(Inherited from XlsObject .)
Protected method SetParent
Sets parent of the object.
(Inherited from XlsObject .)
Public method ToString
Returns a string that represents the current object.
(Inherited from Object .)
Top
Fields
Name Description
Protected field m_bIsDisposed
Flag which indicates if the object was disposed or not.
(Inherited from XlsObject .)
Top
See Also