Legend 类

定义

public ref class Legend : System::Windows::Forms::DataVisualization::Charting::ChartNamedElement

public class Legend : System.Windows.Forms.DataVisualization.Charting.ChartNamedElement

type Legend = class
    inherit ChartNamedElement

Public Class Legend
Inherits ChartNamedElement

继承

Object

ChartElement

ChartNamedElement

Legend

注解

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

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

图例可以：

• 停靠并对齐。

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

• 自动调整其内容。

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

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

• 调整图表图像中任意位置的大小和位置。

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

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

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

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

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

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

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

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

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

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

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

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

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

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