Skip to main content

"scichart-financial-tools" Overview

scichart-financial-tools provides trading annotations, trading modifiers, trader themes, OHLC data filters and the label / snapping enums used by the examples in this section. The annotation types share MultiPointAnnotationBase📘, PolyLineAnnotation📘, and FreehandDrawingAnnotation📘.

Above: The JavaScript Trading Drawing Tools example from the SciChart.js Demo

For the full API reference, see API Documentation📘.

The annotations integrate with normal SciChart.js surfaces and axes, but their multi-point editing model lives in scichart-financial-tools. Use this page as the map; the individual pages contain the focused live examples.

npm i scichart scichart-financial-tools

Annotation Types​

AnnotationPlacement PointsMain Use
PolyLineAnnotation📘2 or moreBase concrete multi-point line / polygon annotation
ExtendedLineAnnotation2Trend line, ray or infinite line
HorizontalTrendLineAnnotation1Horizontal trend line
VerticalTrendLineAnnotation1Vertical trend line
CrossLineAnnotation1Crosshair-style guide from a single anchor
AngleLineAnnotation2Angled guide line
CyclicLineAnnotation2Cyclical projection line
CyclicArcAnnotation2Cyclical arc guide
FibonacciTimeZoneAnnotation2Fibonacci time-zone projections
PitchforkAnnotation3Andrews' Pitchfork with optional zones
PitchfanAnnotation3Projected fan lines from pitchfork points
SchiffPitchforkAnnotation3Schiff pitchfork variant with an inward virtual handle
ModifiedSchiffPitchforkAnnotation3Modified Schiff pitchfork variant with a midpoint virtual handle
InsidePitchforkAnnotation3Inside pitchfork variant with an inward guide ray
SectorAnnotation📘3Circular or radial sector annotation
ChannelAnnotation📘3 placement points, 4 cornersParallel ChannelAnnotation
FlatBottomChannelAnnotation📘3 placement points, 4 cornersChannel with horizontal lower boundary
DisjointChannelAnnotation📘3 placement points, 4 cornersChannel with the second side constrained from the first
FibonacciRetracementAnnotation📘2 by default, 3 in skewed modeRetracement levels, regions and level labels
FibonacciExtensionAnnotation📘3Extension levels from a measured trend and start offset
FibonacciCirclesAnnotation📘2Fibonacci circles or ovals from opposite corners
FibonacciSpeedResistanceArcsAnnotation📘2Concentric speed resistance arcs from a center and radius
FibonacciWedgeAnnotation📘3Fibonacci arcs constrained inside a wedge
MeasureAnnotation📘2Change between two points
StopLossTakeProfitAnnotation📘2Stop-loss or take-profit zone
FreehandDrawingAnnotation📘Many sampled pointsEditable freehand drawing stored as a polyline

Annotation Class Hierarchy​

Modifiers​

ModifierMain Use
MultiPointAnnotationPlacementModifier📘Click-to-place workflow for supported multi-point annotations. See Placement and Editing.
MultiPointAnnotationEditorModifier📘Schema-driven editor panel for selected multi-point annotations. See Annotation editor modifier.
AnnotationEraserModifier📘Pointer-driven eraser that removes annotations under a click or drag trail. See Annotation eraser.
FreehandDrawingModifier📘Captures pointer strokes and creates FreehandDrawingAnnotation📘 instances. See Freehand drawing modifier.
SeriesValueModifier📘Adds y-axis markers that track latest / last-visible renderable series values. See Series value modifier.

Data Filters​

FilterMain Use
OhlcHeikinAshiFilter📘Converts OHLC candles to Heikin-Ashi candles
OhlcRenkoFilter📘Converts OHLC data into Renko bricks
PointAndFigureFilter📘Converts OHLC close values into Point & Figure marks

See the individual data filter pages for live examples with source / filtered toggles:

Themes and Enums​

SciTraderDarkTheme📘 and SciTraderLightTheme📘 provide financial-chart styling for examples and applications.

Common trading enum exports include:

Shared Labels​

All annotations based on MultiPointAnnotationBase📘 inherit generic multi-point labels. See Multi-Point Labels Deep Dive for the shared point, segment and axis label model, or open the individual trading annotation pages for live examples.

Some tools also have their own label systems:

Grip Points​

See Also​