# 接口：LegendElement

# 类型参数

名称	类型
`TType`	扩展 `ChartType`

# 层次

default<AnyObject, LegendOptions<TType>>
LayoutItem

↳ LegendElement

# 属性

# $animations

• $animations: Record<string, Animation>

# 继承自

Element.$animations

# 定义于

core/core.element.ts:15 (opens new window)

# active

• active: boolean = false

# 继承自

Element.active

# 定义于

core/core.element.ts:13 (opens new window)

# bottom

• bottom: number

项的底部边缘。由布局系统设置，不能在更新中使用

# 继承自

LayoutItem.bottom

# 定义于

types/layout.d.ts:41 (opens new window)

# chart

• chart: Chart<TType, DistributiveArray<ChartTypeRegistry[TType]["defaultDataPoint"]>, unknown>

# 定义于

types/index.d.ts:2343 (opens new window)

# ctx

• ctx: CanvasRenderingContext2D

# 定义于

types/index.d.ts:2344 (opens new window)

# fullSize

• fullSize: boolean

如果为 true，并且项是水平的，那么将垂直盒子向下推

# 继承自

LayoutItem.fullSize

# 定义于

types/layout.d.ts:17 (在新窗口中打开)

# height

• height: number

项目的宽高度。必须在 update() 后生效。

# 继承自

LayoutItem.height

# 定义于

types/layout.d.ts:25 (在新窗口中打开)

# left

• left: number

项目的左边距。由布局系统设置，update()时不可用。

# 继承自

LayoutItem.left

# 定义于

types/layout.d.ts:29 (在新窗口中打开)

# legendItems

• 可选 legendItems: LegendItem[]

# 定义于

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

# options

• options: LegendOptions<TType>

# 覆盖

Element.options

# 定义于

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

# position

• position: LayoutPosition

在图表布局中项目的位置。可能的值有

# 继承自

LayoutItem.position

# 定义于

types/layout.d.ts:9 (在新窗口中打开)

# right

• right: number

项目的右侧边缘。由布局系统设置，不能在更新中使用

# 继承自

LayoutItem.right

# 定义于

types/layout.d.ts:37 (在新窗口中打开)

# top

• top: number

项目的顶部边缘。由布局系统设置，不能在更新中使用

# 继承自

LayoutItem.top

# 定义于

types/layout.d.ts:33 (在新窗口中打开)

# weight

• weight: number

用于排序项的权重。权重越高，项越远离图表区域

# 继承自

LayoutItem.weight

# 定义于

types/layout.d.ts:13 (在新窗口中打开)

# width

• width: number

项的宽度。必须在update()更新后有效

# 继承自

LayoutItem.width

# 定义于

types/layout.d.ts:21 (在新窗口中打开)

# x

• x: number

# 继承自

Element.x

# 定义于

源文件/core/core.element.ts:11 (在新窗口中打开)

# y

• y: number

# 继承自

Element.y

# 定义于

源文件/core/core.element.ts:12 (在新窗口中打开)

# 方法

# beforeLayout

▸ 可选 beforeLayout(): void

在布局过程开始之前调用

# 返回值

void

# 继承自

LayoutItem.beforeLayout

# 定义于

types/layout.d.ts:46 (在新窗口中打开)

# draw

▸ draw(chartArea): void

绘制元素

# 参数

名称	类型
`chartArea`	`ChartArea`

# 返回值

void

# 继承自

LayoutItem.draw

# 定义于

types/layout.d.ts:50 (在新窗口中打开)

# getPadding

▸ 可选 getPadding(): ChartArea

返回边缘填充的对象

# getProps

▸ getProps<P>(props, final?): Pick<AnyObject, P[number]>

获取每个属性当前或最终值。可以返回额外属性（整个对象）。

# 类型参数

名称	类型
`P`	extends `string`[]

# 参数

名称	类型	描述
`props`	`P`	要获取的属性
`final?`	`布尔型`	获取最终值（动画目标）

# 返回值

选择<AnyObject, P[number]>

# 继承自

Element.getProps

# 定义于

core/core.element.ts:31 (在新窗口中打开)

▸ getProps<P>(props, final?): Partial<Record<P, unknown>>

# 类型参数

名称	类型
`P`	extends `string`

# 参数

名称	类型
`props`	`P`[]
`final?`	`布尔型`

# 返回值

Partial<Record<P, unknown>>

# 继承自

Element.getProps

# 定义于

core/core.element.ts:32 (在新窗口中打开)

# hasValue

▸ hasValue(): boolean

# 返回值

布尔型

# 继承自

Element.hasValue

# 定义于

core/core.element.ts:22 (在新窗口中打开)

# isHorizontal

▸ isHorizontal(): boolean

返回true如果布局项是水平的（即顶部或底部）

# 返回值

布尔型

# 继承自

LayoutItem.isHorizontal

# 定义于

types/layout.d.ts:58 (在新窗口中打开)

# tooltipPosition

▸ tooltipPosition(useFinalPosition): Point

# 参数

名称	类型
`useFinalPosition`	`布尔型`

# 返回值

Point

# 继承自

Element.tooltipPosition

# 定义于

core/core.element.ts:17 (在新窗口中打开)

# update

▸ update(width, height, margins?): void

接受两个参数：宽度和高度。

# 参数

名称	类型
`width`	`数字`
`height`	`数字`
`margins?`	`ChartArea`

# 返回值

void

# 继承自

LayoutItem.update

# 定义在

types/layout.d.ts:64 (在新窗口中打开)

← LayoutItem LegendItem →