Documentation Index
Fetch the complete documentation index at: https://brandtnewlabs.mintlify.app/llms.txt
Use this file to discover all available pages before exploring further.
LiveChart renders one series in line or candlestick mode. Props marked required must be
provided; everything else has a default.
Data
Growing array of
{ time, value } points. Read on the UI thread.Latest live value, interpolated between data updates.
Display mode
Line/area or OHLC candlestick rendering.
Committed OHLC bars, sorted by
time (candle mode).Seconds per candle bucket (e.g.
60 for 1-minute bars).In-progress candle, updated each tick;
null between buckets.Line, fill & tip
Main line styling:
width, color.Area fill under the line.
Value badge pill at the tip.
Pulsing ring on the live dot.
Horizontal dashed line at the current value.
Render the live value as large top-left text.
Tint the
showValue text by momentum (green up / red down).Momentum & degen
Momentum-based dot/badge coloring. See Momentum & degen.
Particle burst + screen shake on momentum swings.
JS-thread callback when a degen shake starts.
Trades, markers & references
Live trade fills for on-chart markers.
Glyph markers drawn into the canvas (UI-thread read).
Fires when a marker is tapped;
null on a miss.Tap hit-test radius in px.
Reference lines / bands (horizontal line, value band, or time band).
Scrubbing
Crosshair scrubbing on drag.
Fires while scrubbing;
null when it ends.Axes, grid & range
Time-axis labels.
Value-axis grid + labels.
Grid-line color / width / dash / opacity.
Visible window in seconds.
Freeze scrolling; resume catches up to real time.
Breathing-line loading shell until data is ready.
Value-lerp speed (0 = frozen, 1 = instant).
Tight Y-axis so small moves fill the height.
Clamp the Y-axis lower bound at 0.
Hard upper bound for the Y-axis range.
Right-edge buffer as a fraction of
timeWindow.Override the engine’s “now” (unix seconds) — useful for historical playback.
Theming & layout
Color scheme.
Primary accent; the palette is derived from it.
Override individual resolved-palette keys.
Font family / size / weight / custom typeface for all chart text.
Soft fade on the left edge.
Padding for the drawing area (
top, right, bottom, left).Container
View style.Text & accessibility
Formatter for value labels (axes, badge, tooltips).
Formatter for time labels.
Label shown when there are fewer than two samples and
loading is false.Accessibility label for the chart container.
Accessibility role for the container.
Config-object types (
LineConfig, BadgeConfig, DegenOptions, ReferenceLine, etc.) are
documented in the Types reference.