The Circular3DTooltip module is used to render tooltips for a circular 3D chart.
Creates and returns an HTMLDivElement for the tooltip.
Returns HTMLDivElement
Creates a tooltip for a circular3D chart.
| Parameter | Type | Description |
|---|---|---|
| chart | Circular3D |
The circular 3D chart instance. |
| isFirst | boolean |
A flag indicating whether it is the first tooltip. |
| location | Circular3DLocation |
The location where the tooltip will be positioned. |
| clipLocation | Circular3DLocation |
The clipping location for the tooltip. |
| point | Circular3DPoints |
The circular 3D point associated with the tooltip. |
| offset | number |
The offset for the tooltip. |
| bounds | Rect |
The bounds of the tooltip. |
| extraPoints | Circular3DPointData[] |
An array of additional Circular3DPointData for the tooltip. |
| templatePoint | Circular3DPoints | Circular3DPoints[] |
The template point or points for the tooltip. |
| customTemplate (optional) | string | Function |
A custom template for the tooltip, specified as a string or a function. |
Returns void
Fades out the tooltip associated with the provided Circular3DPointData.
Returns void
Gets the HTML element with the specified ID from the document.
| Parameter | Type | Description |
|---|---|---|
| id | string |
The ID of the HTML element to retrieve. |
Returns HTMLElement
Gets the tooltip element based on the visibility of the tooltip.
| Parameter | Type | Description |
|---|---|---|
| isTooltip | boolean |
A flag indicating whether the tooltip is currently visible. |
Returns HTMLDivElement
Highlights or un highlights a specific point in a circular 3D chart series.
| Parameter | Type | Description |
|---|---|---|
| series | Circular3DSeries |
The circular 3D series to which the point belongs. |
| pointIndex | number |
The index of the point to be highlighted or un highlighted. |
| highlight | boolean |
A flag indicating whether to highlight (true) or un highlight (false) the point. |
Returns void
Highlights multiple points in a circular 3D chart series. This method iterates through a collection of points (assuming they are represented by ‘i’) and applies the highlight effect to each point.
Returns void
Handles the mouse leave event for the circular 3D chart.
Returns void
Handles the mouse move event for the circular 3D chart.
| Parameter | Type | Description |
|---|---|---|
| event | PointerEvent | TouchEvent |
The mouse or touch event. |
| chart | Circular3D |
The circular 3D chart instance. |
Returns void
Handles the mouse up event for the circular 3D chart.
| Parameter | Type | Description |
|---|---|---|
| event | PointerEvent | TouchEvent |
The mouse or touch event. |
| chart | Circular3D |
The circular 3D chart instance. |
Returns void
Pushes Circular3D point data to the currentPoints array and updates the tooltip div if tooltip are enabled for the series.
| Parameter | Type | Description |
|---|---|---|
| data | Circular3DPointData |
The Circular3D point data to be pushed. |
| tooltipDiv | HTMLDivElement |
The tooltip div element to be updated if tooltip are enabled. |
Returns boolean
Removes the highlight from a previously highlighted point in a circular 3D chart series.
Returns void
Removes the tooltip with a specified duration.
| Parameter | Type | Description |
|---|---|---|
| duration | number |
The duration for the tooltip removal animation. |
Returns void
Renders the tooltip for a circular 3D series based on the provided point data.
| Parameter | Type | Description |
|---|---|---|
| chart | Circular3D |
The circular 3D chart instance. |
| data | Circular3DPointData |
The Circular3D point data for which the tooltip will be rendered. |
Returns void
Stops the animation by clearing the tooltip interval.
Returns void
Displays the tooltip for the circular 3D pie chart on pointer events or touch events.
| Parameter | Type | Description |
|---|---|---|
| event | PointerEvent | TouchEvent |
The event triggering the tooltip display (pointer event or touch event). |
Returns void
Updates the previous point with additional Circular3DPointData.
| Parameter | Type | Description |
|---|---|---|
| extraPoints | Circular3DPointData[] |
An array of additional Circular3DPointData to update the previous point. |
Returns void