Legend Klasa

Definicja

Reprezentuje legendę obrazu wykresu.

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
Dziedziczenie

Uwagi

Klasa Legend hermetyzuje wszystkie funkcje Chart legendy kontrolki i jest uwidoczniona przy użyciu Legends właściwości kolekcji obiektu głównego Chart .

Obraz wykresu może mieć dowolną liczbę legend.

Legendy mogą:

  • Zadokuj i wyrównaj.

  • Być wyświetlane wewnątrz lub na zewnątrz wykreślionych obszarów wykresu.

  • Automatycznie dopasuj ich zawartość.

  • Użyj wstępnie zdefiniowanego stylu, takiego jak wiersz, kolumna lub tabela.

  • Użyj kreskowania, kolorów gradientu i obrazów tła.

  • Rozmiar i położenie w dowolnym miejscu na obrazie wykresu.

Elementy legendy są reprezentowane przez LegendItem obiekt i są elementami domyślnymi lub niestandardowymi. Elementy niestandardowe nie są skojarzone z danymi i można je dodawać, usuwać i modyfikować przy użyciu CustomItems właściwości .

Domyślne elementy są domyślnie automatycznie dodawane do legendy i są nazwami wykreśliwanych punktów danych dla wykresów pierścieniowych i kołowych.

W przypadku wszystkich innych typów wykresów domyślne elementy to nazwy wykreślionych serii danych. Każda seria ma Legend właściwość definiującą nazwę legendy, która będzie używana. Element legendy nie zostanie utworzony dla serii, jeśli właściwość jest ustawiona IsVisibleInLegend na falsewartość . Tekst tych elementów domyślnych można zmienić przy użyciu LegendText właściwości . Ta właściwość umożliwia określenie wstępnie zdefiniowanych słów kluczowych, które zostaną zastąpione odpowiednimi wartościami w czasie wykonywania.

Jeśli masz wykres kołowy i ustawisz Label właściwość , spowoduje to również ustawienie tekstu legendy na wartość ustawioną dla etykiet. Jeśli chcesz ustawić tekst na inną wartość, możesz ustawić LegendText właściwość . W większości przypadków należy ustawić LegendText właściwość na "#AXISLABEL" lub "#VALX".

Symbole serii legendy to prostokąty, kropki lub linie. Typ symboli jest ustawiany automatycznie przez wykres i zależy od typu wykresu.

Domyślnie tekst legendy ma automatycznie rozmiar. Automatyczne określanie rozmiaru tekstu legendy można wyłączyć, wyłączając IsTextAutoFit właściwość . Gdy ta właściwość jest ustawiona na falsewartość , rozmiar tekstu legendy jest określany przez właściwość Size legendy Font. IsTextAutoFit Jeśli właściwość jest włączona, właściwość określa minimalny rozmiar czcionki, AutoFitMinFontSize który może mieć element legendy podczas zmiany rozmiaru.

Właściwość TextWrapThreshold definiuje limit liczby znaków, które można wyświetlić w jednym wierszu przed zawijaniem tekstu do innego wiersza. Jeśli nie chcesz zawijać tekstu w legendzie, ustaw wartość TextWrapThreshold właściwości na zero. Domyślnie, gdy cały tekst legendy nie mieści się w legendzie, tekst zostanie obcięty. Można ustawić TextWrapThreshold na legendzie, aby tekst był zawijany, a nie obcinany.

Jeśli zawartość legendy nie może mieścić się w danym miejscu, wpisy legendy są obcinane. Zostanie wyświetlony wielokropek wskazujący, że istnieje więcej wpisów niż legenda ma miejsce. Aby zapobiec obcinaniu elementów legendy, ustaw pozycję i rozmiar legendy Position przy użyciu właściwości . Podczas ustawiania pozycji lub rozmiaru legendy wykres nie może już automatycznie ustawiać elementów na wykresie. W niektórych przypadkach wiele z nich musi ręcznie ustawić inne elementy wykresu, aby uzyskać żądany wygląd.

