RangeAreaSeries module is used to render the range area series.
Adds a area path to equate the start and end paths.
| Parameter | Type | Description |
|---|---|---|
| options | PathOption |
The options for the path. |
| series | Series |
The series to which the path belongs. |
| clipRect | string |
The clip rectangle for the path. |
Returns void
Appends a line path to the chart.
| Parameter | Type | Description |
|---|---|---|
| options | PathOption |
The options for the path. |
| series | Series |
The series to which the path belongs. |
| clipRect | string |
The clipping rectangle for the path. |
Returns void
Animates the series.
| Parameter | Type | Description |
|---|---|---|
| series | Series |
Defines the series to animate. |
Returns void
Performs linear animation for the series based on the provided animation model.
| Parameter | Type | Description |
|---|---|---|
| series | Series |
The series to animate. |
| animation | AnimationModel |
The animation model containing animation details. |
Returns void
Executes progressive animation for the series.
| Parameter | Type | Description |
|---|---|---|
| series | Series |
The series for which progressive animation is executed. |
| option | AnimationModel |
The animation option. |
Returns void
Gets the border direction based on the provided direction.
| Parameter | Type | Description |
|---|---|---|
| direction | string |
The direction string. |
Returns string
Gets the first and last visible points from a collection of points.
| Parameter | Type | Description |
|---|---|---|
| points | Points[] |
Collection of points. |
Returns Object
To generate the line path direction.
| Parameter | Type | Description |
|---|---|---|
| firstPoint | Points |
firstPoint |
| secondPoint | Points |
secondPoint |
| series | Series |
series |
| isInverted | boolean |
isInverted |
| getPointLocation | Function |
getPointLocation |
| startPoint | string |
startPoint |
Returns string
Removes the border from the empty points based on the provided border direction.
| Parameter | Type | Description |
|---|---|---|
| borderDirection | string |
The border direction. |
Returns string
Renders the provided Range Area series on the chart based on the given x-axis, y-axis, and inversion status.
| Parameter | Type | Description |
|---|---|---|
| series | Series |
The series to render. |
| xAxis | Axis |
The x-axis of the chart. |
| yAxis | Axis |
The y-axis of the chart. |
| inverted | boolean |
A flag indicating whether the chart is inverted or not. |
| pointAnimate | boolean |
A flag indicating whether the points should be animated. |
| pointUpdate (optional) | boolean |
A flag indicating whether the points should be updated. |
Returns void
To store the symbol location and region.
| Parameter | Type | Description |
|---|---|---|
| point | Points |
point |
| series | Series |
series |
| isInverted | boolean |
isInverted |
| getLocation | Function |
getLocation |
Returns void
Checks if the y-value of a point falls within the y-axis range.
| Parameter | Type | Description |
|---|---|---|
| point | Points |
The point to be checked. |
| yAxis | Axis |
The y-axis. |
Returns boolean