Legend Klasse

Definition

Stellt die Legende für das Diagrammbild dar.Represents the legend for the chart image.

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
Vererbung

Hinweise

Die Legend -Klasse kapselt die gesamte Funktionalität Chart der Legende des Steuer Elements und wird mithilfe der Legends -Auflistungs Eigenschaft des Chart root-Objekts verfügbar gemacht.The Legend class encapsulates all the functionality of the Chart control's legend, and is exposed using the Legends collection property of the root Chart object.

Für ein Diagramm Bild kann eine beliebige Anzahl von Legenden vorhanden sein.There can be any number of legends for a chart image.

Legenden können:Legends can:

  • Angedockt und ausgerichtet werden.Be docked and aligned.

  • Wird innerhalb oder außerhalb der geplotteten Diagramm Flächen angezeigt.Be displayed inside or outside the plotted chart areas.

  • Der Inhalt wird automatisch angepasst.Automatically fit their contents.

  • Verwenden Sie einen vordefinierten Stil, z. b. Zeile, Spalte oder Tabelle.Use a predefined style, such as row, column or table.

  • Verwendung von Schraffuren, Farbverlaufs Farben und Hintergrundbildern.Use hatching, gradient colors and background images.

  • Größe und Position innerhalb des Diagramm Bilds.Be sized and positioned anywhere within the chart image.

Legenden Elemente werden durch das LegendItem -Objekt dargestellt, und sind entweder Default-oder Custom-Elemente.Legend items are represented by the LegendItem object, and are either default or custom items. Benutzerdefinierte Elemente sind nicht Daten zugeordnet und können mithilfe der CustomItems -Eigenschaft hinzugefügt, gelöscht und geändert werden.Custom items are not associated with data, and can be added, deleted and modified using the CustomItems property.

Standardelemente werden der Legende standardmäßig automatisch hinzugefügt, und sind die Namen der geplotteten Datenpunkte für Ring-und Kreis Diagramme.Default items are by default automatically added to the legend, and are the names of the plotted data points for doughnut and pie charts.

Für alle anderen Diagrammtypen sind die Standardelemente die Namen der Zeichnungsdaten Reihe.For all other chart types, the default items are the names of the plotted data series. Jede Reihe verfügt über Legend eine-Eigenschaft, die den Namen der zu verwendenden Legende definiert.Each series has a Legend property that defines the name of the legend that will be used. Ein Legenden Element wird nicht für eine Reihe erstellt, wenn die IsVisibleInLegend -Eigenschaft auf falsefestgelegt ist.A legend item will not be created for a series if the IsVisibleInLegend property is set to false. Der Text für diese Standardelemente kann mithilfe der LegendText -Eigenschaft geändert werden.The text for these default items can be changed using the LegendText property. Mit dieser Eigenschaft können Sie vordefinierte Schlüsselwörter angeben, die zur Laufzeit durch die entsprechenden Werte ersetzt werden.This property will allow you to specify predefined keywords that will be replaced by their appropriate values at run-time.

Wenn Sie ein Kreis Diagramm haben und die Label -Eigenschaft festlegen, wird auch der Legenden Text auf den Wert festgelegt, den Sie für die Bezeichnungen festgelegt haben.If you have a pie chart and you set the Label property, it will also set the legend text to the value you set for the labels. Wenn Sie den Text auf einen anderen Wert festlegen möchten, können Sie die LegendText -Eigenschaft festlegen.If you want to set the text to a different value, you can set the LegendText property. In den meisten Fällen sollten Sie die LegendText -Eigenschaft auf "#AxisLabel" oder "#VALX" festlegen.In most cases, you would want to set the LegendText property to "#AXISLABEL" or "#VALX".

Legenden Reihen Symbole sind Rechtecke, Punkte oder Linien.Legend series symbols are rectangles, dots or lines. Der Symboltyp wird automatisch vom Diagramm festgelegt und hängt vom gezeichnungs Diagrammtyp ab.The symbol type is set automatically by the chart and depends on the plotted chart type.

