Explore the types, options and methods behind your charts. This reference is generated from the source used by the current website build; the package version appears in the page title.
| What you are building | Reference | Guide |
|---|---|---|
| A chart with your own interface | Chart API | Core concepts |
| A complete chart with controls | Widget | Widget guide |
| Named workspaces and indicator templates | Workspace | Workspaces guide |
| Price, drawing and study alerts | AlertController | Alerts guide |
| Open interest observations and studies | Bar | Open interest guide |
| CSV and structured chart observations | Chart API | Chart data export |
| A searchable object inventory | ChartObjects | Objects guide |
| Interactive drawing tools | Drawing controller | Drawing playground |
| A depth ladder | Depth of market | Simulated live demo |
| Daily TPO profiles | Market profile | Profile demo and themes |
AlertController supplies draggable price and study-threshold lines.
Pointer movement is visual preview; release commits one alert:updated event.
Drawing-owned levels remain tied to the drawing. The
live example demonstrates
preview, release and cancellation without a trading connection. The
Alerts guide covers construction, source binding,
delivery, expiry and persistence.
Set IndicatorDescriptor.hasSource to show the source action and handle
indicatorSource in your host. Use markerAnchor: 'price' for overlay signals
measured against candle highs and lows; plot anchoring remains the default.
ChartOptions.legendIconSize and chart.setLegendIconSize() size every legend
row consistently. See the indicator guide
for a runnable source-button and signal example.
Use Instrument for validated source, calendar and formatting rules. The optional workspace tier adds portable named layouts and indicator templates; the widget accepts per-instance translation and trading capabilities. Trader alerts use host-delivered events and restore their drawing/study anchors without firing on history. Open interest remains an optional level with explicit instrument support and missing-data gaps.
Read the instrument guide, widget guide and compatibility policy before wiring these contracts into a trading host. The library does not assume broker order authority.
Wheel input respects pixel, line and page deltas. Horizontal input pans time; wheel input
over a visible price axis scales that axis. ChartOptions.animAutoscale eases automatic
price changes during navigation. WidgetOptions.mobile controls the responsive header,
bottom bar and drawing sheets while sharing existing drawings and object state.
See the interaction guide,
mobile guide for the responsive controls and
their touch behavior.
ChartObjects shares inventory, supported actions and lifecycle notifications
between widget and custom hosts. widget.openObjects() opens the packaged panel.
Indicator visibility is part of saved layouts, and dialogs fit the chart's actual
container width and height. See the Objects guide.
The Footprint API adds
profile, ladder and heatmap styles, independent text coloring, configurable
tableRows, and volumeDivisor for quantity or lot display. Batch and live
footprints preserve actual OHLC, trade counts and intrabar delta extremes.
See the orderflow guide and
release notes.
The profile reference includes blockDisplay: 'compact', per-session
setSessionSplit / isSessionSplit, and the showSessionOpen / showLastPrice
marker options. See the release notes
for the full release details.
Use search to find a symbol, or browse the modules in the navigation. Each member links to its source definition so you can inspect the exact implementation.