Legend Classe

Définition

Espace de noms:

System.Web.UI.DataVisualization.Charting

Assembly:

System.Web.DataVisualization.dll

Représente la légende de l’image du graphique.

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

Héritage

Object

ChartElement

ChartNamedElement

Legend

Remarques

La Legend classe encapsule toutes les fonctionnalités de la Chart légende du contrôle et est exposée à l’aide de la propriété de collection Legends de l’objet racine Chart .

Il peut y avoir un nombre quelconque de légendes pour une image de graphique.

Les légendes peuvent :

• Être ancré et aligné.

• Être affiché à l’intérieur ou à l’extérieur des zones de graphique tracées.

• Ajuster automatiquement leur contenu.

• Utilisez un style prédéfini, tel que ligne, colonne ou tableau.

• Utilisez les hachures, les couleurs dégradées et les images d’arrière-plan.

• Être dimensionné et positionné n’importe où dans l’image de graphique.

Les éléments de légende sont représentés par l’objet LegendItem et sont des éléments par défaut ou personnalisés. Les éléments personnalisés ne sont pas associés aux données et peuvent être ajoutés, supprimés et modifiés à l’aide de la CustomItems propriété .

Par défaut, les éléments par défaut sont automatiquement ajoutés à la légende et sont les noms des points de données tracés pour les graphiques en anneau et en secteurs.

Pour tous les autres types de graphiques, les éléments par défaut sont les noms des séries de données tracées. Chaque série a une Legend propriété qui définit le nom de la légende qui sera utilisée. Un élément de légende n’est pas créé pour une série si la IsVisibleInLegend propriété a la valeur false. Le texte de ces éléments par défaut peut être modifié à l’aide de la LegendText propriété . Cette propriété vous permet de spécifier des mots clés prédéfinis qui seront remplacés par leurs valeurs appropriées au moment de l’exécution.

Si vous avez un graphique à secteurs et que vous définissez la Label propriété, le texte de légende est également défini sur la valeur que vous définissez pour les étiquettes. Si vous souhaitez définir le texte sur une valeur différente, vous pouvez définir la LegendText propriété . Dans la plupart des cas, vous souhaitez définir la LegendText propriété sur « #AXISLABEL » ou « #VALX ».

Les symboles de série de légendes sont des rectangles, des points ou des lignes. Le type de symbole est défini automatiquement par le graphique et dépend du type de graphique tracé.

Le texte de légende est automatiquement dimensionné par défaut. Vous pouvez désactiver le dimensionnement automatique du texte de légende en désactivant la IsTextAutoFit propriété . Lorsque cette propriété a la falsevaleur , la taille du texte de la légende est déterminée par la propriété Size de la légende Font. Si la IsTextAutoFit propriété est activée, la AutoFitMinFontSize propriété détermine la taille de police minimale qu’un élément de légende peut avoir lors du redimensionnement.

La TextWrapThreshold propriété définit une limite du nombre de caractères pouvant être affichés sur une ligne avant que le texte ne soit encapsulé à une autre ligne. Si vous ne souhaitez pas encapsuler le texte de la légende, définissez la valeur de la TextWrapThreshold propriété sur zéro. Par défaut, lorsque l’intégralité du texte de la légende ne tient pas dans la légende, le texte est tronqué. Vous pouvez définir sur TextWrapThreshold la légende pour que le texte soit encapsulé au lieu d’être tronqué.

Si le contenu de la légende ne peut pas tenir dans l’espace donné, les entrées de légende sont tronquées. Des points de suspension sont affichés pour indiquer qu’il y a plus d’entrées que la légende n’a d’espace. Pour empêcher la troncation des éléments de légende, définissez la position et la taille de la légende à l’aide de la Position propriété . Lors de la définition de la position ou de la taille de la légende, le graphique ne peut plus positionner automatiquement les éléments du graphique. Dans certains cas, vous avez beaucoup besoin de positionner manuellement d’autres éléments de graphique pour obtenir l’apparence souhaitée.

Une autre option consiste à définir vos propres colonnes de cellule au lieu d’utiliser les paramètres de légende par défaut.

L’objet Legend a une collection CellColumn ; chaque objet CellColumn représente une colonne dans la légende. Une colonne de cellule a MaximumWidth des propriétés et MinimumWidth qui peuvent être utilisées pour ajuster la taille des colonnes.

Lorsque la légende contient de nombreuses entrées, InterlacedRows peut être utilisé pour améliorer la lisibilité. Lorsque cette propriété a la valeur True, elle affiche une couleur d’arrière-plan que vous pouvez définir à l’aide de la InterlacedRowsColor propriété .

Par défaut, la légende est positionnée dans le coin supérieur droit du graphique. Cette position peut être modifiée à l’aide des Docking propriétés et Alignment de la légende. La légende peut également être associée à une zone de graphique à l’aide de la DockedToChartArea propriété . Cette propriété spécifie le nom de la zone de graphique pour laquelle la légende doit être ancrée. En outre, la IsDockedInsideChartArea propriété peut être utilisée pour afficher la légende à l’intérieur d’une zone de graphique.

Lorsque IsDockedInsideChartArea a la valeur False, la MaximumAutoSize propriété définit la taille maximale, en pourcentage, de la légende dans le graphique disponible lorsque la légende est automatiquement positionnée. Cette propriété doit être définie si vous souhaitez ajuster la largeur ou la hauteur de la légende une fois les propriétés d’ancrage définies.

La légende peut être modifiée à l’aide de l’événement CustomizeLegend .

Constructeurs

Legend()	Initialise une nouvelle instance de la classe Legend.
Legend(String)	Initialise une nouvelle instance de la classe AnnotationPathPoint avec le nom de légende spécifié.

Propriétés

