# 接口: 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。`默认` undefined
`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

这将强制在画布上渲染图例时，无论画布上指定的 CSS 如何，文本方向为 'rtl' 或 'ltr'。

默认

画布的默认值

# 定义在

types/index.d.ts:2482 (在新窗口中打开)

# title

• title: Object

# 类型声明

名称	类型	描述
`color`	`Color`	标题的颜色 `参见` Defaults.color
`display`	`boolean`	是否显示图例标题。 `默认值` false
`font`	`ScriptableAndScriptableOptions`<`Partial`<`FontSpec`>, `ScriptableChartContext`>	参见字体
`padding?`	`number` \| `ChartArea`	-
`position`	`"center"` \| `"end"` \| `"start"`	-
`text`	`string`	字符串标题。