"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 i scichart scichart-financial-tools
Annotation Types​
| Annotation | Placement Points | Main Use |
|---|---|---|
| PolyLineAnnotation📘 | 2 or more | Base concrete multi-point line / polygon annotation |
| ExtendedLineAnnotation | 2 | Trend line, ray or infinite line |
| HorizontalTrendLineAnnotation | 1 | Horizontal trend line |
| VerticalTrendLineAnnotation | 1 | Vertical trend line |
| CrossLineAnnotation | 1 | Crosshair-style guide from a single anchor |
| AngleLineAnnotation | 2 | Angled guide line |
| CyclicLineAnnotation | 2 | Cyclical projection line |
| CyclicArcAnnotation | 2 | Cyclical arc guide |
| FibonacciTimeZoneAnnotation | 2 | Fibonacci time-zone projections |
| PitchforkAnnotation | 3 | Andrews' Pitchfork with optional zones |
| PitchfanAnnotation | 3 | Projected fan lines from pitchfork points |
| SchiffPitchforkAnnotation | 3 | Schiff pitchfork variant with an inward virtual handle |
| ModifiedSchiffPitchforkAnnotation | 3 | Modified Schiff pitchfork variant with a midpoint virtual handle |
| InsidePitchforkAnnotation | 3 | Inside pitchfork variant with an inward guide ray |
| SectorAnnotation📘 | 3 | Circular or radial sector annotation |
| ChannelAnnotation📘 | 3 placement points, 4 corners | Parallel ChannelAnnotation |
| 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 |
| 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. |
| 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​
| 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:
- 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:
- 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.
Grip Points​
-
For grip snapping behavior, see Annotation Point Snapping.
-
For grip styling and selection outlines, see SVG drag points, Keyboard shortcuts and Adorner properties.
See Also​
- Multi-Point Labels Deep Dive
- Annotation Point Snapping
- Trend Line Annotations
- Repeating / cyclic annotations
- Pitchfork annotations
- Placement and Editing
- Annotation editor modifier
- Series value modifier
- Heikin-Ashi filter
- Renko filter
- Point & Figure filter
- AnnotationHoverModifier
- Annotation eraser
- SVG drag points
- Keyboard shortcuts
- Adorner properties
- Fibonacci channel
- PolyLineAnnotation