Legend Clase

Definición

Espacio de nombres:

System.Windows.Forms.DataVisualization.Charting

Ensamblado:

System.Windows.Forms.DataVisualization.dll

Representa la leyenda de la imagen del gráfico.

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

Herencia

Object

ChartElement

ChartNamedElement

Legend

Comentarios

La Legend clase encapsula toda la funcionalidad de la Chart leyenda del control y se expone mediante la Legends propiedad de colección del objeto raíz Chart .

Puede haber cualquier número de leyendas para una imagen de gráfico.

Las leyendas pueden:

• Acoplarse y alinearse.

• Se mostrará dentro o fuera de las áreas del gráfico trazado.

• Ajuste automáticamente a su contenido.

• Use un estilo predefinido, como fila, columna o tabla.

• Use sombreado, colores degradados e imágenes de fondo.

• Ajustar el tamaño y colocarse en cualquier parte de la imagen del gráfico.

Los elementos de leyenda se representan mediante el LegendItem objeto y son elementos predeterminados o personalizados. Los elementos personalizados no están asociados a los datos y se pueden agregar, eliminar y modificar mediante la CustomItems propiedad .

Los elementos predeterminados se agregan automáticamente a la leyenda y son los nombres de los puntos de datos trazados para los gráficos circulares y anillos.

Para todos los demás tipos de gráficos, los elementos predeterminados son los nombres de la serie de datos trazados. Cada serie tiene una Legend propiedad que define el nombre de la leyenda que se usará. No se creará un elemento de leyenda para una serie si la IsVisibleInLegend propiedad está establecida falseen . El texto de estos elementos predeterminados se puede cambiar mediante la LegendText propiedad . Esta propiedad le permitirá especificar palabras clave predefinidas que se reemplazarán por sus valores adecuados en tiempo de ejecución.

Si tiene un gráfico circular y establece la Label propiedad , también establecerá el texto de leyenda en el valor establecido para las etiquetas. Si desea establecer el texto en un valor diferente, puede establecer la LegendText propiedad . En la mayoría de los casos, le gustaría establecer la LegendText propiedad en "#AXISLABEL" o "#VALX".

Los símbolos de la serie de leyendas son rectángulos, puntos o líneas. El gráfico establece automáticamente el tipo de símbolo y depende del tipo de gráfico trazado.

De forma predeterminada, el texto de la leyenda se ajusta automáticamente. Para deshabilitar el ajuste automático de tamaño del texto de leyenda, deshabilite la IsTextAutoFit propiedad . Cuando esta propiedad se establece falseen , el tamaño del texto de leyenda viene determinado por la propiedad Size de la leyenda Font. Si la IsTextAutoFit propiedad está habilitada, la AutoFitMinFontSize propiedad determina el tamaño mínimo de fuente que puede tener un elemento de leyenda al cambiar el tamaño.

La TextWrapThreshold propiedad define un límite en el número de caracteres que se pueden mostrar en una línea antes de que el texto se ajuste a otra línea. Si no desea encapsular texto en la leyenda, establezca el valor de la TextWrapThreshold propiedad en cero. De forma predeterminada, cuando todo el texto de la leyenda no cabe en la leyenda, el texto se truncará. Puede establecer en TextWrapThreshold la leyenda para que el texto se ajuste en lugar de truncarse.

Si el contenido de la leyenda no puede caber en el espacio especificado, se truncan las entradas de leyenda. Se muestra un botón de puntos suspensivos para indicar que hay más entradas de las que la leyenda tiene espacio. Para evitar que los elementos de leyenda se trunquen, establezca la posición y el tamaño de la leyenda mediante la Position propiedad . Al establecer la posición o el tamaño de la leyenda, el gráfico ya no puede colocar automáticamente los elementos del gráfico. En algunos casos, muchos necesitan colocar manualmente otros elementos del gráfico para lograr la apariencia deseada.

Otra opción sería definir sus propias columnas de celda en lugar de usar la configuración de leyenda predeterminada.

El Legend objeto tiene una colección CellColumn; cada objeto CellColumn representa una columna de la leyenda. Una columna de celda tiene MaximumWidth propiedades y MinimumWidth que se pueden usar para ajustar el tamaño de las columnas.

Cuando la leyenda contiene muchas entradas, InterlacedRows se puede usar para mejorar la legibilidad. Cuando esta propiedad se establece en True, mostrará un color de retroceso que se puede establecer mediante la InterlacedRowsColor propiedad .

De forma predeterminada, la leyenda se coloca en la esquina superior derecha del gráfico. Esta posición se puede modificar mediante las Docking propiedades y Alignment de la leyenda. La leyenda también se puede asociar a un área de gráfico mediante el uso de la DockedToChartArea propiedad . Esta propiedad especifica el nombre del área de gráfico para la que se debe acoplar la leyenda. Además, la IsDockedInsideChartArea propiedad se puede usar para mostrar la leyenda dentro de un área de gráfico.

Cuando IsDockedInsideChartArea se establece en False, la MaximumAutoSize propiedad define el tamaño máximo, en porcentaje, de la leyenda dentro del gráfico disponible cuando la leyenda se coloca automáticamente. Esta propiedad debe establecerse si desea ajustar el ancho o alto de la leyenda después de establecer las propiedades de acoplamiento.

La leyenda se puede modificar mediante el CustomizeLegend evento .

Constructores

Nombre	Description
Legend()	Inicializa una nueva instancia de la clase Legend.
Legend(String)	Inicializa una nueva instancia de la Legend clase con el nombre de leyenda especificado.

Propiedades

