Generated from the TypeScript sources. Every export ships with dense JSDoc, so this mirrors exactly what your editor shows on hover.
Where things live
| Area | Entry points |
|---|---|
| 2D | Plot, LineLayer, ScatterLayer, BarLayer, AreaLayer, HeatmapLayer, … |
| 3D | Plot3D, SurfaceLayer, PointCloudLayer, Boxes3DLayer, VolumeLayer, … |
| Polar | PolarPlot |
| Scales & axes | makeScale, LinearScale, LogScale, TimeScale, OrdinalTimeScale, Axis, autoTicks |
| Colour | colormap, colormapLUT, registerColormap, palette, registerPalette, symmetricDomain |
| Finance | addBollinger, addDrawdown, the indicators, the transforms |
| Statistics | addRegression, addPsd, addWaterfall, addCorrMatrix, welch, loess, linearRegression |
| ML | addRocCurve, addConfusionMatrix, classificationReport, pca, … |
| Model graphs | addModelGraph, addModelGraph3D, modelGraphFrom*, modelLayout |
| GL toolkit | createProgram, TRANSFORM_GLSL, bufferUsage — for writing your own layer |
Classes
- AreaLayer
- Axis
- Bar3DLayer
- BarLayer
- Boxes3DLayer
- BoxLayer
- CandlestickLayer
- CategoricalScale
- Contour3DLayer
- ContourLayer
- ErrorBarLayer
- GraphLayer
- HeatmapLayer
- HexbinLayer
- ImageLayer
- IsosurfaceLayer
- Line3DLayer
- LinearScale
- LineLayer
- LogScale
- OhlcLayer
- OrdinalTimeScale
- PatchesLayer
- PieLayer
- Plot
- Plot3D
- PlotGrid
- PointCloudLayer
- PolarPlot
- Quiver3DLayer
- QuiverLayer
- ScatterLayer
- StemLayer
- SurfaceLayer
- TimeScale
- VolumeLayer
Interfaces
- AdapterOptions
- Adx
- AreaOptions
- AreaSeries
- Aroon
- AttentionMapHandle
- AttentionMapOptions
- AxisConfig
- AxisFrame
- AxisScaleOptions
- Bar3DOptions
- BarbsHandle
- BarbsOptions
- BarOptions
- BarSeries
- BeeswarmOptions
- BollingerBands
- BollingerHandle
- BollingerOptions
- Bounds
- Bounds3
- Box3D
- Boxes3DOptions
- BoxGroup
- BoxOptions
- BoxStats
- Brick
- CalibrationCurve
- CalibrationHandle
- CalibrationOptions
- Candle
- CandlestickData
- CandlestickOptions
- CellPlacement
- Channel
- ChordGroupArc
- ChordLayoutOptions
- ChordLayoutResult
- ChordOptions
- ChordRibbon
- ClassificationReport
- ClassScore
- ColorbarOptions
- ColorbarTheme
- ColorInfo
- ConfusionMatrix
- ConfusionMatrixHandle
- ConfusionMatrixOptions
- Contour3DOptions
- ContourFilledHandle
- ContourFilledOptions
- ContourOptions
- Correlation
- CorrMatrixHandle
- CorrMatrixOptions
- CSVOptions
- DecisionBoundaryHandle
- DecisionBoundaryOptions
- Density
- DepthCurves
- DepthHandle
- DepthOptions
- Drawdown
- DrawdownHandle
- DrawdownOptions
- DrawState
- EcdfOptions
- EmbeddingHandle
- EmbeddingOptions
- ErrorBarData
- ErrorBarOptions
- EventPlotOptions
- ExportOptions
- FeatureImportanceHandle
- FeatureImportanceOptions
- FibLevel
- ForceLayoutOptions
- FunnelItem
- FunnelLayoutOptions
- FunnelOptions
- FunnelStage
- GaugeLayoutOptions
- GaugeOptions
- GaugeThreshold
- GraphData
- GraphInput
- GraphOptions
- GridTitleOptions
- GroupedBarOptions
- HeatmapOptions
- HeikinAshiOptions
- HexbinOptions
- Hist2dHandle
- Hist2dOptions
- Histogram
- Histogram2D
- HoverReadoutRow
- Ichimoku
- ImageOptions
- IsobandPolygon
- IsosurfaceOptions
- KerasAdapterOptions
- KerasLayerConfig
- KerasModelConfig
- Label3D
- Layer
- Layer3D
- Layout
- LearningCurveHandle
- LearningCurveOptions
- LegendOptions
- LiftCurve
- LiftCurveHandle
- LiftCurveOptions
- Line3DOptions
- LinearFit
- LineOptions
- Macd
- MlpOptions
- ModelBlock
- ModelBoxSizing
- ModelEdge
- ModelEdgePath
- ModelGraph
- ModelGraph3DHandle
- ModelGraph3DOptions
- ModelGraphHandle
- ModelGraphOptions
- ModelLayoutOptions
- ModelLayoutResult
- ModelNode
- ModelNodeBox
- MulticlassRoc
- Ohlc
- OhlcArrays
- OhlcInput
- OhlcOptions
- OnnxAdapterOptions
- OnnxGraph
- OnnxNode
- ParallelAxis
- ParallelHandle
- ParallelLayoutResult
- ParallelLine
- ParallelOptions
- PartialDependenceHandle
- PartialDependenceOptions
- Patch
- PatchesOptions
- PcaResult
- PcolormeshOptions
- PfColumn
- Picked
- PieOptions
- PivotLevels
- Plot3DOptions
- PlotGridOptions
- PlotOptions
- PlotTitleOptions
- PointCloudOptions
- PolarLineOptions
- PolarOptions
- PolarScatterOptions
- PolarSeries
- PrCurve
- PrCurveHandle
- PrCurveOptions
- PredVsActualHandle
- PredVsActualOptions
- Psd
- PsdHandle
- PsdOptions
- Quiver3DOptions
- QuiverOptions
- RegressionHandle
- RegressionOptions
- RenkoOptions
- ResampledOhlc
- ResidualsHandle
- ResidualsOptions
- ResolvedAxisStyle
- RidgeGroup
- RidgelineHandle
- RidgelineOptions
- Ring
- RocCurve
- RocCurveHandle
- RocCurveOptions
- SankeyLayoutOptions
- SankeyLayoutResult
- SankeyLink
- SankeyNode
- SankeyNodeRect
- SankeyOptions
- SankeyRibbon
- ScalarField
- Scale
- ScatterOptions
- SequentialLayer
- ShapBeeswarmHandle
- ShapBeeswarmOptions
- SklearnStep
- Spectrogram
- StackedAreaOptions
- StackedBarOptions
- StemOptions
- Stochastic
- Streamline
- StreamlineOptions
- StreamplotHandle
- StreamplotOptions
- SunburstArc
- SunburstLayoutOptions
- SunburstNode
- SunburstOptions
- SuperTrend
- SurfaceOptions
- Table
- Theme
- Tick
- ToolbarHost
- ToolbarTheme
- TorchFxNode
- TrainingCurvesHandle
- TrainingCurvesOptions
- TrainingSeries
- TreemapCell
- TreemapExtent
- TreemapItem
- TreemapOptions
- Trend
- Triangulation
- TriangulationInput
- TricontourfHandle
- TricontourfOptions
- TricontourOptions
- TripcolorHandle
- TripcolorOptions
- TriplotHandle
- TriplotOptions
- VectorField
- VolumeOptions
- VolumeProfile
- VolumeProfileOptions
- WaterfallHandle
- WaterfallOptions
- WaterfallTickOptions
- WelchOptions
- YAxisOptions
Type Aliases
- Annotation
- BoxDims
- BuiltinColormapName
- BuiltinPaletteName
- Color
- ColormapKind
- ColormapName
- ColormapSpec
- Dim
- DrawTool
- ErrInput
- ImageSource
- InteractionMode
- LayerCategory
- LineJoin
- MarkerShape
- Mat4
- PaletteName
- PaletteSpec
- PickMode
- Range
- RenderType
- RGB
- ScaleType
- TicksSpec
- TimeFormat
- WindowName
Variables
- CHORD_PALETTE
- COLORMAP_KIND
- darkTheme
- DEFAULT_PALETTE
- FUNNEL_PALETTE
- LAYER_COLORS
- lightTheme
- ML_PALETTE
- PALETTES
- PARALLEL_PALETTE
- TRANSFORM_GLSL
- TRANSFORM_UNIFORMS
- TREEMAP_PALETTE
Functions
- addAttentionMap
- addBarbs
- addBollinger
- addCalibration
- addChord
- addConfusionMatrix
- addContourFilled
- addCorrMatrix
- addDecisionBoundary
- addDepth
- addDrawdown
- addEcdf
- addEmbedding
- addEventPlot
- addFeatureImportance
- addFunnel
- addGauge
- addHeikinAshi
- addHist2d
- addLearningCurve
- addLiftCurve
- addModelGraph
- addModelGraph3D
- addParallelCoordinates
- addPartialDependence
- addPcolormesh
- addPrCurve
- addPredVsActual
- addPsd
- addRegression
- addRenko
- addResiduals
- addRidgeline
- addRocCurve
- addSankey
- addShapBeeswarm
- addStreamplot
- addSunburst
- addTrainingCurves
- addTreemap
- addTricontour
- addTricontourf
- addTripcolor
- addTriplot
- addVolumeProfile
- addWaterfall
- adx
- aroon
- atr
- autoTicks
- beeswarmLayout
- blockMax
- bollinger
- boxStats
- brierScore
- bufferUsage
- calibrationCurve
- canvasToBlob
- cci
- chordLayout
- classificationReport
- collectLayers
- colormap
- colormapFromStops
- colormapGradient
- colormapLUT
- colormapNames
- confusionMatrix
- copyCanvasToClipboard
- correlation
- corrMatrix
- createProgram
- createToolbar
- crossCorrelate
- defaultFormat
- delaunay
- depth
- discreteColormap
- donchian
- downloadCanvas
- drawdown
- earcut
- ecdf
- ema
- emaSmooth
- fft
- fibRetracements
- firstFinite
- forceLayout
- formatCount
- formatDuration
- formatShape
- funnelLayout
- gaugeLayout
- heikinAshi
- hist2d
- histogram
- ichimoku
- isLayer
- isobands
- kde
- keltner
- layerCategory
- liftCurve
- linearRegression
- linearTrend
- lineBreak
- linkX
- linkY
- loess
- logLoss
- lttb
- macd
- mae
- makeScale
- marchingCubes
- mfi
- mlpModel
- modelBoxDims
- modelGraphFromKeras
- modelGraphFromOnnx
- modelGraphFromSklearn
- modelGraphFromTorchFx
- modelLayout
- mse
- niceTimeStep
- obv
- palette
- paletteColor
- paletteNames
- parabolicSar
- parallelLayout
- parseColor
- parseCSV
- pca
- pivotPoints
- pointAndFigure
- prCurve
- quantileSorted
- r2
- registerColormap
- registerPalette
- renderColorbars
- renko
- resampleOhlc
- resolveAxisStyle
- resolveTicks
- reverseColormap
- rmse
- rocCurve
- rocCurveOvR
- rollingStd
- rsi
- sankeyLayout
- savitzkyGolay
- sequentialModel
- setTransformUniforms
- sma
- spectrogram
- standardize
- stochastic
- streamlines
- sunburstLayout
- superTrend
- symmetricDomain
- tensorMetrics
- toColorCss
- treemapLayout
- triangleEdges
- trueRange
- uniformLocations
- volumeProfile
- vwap
- waterfallTimeTicks
- welch
- williamsR
- windowFunction
- withMinorTicks
- wma
- zscore