Skip to main content
All docs
V23.2

HeatmapLegend Members

A heatmap legend.

Constructors

Name Description
HeatmapLegend(ChartElement) Initializes a new instance of the HeatmapLegend class with specified settings.

Properties

Name Description
AlignmentHorizontal Gets or sets the legend’s horizontal alignment within the chart control. Inherited from LegendBase.
AlignmentVertical Gets or sets the legend’s vertical alignment within the chart control. Inherited from LegendBase.
BackColor Gets or sets the legend’s background color. Inherited from LegendBase.
BackImage Gets the background image settings. Inherited from LegendBase.
Border Gets the legend’s border settings. Inherited from LegendBase.
CustomItems Returns the custom legend item collection. Inherited from LegendBase.
Direction Gets or sets the direction in which the names of the series are displayed within the legend. Inherited from LegendBase.
DXFont Gets or sets the font used to display the legend’s content. Inherited from LegendBase.
EnableAntialiasing Gets or sets a value indicating whether antialiasing is enabled for the chart legend. Inherited from LegendBase.
EquallySpacedItems Gets or sets a value indicating whether the legend items are arranged in left-aligned columns. Inherited from LegendBase.
FillStyle Gets the legend’s background fill style. Inherited from LegendBase.
Font Gets or sets the font used to display the legend’s content. Inherited from LegendBase.
HorizontalIndent Specifies the horizontal indent between legend items. Inherited from LegendBase.
ItemVisibilityMode Specifies how to display custom and automatically generated items in a legend. Inherited from LegendBase.
LegendID Inherited from LegendBase.
Margins Specifies the indent between the legend‘s edge and other chart elements (e.g. diagram and chart titles), in pixels. Inherited from LegendBase.
MarkerOffset Gets or sets the offset between a marker and check box, when both are displayed in the legend. Inherited from LegendBase.
MarkerSize Gets or sets the marker’s height and width. Inherited from LegendBase.
MaxHorizontalPercentage Gets or sets the legend’s maximum possible width (in percents). Inherited from LegendBase.
MaxVerticalPercentage Gets or sets the legend’s maximum possible height (in percents). Inherited from LegendBase.
Name Gets or sets the name of the chart element. Inherited from ChartElementNamed.
Padding Specifies the internal space between the legend‘s content and its edge, in pixels. Inherited from LegendBase.
Shadow Gets the legend’s shadow settings. Inherited from LegendBase.
Tag Gets or sets the object that contains data related to the chart element. Inherited from ChartElement.
TextColor Gets or sets the legend’s text color. Inherited from LegendBase.
TextOffset Specifies the indent between legend markers and their text. Inherited from LegendBase.
TextVisible Specifies whether the legend items’ text is visible. Inherited from LegendBase.
Title Returns the legend title settings. Inherited from LegendBase.
VerticalIndent Specifies the vertical indent between legend items. Inherited from LegendBase.
Visibility Specifies whether to show the legend on a chart. Inherited from LegendBase.

Methods

Name Description
Assign(ChartElement) Copies all the settings from the LegendBase object passed as the parameter. Inherited from LegendBase.
Clone() Creates a copy of the current ChartElement object. Inherited from ChartElement.
Dispose() Releases all resources used by the LegendBase object. Inherited from LegendBase.
Equals(Object, Object) static Determines whether the specified object instances are considered equal. Inherited from Object.
Equals(Object) Determines whether the specified object is equal to the current object. Inherited from Object.
GetHashCode() Serves as the default hash function. Inherited from Object.
GetType() Gets the Type of the current instance. Inherited from Object.
MemberwiseClone() protected Creates a shallow copy of the current Object. Inherited from Object.
ReferenceEquals(Object, Object) static Determines whether the specified Object instances are the same instance. Inherited from Object.
ToString() Returns the textual representation of the named chart element. Inherited from ChartElementNamed.
See Also