# 介面：LegendOptions<TType>

# 型別參數

名稱	型別
`TType`	繼承 `ChartType`

# 屬性

# align

• align: Align

圖例的對齊方式。

預設

'center'

# 定義於

types/index.d.ts:2364 (在新視窗中開啟)

# display

• display: boolean

是否顯示圖例？

預設

true

# 定義於

types/index.d.ts:2354 (在新視窗中開啟)

# fullSize

• fullSize: boolean

標記此方塊應佔用畫布的完整寬度/高度（移動其他方塊）。在日常使用中，不太可能需要更改此設定。

預設

true

# 定義於

types/index.d.ts:2377 (在新視窗中開啟)

# labels

• labels: Object

# 型別宣告

名稱	型別	描述
`borderRadius`	`number`	覆寫要使用的 borderRadius。`預設` 未定義
`boxHeight`	`number`	彩色方塊的高度。`預設` fontSize
`boxPadding`	`number`	顏色方塊與文字之間的間距。`預設` 1
`boxWidth`	`number`	彩色方塊的寬度。`預設` 40
`color`	`Color`	標籤的顏色。`請參閱` Defaults.color
`font`	`ScriptableAndScriptableOptions`<`Partial`<`FontSpec`>, `ScriptableChartContext`>	標籤的字型。`請參閱` Defaults.font
`padding`	`number`	彩色方塊行之間的間距。`預設` 10
`pointStyle`	`PointStyle`	覆寫圖例的點樣式。僅在 usePointStyle 為 true 時適用
`pointStyleWidth`	`number`	如果 usePointStyle 為 true，則用於圖例的點樣式的寬度。
`textAlign?`	`TextAlign`	文字對齊方式
`useBorderRadius`	`boolean`	標籤 borderRadius 將與對應的 borderRadius 匹配。`預設` false
`usePointStyle`	`boolean`	標籤樣式將與對應的點樣式匹配（大小基於 boxWidth 和 font.size 之間的最小值）。`預設` false
`filter`	(`item`: `LegendItem`, `data`: `ChartData`<keyof `ChartTypeRegistry`, (`number` \| [`number`, `number`] \| `Point` \| `BubbleDataPoint`)[], `unknown`>) => `boolean`	從圖例中篩選出圖例項目。接收 2 個參數，一個圖例項目和圖表資料
`generateLabels`	(`chart`: `Chart`<keyof `ChartTypeRegistry`, (`number` \| [`number`, `number`] \| `Point` \| `BubbleDataPoint`)[], `unknown`>) => `LegendItem`[]	為圖例中的每個事物產生圖例項目。預設實作會傳回文字 + 彩色方塊的樣式。請參閱圖例項目以取得詳細資訊。
`sort`	(`a`: `LegendItem`, `b`: `LegendItem`, `data`: `ChartData`<keyof `ChartTypeRegistry`, (`number` \| [`number`, `number`] \| `Point` \| `BubbleDataPoint`)[], `unknown`>) => `number`	排序圖例項目

# 定義於

types/index.d.ts:2396 (在新視窗中開啟)

# maxHeight

• maxHeight: number

圖例的最大高度，以像素為單位

# 定義於

types/index.d.ts:2368 (在新視窗中開啟)

# maxWidth

• maxWidth: number

圖例的最大寬度，以像素為單位

# 定義於

types/index.d.ts:2372 (開啟新視窗)

# position

• position: LayoutPosition

圖例的位置。

預設

'top'

# 定義於

types/index.d.ts:2359 (開啟新視窗)

# reverse

• reverse: boolean

圖例將以相反的順序顯示資料集。

預設

false

# 定義於

types/index.d.ts:2382 (開啟新視窗)

# rtl

• rtl: boolean

若為 true，則從右到左渲染圖例。

# 定義於

types/index.d.ts:2477 (開啟新視窗)

# textDirection

• textDirection: string

這將強制畫布上的文字方向為 'rtl' 或 'ltr' 以渲染圖例，而無論畫布上指定的 CSS 為何。

預設

畫布的預設值

# 定義於

types/index.d.ts:2482 (開啟新視窗)

# title

• title: Object

# 型別宣告

名稱	型別	描述
`color`	`Color`	標題顏色 `參見` Defaults.color
`display`	`boolean`	是否顯示圖例標題。`預設值` false
`font`	`ScriptableAndScriptableOptions`<`Partial`<`FontSpec`>, `ScriptableChartContext`>	參見 Fonts
`padding?`	`number` \| `ChartArea`	-
`position`	`"center"` \| `"end"` \| `"start"`	-
`text`	`string`	標題字串。