Der Legenden Text wird standardmäßig automatisch vergrößert.Legend text by default is automatically sized. Sie können die automatische Größenänderung von Legenden Text deaktivieren, indem IsTextAutoFit Sie die-Eigenschaft deaktivieren.You can disable automatic sizing of legend text by disabling the IsTextAutoFit property. Wenn diese Eigenschaft auf falsefestgelegt ist, wird die Größe des Legenden Texts von der Size-Eigenschaft der Legende Fontbestimmt.When this property is set to false, the size of the legend text is determined by the Size property of the legend Font. Wenn die IsTextAutoFit -Eigenschaft aktiviert ist, AutoFitMinFontSize bestimmt die-Eigenschaft den minimalen Schrift Grad, den ein Legenden Element bei der Größenänderung aufweisen kann.If the IsTextAutoFit property is enabled, the AutoFitMinFontSize property determines the minimum font size that a legend item can have when resizing.

Die TextWrapThreshold -Eigenschaft definiert eine Beschränkung für die Anzahl der Zeichen, die in einer Zeile angezeigt werden können, bevor der Text in eine andere Zeile umschließt wird.The TextWrapThreshold property defines a limit on the number of characters that can be shown on one line before text is wrapped to another line. Wenn Sie den Text in der Legende nicht umschließen möchten, legen Sie den Wert TextWrapThreshold der-Eigenschaft auf 0 (null) fest.If you do not wish to wrap text in the legend, set the value of the TextWrapThreshold property to zero. Wenn der gesamte Legenden Text nicht in die Legende passt, wird der Text standardmäßig abgeschnitten.By default, when the entire legend text does not fit in the legend, the text will be truncated. Sie können für die TextWrapThreshold Legende festlegen, dass der zu Umbruch Ende Text statt abgeschnitten werden soll.You can set the TextWrapThreshold on the legend to get the text to wrap instead of being truncated.

Wenn der Inhalt der Legende nicht in den angegebenen Bereich passt, werden Legenden Einträge abgeschnitten.If the contents of the legend cannot fit into the given space, legend entries are truncated. Es wird ein Auslassungs Zeichen angezeigt, um anzugeben, dass mehr Einträge vorhanden sind, als in der Legende vorhanden sind.An ellipsis is shown to indicate that there are more entries than the legend has space for. Um zu verhindern, dass die Legenden Elemente abgeschnitten werden, legen Sie die Position und die Größe der Legende Position mithilfe der-Eigenschaft fest.To prevent the legend items from being truncated, set the position and size of the legend using the Position property. Beim Festlegen der Legenden Position oder-Größe kann das Diagramm die Elemente im Diagramm nicht mehr automatisch positionieren.When setting the legend position or size, the chart can no longer automatically position the elements in the chart. In einigen Fällen müssen Sie andere Diagramm Elemente manuell positionieren, um die gewünschte Darstellung zu erzielen.In some cases, you many need to manually position other chart elements to achieve the desired appearance.

Eine andere Möglichkeit besteht darin, eigene Zellen Spalten zu definieren, anstatt die Standard Legenden Einstellungen zu verwenden.Another option would be to define your own cell columns instead of using the default legend settings.

Das Legend -Objekt verfügt über eine cellcolumn-Auflistung. jedes cellcolumn-Objekt stellt eine Spalte in der Legende dar.The Legend object has a CellColumn Collection; each CellColumn object represents a column in the Legend. Eine Zellen Spalte verfügt MaximumWidth über MinimumWidth die Eigenschaften und, mit denen die Größe der Spalten angepasst werden kann.A cell column has MaximumWidth and MinimumWidth properties that can be used to adjust the size of the columns.

Wenn die Legende viele Einträge enthält, InterlacedRows kann verwendet werden, um die Lesbarkeit zu verbessern.When the legend contains many entries, InterlacedRows can be used to improve readability. Wenn diese Eigenschaft auf true festgelegt ist, wird eine Hintergrundfarbe angezeigt, die Sie mithilfe der InterlacedRowsColor -Eigenschaft festlegen können.When this property is set to True, it will display a back color that you can set using the InterlacedRowsColor property.

