TooltipPortalSettings
@elastic/charts • Exports
@elastic/charts / TooltipPortalSettings
Interface: TooltipPortalSettings<B>
Tooltip portal settings
Contents
Extended By
Type parameters
• B = never
Properties
boundary?
boundary?:
HTMLElement|B
Boundary element to contain tooltip within
'chart' will use the chart container as the boundary
Default Value
parent scroll container
Source
packages/charts/src/components/portal/types.ts:112
boundaryPadding?
boundaryPadding?:
number|Partial<PerSideDistance>
Boundary element padding. Used to reduce extents of boundary placement when margins or paddings are used on boundary
Default Value
0
Source
packages/charts/src/components/portal/types.ts:119
fallbackPlacements?
fallbackPlacements?:
Placement[]
If given tooltip placement is not suitable, these Placements will
be used as fallback placements.
Source
packages/charts/src/components/portal/types.ts:104
offset?
offset?:
number
Custom tooltip offset
Default Value
10
Source
packages/charts/src/components/portal/types.ts:124
placement?
placement?:
Placement
Preferred placement of tooltip relative to anchor.
This may not be the final placement given the positioning fallbacks.
Default Value
right (Placement:type) | Placement.Right
Source
packages/charts/src/components/portal/types.ts:99
Generated using typedoc-plugin-markdown and TypeDoc