Legend 类

定义

命名空间:

System.Web.UI.DataVisualization.Charting

程序集:

System.Web.DataVisualization.dll

表示图表图像的图例。

public ref class Legend : System::Web::UI::DataVisualization::Charting::ChartNamedElement

public class Legend : System.Web.UI.DataVisualization.Charting.ChartNamedElement

type Legend = class
    inherit ChartNamedElement

Public Class Legend
Inherits ChartNamedElement

继承

Object

ChartElement

ChartNamedElement

Legend

注解

类 Legend 封装控件图例的所有功能 Chart ，并使用 Legends 根 Chart 对象的 集合属性公开。

图表图像可以有任意数量的图例。

图例可以：

• 进行停靠和对齐。

• 显示在绘制的图表区域内部或外部。

• 自动调整其内容。

• 使用预定义样式，例如行、列或表。

• 使用阴影、渐变颜色和背景图像。

• 调整大小并定位在图表图像中的任意位置。

图例项由 LegendItem 对象表示，是默认项或自定义项。 自定义项不与数据关联，可以使用 属性添加、删除和修改 CustomItems 。

默认项默认自动添加到图例中，是圆环图和饼图的绘制数据点的名称。

对于所有其他图表类型，默认项是绘制的数据系列的名称。 每个系列都有一个 Legend 属性，用于定义将使用的图例的名称。 如果 IsVisibleInLegend 属性设置为 false，则不会为系列创建图例项。 可以使用 属性更改 LegendText 这些默认项的文本。 此属性将允许指定预定义关键字，这些关键字将在运行时替换为相应的值。

如果有饼图并设置了 Label 属性，它还会将图例文本设置为为标签设置的值。 如果要将文本设置为其他值，可以设置 LegendText 属性。 在大多数情况下，需要将 属性设置为 LegendText “#AXISLABEL”或“#VALX”。

图例系列符号是矩形、点或线条。 符号类型由图表自动设置，具体取决于绘制的图表类型。

图例文本默认自动调整大小。 可以通过禁用 属性来禁用图例文本的自动大小调整 IsTextAutoFit 。 当此属性设置为 false时，图例文本的大小由图例 Font的 Size 属性决定。 如果启用 属性 IsTextAutoFit ，则 AutoFitMinFontSize 属性将确定图例项在调整大小时可以具有的最小字号。

属性 TextWrapThreshold 定义在文本换行到另一行之前可在一行中显示的字符数的限制。 如果不希望将图例中的文本换行，请将 属性的值 TextWrapThreshold 设置为零。 默认情况下，当整个图例文本不适合图例时，文本将被截断。 可以在图例上设置 TextWrapThreshold ，使文本换行而不是被截断。

如果图例的内容不能容纳在给定的空间中，则图例条目将被截断。 显示一个省略号，指示条目多于图例的空格。 若要防止图例项被截断，请使用 Position 属性设置图例的位置和大小。 设置图例位置或大小时，图表不能再自动定位图表中的元素。 在某些情况下，需要手动定位其他图表元素才能实现所需的外观。

另一个选项是定义自己的单元格列，而不是使用默认图例设置。

对象 Legend 具有 CellColumn 集合;每个 CellColumn 对象表示图例中的一列。 单元格列具有 MaximumWidth 可用于调整列大小的 和 MinimumWidth 属性。

当图例包含许多条目时， InterlacedRows 可用于提高可读性。 当此属性设置为 True 时，它将显示可以使用 属性设置 InterlacedRowsColor 的背面颜色。

默认情况下，图例位于图表的右上角。 可以使用图例的 和 Alignment 属性修改Docking此位置。 图例还可以通过使用 DockedToChartArea 属性与图表区相关联。 此属性指定图例应停靠的图表区域的名称。 此外， IsDockedInsideChartArea 属性还可用于显示图表区域中的图例。

当 设置为 False 时 IsDockedInsideChartArea ， MaximumAutoSize 属性定义自动定位图例时可用图表中图例的最大大小（以百分比为单位）。 如果要在设置停靠属性后调整图例的宽度或高度，应设置此属性。

可以使用 事件修改 CustomizeLegend 图例。

构造函数

Legend()	初始化 Legend 类的新实例。
Legend(String)	使用指定的图例名称初始化 AnnotationPathPoint 类的新实例。