Standardmäßig wird die Legende in der oberen rechten Ecke des Diagramms positioniert.By default, the legend is positioned in the top-right corner of the chart. Diese Position kann mithilfe der Docking -Eigenschaft und der- Alignment Eigenschaft der Legende geändert werden.This position can be modified by using the Docking and Alignment properties of the legend. Die Legende kann auch einem Diagrammbereich DockedToChartArea mithilfe der-Eigenschaft zugeordnet werden.The legend can also be associated with a chart area by use of the DockedToChartArea property. Diese Eigenschaft gibt den Namen der Diagrammbereich an, für den die Legende angedockt werden soll.This property specifies the name of the chart area for which the legend should be docked. Außerdem kann die IsDockedInsideChartArea -Eigenschaft verwendet werden, um die Legende in einem Diagrammbereich anzuzeigen.In addition, the IsDockedInsideChartArea property can be used to display the legend inside a chart area.

Wenn IsDockedInsideChartArea auf false festgelegt ist, MaximumAutoSize definiert die-Eigenschaft die maximale Größe (in Prozent) der Legende innerhalb des verfügbaren Diagramms, wenn die Legende automatisch positioniert wird.When IsDockedInsideChartArea is set to False, the MaximumAutoSize property defines the maximum size, in percent, of the legend within the available chart when the legend is automatically positioned. Diese Eigenschaft sollte festgelegt werden, wenn Sie die Breite oder Höhe der Legende nach dem Festlegen der Andock Eigenschaften anpassen möchten.This property should be set if you wish to adjust the width or height of the legend after the docking properties have been set.

Die Legende kann mithilfe des CustomizeLegend -Ereignisses geändert werden.The legend can be modified using the CustomizeLegend event.

Konstruktoren

Legend()

Initialisiert eine neue Instanz der Legend-Klasse.Initializes a new instance of the Legend class.

Legend(String)

Initialisiert eine neue Instanz der AnnotationPathPoint-Klasse mit dem angegebenen Legendennamen.Initializes a new instance of the AnnotationPathPoint class with the specified legend name.

Eigenschaften

Alignment

Ruft die Textausrichtung in der Legende ab oder legt diese fest.Gets or sets the alignment of the legend.

AutoFitMinFontSize

Ruft den minimalen Schriftgrad ab, der vom Algorithmus für die automatische Anpassung des Legendentexts verwendet werden kann, oder legt diesen fest.Gets or sets the minimum font size that can be used by the autofitting algorithm for the legend text.

BackColor

Ruft die Hintergrundfarbe einer Legende ab oder legt diese fest.Gets or sets the background color of a legend.

BackGradientStyle

Ruft die Ausrichtung für den Hintergrundfarbverlauf einer Legende ab oder legt diese fest.Gets or sets the orientation for the background gradient of a legend. Bestimmt außerdem, ob ein Farbverlauf verwendet wird.Also determines whether a gradient is used.

BackHatchStyle

Ruft die Schraffurart einer Legende ab oder legt diese fest.Gets or sets the hatching style of a legend.

BackImage

Ruft das Hintergrundbild einer Legende ab oder legt dieses fest.Gets or sets the background image of a legend.

BackImageAlignment

Ruft die für den Unscaled-Zeichnungsmodus verwendete Ausrichtung des Hintergrundbilds ab oder legt diese fest.Gets or sets the background image alignment used for the Unscaled drawing mode.

BackImageTransparentColor

Ruft eine Farbe ab, die beim Zeichnen des Hintergrundbilds durch eine transparente Farbe ersetzt wird, oder legt diese fest.Gets or sets a color that will be replaced with a transparent color when the background image is drawn.

BackImageWrapMode

Ruft den Zeichnungsmodus eines Legendenhintergrundbilds ab oder legt diesen fest.Gets or sets the drawing mode of a legend background image.

BackSecondaryColor

Ruft die sekundäre Farbe eines Legendenhintergrunds ab oder legt diese fest.Gets or sets the secondary color of a legend background.

BorderColor