Alignment	Récupère ou définit l’alignement de la légende.
AutoFitMinFontSize	Obtient ou définit la taille de police minimale qui peut être utilisée par l'algorithme d'ajustement automatique pour le texte de la légende.
BackColor	Obtient ou définit la couleur d'arrière-plan d'une légende.
BackGradientStyle	Obtient ou définit l'orientation du dégradé d'arrière-plan d'une légende. Détermine aussi l'utilisation d'un dégradé.
BackHatchStyle	Obtient ou définit le style de hachurage d'une légende.
BackImage	Obtient ou définit l'image d'arrière-plan d'une légende.
BackImageAlignment	Obtient ou définit l'alignement d'image d'arrière-plan utilisé pour le mode dessin Unscaled.
BackImageTransparentColor	Obtient ou définit une couleur qui sera remplacée par une couleur transparent lorsque l'image d'arrière-plan est dessinée.
BackImageWrapMode	Obtient ou définit le mode dessin d'une image d'arrière-plan de légende.
BackSecondaryColor	Obtient ou définit la couleur secondaire de l'arrière-plan d'une légende.
BorderColor	Obtient ou définit la couleur de la bordure d'une légende.
BorderDashStyle	Obtient ou définit le style de la bordure d'une légende.
BorderWidth	Obtient ou définit l'épaisseur de la bordure d'une légende.
CellColumns	Obtient l'objet LegendCellColumnCollection d'une légende.
CustomItems	Récupère un objet LegendItemsCollection utilisé pour les éléments de légende personnalisés.
DockedToChartArea	Obtient ou définit le nom de l'objet ChartArea dans lequel la légende sera ancrée.
Docking	Obtient ou définit une valeur qui détermine où la légende est ancrée.
Enabled	Obtient ou définit une valeur qui détermine si la légende est activée.
Font	Obtient ou définit un objet Font qui est utilisé pour définir les propriétés de police de la légende.
ForeColor	Obtient ou définit la couleur du texte de la légende.
HeaderSeparator	Obtient ou définit le type de séparateur visuel de l'en-tête de la légende.
HeaderSeparatorColor	Obtient ou définit la couleur du séparateur de l'en-tête de la légende.
InsideChartArea	Obtient ou définit le nom de la zone de graphique dans laquelle la légende est dessinée.
InterlacedRows	Obtient ou définit un indicateur qui détermine si les lignes de légende sont dessinées avec la couleur d'arrière-plan entrelacée.
InterlacedRowsColor	Obtient ou définit la couleur d'arrière-plan des lignes entrelacées de la légende.
IsDockedInsideChartArea	Obtient ou définit un indicateur qui détermine si la légende est ancrée à l'intérieur ou à l'extérieur de la zone de graphique.
IsEquallySpacedItems	Obtient ou définit un indicateur qui détermine si tous les éléments de la légende sont espacés de façon égale.
IsTextAutoFit	Obtient ou définit un indicateur qui détermine si le texte de la légende est dimensionné automatiquement.
ItemColumnSeparator	Obtient ou définit le type de séparateur visuel des colonnes de tableau de légende.
ItemColumnSeparatorColor	Obtient ou définit la couleur du séparateur des colonnes de tableau de légende.
ItemColumnSpacing	Obtient ou définit l'espacement des colonnes de tableau de légende.
LegendItemOrder	Obtient ou définit un indicateur qui spécifie l'ordre d'affichage des éléments de légende. Cette propriété affecte uniquement les éléments de légende qui sont automatiquement ajoutés pour la série de graphique ; elle n'a aucun effet sur les éléments de légende personnalisés.
LegendStyle	Obtient ou définit le style de la légende.
MaximumAutoSize	Obtient ou définit la taille maximale de la légende, mesurée sous forme de pourcentage de la zone de graphique. Cette valeur est utilisée par l'algorithme de disposition automatique.
Name	Obtient ou définit le nom de la légende.
Position	Obtient ou définit un objet ElementPosition qui peut être utilisé pour obtenir ou définir la position de la légende.
ShadowColor	Obtient ou définit la couleur de l'ombre de la légende.
ShadowOffset	Obtient ou définit le décalage de l'ombre de la légende (en pixels).
TableStyle	Obtient ou définit le style de table Légende.
Tag	Obtient ou définit un objet associé à cet élément de graphique. (Hérité de ChartElement)
TextWrapThreshold	Obtient ou définit le nombre de caractères qui peuvent être affichés de façon séquentielle dans la légende avant que le texte ne soit renvoyé automatiquement à la ligne.
Title	Obtient ou définit le texte du titre de la légende.
TitleAlignment	Obtient ou définit l'alignement du titre de la légende.
TitleBackColor	Obtient ou définit la couleur d'arrière-plan du titre de la légende.
TitleFont	Obtient ou définit la police du titre de la légende.
TitleForeColor	Obtient ou définit la couleur de texte du titre de la légende.
TitleSeparator	Obtient ou définit le type de séparateur visuel du titre de la légende.
TitleSeparatorColor	Récupère ou définit la couleur du séparateur de titre de légende.

Méthodes

Dispose()	Libère les ressources utilisées par le ChartElement. (Hérité de ChartElement)
Dispose(Boolean)	Libère les ressources non managées utilisées par Legend et libère éventuellement les ressources managées.
Equals(Object)	Détermine si l'objet Object spécifié est égal à l'objet ChartElement actuel. (Hérité de ChartElement)
GetHashCode()	Retourne une fonction de hachage pour un type particulier. (Hérité de ChartElement)
GetType()	Obtient le Type de l'instance actuelle. (Hérité de Object)
MemberwiseClone()	Crée une copie superficielle du Object actuel. (Hérité de Object)
ToString()	Retourne une chaîne qui représente le Object actuel. (Hérité de ChartElement)