# 接口：TooltipOptions<TType>

• filter: (e: TooltipItem<TType>, index: number, array: TooltipItem<TType>[], data: ChartData<keyof ChartTypeRegistry, (number | [number, number] | Point | BubbleDataPoint)[], unknown>> => boolean

# 类型声明

▸ (e, index, array, data): boolean

# 参数

名称	类型
`e`	`TooltipItem`<`TType`>
`index`	`number`
`array`	`TooltipItem`<`TType`>[]
`data`	`ChartData`<keyof `ChartTypeRegistry`, (`number` \| [`number`, `number`] \| `Point` \| `BubbleDataPoint`)[], `unknown`>

# 返回

boolean

# 定义于

types/index.d.ts:2740 (打开新窗口)

# footerAlign

• footerAlign: Scriptable<TextAlign, ScriptableTooltipContext<TType>>

底部文本行的水平对齐方式。

默认

'left'

# 定义于

types/index.d.ts:2821 (打开新窗口)

# footerColor

• footerColor: Scriptable<Color, ScriptableTooltipContext<TType>>

页脚颜色

默认

'#fff'

# 定义于

types/index.d.ts:2811 (打开新窗口)

# footerFont

• footerFont: ScriptableAndScriptableOptions<Partial<FontSpec>, ScriptableTooltipContext<TType>>

参考字体

默认

# 定义于

types/index.d.ts:2816 (打开新窗口)

# footerMarginTop

• footerMarginTop: Scriptable<number, ScriptableTooltipContext<TType>>

在绘制页脚前添加的边距。

默认

# 定义于

types/index.d.ts:2806 (打开新窗口)

# footerSpacing

• footerSpacing: Scriptable<number, ScriptableTooltipContext<TType>>

在每行页脚顶部和底部添加的间距。

默认

# 定义于

types/index.d.ts:2801 (打开新窗口)

# includeInvisible

• includeInvisible: boolean

如果为true，则在评估交互时，也会包含图表区域外的不可见点。

默认

false

# 继承自

CoreInteractionOptions.includeInvisible

# 定义于

types/index.d.ts:1585 (打开新窗口)

intersect

• intersect: boolean

如果为真，悬停模式仅在鼠标位置与图表上的项目相交时应用。

默认

true

# 继承自

CoreInteractionOptions.intersect

# 定义在

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

# itemSort

• itemSort: (a: TooltipItem<TType>, b: TooltipItem<TType>, data: ChartData<keyof ChartTypeRegistry, (number | [number, number] | Point | BubbleDataPoint][], unknown>) => number

# 类型声明

▸ (a, b, data): number

对提示项排序。

# 参数

名称	类型
`a`	`TooltipItem`<`TType`>
`b`	`TooltipItem`<`TType`>
`data`	`ChartData`<keyof `ChartTypeRegistry`, (`number` \| [`number`, `number`] \| `Point` \| `BubbleDataPoint`)[], `unknown`>

# 返回值

number

# 定义在

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

# mode

• mode: keyof InteractionModeMap

设置哪些元素出现在提示框中。请参阅交互模式以获取详细信息。

默认

'nearest'

# 继承自

CoreInteractionOptions.mode

# 定义在

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

# multiKeyBackground

• multiKeyBackground: Scriptable<Color, ScriptableTooltipContext<TType>>

当提示框中有多个项目时，绘制在彩色框背后的颜色。

默认

'#fff'

# 定义在

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

# padding

• padding: Scriptable<Padding, ScriptableTooltipContext<TType>>

添加到提示框的填充。

默认

# 定义在

types/index.d.ts:2826 (新窗口打开)

# position

• position: Scriptable<keyof TooltipPositionerMap, ScriptableTooltipContext<TType>>

工具提示定位模式

# 定义于

types/index.d.ts:2727 (新窗口打开)

# rtl

• rtl: Scriptable<boolean, ScriptableTooltipContext<TType>>

从右向左渲染图例时设为true。

# 定义于

types/index.d.ts:2880 (新窗口打开)

# textDirection

• textDirection: Scriptable<string, ScriptableTooltipContext<TType>>

强制在canvas上以'rtl'或'ltr'方向渲染工具提示文本，忽略canvas上指定的CSS。

默认

canvas的默认值

# 定义于

types/index.d.ts:2886 (新窗口打开)

# titleAlign

• titleAlign: Scriptable<TextAlign, ScriptableTooltipContext<TType>>

标题文本行的水平对齐。

默认

'left'

# 定义于

types/index.d.ts:2776 (新窗口打开)

# titleColor

• titleColor: Scriptable<Color, ScriptableTooltipContext<TType>>

标题颜色

默认

'#fff'

# 定义于

types/index.d.ts:2756（在新窗口中打开）

# titleFont

• titleFont: ScriptableAndScriptableOptions<code>Partial<FontSpec>, ScriptableTooltipContext<TType>>

参考字体

默认

# 定义于

types/index.d.ts:2761（在新窗口中打开）

# titleMarginBottom

• titleMarginBottom: Scriptable<number, ScriptableTooltipContext<TType>>

标题部分底部添加的边距。

默认

# 定义于

types/index.d.ts:2771（在新窗口中打开）

# titleSpacing

• titleSpacing: Scriptable<number, ScriptableTooltipContext<TType>>

每行标题上下添加的间距。

默认

# 定义于

types/index.d.ts:2766（在新窗口中打开）

# usePointStyle

• usePointStyle: Scriptable<boolean, ScriptableTooltipContext<TType>>

使用对应的数据点样式（从数据集选项中获取）代替颜色框，例如：星号、三角形等。（大小基于boxWidth和boxHeight之间的小值确定）

默认

false

# 定义于

types/index.d.ts:2866（在新窗口中打开）

# xAlign

• xAlign: Scriptable<TooltipXAlignment, ScriptableTooltipContext<TType>>

覆盖提示框对齐计算

# 定义于

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

# yAlign

• yAlign: Scriptable<TooltipYAlignment, ScriptableTooltipContext<TType>>

# 定义于

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

# 方法

# 外部

▸ external(this, args): void

参见外部提示框部分。

# 参数

名称	类型
`此`	`TooltipModel`<`TType`>
`args`	`对象`
`args.chart`	`Chart`<keyof `ChartTypeRegistry`, (`number` \| [`number`, `number`] \| `Point` \| `BubbleDataPoint`)[], `unknown`>
`args.tooltip`	`TooltipModel`<`TType`>

# 返回值

void

# 定义于

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

← TooltipModel TooltipPosition →

# 接口：TooltipOptions<TType>

# 类型参数

# 层次结构

# 属性

# 动画

# 定义在

# 动画序列

# 定义在

# 轴

# 继承自

# 定义在

# 背景颜色

# 定义在

# 主体对齐方式

# 定义在

# bodyColor

# 定义在

# bodyFont

# 定义在

# bodySpacing

# 定义在

# borderColor

# 定义在

# borderWidth

# 定义在

# boxHeight

# 定义于

# boxPadding

# 定义于

# boxWidth

# 定义于

# callbacks

# 定义于

# caretPadding

# 定义于

# caretSize

# 定义于

# cornerRadius

# 定义于

# displayColors

# 定义于

# enabled

# 定义于

# filter

# 类型声明

# 参数

# 返回

# 定义于

# footerAlign

# 定义于

# footerColor

# 定义于

# footerFont

# 定义于

# footerMarginTop

# 定义于

# footerSpacing

# 定义于

# includeInvisible

# 继承自

# 定义于

intersect

# 继承自

# 定义在

# itemSort

# 类型声明

# 参数

# 返回值

# 定义在

# mode

# 继承自

# 定义在

# multiKeyBackground

# 定义在

# padding

# 定义在

# position

# 定义于

# rtl

# 定义于