Ruft die Rahmenfarbe einer Legende ab oder legt diese fest.Gets or sets the border color of a legend.

BorderDashStyle

Ruft die Rahmenart einer Legende ab oder legt diese fest.Gets or sets the border style of a legend.

BorderWidth

Ruft die Rahmenbreite einer Legende ab oder legt diese fest.Gets or sets the border width of a legend.

CellColumns

Ruft die LegendCellColumnCollection für eine Legende ab.Gets the LegendCellColumnCollection for a legend.

CustomItems

Ruft ein LegendItemsCollection-Objekt ab, das für benutzerdefinierte Legendenelemente verwendet wird.Gets a LegendItemsCollection object used for custom legend items.

DockedToChartArea

Ruft den Namen der ChartArea ab, an die die Legende angedockt wird, oder legt diesen fest.Gets or sets the name of the ChartArea where the legend will be docked.

Docking

Ruft einen Wert ab, der bestimmt, wo die Legende angedockt wird, oder legt diesen fest.Gets or sets a value that determines where the legend is docked.

Enabled

Ruft einen Wert ab, der bestimmt, ob die Legende aktiviert ist, oder legt diesen fest.Gets or sets a value that determines if the legend is enabled.

Font

Ruft ein Font-Objekt ab, mit dem Schriftarteigenschaften der Legende festgelegt werden, oder legt dieses fest.Gets or sets a Font object, which is used to set font properties of the legend.

ForeColor

Ruft die Farbe des Legendentexts ab oder legt diese fest.Gets or sets the color of the legend text.

HeaderSeparator

Ruft den Typ des visuellen Trennzeichens für den Legendenheader ab oder legt diesen fest.Gets or sets the visual separator type for the legend header.

HeaderSeparatorColor

Ruft die Farbe des Trennzeichens für den Legendenheader ab oder legt diese fest.Gets or sets the color of the separator for the legend header.

InsideChartArea

Ruft den Namen des Diagrammbereichs ab, in dem die Legende gezeichnet wird, oder legt diesen fest.Gets or sets the name of the chart area in which the legend is drawn.

InterlacedRows

Ruft ein Flag ab, das angibt, ob Legendenzeilen mit Zeilensprunghintergrundfarbe gezeichnet werden, oder legt dieses fest.Gets or sets a flag that indicates if legend rows will be drawn with interlaced background color.

InterlacedRowsColor

Ruft die Hintergrundfarbe der Zeilensprungzeilen der Legende ab oder legt diese fest.Gets or sets the background color of the legend's interlaced rows.

IsDockedInsideChartArea

Ruft ein Flag ab, das angibt, ob die Legende innerhalb oder außerhalb des Diagrammbereichs angedockt wird, oder legt dieses fest.Gets or sets a flag that indicates whether the legend is docked inside or outside the chart area.

IsEquallySpacedItems

Ruft ein Flag ab, das angibt, ob alle Legendenelemente den gleichen Abstand aufweisen, oder legt dieses fest.Gets or sets a flag that indicates whether all legend items are equally spaced.

IsTextAutoFit

Ruft ein Flag ab, das angibt, ob die Größe des Legendentexts automatisch angepasst wird, oder legt dieses fest.Gets or sets a flag that indicates whether the legend text is automatically sized.

ItemColumnSeparator

Ruft den Typ des visuellen Trennzeichens für die Legendentabellenspalten ab oder legt diesen fest.Gets or sets the visual separator type for the legend table columns.

ItemColumnSeparatorColor

Ruft die Farbe des Trennzeichens für die Legendentabellenspalten ab oder legt diese fest.Gets or sets the color of the legend table column separator.

ItemColumnSpacing

Ruft den Spaltenabstand der Legendentabelle ab oder legt diesen fest.Gets or sets the legend table column spacing.

LegendItemOrder

Ruft ein Flag ab, das die Reihenfolge angibt, in der Legendenelemente angezeigt werden, oder legt diesen fest.Gets or sets a flag that specifies the order in which legend items are displayed. Diese Eigenschaft wirkt sich nur auf Legendenelemente aus, die für die Diagrammreihen automatisch hinzugefügt werden. Sie wirkt sich nicht auf benutzerdefinierte Legendenelemente aus.This property only affects legend items automatically added for the chart series; it has no effect on custom legend items.