Inną opcją jest zdefiniowanie własnych kolumn komórek zamiast używania domyślnych ustawień legendy.

Obiekt Legend ma kolekcję CellColumn; każdy obiekt CellColumn reprezentuje kolumnę w legendzie. Kolumna komórki zawiera MaximumWidth właściwości, MinimumWidth których można użyć do dostosowania rozmiaru kolumn.

Gdy legenda zawiera wiele wpisów, InterlacedRows można jej użyć do zwiększenia czytelności. Po ustawieniu tej właściwości na wartość True zostanie wyświetlony kolor tła, który można ustawić przy użyciu InterlacedRowsColor właściwości .

Domyślnie legenda jest umieszczona w prawym górnym rogu wykresu. To położenie można zmodyfikować przy użyciu Docking właściwości i Alignment legendy. Legenda może być również skojarzona z obszarem wykresu DockedToChartArea przy użyciu właściwości . Ta właściwość określa nazwę obszaru wykresu, dla którego legenda powinna być zadokowana. Ponadto IsDockedInsideChartArea właściwość może służyć do wyświetlania legendy w obszarze wykresu.

Po IsDockedInsideChartArea ustawieniu wartości False MaximumAutoSize właściwość definiuje maksymalny rozmiar legendy w procentach w ramach dostępnego wykresu, gdy legenda zostanie automatycznie umieszczona. Tę właściwość należy ustawić, jeśli chcesz dostosować szerokość lub wysokość legendy po ustawieniu właściwości dokowania.

Legendę można modyfikować przy użyciu CustomizeLegend zdarzenia.

Konstruktory

Legend()

Inicjuje nowe wystąpienie klasy Legend.

Legend(String)

Inicjuje AnnotationPathPoint nowe wystąpienie klasy o określonej nazwie legendy.

Właściwości

Alignment

Pobiera lub ustawia wyrównanie legendy.

AutoFitMinFontSize

Pobiera lub ustawia minimalny rozmiar czcionki, który może być używany przez algorytm autodopasowania tekstu legendy.

BackColor

Pobiera lub ustawia kolor tła legendy.

BackGradientStyle

Pobiera lub ustawia orientację gradientu tła legendy. Określa również, czy jest używany gradient.

BackHatchStyle

Pobiera lub ustawia styl wykluwania legendy.

BackImage

Pobiera lub ustawia obraz tła legendy.

BackImageAlignment

Pobiera lub ustawia wyrównanie obrazu tła używane w trybie rysunku Unscaled .

BackImageTransparentColor

Pobiera lub ustawia kolor, który zostanie zastąpiony przezroczystym kolorem po narysowanym obrazie tła.

BackImageWrapMode

Pobiera lub ustawia tryb rysowania obrazu tła legendy.

BackSecondaryColor

Pobiera lub ustawia pomocniczy kolor tła legendy.

BorderColor

Pobiera lub ustawia kolor obramowania legendy.

BorderDashStyle

Pobiera lub ustawia styl obramowania legendy.

BorderWidth

Pobiera lub ustawia szerokość obramowania legendy.

CellColumns

Pobiera element LegendCellColumnCollection dla legendy.

CustomItems

LegendItemsCollection Pobiera obiekt używany dla niestandardowych elementów legendy.

DockedToChartArea

Pobiera lub ustawia nazwę, w ChartArea której będzie zadokowana legenda.

Docking

Pobiera lub ustawia wartość, która określa, gdzie legenda jest zadokowana.

Enabled

Pobiera lub ustawia wartość, która określa, czy legenda jest włączona.

Font

Pobiera lub ustawia Font obiekt, który służy do ustawiania właściwości czcionki legendy.

ForeColor

Pobiera lub ustawia kolor tekstu legendy.

HeaderSeparator

Pobiera lub ustawia typ separatora wizualizacji dla nagłówka legendy.

HeaderSeparatorColor

