Legend 類別

定義

命名空間:

System.Windows.Forms.DataVisualization.Charting

組件:

System.Windows.Forms.DataVisualization.dll

代表圖表圖例。

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

繼承

Object

ChartElement

ChartNamedElement

Legend

備註

這個 Legend 類別封裝了控制項圖例的所有功能 Chart ，並透過 Legends 根 Chart 物件的集合屬性來暴露。

一張圖表的圖例可以有無限多個。

傳奇可以：

• 保持對接並對齊。

• 可顯示在圖表區域內外。

• 自動符合內容。

• 使用預先定義的樣式，例如列、欄或表格。

• 使用陰影、漸層色彩和背景影像。

• 尺寸和位置都可以放在圖表中的任何位置。

傳說物品由 LegendItem 物件表示，且可選擇預設或自訂物品。 自訂項目不會與資料相關聯，且可透過該 CustomItems 屬性新增、刪除及修改。

預設項目預設會自動加入圖例中，並且是甜甜圈和圓餅圖所繪製資料點的名稱。

對於其他所有圖表類型，預設項目為繪製資料系列的名稱。 每個系列都有 Legend 一個屬性，定義將使用的圖例名稱。 若 IsVisibleInLegend 屬性設定為 false，則不會為序列建立圖例項目。 這些預設項目的文字可以透過屬性 LegendText 來更改。 這個屬性會讓你指定預先定義的關鍵字，執行時會被相應的值取代。

如果你有圓餅圖並設定屬性 Label ，它也會把圖例文字設定成你設定的標籤值。 如果你想把文字設定成不同的值，可以設定屬性 LegendText 。 大多數情況下，你會想把屬性設 LegendText 為「#AXISLABEL」或「#VALX」。

圖例系列符號為矩形、點或線條。 符號類型由圖表自動設定，並依照繪製的圖表類型而定。

圖例文字預設會自動調整大小。 你可以透過停用 IsTextAutoFit 該屬性來關閉圖例文字的自動大小。 當此屬性設為 false時，圖例文字的大小由圖例 Font的 Size 屬性決定。 若啟用該 IsTextAutoFit 屬性，該 AutoFitMinFontSize 屬性會決定圖例項目在調整大小時的最小字型大小。

此 TextWrapThreshold 特性定義了在文字被換行前，一行可顯示字元數量的限制。 如果你不想在圖例中包裹文字，請將屬性值設 TextWrapThreshold 為零。 預設情況下，當整個圖例文字無法放入圖例時，該文字會被截斷。 你可以在圖例上設定 ， TextWrapThreshold 讓文字能換行而不是被截斷。

若圖例內容無法填入給定空間，則圖例條目會被截斷。 省略號表示條目數量超過圖例的空間。 為了防止圖例項目被截斷，請使用屬性 Position 設定圖例的位置與大小。 設定圖例位置或大小時，圖表無法自動定位圖表中的元素。 有時你還需要手動調整其他圖表元素，才能達到理想的效果。

另一個選擇是自己定義單元欄位，而不是使用預設的圖例設定。

該 Legend 物件有一個 CellColumn 集合;每個 CellColumn 物件代表圖例中的一欄。 儲存格欄位具有 MaximumWidth 屬性 MinimumWidth ，可用來調整欄位大小。

當圖例包含多個條目時， InterlacedRows 可以用來提升可讀性。 當這個屬性設為 True，它會顯示一個背面顏色，你可以用這個 InterlacedRowsColor 屬性來設定。

預設情況下，圖例會位於圖表的右上角。 此位置可透過圖 Docking 例的 與 Alignment 屬性進行修改。 圖例也可以根據該物業與圖表區域 DockedToChartArea 相連結。 此性質指定圖例應停靠的航海圖區域名稱。 此外，該 IsDockedInsideChartArea 屬性還能用來在圖表區域內顯示圖例。

當 IsDockedInsideChartArea 設為 False 時， MaximumAutoSize 屬性會定義圖例在圖例自動定位時，圖例的最大大小（百分比）。 如果你想在設定好對接屬性後調整圖例的寬度或高度，應該設定這個屬性。

傳說可以根據 CustomizeLegend 事件進行修改。

建構函式

名稱	Description
Legend()	初始化 Legend 類別的新執行個體。
Legend(String)	初始化一個以指定圖例名稱的新類別實例 Legend 。

屬性