LegendStyle

Ruft die Art der Legende ab oder legt diese fest.Gets or sets the style of the legend.

MaximumAutoSize

Ruft die maximale Größe der Legende ab, die als Prozentsatz des Diagrammbereichs angegeben wird, oder legt diese fest.Gets or sets the maximum size of the legend, measured as a percentage of the chart area. Dieser Wert wird vom Algorithmus für automatisches Layout verwendet.This value is used by the automatic layout algorithm.

Name

Ruft den Namen der Legende ab oder legt diesen fest.Gets or sets the name of the legend.

Position

Ruft ein ElementPosition-Objekt ab, mit dem die Position der Legende abgerufen oder festgelegt werden kann, oder legt dieses fest.Gets or sets an ElementPosition object, which can be used to get or set the position of the legend.

ShadowColor

Ruft die Schattenfarbe der Legende ab oder legt diese fest.Gets or sets the shadow color of the legend.

ShadowOffset

Ruft den Schattenoffset in Pixel der Legende ab oder legt diesen fest.Gets or sets the shadow offset, in pixels, of the legend.

TableStyle

Ruft das Format der Legendentabelle ab oder legt dieses fest.Gets or sets the legend table style.

Tag

Ruft ein Objekt ab, das dem Diagrammelement zugeordnet ist, oder legt dieses fest.Gets or sets an object associated with this chart element.

(Geerbt von ChartElement)
TextWrapThreshold

Ruft die Anzahl von Zeichen ab, die in der Legende nacheinander angezeigt werden können, bevor der Text umbrochen wird, oder legt diese fest.Gets or sets the number of characters that can be sequentially displayed in the legend before the text is wrapped.

Title

Ruft den Text des Legendentitels ab oder legt diesen fest.Gets or sets the text of the legend title.

TitleAlignment

Ruft die Ausrichtung des Legendentitels ab oder legt diese fest.Gets or sets the alignment of the legend title.

TitleBackColor

Ruft die Hintergrundfarbe des Legendentitels ab oder legt diese fest.Gets or sets the background color of the legend title.

TitleFont

Ruft die Schriftart für den Legendentitel ab oder legt diese fest.Gets or sets the font for the legend title.

TitleForeColor

Ruft die Textfarbe des Legendentitels ab oder legt diese fest.Gets or sets the text color of the legend title.

TitleSeparator

Ruft den Typ des visuellen Trennzeichens für den Legendentitel ab oder legt diesen fest.Gets or sets the visual separator type for the legend title.

TitleSeparatorColor

Ruft die Farbe der Trennlinie für den Legendentitel ab oder legt sie fest.Gets or sets the color of the legend title separator.

Methoden

Dispose()

Gibt die von der ChartElement verwendeten Ressourcen frei.Releases the resources used by the ChartElement.

(Geerbt von ChartElement)
Dispose(Boolean)

Gibt die von Legend verwendeten nicht verwalteten Ressourcen und optional die verwalteten Ressourcen frei.Releases the unmanaged resources used by the Legend and optionally releases the managed resources.

Equals(Object)

Bestimmt, ob das angegebene Object und das aktuelle ChartElement gleich sind.Determines whether the specified Object is equal to the current ChartElement.

(Geerbt von ChartElement)
GetHashCode()

Gibt eine Hashfunktion für einen bestimmten Typ zurück.Returns a hash function for a particular type.

(Geerbt von ChartElement)
GetType()

Ruft den Type der aktuellen Instanz ab.Gets the Type of the current instance.

(Geerbt von Object)
MemberwiseClone()

Erstellt eine flache Kopie des aktuellen Object.Creates a shallow copy of the current Object.

(Geerbt von Object)
ToString()

Gibt eine Zeichenfolge zurück, die das aktuelle Object-Objekt darstellt.Returns a string that represents the current Object.

(Geerbt von ChartElement)

Gilt für: