SciChart.js JavaScript Charts User Manual
SciChart.js JavaScript Charts User Manual
Minimum Browser Requirements
Online Resources and Help
Licensing SciChart.js
Get Started: Tutorials, Examples
Tutorials (JavaScript APIs / npm / webpack)
Tutorial 01 - Setting up a npm Project with SciChart.js
Tutorial 02 - Adding Series and Data
Tutorial 03 - Adding Zooming, Panning Behavior
Tutorial 04 - Adding Realtime Updates
Tutorial 05 - Zoom and Pan with Realtime Updates
Tutorial 06 - Adding Annotations
Tutorial 07 - Adding Tooltips and Legends
Tutorial 08 - Adding Multiple Axis
Tutorial 09 - Linking Multiple Charts
Tutorial 10 - Vertical Charts
Tutorials (index.min.js from CDN)
Tutorial 01 - Including SciChart.js in an HTML Page using CDN
Tutorial 02 - Including index.min.js and WebAssembly Files offline
Tutorials (SciChart React)
(Deprecated Tutorial) - Creating a SciChart React Component from the Ground Up
Tutorial 01 - Setting up a project with scichart-react and config object
Tutorial 02 - Creating a Chart with scichart-react
Tutorial 03 - Modifying Chart Data and Behavior in React
Tutorial 04 - Adding & Removing Charts To a Group in React
Tutorial 05 - Synchronizing React Charts with Data in a Group
Worked Examples
How do I? ... Worked Examples with SciChart.js
How to: Pan the Chart with the MouseWheel
How to: Export an Image From Chart
The SciChart.js Examples Suite
The SciChart.js Examples Suite
What's New?
What's New in SciChart.js SDK v2.x
What's New in SciChart.js SDK v2.1
Whats' New in SciChart.js SDK v2.2
What's New in SciChart.js SDK v3.0
What's New in SciChart.js SDK v3.1
What's New in SciChart.js SDK v3.2
What's New in SciChart.js SDK v3.3
What's New in SciChart.js SDK v3.4
What's New in SciChart.js SDK v3.5
Breaking Changes in SciChart.js v2.x from v1.x
SciChart.js JavaScript 2D Charts API
The SciChartSurface (Root Chart Control)
The SciChartSurface Type
Creating a new SciChartSurface and loading Wasm
Setting a Runtime License on a SciChartSurface
Deploying Wasm (WebAssembly) and Data Files with your app
2D Chart Types
Start Here - RenderableSeries Overview
Common Series APIs
Series isVisible and isVisibleChanged API
Drawing Gaps in Series (null data)
Drawing PointMarkers on Series (Scatter markers)
Series Text DataPoint Labels API
Adding DataLabels to a Chart Series
Data Label Positioning
Data Label Colouring
Custom DataLabel Formatting with getText()
Getting Labels from Metadata
DataLabel SkipModes and Culling
Series PaletteProvider API
The PaletteProvider API
Per-point Colouring of Line Segments
Per-point Colouring of Mountain Segments
Per-Point Colouring of Band Segments
Per-Point Colouring of Bubble Charts
Per-Point Colouring of Candlestick / OHLC Charts
Per-Point Colouring of Column Charts
Per-Point Colouring of Scatter Charts (or PointMarkers)
Per-Point Colouring of Impulse Charts
The PaletteFactory Helper Class
Series Hit Test API
RenderableSeries Hit-Test API
Hit-Test API for Band Series
Hit-Test API for Line Series
Hit-Test API for Bubble Series
Hit-Test API for Column Series
Hit-Test API for Heatmap Series
Hit-Test API and Metadata
Hit-Test API for Mountain Series
Hit-Test API for Candlestick and OHLC Series
Hit-Test API for Scatter Series
Hit-Test API for Stacked Column Series
Hit-Test API for Stacked Mountain Series
DataSeries (Data Updates) API
The DataSeries API
Append, Insert, Update, Remove
DataSeries Get Set value at Index
DataSeries Realtime Updates
Data Resampling
Deleting DataSeries Memory
Data PointMetadata API
DataSeries PointMetaData Api
Metadata and PaletteProviders
Metadata and Tooltips
Metadata and HitTest
Data Filters (Transforms) API
What is the Filters API
Scale Offset Filters
Linear Trendline Filter
Moving Average Filter
Ratio Filter
Creating a Custom Filter
Render Data Transforms API
The RenderDataTransforms API
The Line Series Type
The Digital (Step) Line Series
The Scatter Series Type
The Mountain (Area) Series Type
The Digital (Step) Mountain Series Type
The Column Series Type
Column Series Data Point Width Mode
The Uniform Heatmap Chart Type
Updating (Realtime) Heatmaps
Heatmap ColorMaps and Legends
The Non-Uniform Heatmap Chart Type
The Contours Series Type
The Candlestick Series type
The OHLC Series Type
The Lollipop (Impulse or Stem) Chart Type
The Error Bars Chart Type
The Band Series type
The Digital (Step) Band Series Type
The Bubble Series Type
The Fan Charts Type
The Stacked Column Series Type
The Stacked Mountain Series Type
The Pie Chart Type
The Donut Chart Type
The Spline (Smoothed) Line Series Type
The Spline (Smoothed) Mountain Series Type
The Spline (Smoothed) Band Series Type
The Bezier (Smoothed) Stacked Mountain Series Type
The Text Series Type
Builder (JSON Chart Definition) API
Intro to the Builder API
Creating a Simple Chart
Creating a Pie Chart
Working with Data
Complex Options
Custom Subtypes
Serialization and Deserialization of Charts
Axis APIs
Start Here - Axis Overview in SciChart.js
Axis Types
Common Axis Base Type and Options
The Numeric Axis
The DateTimeNumericAxis
The Logarithmic Axis
The Category Axis
Text / String Axis
Axis Ranging, Scaling
Axis Ranging - AutoRange
Axis Ranging - Set Range and Zoom to Fit
Axis Ranging - How to Listen to VisibleRange Changes
Axis Labels
LabelProvider API Overview
Axis Labels - The ENumericFormat Enum
Custom LabelProviders: Dynamic Dates on Zoom
Custom LabelProviders: Readable Numbers
Rotating Axis Labels
Text and Multi-Line Labels
Image Labels
Label Style, Alignment and Positioning
Performance Considerations - Native Text Axis Labels
Axis Tick, Label Interval
Gridline and Label Spacing (Interval)
The TickProvider API
Fixed Label Intervals - Static Axis Feature
Multi Axis and Layout
Secondary and Multiple Axis
Vertical Charts (Rotate, Transpose Axis)
Inner Axis Layout
Central Axis Layout
Vertically Stacked Axis Layout
Horizontally Stacked Axis Layout
Advanced Options - Custom Layout Managers
Axis Styling
Title, Labels, Gridlines and Axis Band Style
Axis Borders and Background
Visibility of Axis Elements
Misc
Axis APIs - Convert Pixel to Data Coordinates
Animations API
The Animations API
Series Startup Animations
Style Transition Animations
Dataset Animations
Generic Animations
Annotations API
The Annotations API Overview
BoxAnnotation
LineAnnotation
TextAnnotation
CustomAnnotation
VerticalLineAnnotation
HorizontalLineAnnotation
AxisMarkerAnnotation
Image AxisMarkerAnnotation
SVG Axis Marker Annotation
NativeTextAnnotation
Editable Annotations
Styling Annotation Selection
Annotation Hover
ChartModifier API
ChartModifier APIs
What is the ChartModifier API
Common ChartModifiers Features
Zooming and Panning
ZoomPanModifier
RubberBandXyZoomModifier
PinchZoomModifier
ZoomExtentsModifier
YAxisDragModifier
XAxisDragModifier
MouseWheelZoomModifier
Easy Overview charts with SciChartOverview
CursorModifier (Crosshair + Tooltips)
The CursorModifier Type
Formatting CursorModifier Tooltip Items
Active Legends - CursorModifier output into a legend
Customizing the CursorModifier Tooltip Container Appearance
Interpolated Tooltip Values
RolloverModifier (VerticalLine + Tooltips)
Rollover Modifier
VerticalSliceModifier (Multiple Vertical Lines + Tooltips)
The VerticalSliceModifier Type
Formatting VerticalSlice Tooltip Items
Active Legends - VerticalSliceModifier output to a Legend
Customizing VerticalSliceModifier Tooltip Containers
Miscellaneous Modifiers
Legend Modifier
Selection
Series Selection
DataPoint Selection
Annotation Hover
Custom Modifiers
Custom Chart Modifier API
Detecting Clicks On Chart Parts with a Custom Modifier
Subcharts API
What is the SubCharts API?
SubCharts Positioning
SubChart Sub Surface Transparency
SubCharts Html Container
Worked Example: Re-usable Chart Groups with SubCharts
Worked Example: Dynamic Multi-Panel charts with SubCharts
Worked Example: Resizable Multi Pane Charts with SubCharts
Worked Example: Using SubCharts to create a Large Dashboard
Styling and Theming
Chart Styling - ThemeManager API
Chart Styling - Creating a Custom Theme
Chart Styling - Style Chart Parts in Code
Chart Styling - Margin and Padding
Series Styling - Dash Line Patterns
Chart Styling - Image, Transparent or Blurred Backgrounds
Chart Styling - Theming of Wait Loader
CSS Classes, Ids
Chart Styling - Auto Coloring
Chart Styling - Chart Titles
Chart Synchronization APIs
Synchronizing Multiple Charts
Synchronizing Vertical Charts
Accessibility
Creating Accessible Charts
Voice Over
Color and Contrast
Keyboard Accessibility
Miscellaneous APIs
Retina Support and Browser Zoom
Batching updates or Temporary Suspending Drawing
Native Text Api
Performance Tips
Performance Tips & Tricks
Memory Best Practices
Memory Leak Debugging
SciChart.js JavaScript 3D Charts API
SciChart3D Basics
Creating your first SciChartSurface3D
SciChart3DSurface.create() vs. createSingle()
Coordinates in 3D Space
The SciChartSurface Camera
Axis3D APIs
Axis3D APIs Overview
Numeric and Date Axis in SciChart3D
Axis3D Text (Label) Formatting
Axis3D Gridline and Label Spacing (Interval)
3D Chart Types
The Scatter 3D Chart Type
The Bubble 3D Chart Type
The Surface Mesh 3D Chart Type
The Lines 3D Chart Type
The Column 3D Chart Type
ChartModifier 3D API
Zooming and Panning
Orbit Modifier 3D
Pinch Zoom Modifier 3D
Mouse Wheel Zoom Modifier 3D
Reset Camera Modifier 3D
Tooltips
Tooltip Modifier 3D
API Documentation
TypeDoc API Documentation