TooltipProps
Configuration options for tooltip components.
Props
The following table outlines the props for the TooltipProps:
| Name | Type | Default | Description |
|---|---|---|---|
| allowHighlight | boolean | - | Enables highlighting of the tooltip. |
| areaBounds | - | Boundary constraints for tooltip positioning. | |
| arrowPadding | number | - | Padding around the tooltip arrow in pixels. |
| availableSize | - | Available size for the tooltip rendering area. | |
| border | - | Border styling options for the tooltip. | |
| clipBounds | - | Bounds for clipping the tooltip positioning. | |
| content | string[] | - | Array of content strings to display in the tooltip. |
| controlInstance | object | - | Reference to the parent control instance. |
| controlName | string | - | Name of the parent control. |
| crosshair | boolean | - | Enables or disables the crosshair feature. |
| data | Object | - | Data object to be passed to tooltip template functions. |
| duration | number | - | Duration of the tooltip animation in milliseconds. |
| enableAnimation | boolean | - | Enables or disables animation effects when showing/hiding the tooltip. |
| enableRTL | boolean | - | Enables right-to-left text direction for the tooltip. |
| enableShadow | boolean | - | Enables or disables the shadow effect for the tooltip. |
| fill | string | - | Background fill color of the tooltip. |
| header | string | - | Text content for the tooltip header. |
| inverted | boolean | - | Determines if the tooltip should be inverted (horizontal vs. vertical orientation). |
| isCanvas | boolean | - | Indicates if the tooltip is being rendered on a canvas element. |
| isFixed | boolean | - | Determines if the tooltip is fixed in position. |
| isNegative | boolean | - | Indicates if the tooltip represents negative values. |
| isTextWrap | boolean | - | Enables text wrapping within the tooltip. |
| location | - | Position coordinates where the tooltip should be displayed. | |
| marginX | number | - | Horizontal margin within the tooltip in pixels. |
| marginY | number | - | Vertical margin within the tooltip in pixels. |
| markerSize | number | - | Size of the marker symbols in pixels. |
| offset | number | - | Offset distance from the tooltip position in pixels. |
| opacity | number | - | Opacity level for the tooltip (0 to 1). |
| palette | string[] | - | Array of colors for the series markers in the tooltip. |
| rx | number | - | X-radius for rounded corners of the tooltip. |
| ry | number | - | Y-radius for rounded corners of the tooltip. |
| shapes | - | Array of shape types for the series markers in the tooltip. | |
| shared | boolean | - | Indicates whether the tooltip is shared among multiple data points. |
| showHeaderLine | boolean | - | Shows or hides the header line separator in the tooltip. |
| showNearestTooltip | boolean | - | Shows tooltip for the nearest data point. |
| template | Function | - | Custom template for the tooltip, either as an HTML string or a render function. |
| textStyle | - | Text style options for the tooltip content. | |
| theme | - | Theme to apply to the tooltip. | |
| tooltipPlacement | - | Explicitly sets the tooltip placement direction. |