属性

Alignment	获取或设置图例的对齐方式。
AutoFitMinFontSize	获取或设置可用于图例文本自动调整算法的最小字号。
BackColor	获取或设置图例的背景色。
BackGradientStyle	获取或设置图例的背景渐变方向。 还确定是否使用渐变。
BackHatchStyle	获取或设置图例的阴影类型。
BackImage	获取或设置图例的背景图像。
BackImageAlignment	获取或设置用于 Unscaled 绘制模式的背景图像对齐方式。
BackImageTransparentColor	获取或设置在绘制背景图像时，将替换为透明色的颜色。
BackImageWrapMode	获取或设置图例背景图像的绘制模式。
BackSecondaryColor	获取或设置图例背景的辅助颜色。
BorderColor	获取或设置图例的边框颜色。
BorderDashStyle	获取或设置图例的边框样式。
BorderWidth	获取或设置图例的边框宽度。
CellColumns	获取图例的 LegendCellColumnCollection。
CustomItems	获取用于自定义图例项的 LegendItemsCollection 对象。
DockedToChartArea	获取或设置图例将停靠于其上的 ChartArea 的名称。
Docking	获取或设置一个确定图例停靠位置的值。
Enabled	获取或设置一个确定图例是否启用的值。
Font	获取或设置用于设置图例字体属性的 Font 对象。
ForeColor	获取或设置图例文本的颜色。
HeaderSeparator	获取或设置图例标题的直观分隔符类型。
HeaderSeparatorColor	获取或设置图例标题分隔符的颜色。
InsideChartArea	获取或设置在其中绘制图例的图表区域的名称。
InterlacedRows	获取或设置可指示是否使用交错背景色绘制图例行的标志。
InterlacedRowsColor	获取或设置图例交替行的背景色。
IsDockedInsideChartArea	获取或设置可指示图例是停靠在图表区域内还是其外的标志。
IsEquallySpacedItems	获取或设置可指示所有图例项是否均等间距分布的标志。
IsTextAutoFit	获取或设置指示图例文本是否自动调整大小的标志。
ItemColumnSeparator	获取或设置图例表列的直观分隔符类型。
ItemColumnSeparatorColor	获取或设置图例表列分隔符的颜色。
ItemColumnSpacing	获取或设置图例表列间距。
LegendItemOrder	获取或设置用于指定图例项显示顺序的标志。 此属性仅对自动添加到图表序列中的图例项有效；对自定义图例项无效。
LegendStyle	获取或设置图例样式。
MaximumAutoSize	获取或设置图例的最大大小（以图表区域的百分比形式表示）。 此值由自动布局算法使用。
Name	获取或设置图例的名称。
Position	获取或设置可用于获取或设置图例位置的 ElementPosition 对象。
ShadowColor	获取或设置图例的阴影颜色。
ShadowOffset	获取或设置图例的阴影偏移量（以像素为单位）。
TableStyle	获取或设置图例表样式。
Tag	获取或设置与此图表元素关联的对象。 (继承自 ChartElement)
TextWrapThreshold	获取或设置可在文本换行前在图例中连续显示的字符数。
Title	获取或设置图例标题的文本。
TitleAlignment	获取或设置图例标题的对齐方式。
TitleBackColor	获取或设置图例标题的背景色。
TitleFont	获取或设置图例标题的字体。
TitleForeColor	获取或设置图例标题的文本颜色。
TitleSeparator	获取或设置图例标题的直观分隔符类型。
TitleSeparatorColor	获取或设置图例标题分隔符的颜色。

方法

Dispose()	释放由 ChartElement 占用的资源。 (继承自 ChartElement)
Dispose(Boolean)	释放由 Legend 占用的非托管资源，还可以另外再释放托管资源。
Equals(Object)	确定指定的 Object 是否等同于当前的 ChartElement。 (继承自 ChartElement)
GetHashCode()	返回特定类型的哈希算法。 (继承自 ChartElement)
GetType()	获取当前实例的 Type。 (继承自 Object)
MemberwiseClone()	创建当前 Object 的浅表副本。 (继承自 Object)
ToString()	返回表示当前 Object 的字符串。 (继承自 ChartElement)