Trading Annotations Overview
Trading annotations are provided by the scichart-financial-tools package. This package also provides the shared MultiPointAnnotationBase📘, PolyLineAnnotation📘, FreehandDrawingAnnotation📘, trading modifiers, trader themes, OHLC data filters and the label / snapping enums used by the examples in this section.
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,
FibonacciRetracementAnnotation,
FreehandDrawingAnnotation,
FreehandDrawingModifier,
MultiPointAnnotationBase,
MultiPointAnnotationPlacementModifier,
PitchfanAnnotation,
PitchforkAnnotation,
PolyLineAnnotation,
SciTraderLightTheme,
StopLossTakeProfitAnnotation
} from "scichart-financial-tools";
Hover and cursor feedback in the examples uses AnnotationHoverModifier from scichart.
Annotation Tools​
| Annotation | Points | Main Use |
|---|---|---|
| PolyLineAnnotation📘 | 2 or more | Base concrete multi-point line / polygon annotation |
| ChannelAnnotation📘 | 3 placement points, 4 corners | Parallel price channel |
| 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📘 | 3 | Retracement levels, regions and level labels |
| 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 |
Modifiers​
| Modifier | Main Use |
|---|---|
| MultiPointAnnotationPlacementModifier📘 | Click-to-place workflow for supported multi-point annotations |
| MultiPointAnnotationEditorModifier📘 | Schema-driven editor panel for selected multi-point annotations |
| FreehandDrawingModifier📘 | Captures pointer strokes and creates FreehandDrawingAnnotation📘 instances |
| SeriesValueModifier📘 | Adds y-axis markers that track latest / last-visible renderable series values |
Financial 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 |
Themes and Enums​
SciTraderDarkTheme📘 and SciTraderLightTheme📘 provide financial-chart styling for examples and applications.
Common trading enum exports include:
- ETradingAnnotationType📘
- ETradingChartModifierType📘
- ELastYMode📘
- EAnnotationVisibilityMode📘
- EMultiPointLabelAnchorMode📘
- EAxisLabelDrawMode📘
- ESegmentLabelRotationMode📘
- ESnapMode📘
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:
- FibonacciRetracementAnnotation📘 has 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.