Table of Contents

The TypeDoc documentation for SciChart.js can be found here📘.

• User Manual
  • Table of Contents
  • Features, Chart Types and more supported by SciChart.js
  • Minimum Browser Requirements
  • Online Resources and Help
  • Licensing SciChart.js
    • Get Started here
    • Location & Management of Licenses after Purchase
    • Activating a Purchased Developer License
    • Deploying SciChart.js to Domains
    • Deploying SciChart.js with Advanced Licensing (OEM)
    • Github Source Code Access
    • SciChart.js Licensing Troubleshooting
    • Misc licensing faqs
  • Language Support
    • SciChart 是否支持中文
    • SciChartは日本語をサポートしていますか？
• Get Started: Tutorials, Examples
  • Tutorial 01 - Setting up a project with scichart-react and config object
  • 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
  • The SciChart.js Examples Suite
  • FAQs
    • Virtualized data example JS RxJS from CDN without NPM
    • Custom Rollover SVG Tooltips
    • Custom Side-By-Side Series
    • How to Detect If a User Is Zooming or Panning
• What's New?
  • What's New in SciChart.js SDK v4.0
  • Breaking Changes in SciChart.js v4.x from v3.x
• 2D Charts API
  • The SciChartSurface
    • The SciChartSurface Type
    • The SciChartPolarSurface Type
    • Creating a new SciChartSurface and loading Wasm
    • Setting a Runtime License on a SciChartSurface
    • Deploying Wasm (WebAssembly) with your app
  • 2D Chart Types
    • RenderableSeries Overview
    • Common Series APIs
      • Series isVisible and isVisibleChanged API
      • Drawing Gaps in Series (null data)
      • Drawing PointMarkers on Series (Scatter markers)
    • DataLabels API
      • DataLabels API Overview
      • Data Label Positioning
      • Data Label Coloring
      • Custom DataLabel Formatting with getText()
      • Getting Labels from Metadata
      • DataLabel SkipModes and Culling
      • Polar Data Point Labels
    • PaletteProvider API
      • PaletteProvider API Overview
      • Per-point Colouring for Line Series
      • 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
      • Per-Point Coloring for Rectangle Series
      • Per-Point Coloring for Line Segment Series
      • Per-Point Coloring for Triangle Series
      • Per-Point Coloring for Polar Band Series
      • Per-Point Coloring for Polar Column Series
      • Per-Point Coloring for Polar Line Series
      • Per-Point Coloring for Polar Scatter Series
      • The PaletteFactory Helper Class
    • Hit-Test API
      • Hit-Test API overview
      • 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 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
      • Hit-Test API for Rectangle Series
      • Hit-Test API for Line Segment Series
      • Hit-Test API for Triangle Series
      • Hit-Test API for Polar Band Series
      • Hit-Test API for Polar Column Series
      • Hit-Test API for Polar Line Series
      • Hit-Test API for Polar Mountain Series
      • Hit-Test API for Polar Stacked Column Series
      • Hit-Test API for Polar Stacked Mountain Series
      • Hit-Test API for Polar Uniform Heatmap Renderable Series
      • Hit-Test API for Polar XY Scatter Series
      • Hit-Test API and Metadata
    • DataSeries (Data Updates) API
      • DataSeries API Overview
      • Append, Insert, Update, Remove
      • Accessing DataSeries xValues, yValues and count
      • DataSeries Realtime Updates
      • DataSeries Resampling
      • Deleting DataSeries Memory
    • PointMetadata API
      • PointMetadata API
      • Metadata and PaletteProviders
      • Metadata and Tooltips
      • Metadata and HitTest
    • Data Filters (Transforms) API
      • Data Filters API
      • Scale Offset Filters
      • Linear Trendline Filter
      • Moving Average Filter
      • Ratio Filter
      • Creating a Custom Filter
    • 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
    • Column Series
      • The Column Series Type
      • Column Series Data Point Width Mode
    • Uniform Heatmap Series
      • 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 Rectangle Series Type
    • The Triangle Series Type
    • The Line Segment Series Type
    • The Treemap Chart 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
    • The Box Plot Series Type
    • The Partial Polar Chart Type
    • The Polar Gauge Chart Type
    • The Polar Band Series Type
    • The Polar Column Chart Type
    • The Polar Line Chart Type
    • The Polar Mountain Chart Type
    • The Polar Stacked Column Chart Type
    • The Polar Stacked Mountain Chart Type
    • The Polar Uniform Heatmap Chart Type
    • The Polar Scatter Chart Type
    • The Pie Chart (using Polar Columns)
    • The Polar Radar Chart Type
    • The Polar Text Series Type
    • The Polar Triangle Series Type
    • The Polar Sunburst Chart Type
  • Builder (JSON Chart Definition) API
    • Intro to the Builder API
    • Creating a Simple Chart
    • Creating a 3D Chart
    • Creating a Pie Chart
    • Creating a Polar Chart
    • Working with Data
    • Complex Options
    • Custom Subtypes
    • Serialization and Deserialization of Charts
  • Axis APIs
    • Axis API Overview
    • Axis Types
      • Common Axis Base Type and Options
      • The Numeric Axis
      • The DateTimeNumericAxis
      • The Logarithmic Axis
      • The Category Axis
      • Text / String Axis
      • The Polar Numeric Axis
      • The Polar Category 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
      • Axis 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
      • Native Text Axis Labels
      • Polar Axis Labels
      • Axis Labels FAQs
    • 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 Axes
      • Vertical Charts (Rotate, Transpose Axis)
      • Inner Axis Layout
      • Central Axis Layout
      • Vertically Stacked Axis Layout
      • Horizontally Stacked Axis Layout
      • Advanced Options - Custom Layout Managers
      • Polar Chart Layout
      • Axis Offset and OverrideOffset
    • Axis Styling
      • Title, Labels, Gridlines and Axis Band Style
      • Axis Borders and Background
      • Visibility of Axis Elements
      • Polar Axis Styling
    • Misc
      • Axis APIs - Convert Pixel to Data Coordinates
      • Axis APIs – Convert Polar Pixel to Data Coordinates
  • Animations API
    • Animations API Overview
    • Series Startup Animations
    • Style Transition Animations
    • Dataset Animations
    • Generic Animations
  • Annotations API
    • Annotations API Overview
    • BoxAnnotation
    • LineAnnotation
    • TextAnnotation
    • CustomAnnotation
    • VerticalLineAnnotation
    • HorizontalLineAnnotation
    • LineArrowAnnotation
    • AxisMarkerAnnotation
      • AxisMarkerAnnotation
      • Image AxisMarkerAnnotation
      • SVG Axis Marker Annotation
    • NativeTextAnnotation
    • HTML Annotations
    • ArcAnnotation
    • PolarArcAnnotation
    • PolarPointerAnnotation
    • Editable Annotations
    • Styling Annotation Selection
    • Annotation Hover
  • ChartModifier API
    • Legend Modifier
    • What is the ChartModifier API
    • Common ChartModifiers Features
    • Zooming and Panning
      • ZoomPanModifier
      • RubberBandXyZoomModifier
      • PinchZoomModifier
      • ZoomExtentsModifier
      • YAxisDragModifier
      • XAxisDragModifier
      • MouseWheelZoomModifier
      • Easy Overview charts with SciChartOverview
    • CursorModifier
      • The CursorModifier Type
      • Formatting CursorModifier Tooltip Items
      • Active Legends - CursorModifier output into a legend
      • Customizing the CursorModifier Tooltip Container Appearance
      • Interpolated Tooltip Values
    • Rollover Modifier
    • VerticalSliceModifier
      • The VerticalSliceModifier Type
      • Formatting VerticalSlice Tooltip Items
      • Active Legends - VerticalSliceModifier output to a Legend
      • Customizing VerticalSliceModifier Tooltip Containers
    • Polar Chart Modifiers
      • PolarArcZoomModifier
      • PolarCursorModifier
      • PolarDataPointSelectionModifier
      • PolarSeriesSelectionModifier
      • PolarLegendModifier
      • PolarMouseWheelZoomModifier
      • PolarPanModifier
      • PolarZoomExtentsModifier
    • Selection & Hover
      • Series Selection and Hover
      • 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
    • Combining Polar and Cartesian Charts
    • 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
    • Polar Chart Styling
  • 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
    • Glow and DropShadow Shader Effects
    • Ordered Rendering
    • Render Events
  • Performance Tips
    • Performance Tips & Tricks
    • Memory Best Practices
    • Memory Leak Debugging
• 3D Charts API
  • Creating a 3D Chart
  • SciChart3D Basics
    • Creating your first SciChart3DSurface
    • 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 SurfaceMesh 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
    • Tooltip Modifier 3D