"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📘.

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 install scichart scichart-financial-tools

import {
    ChannelAnnotation,
    EAnnotationVisibilityMode,
    ETradingAnnotationType,
    ExtendedLineAnnotation,
    FibonacciCirclesAnnotation,
    FibonacciExtensionAnnotation,
    FibonacciRetracementAnnotation,
    FibonacciSpeedResistanceArcsAnnotation,
    FibonacciWedgeAnnotation,
    FreehandDrawingAnnotation,
    FreehandDrawingModifier,
    MultiPointAnnotationBase,
    MultiPointAnnotationPlacementModifier,
    OhlcHeikinAshiFilter,
    OhlcRenkoFilter,
    PitchfanAnnotation,
    PitchforkAnnotation,
    PointAndFigureFilter,
    PolyLineAnnotation,
    SciTraderLightTheme,
    StopLossTakeProfitAnnotation
} from "scichart-financial-tools";

Hover and cursor feedback in the examples uses AnnotationHoverModifier from scichart.

Annotation Types

Annotation	Points	Main Use
PolyLineAnnotation📘	2 or more	Base concrete multi-point line / polygon annotation
ChannelAnnotation📘	3 placement points, 4 corners	Parallel ChannelAnnotation
ExtendedLineAnnotation📘	2	Trend line, ray or infinite line
FlatBottomChannelAnnotation📘	3 placement points, 4 corners	Channel with horizontal lower boundary
DisjointChannelAnnotation📘	3 placement points, 4 corners	Channel with the second side constrained from the first
FibonacciRetracementAnnotation📘	2 by default, 3 in skewed mode	Retracement levels, regions and level labels
FibonacciExtensionAnnotation📘	3	Extension levels from a measured trend and start offset
FibonacciCirclesAnnotation📘	2	Fibonacci circles or ovals from opposite corners
FibonacciSpeedResistanceArcsAnnotation📘	2	Concentric speed resistance arcs from a center and radius
FibonacciWedgeAnnotation📘	3	Fibonacci arcs constrained inside a wedge
PitchforkAnnotation📘	3	Andrews' Pitchfork with optional zones
PitchfanAnnotation📘	3	Projected fan lines from pitchfork points
MeasureAnnotation📘	2	Change between two points
StopLossTakeProfitAnnotation📘	2	Stop-loss or take-profit zone
FreehandDrawingAnnotation📘	Many sampled points	Editable freehand drawing stored as a polyline

Annotation Class Hierarchy

Modifiers

Modifier	Main 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.
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

Filter	Main 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:

Fibonacci annotations have Fibonacci level labels and formatFibonacciLabel📘.
MeasureAnnotation📘 has a measurement label and labelDataTemplate📘.
StopLossTakeProfitAnnotation📘 automatically contributes Y-axis labels for entry and target levels.

For point, segment and axis label options, see Multi-Point Labels Deep Dive.

Annotation Types​

Annotation Class Hierarchy​

Modifiers​

Data Filters​

Themes and Enums​

Shared Labels​

See Also​