名稱	Description
Alignment	取得或設定傳說的陣營。
AutoFitMinFontSize	取得或設定自動擬合演算法可用於圖例文字的最小字體大小。
BackColor	取得或設定圖例的背景色。
BackGradientStyle	取得或設定圖例背景梯度的方向。 同時也決定是否使用梯度。
BackHatchStyle	獲得或設定傳奇的孵化風格。
BackImage	取得或設定傳說的背景影像。
BackImageAlignment	取得或設定繪 Unscaled 圖模式所用的背景影像對齊。
BackImageTransparentColor	取得或設定一個顏色，當繪製背景影像時會被透明顏色取代。
BackImageWrapMode	取得或設定圖例背景圖像繪圖模式。
BackSecondaryColor	取得或設定圖例背景的次要顏色。
BorderColor	取得或設定圖例的邊框顏色。
BorderDashStyle	取得或設定傳說的邊界風格。
BorderWidth	取得或設定圖例的邊界寬度。
CellColumns	取得 LegendCellColumnCollection 包含圖例單元欄位集合的物件。
CustomItems	獲得 LegendItemsCollection 一個用於自訂傳說物品的物件。
DockedToChartArea	取得或設定圖例將被停靠的名稱 ChartArea 。
Docking	會取得或設定一個數值，決定該傳說是否被停靠。
Enabled	取得或設定一個值，指示該圖例是否啟用。
Font	取得或設定一個 Font 物件，用來設定圖例的字型屬性。
ForeColor	取得或設定圖例文字的顏色。
HeaderSeparator	取得或設定圖例標頭的視覺分隔符類型。
HeaderSeparatorColor	取得或設定圖例標頭分隔符的顏色。
InsideChartArea	取得或設定圖例所繪製的圖表區域名稱。
InterlacedRows	取得或設定一個旗標，指示圖例列是否會以交錯背景色繪製。
InterlacedRowsColor	取得或設定圖例交錯行的背景色。
IsDockedInsideChartArea	會觸發或設定一個旗標，指示圖例是在圖表區域內還是外面停靠。
IsEquallySpacedItems	會獲得或設定一個旗標，指示所有傳例項目是否相等間距。
IsTextAutoFit	會取得或設定一個旗標，指示圖例文字是否自動調整大小。
ItemColumnSeparator	取得或設定圖例表欄位的視覺分隔符類型。
ItemColumnSeparatorColor	取得或設定圖例表欄位分隔符的顏色。
ItemColumnSpacing	取得或設定圖例表的欄位間距。
LegendItemOrder	取得或設定一個值，指定說明項目的顯示順序。 此特性僅影響自動加入圖表系列的圖例項目;它對自訂傳說物品沒有影響。
LegendStyle	取得或定下傳奇的風格。
MaximumAutoSize	取得或設定圖例的最大大小，以圖表面積的百分比計算。 此值被自動佈局演算法所利用。
Name	取得或設定傳說的名字。
Position	取得或設定一個 ElementPosition 物件，可以用來取得或設定圖例的位置。
ShadowColor	它會取得或設定圖例的陰影顏色。
ShadowOffset	讓陰影偏移（以像素為單位）來設定圖例。
TableStyle	以傳說桌的方式取得或設定。
Tag	取得或設定與此圖表元素相關的物件。 (繼承來源 ChartElement)
TextWrapThreshold	取得或設定在文字換行前可依序顯示的字元數。
Title	取得或設定圖例標題的文字。
TitleAlignment	取得或設定傳奇頭銜的陣營。
TitleBackColor	取得或設定圖例標題的背景色。
TitleFont	取得或設定圖例標題的字體。
TitleForeColor	取得或設定圖例標題的文字顏色。
TitleSeparator	取得或設定圖例標題的視覺分隔碼類型。
TitleSeparatorColor	取得或設定圖例標題分隔符的顏色。

方法

名稱	Description
Dispose()	釋放 所使用的 ChartElement資源。 (繼承來源 ChartElement)
Dispose(Boolean)	釋放 未管理的資源， Legend 並可選擇性地釋放受管理資源。
Equals(Object)	判斷指定的 Object 是否等於電流 ChartElement。 (繼承來源 ChartElement)
GetHashCode()	回傳特定類型的雜湊函數。 (繼承來源 ChartElement)
GetType()	取得目前實例的 Type。 (繼承來源 Object)
MemberwiseClone()	建立目前 Object的淺層複本。 (繼承來源 Object)
ToString()	回傳一個代表當前 Object的字串。 (繼承來源 ChartElement)