# Interface: TooltipModel<TType>
# Type parameters
Name | Type |
---|---|
TType | extends ChartType |
# Hierarchy
default
<AnyObject
,TooltipOptions
<TType
>>↳
TooltipModel
# Properties
# $animations
• $animations: Record
<string
, Animation
>
# Inherited from
Element.$animations
# Defined in
core/core.element.ts:15 (opens new window)
# active
• active: boolean
= false
# Inherited from
Element.active
# Defined in
core/core.element.ts:13 (opens new window)
# afterBody
• afterBody: string
[]
# Defined in
types/index.d.ts:2605 (opens new window)
# beforeBody
• beforeBody: string
[]
# Defined in
types/index.d.ts:2603 (opens new window)
# body
• body: { after
: string
[] ; before
: string
[] ; lines
: string
[] }[]
# Defined in
types/index.d.ts:2601 (opens new window)
# caretX
• caretX: number
# Defined in
types/index.d.ts:2592 (opens new window)
# caretY
• caretY: number
# Defined in
types/index.d.ts:2593 (opens new window)
# chart
• Readonly
chart: Chart
<TType
, DistributiveArray
<ChartTypeRegistry
[TType
]["defaultDataPoint"
]>, unknown
>
# Defined in
types/index.d.ts:2577 (opens new window)
# dataPoints
• dataPoints: TooltipItem
<TType
>[]
# Defined in
types/index.d.ts:2580 (opens new window)
# footer
• footer: string
[]
# Defined in
types/index.d.ts:2613 (opens new window)
# height
• height: number
# Defined in
types/index.d.ts:2590 (opens new window)
# labelColors
• labelColors: TooltipLabelStyle
[]
# Defined in
types/index.d.ts:2616 (opens new window)
# labelPointStyles
• labelPointStyles: { pointStyle
: PointStyle
; rotation
: number
}[]
# Defined in
types/index.d.ts:2618 (opens new window)
# labelTextColors
• labelTextColors: Color
[]
# Defined in
types/index.d.ts:2617 (opens new window)
# opacity
• opacity: number
# Defined in
types/index.d.ts:2621 (opens new window)
# options
• options: TooltipOptions
<TType
>
# Overrides
Element.options
# Defined in
types/index.d.ts:2624 (opens new window)
# title
• title: string
[]
# Defined in
types/index.d.ts:2609 (opens new window)
# width
• width: number
# Defined in
types/index.d.ts:2589 (opens new window)
# x
• x: number
# Overrides
Element.x
# Defined in
types/index.d.ts:2587 (opens new window)
# xAlign
• xAlign: TooltipXAlignment
# Defined in
types/index.d.ts:2583 (opens new window)
# y
• y: number
# Overrides
Element.y
# Defined in
types/index.d.ts:2588 (opens new window)
# yAlign
• yAlign: TooltipYAlignment
# Defined in
types/index.d.ts:2584 (opens new window)
# Methods
# getActiveElements
▸ getActiveElements(): ActiveElement
[]
# Returns
# Defined in
types/index.d.ts:2626 (opens new window)
# getProps
▸ getProps<P
>(props
, final?
): Pick
<AnyObject
, P
[number
]>
Gets the current or final value of each prop. Can return extra properties (whole object).
# Type parameters
Name | Type |
---|---|
P | extends string [] |
# Parameters
Name | Type | Description |
---|---|---|
props | P | properties to get |
final? | boolean | get the final value (animation target) |
# Returns
Pick
<AnyObject
, P
[number
]>
# Inherited from
Element.getProps
# Defined in
core/core.element.ts:31 (opens new window)
▸ getProps<P
>(props
, final?
): Partial
<Record
<P
, unknown
>>
# Type parameters
Name | Type |
---|---|
P | extends string |
# Parameters
Name | Type |
---|---|
props | P [] |
final? | boolean |
# Returns
Partial
<Record
<P
, unknown
>>
# Inherited from
Element.getProps
# Defined in
core/core.element.ts:32 (opens new window)
# hasValue
▸ hasValue(): boolean
# Returns
boolean
# Inherited from
Element.hasValue
# Defined in
core/core.element.ts:22 (opens new window)
# setActiveElements
▸ setActiveElements(active
, eventPosition
): void
# Parameters
Name | Type |
---|---|
active | ActiveDataPoint [] |
eventPosition | Point |
# Returns
void
# Defined in
types/index.d.ts:2627 (opens new window)
# tooltipPosition
▸ tooltipPosition(useFinalPosition
): Point
# Parameters
Name | Type |
---|---|
useFinalPosition | boolean |
# Returns
# Inherited from
Element.tooltipPosition