Nombre	Description
Alignment	Obtiene o establece la alineación de la leyenda.
AutoFitMinFontSize	Obtiene o establece el tamaño de fuente mínimo que puede usar el algoritmo de ajuste automático para el texto de leyenda.
BackColor	Obtiene o establece el color de fondo de una leyenda.
BackGradientStyle	Obtiene o establece la orientación para el degradado de fondo de una leyenda. También determina si se usa un degradado.
BackHatchStyle	Obtiene o establece el estilo de sombreado de una leyenda.
BackImage	Obtiene o establece la imagen de fondo de una leyenda.
BackImageAlignment	Obtiene o establece la alineación de la imagen de fondo utilizada para el Unscaled modo de dibujo.
BackImageTransparentColor	Obtiene o establece un color que se reemplazará por un color transparente cuando se dibuje la imagen de fondo.
BackImageWrapMode	Obtiene o establece el modo de dibujo de imagen de fondo de leyenda.
BackSecondaryColor	Obtiene o establece el color secundario de un fondo de leyenda.
BorderColor	Obtiene o establece el color de borde de una leyenda.
BorderDashStyle	Obtiene o establece el estilo de borde de una leyenda.
BorderWidth	Obtiene o establece el ancho del borde de una leyenda.
CellColumns	Obtiene el LegendCellColumnCollection objeto que contiene la colección de columnas de celda para una leyenda.
CustomItems	Obtiene un LegendItemsCollection objeto utilizado para los elementos de leyenda personalizados.
DockedToChartArea	Obtiene o establece el nombre de donde ChartArea se acoplará la leyenda.
Docking	Obtiene o establece un valor que determina si la leyenda está acoplada.
Enabled	Obtiene o establece un valor que indica si la leyenda está habilitada.
Font	Obtiene o establece un Font objeto , que se usa para establecer las propiedades de fuente de la leyenda.
ForeColor	Obtiene o establece el color del texto de la leyenda.
HeaderSeparator	Obtiene o establece el tipo de separador visual para el encabezado de leyenda.
HeaderSeparatorColor	Obtiene o establece el color del separador para el encabezado de leyenda.
InsideChartArea	Obtiene o establece el nombre del área del gráfico en la que se dibuja la leyenda.
InterlacedRows	Obtiene o establece una marca que indica si las filas de leyenda se dibujarán con color de fondo entrelazado.
InterlacedRowsColor	Obtiene o establece el color de fondo de las filas entrelazadas de la leyenda.
IsDockedInsideChartArea	Obtiene o establece una marca que indica si la leyenda está acoplada dentro o fuera del área del gráfico.
IsEquallySpacedItems	Obtiene o establece una marca que indica si todos los elementos de leyenda están igualmente espaciados.
IsTextAutoFit	Obtiene o establece una marca que indica si el texto de la leyenda se ajusta automáticamente.
ItemColumnSeparator	Obtiene o establece el tipo de separador visual para las columnas de la tabla de leyenda.
ItemColumnSeparatorColor	Obtiene o establece el color del separador de columnas de la tabla de leyenda.
ItemColumnSpacing	Obtiene o establece el espaciado de columna de la tabla de leyenda.
LegendItemOrder	Obtiene o establece un valor que especifica el orden en el que se muestran los elementos de leyenda. Esta propiedad solo afecta a los elementos de leyenda agregados automáticamente para la serie de gráficos; no tiene ningún efecto en los elementos de leyenda personalizados.
LegendStyle	Obtiene o establece el estilo de la leyenda.
MaximumAutoSize	Obtiene o establece el tamaño máximo de la leyenda, medido como un porcentaje del área del gráfico. El algoritmo de diseño automático usa este valor.
Name	Obtiene o establece el nombre de la leyenda.
Position	Obtiene o establece un ElementPosition objeto , que se puede usar para obtener o establecer la posición de la leyenda.
ShadowColor	Obtiene o establece el color de sombra de la leyenda.
ShadowOffset	Obtiene o establece el desplazamiento de sombra, en píxeles, de la leyenda.
TableStyle	Obtiene o establece el estilo de tabla de leyenda.
Tag	Obtiene o establece un objeto asociado a este elemento de gráfico. (Heredado de ChartElement)
TextWrapThreshold	Obtiene o establece el número de caracteres que se pueden mostrar secuencialmente en la leyenda antes de que se ajuste el texto.
Title	Obtiene o establece el texto del título de la leyenda.
TitleAlignment	Obtiene o establece la alineación del título de la leyenda.
TitleBackColor	Obtiene o establece el color de fondo del título de la leyenda.
TitleFont	Obtiene o establece la fuente del título de la leyenda.
TitleForeColor	Obtiene o establece el color de texto del título de la leyenda.
TitleSeparator	Obtiene o establece el tipo de separador visual para el título de la leyenda.
TitleSeparatorColor	Obtiene o establece el color del separador de título de leyenda.

Métodos

Nombre	Description
Dispose()	Libera los recursos usados por .ChartElement (Heredado de ChartElement)
Dispose(Boolean)	Libera los recursos no administrados utilizados por Legend y, opcionalmente, libera los recursos administrados.
Equals(Object)	Determina si el objeto especificado Object es igual al objeto actual ChartElement. (Heredado de ChartElement)
GetHashCode()	Devuelve una función hash para un tipo determinado. (Heredado de ChartElement)
GetType()	Obtiene el Type de la instancia actual. (Heredado de Object)
MemberwiseClone()	Crea una copia superficial del Objectactual. (Heredado de Object)
ToString()	Devuelve una cadena que representa el objeto actual Object. (Heredado de ChartElement)