Pobiera lub ustawia kolor separatora nagłówka legendy.

InsideChartArea

Pobiera lub ustawia nazwę obszaru wykresu, w którym jest rysowana legenda.

InterlacedRows

Pobiera lub ustawia flagę wskazującą, czy wiersze legendy zostaną narysowane z przeplotem koloru tła.

InterlacedRowsColor

Pobiera lub ustawia kolor tła przeplatanych wierszy legendy.

IsDockedInsideChartArea

Pobiera lub ustawia flagę wskazującą, czy legenda jest zadokowana wewnątrz obszaru wykresu, czy poza nim.

IsEquallySpacedItems

Pobiera lub ustawia flagę wskazującą, czy wszystkie elementy legendy są równomiernie rozmieszczone.

IsTextAutoFit

Pobiera lub ustawia flagę wskazującą, czy tekst legendy ma automatycznie rozmiar.

ItemColumnSeparator

Pobiera lub ustawia typ separatora wizualizacji dla kolumn tabeli legendy.

ItemColumnSeparatorColor

Pobiera lub ustawia kolor separatora kolumn tabeli legendy.

ItemColumnSpacing

Pobiera lub ustawia odstępy między kolumnami tabeli legendy.

LegendItemOrder

Pobiera lub ustawia flagę określającą kolejność wyświetlania elementów legendy. Ta właściwość wpływa tylko na elementy legendy automatycznie dodawane dla serii wykresów; nie ma wpływu na elementy legendy niestandardowej.

LegendStyle

Pobiera lub ustawia styl legendy.

MaximumAutoSize

Pobiera lub ustawia maksymalny rozmiar legendy mierzony jako procent obszaru wykresu. Ta wartość jest używana przez algorytm automatycznego układu.

Name

Pobiera lub ustawia nazwę legendy.

Position

Pobiera lub ustawia ElementPosition obiekt, który może służyć do pobierania lub ustawiania pozycji legendy.

ShadowColor

Pobiera lub ustawia kolor cienia legendy.

ShadowOffset

Pobiera lub ustawia przesunięcie cienia w pikselach legendy.

TableStyle

Pobiera lub ustawia styl tabeli legendy.

Tag

Pobiera lub ustawia obiekt skojarzony z tym elementem wykresu.

(Odziedziczone po ChartElement)
TextWrapThreshold

Pobiera lub ustawia liczbę znaków, które mogą być sekwencyjnie wyświetlane w legendzie przed opakowaniem tekstu.

Title

Pobiera lub ustawia tekst tytułu legendy.

TitleAlignment

Pobiera lub ustawia wyrównanie tytułu legendy.

TitleBackColor

Pobiera lub ustawia kolor tła tytułu legendy.

TitleFont

Pobiera lub ustawia czcionkę tytułu legendy.

TitleForeColor

Pobiera lub ustawia kolor tekstu tytułu legendy.

TitleSeparator

Pobiera lub ustawia typ separatora wizualizacji dla tytułu legendy.

TitleSeparatorColor

Pobiera lub ustawia kolor separatora tytułu legendy.

Metody

Dispose()

Zwalnia zasoby używane przez element ChartElement.

(Odziedziczone po ChartElement)
Dispose(Boolean)

Zwalnia zasoby niezarządzane używane przez element Legend i opcjonalnie zwalnia zasoby zarządzane.

Equals(Object)

Określa, czy określona Object wartość jest równa bieżącej ChartElementwartości .

(Odziedziczone po ChartElement)
GetHashCode()

Zwraca funkcję skrótu dla określonego typu.

(Odziedziczone po ChartElement)
GetType()

Type Pobiera wartość bieżącego wystąpienia.

(Odziedziczone po Object)
MemberwiseClone()

Tworzy płytkią kopię bieżącego Objectelementu .

(Odziedziczone po Object)
ToString()

Zwraca ciąg reprezentujący bieżący Objectelement .

(Odziedziczone po ChartElement)

Dotyczy