Legend 類別

定義

命名空間:

System.Web.UI.DataVisualization.Charting

組件:

System.Web.DataVisualization.dll

代表圖表影像的圖例。

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

繼承

Object

ChartElement

ChartNamedElement

Legend

備註

類別 Legend 會封裝控制項圖例的所有功能 Chart ，並使用根 Chart 物件的集合屬性來公開 Legends 。

圖表影像可以有任意數目的圖例。

圖例可以：

• 停駐並對齊。

• 顯示在繪製的圖表區域內或外部。

• 自動調整其內容。

• 使用預先定義的樣式，例如資料列、資料行或資料表。

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

• 調整圖表影像的大小和位置。

圖例專案是以 LegendItem 物件表示，而且是預設或自訂專案。 自訂專案不會與資料相關聯，而且可以使用 屬性來新增、刪除和修改 CustomItems 。

預設專案會自動新增至圖例，而且是環圈圖和圓形圖的繪製資料點名稱。

對於所有其他圖表類型，預設專案是繪製的資料數列名稱。 每個數列都有定義 Legend 將使用之圖例名稱的屬性。 如果屬性設定 false 為 ， IsVisibleInLegend 則不會為數列建立圖例專案。 您可以使用 屬性來變更 LegendText 這些預設專案的文字。 這個屬性可讓您指定在執行時間由其適當值取代的預先定義關鍵字。

如果您有圓形圖並設定 Label 屬性，它也會將圖例文字設定為您為標籤設定的值。 如果您想要將文字設定為不同的值，您可以設定 LegendText 屬性。 在大部分情況下，您會想要將 LegendText 屬性設定為 「#AXISLABEL」 或 「#VALX」。

圖例數列符號是矩形、點或線條。 符號類型是由圖表自動設定，取決於繪製的圖表類型。

圖例文字預設會自動調整大小。 您可以停用 IsTextAutoFit 屬性來停用圖例文字的自動調整大小。 當這個屬性設定為 false 時，圖例文字的大小是由圖例 Font 的 Size 屬性所決定。 IsTextAutoFit如果啟用屬性，屬性 AutoFitMinFontSize 會決定圖例專案在調整大小時所能擁有的最小字型大小。

屬性 TextWrapThreshold 會定義在文字包裝到另一行之前，可以顯示在一行上的字元數限制。 如果您不想在圖例中換行文字，請將 屬性的值 TextWrapThreshold 設定為零。 根據預設，當整個圖例文字不符合圖例時，就會截斷文字。 您可以在圖例上設定 ， TextWrapThreshold 以取得要換行的文字，而不是被截斷。

如果圖例的內容無法放入指定的空間中，則會截斷圖例專案。 顯示省略號，表示圖例具有的空間還多。 若要防止截斷圖例專案，請使用 Position 屬性設定圖例的位置和大小。 設定圖例位置或大小時，圖表無法再自動放置圖表中的元素。 在某些情況下，您有許多需要手動放置其他圖表元素，以達到所需的外觀。

另一個選項是定義您自己的儲存格資料行，而不是使用預設圖例設定。

物件 Legend 具有 CellColumn 集合;每個 CellColumn 物件都代表 Legend 中的資料行。 儲存格資料行具有 MaximumWidth 和 MinimumWidth 屬性，可用來調整資料行的大小。

當圖例包含許多專案時， InterlacedRows 可用來改善可讀性。 當此屬性設定為 True 時，它會顯示您可以使用 屬性設定的 InterlacedRowsColor 返回色彩。

根據預設，圖例位於圖表右上角。 您可以使用圖例的 和 Alignment 屬性來修改 Docking 此位置。 圖例也可以使用 屬性來與圖表區域 DockedToChartArea 產生關聯。 這個屬性會指定圖例應該停駐的圖表區域名稱。 此外， IsDockedInsideChartArea 屬性可用來在圖表區域內顯示圖例。

當 設定為 False 時 IsDockedInsideChartArea ，當圖例自動定位時， MaximumAutoSize 屬性會定義可用圖表內圖例的大小上限百分比。 如果您想要在設定停駐屬性之後調整圖例的寬度或高度，則應設定這個屬性。

您可以使用 事件來修改 CustomizeLegend 圖例。

建構函式

Legend()	初始化 Legend 類別的新執行個體。
Legend(String)	使用指定的圖例名稱初始化 AnnotationPathPoint 類別的新執行個體。

屬性

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	取得或設定圖例標題分隔符號的色彩。

方法

Dispose()	釋放 ChartElement 使用的資源。 (繼承來源 ChartElement)
Dispose(Boolean)	釋放 Legend 所使用的 Unmanaged 資源，並選擇性地釋放 Managed 資源。
Equals(Object)	判斷指定的 Object 是否等於目前的 ChartElement。 (繼承來源 ChartElement)
GetHashCode()	傳回特定型別的雜湊函式。 (繼承來源 ChartElement)
GetType()	取得目前執行個體的 Type。 (繼承來源 Object)
MemberwiseClone()	建立目前 Object 的淺層複製。 (繼承來源 Object)
ToString()	傳回表示目前 Object 的字串。 (繼承來源 ChartElement)