Search results

SplineSeries API in React Chart API component

SplineSeries module is used to render the spline series.

Methods

addAreaPath

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

addPath

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.
* @param {ChartLocation[]} [firstSymbol] - The location of the first symbol.

Returns void

appendLinePath

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

doAnimation

Animates the series.

Parameter Type Description
series Series Defines the series to animate.

Returns void

doLinearAnimation

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

doProgressiveAnimation

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

findSplinePoint

Finds the spline points for the series.

Parameter Type Description
series Series The series for which spline points need to be found.

Returns void

getBorderDirection

Gets the border direction based on the provided direction.

Parameter Type Description
direction string The direction string.

Returns string

getControlPoints

Calculates the control points for a spline segment.

Parameter Type Description
point1 Points The first data point.
point2 Points The second data point.
ySpline1 number The Y-value of the first spline point.
ySpline2 number The Y-value of the second spline point.
series Series The series associated with the data points.

Returns ControlPoints

getFirstLastVisiblePoint

Gets the first and last visible points from a collection of points.

Parameter Type Description
points Points[] Collection of points.

Returns Object

getLineDirection

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

isPointInRange

Checks if the data points are within the range.

Parameter Type Description
points Points[] The data points to check.

Returns boolean

removeEmptyPointsBorder

Removes the border from the empty points based on the provided border direction.

Parameter Type Description
borderDirection string The border direction.

Returns string

render

Render the spline series.

Parameter Type Description
series Series The series to be rendered.
xAxis Axis The x-axis of the chart.
yAxis Axis The y-axis of the chart.
isInverted boolean Specifies whether the chart is inverted.
pointAnimate (optional) boolean Specifies whether the chart is inverted.
pointUpdate (optional) boolean Specifies whether the chart is inverted.

Returns void

storePointLocation

To store the symbol location and region.

Parameter Type Description
point Points point
series Series series
isInverted boolean isInverted
getLocation Function getLocation

Returns void

withinYRange

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