Search results

MomentumIndicator API in React Chart API component

MomentumIndicator module is used to render momentum indicator.

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 line 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

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

createIndicatorElements

Creates elements for a technical indicator in the chart.

Parameter Type Description
chart Chart The chart in which the indicator elements are to be created.
indicator TechnicalIndicator The technical indicator for which elements are to be created.
index number The index of the indicator.

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

getBorderDirection

Gets the border direction based on the provided direction.

Parameter Type Description
direction string The direction string.

Returns string

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

removeEmptyPointsBorder

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

Parameter Type Description
borderDirection string The border direction.

Returns string

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