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 Legends propriété de collection de l’objet racine Chart .

Il peut y avoir n’importe quel nombre de légendes pour une image de graphique.

Les légendes peuvent :

• Être ancré et aligné.

• Afficher à 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 la ligne, la colonne ou la table.

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

• Dimensionnement et position n’importe où dans l’image du 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é.

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 de la série de données tracée. 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 ne sera pas créé pour une série si la IsVisibleInLegend propriété est définie falsesur . 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 en secteurs et que vous définissez la Label propriété, il définit également le texte de légende sur la valeur que vous définissez pour les étiquettes. Si vous souhaitez définir le texte sur une autre valeur, 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 par défaut est automatiquement dimensionné. Vous pouvez désactiver le dimensionnement automatique du texte de légende en désactivant la IsTextAutoFit propriété. Lorsque cette propriété est définie falsesur , la taille du texte de 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 soit encapsulé à une autre ligne. Si vous ne souhaitez pas encapsuler le texte dans 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 légende ne correspond pas à la légende, le texte est tronqué. Vous pouvez définir la TextWrapThreshold légende pour que le texte soit encapsulé au lieu d’être tronqué.

Si le contenu de la légende ne peut pas correspondre à l’espace donné, les entrées de légende sont tronquées. Un point de suspension s’affiche pour indiquer qu’il y a plus d’entrées que la légende pour laquelle il y a de l’espace. Pour empêcher les éléments de légende d’être tronqués, définissez la position et la taille de la légende à l’aide de la Position propriété. Lorsque vous définissez la position ou la taille de la légende, le graphique ne peut plus positionner automatiquement les éléments dans le graphique. Dans certains cas, vous devez souvent 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 et MinimumWidth des propriétés qui peuvent être utilisées pour ajuster la taille des colonnes.

Lorsque la légende contient de nombreuses entrées, InterlacedRows vous pouvez l’utiliser pour améliorer la lisibilité. Lorsque cette propriété a la valeur True, elle affiche une couleur de retour 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 des propriétés 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.

Lorsqu’elle IsDockedInsideChartArea est définie sur 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

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

Propriétés

Nom	Description
Alignment	Obtient 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 de configuration automatique pour le texte de 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 également si un dégradé est utilisé.
BackHatchStyle	Obtient ou définit le style de hachage 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 de l’image d’arrière-plan utilisé pour le Unscaled mode dessin.
BackImageTransparentColor	Obtient ou définit une couleur qui sera remplacée par une couleur transparente 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 d’un arrière-plan de légende.
BorderColor	Obtient ou définit la couleur de bordure d’une légende.
BorderDashStyle	Obtient ou définit le style de bordure d’une légende.
BorderWidth	Obtient ou définit la largeur de bordure d’une légende.
CellColumns	Obtient la LegendCellColumnCollection légende.
CustomItems	Obtient un LegendItemsCollection objet utilisé pour les éléments de légende personnalisés.
DockedToChartArea	Obtient ou définit le nom de l’emplacement ChartArea d’ancrage de la légende.
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 Font objet, 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 légende.
HeaderSeparator	Obtient ou définit le type de séparateur visuel pour l’en-tête de légende.
HeaderSeparatorColor	Obtient ou définit la couleur du séparateur pour l’en-tête de 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 indique si les lignes de légende sont dessinées avec une 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 indique si la légende est ancrée à l’intérieur ou en dehors de la zone de graphique.
IsEquallySpacedItems	Obtient ou définit un indicateur qui indique si tous les éléments de légende sont également espadés.
IsTextAutoFit	Obtient ou définit un indicateur qui indique si le texte de légende est automatiquement dimensionné.
ItemColumnSeparator	Obtient ou définit le type de séparateur visuel pour les colonnes de la table de légendes.
ItemColumnSeparatorColor	Obtient ou définit la couleur du séparateur de colonne de table de légende.
ItemColumnSpacing	Obtient ou définit l’espacement des colonnes de la table de légende.
LegendItemOrder	Obtient ou définit un indicateur qui spécifie l’ordre dans lequel les éléments de légende sont affichés. Cette propriété affecte uniquement les éléments de légende automatiquement ajoutés pour la série de graphiques ; 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 la forme d’un 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 ElementPosition objet, qui peut être utilisé pour obtenir ou définir la position de la légende.
ShadowColor	Obtient ou définit la couleur d’ombre de la légende.
ShadowOffset	Obtient ou définit le décalage d’ombre, en pixels, de la légende.
TableStyle	Obtient ou définit le style de table de 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 séquentiellement dans la légende avant que le texte soit encapsulé.
Title	Obtient ou définit le texte du titre de la légende.
TitleAlignment	Obtient ou définit l’alignement du titre de 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 légende.
TitleForeColor	Obtient ou définit la couleur du texte du titre de la légende.
TitleSeparator	Obtient ou définit le type de séparateur visuel pour le titre de légende.
TitleSeparatorColor	Obtient ou définit la couleur du séparateur de titre de légende.

Méthodes

Nom	Description
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 les Legend ressources gérées et libère éventuellement les ressources managées.
Equals(Object)	Détermine si le spécifié Object est égal à l’actuel ChartElement. (Hérité de ChartElement)
GetHashCode()	Retourne une fonction de hachage pour un type particulier. (Hérité de ChartElement)
GetType()	Obtient la Type de l’instance actuelle. (Hérité de Object)
MemberwiseClone()	Crée une copie superficielle du Objectactuel. (Hérité de Object)
ToString()	Retourne une chaîne qui représente le fichier actif Object. (Hérité de ChartElement)