API REFERENCE
Configuration options
Browse sy-chart options by purpose. Check their defaults and the types supported by each chart.
Data & series
- type
The chart type rendered by the shared sy-chart component. Data structures and supported options vary by type. Check the specific chart's contract first.
- typeLoadTimeout
Budget (ms) for the chart type's element to become ready once it is rendered : a lazy chunk that never arrives turns into the load-failed notice (reason
timeout) with a Retry control. 0 or less = no limit. - series
Display multiple series together. Set a name, values, color, and display options for each series. Each series follows the data type of the selected chart.
- activeSeriesIndex
Set as an HTML attribute or JavaScript property. type: number.
- seriesState
Pass as a JavaScript property. type: LineChartSeriesStateOptions.
- values
Values for a single series. Use the data type required by the selected chart, such as a number array for Line or coordinate array for Scatter. Assign arrays and objects as JavaScript properties.
- seriesActiveTrigger
Allowed values: hover, click, custom. Default: undefined.
- seriesName
Set as an HTML attribute or JavaScript property. type: string.
- seriesPadding
Set as an HTML attribute or JavaScript property. type: number.
- source
the tabular dataset the series read through
encode(a Dataset, a source, or rows); it wins overvalues/series. Namedsourcebecausedatasetis the element's own data-* map. - sourceTransforms
transforms applied to
sourcebefore encoding (filter / sort / regression / boxplot / sample). - encode
which dimensions feed the series (one encode per series); an ordinal x labels the category axis.
- data
Chart-specific data. Use the input structure for the chart, such as a tree, nodes and links, or OHLC records. Not every type in this union applies to every chart.
- categories
Radar category spoke labels (property).
Axes & coordinates
- xAxis
Configure the horizontal axis type, categories, range, and formatting. For a category axis, match the categories order to the value array indices. Charts supporting multiple axes can accept an axis array.
- yAxis
Configure the vertical axis range, ticks, labels, and direction. Use consistent units for comparisons, and consider a zero baseline when comparing bar lengths.
- gridLines
Allowed values: auto, off. Default: undefined.
- xLabelMode
How crowded category-axis labels are decluttered.
'auto'(default) keeps labels horizontal and thins any that would collide.'all'shows everything,'thin'/'rotate'force one strategy,'none'hides the labels. - xLabelRotation
Explicit category-label rotation in degrees (respected as a floor on top of auto-declutter).
- xLabelMaxCount
Hard cap on the number of category-axis labels shown (kept evenly spaced).
- camera3d
Camera and orbit settings shared by the 3D families. Assign objects as properties or JSON attributes.
- orbit3d
Pass as a JavaScript property. type: Orbit3DOptions|boolean|string.
Tooltips & interaction
- hitTolerance
Set as an HTML attribute or JavaScript property. type: number.
- markerClickable
Set as an HTML attribute or JavaScript property. type: boolean.
- markerActiveTrigger
Allowed values: hover, click, custom. Default: 'hover'.
- tooltip
Tooltip settings for pointer-driven values, position, and content.
- crosshair
Bare crosshair or {} enables defaults. Object props and JSON attributes override options. Omit/remove the attribute to disable.
- zoom
cartesian zoom (line / area / column / bar / scatter):
'x'|'y'|'xy'|trueenable the drag rectangle + keyboard on the primary axes; an object refinesmode/drag/keyboard/minRangePx/resetButton. Forwarded to the active family element. - brush
brush selection on the cartesian families (forwarded like
zoom). - drawings
the drawing document (a list, an envelope or a JSON string), forwarded to the cartesian families.
- drawingMode
'none' | 'draw' | 'select': the pointer disposition of the cartesian families (draw places
drawingTool). - drawingTool
the tool a draw mode places (default 'segment').
- drawingSpace
the space new drawings are anchored in ('data' | 'pixel'), forwarded to the cartesian families.
- visualMap
a visual map binding (a
sy-visual-mapsnapshot + the data dimension), forwarded to the cartesian family. - allowSelect
Set as an HTML attribute or JavaScript property. type: boolean.
- tooltipEnabled
Pie tooltip toggle. Named
tooltipEnabledto avoid the cartesiantooltipShowevent. - tooltipFormat
Pie tooltip HTML formatter (property-only — functions can't be set via attribute).
- enableMouseTracking
Pie mouse-tracking toggle. Mirrors Highcharts plotOptions.pie.enableMouseTracking.
- stickyTracking
Keep hover/tooltip until another slice is entered (Highcharts stickyTracking).
- crosshairSnapDistance
Geo Map: point-center capture distance in CSS pixels when crosshair.snap is enabled.
Legend
- legend
Show the legend. Undefined lets each chart use its own default (marimekko/dot-plot default on; the cartesian charts default off).
- legendPosition
Where the legend is positioned.
- legendItems
Pass as a JavaScript property. type: LegendItem[].
- legendFloatAlign
Allowed values: start, center, end. Default: 'end'.
- legendFloatVerticalAlign
Allowed values: top, bottom, middle. Default: 'top'.
- legendDraggable
Set as an HTML attribute or JavaScript property. type: boolean.
Appearance & styling
- color
Pass as a JavaScript property. type: string | ReadonlyArray<string>.
- thickness
Set as an HTML attribute or JavaScript property. type: number.
- marker
Pass as a JavaScript property. type: LineChartMarker | ScatterChartMarkerSymbol | string | ReadonlyArray<string>.
- markerSize
Set as an HTML attribute or JavaScript property. type: number.
- markerLineWidth
Set as an HTML attribute or JavaScript property. type: number.
- markerFilter
Pass as a JavaScript property. type: LineChartMarkerFilter.
- lineDash
Pass as a JavaScript property. type: number[].
- connectNulls
Set as an HTML attribute or JavaScript property. type: boolean.
- smooth
Allowed values: none, monotone, cardinal. Default: 'none'.
- smoothTension
Set as an HTML attribute or JavaScript property. type: number.
- step
Allowed values: none, left, right, center. Default: 'none'.
- fillColor
Set as an HTML attribute or JavaScript property. type: string.
- fillOpacity
Set as an HTML attribute or JavaScript property. type: number.
- fillGradient
Pass as a JavaScript property. type: unknown.
- fillPattern
Pass as a JavaScript property. type: unknown.
- patternKind
Allowed values: dots, diagonal, cross-hatch, diagonal-forward, diagonal-backward, fill. Default: undefined.
- patternColor
Set as an HTML attribute or JavaScript property. type: string.
- patternBackground
Set as an HTML attribute or JavaScript property. type: string.
- patternSize
Set as an HTML attribute or JavaScript property. type: number.
- patternThickness
Set as an HTML attribute or JavaScript property. type: number.
- borderRadius
Pass as a JavaScript property. type: CartesianSeriesCornerRadiusValue.
- borderScope
Allowed values: point, stack, outline. Default: undefined.
- borderColor
Set as an HTML attribute or JavaScript property. type: string.
- borderWidth
Set as an HTML attribute or JavaScript property. type: number.
- borderDashStyle
Allowed values: Solid, Dash, Dot, DashDot, LongDash, LongDashDot. Default: undefined.
- inactiveOtherPoints
Set as an HTML attribute or JavaScript property. type: boolean.
- inactivePointOpacity
Set as an HTML attribute or JavaScript property. type: number.
- palette
Allowed values: tableau10, tableau20, observable10, paired12, set3_12. Default: undefined.
- colors
Pass as a JavaScript property. type: ReadonlyArray<string>.
- labelsMode
Allowed values: none, auto, inside, outside. Default: undefined.
- labelsContent
Allowed values: percent, value, name, name-percent, name-value. Default: undefined.
- labelsDistance
Set as an HTML attribute or JavaScript property. type: number.
- labelsFontSize
Set as an HTML attribute or JavaScript property. type: number.
- labelsMinSweep
Set as an HTML attribute or JavaScript property. type: number.
- labelsConnector
Set as an HTML attribute or JavaScript property. type: boolean.
- inactiveOtherSlices
Set as an HTML attribute or JavaScript property. type: boolean.
- inactiveSliceOpacity
Set as an HTML attribute or JavaScript property. type: number.
- labelsFontWeight
Set as an HTML attribute or JavaScript property. type: number.
- labelsColor
Set as an HTML attribute or JavaScript property. type: string.
- labelsConnectorColor
Set as an HTML attribute or JavaScript property. type: string.
- labelsConnectorWidth
Set as an HTML attribute or JavaScript property. type: number.
- labelsConnectorPadding
Set as an HTML attribute or JavaScript property. type: number.
- labelsConnectorShape
Allowed values: straight, crooked. Default: undefined.
- labelsAllowOverlap
Set as an HTML attribute or JavaScript property. type: boolean.
- labelColor
Tilemap: in-tile label colour.
- colorAxis
Tilemap: value→colour axis (
true/'auto'/object). Property-only; off by default. - colorLegend
Tilemap: show the colour-axis gradient legend (on while the axis is on).
- fillAlpha
The fill opacity of a bubble (the border stays opaque).
- labelMode
Waterfall (): the value labels' mode — value / running / both (
show-labelsswitches them on);labelFormat(bar)replaces the text. - labelFormat
Pass as a JavaScript property. type: (bar: unknown) => string.
- markerRadius
Radar vertex marker radius in px.
- labelPlacement
Funnel/pyramid data-label placement.
- inactiveOtherSections
Dim non-active funnel/pyramid sections when a section is active.
- inactiveSectionOpacity
Opacity applied to non-active funnel/pyramid sections.
- markerColor
Lollipop marker fill override (defaults to
color). - colorful
Variwide: colour each column from the categorical palette.
Size, titles & state
- width
Chart width in pixels. If the container width changes, update width from a ResizeObserver.
- height
Chart height in pixels. Allow space for axes, titles, and the legend.
- chartTitle
The title inside the chart. Explain the data's unit and meaning alongside it.
- chartSubtitle
The subtitle inside the chart.
- emptyColor
Heatmap: the colour of an empty cell (default transparent).
- padding
(ledger E2 / E7) — the value-domain padding fraction of the Pro cartesian families (box plot, bubble, candlestick / OHLC, density map, error bar, waterfall: each wrapper defaults to 0.05). Left unset, the wrapper's own default applies; the Community cartesian families size their domains through their axis inputs instead.
- themeRiverAxes
ThemeRiver time and stacked-magnitude axes.
- themeRiverOffset
Allowed values: silhouette, zero, expand. Default: 'silhouette'.
- themeRiverOrder
Allowed values: input, reverse. Default: 'input'.
- themeRiverColors
Pass as a JavaScript property. type: ReadonlyArray<string>.
- themeRiverOpacity
Set as an HTML attribute or JavaScript property. type: number.
- themeRiverHiddenSeries
Pass as a JavaScript property. type: ReadonlyArray<ThemeRiverId>.
- errorColor
Error bar: the whisker + cap colour; bar mode (a column from zero); the caps' switch.
- loading
Loading overlay ().
- loadingText
Loading overlay text override; falls back to the locale string.
- emptyText
Empty-state text override; falls back to the locale string ().
- showEmpty
Auto empty state when no finite data point exists. Default
true. - error
Error state ().
trueuses the locale default; a string is the message. - errorText
Error body text override (used when
erroris booleantrue). - theme
The theme used for chart colors and typography. Pass a theme name or a supported theme object. Page and chart themes are separate; update both in your app.
- locale
Locale name (
en|ko|ja|zh) or a partial override object ().
Animation & engine
- engine
Renderer selection: auto, standard, or pro. Engine selection is separate from permission to use a Pro chart type.
- proThreshold
Set as an HTML attribute or JavaScript property. type: number.
- unavailable
Allowed values: fallback, error. Default: 'fallback'.
- streamSource
A stream source for live data. Check the contract for the specific type.
- streamWindow
The streaming data range to keep visible.
- streamMax
The maximum number of streaming data points to retain.
- frameBudget
milliseconds a drawn frame may take before the next scheduled frame is skipped (line family; 0 disables skipping).
- streamWindowMs
an absolute stream window: only points appended within the last N ms are visible, sliding every frame (line family; overrides
stream-window). - streamTimestamps
the line family's ring stamps its points (
on, the default — an absolutestream-window-msneeds them) unlessoffopts out (8 MB less at a 1M capacity for charts that only use a count window). - animated
Whether to animate initial display and data changes.
- animationDuration
Animation duration in milliseconds.
- animationEasing
Allowed values: linear, ease-out, ease-in, ease-in-out. Default: 'ease-out'.
- animationType
Allowed values: initial, update. Default: undefined.
- progressive
scatter, Standard engine: paint a heavy frame in chunks (false / 0 = off, true = 5,000 per chunk, a number = points per chunk).
- progressiveThreshold
below this many drawn points the frame paints at once (default 20,000).
- renderPath
Heatmap (): the draw path —
auto/plane/cells.border-radius/border-width/border-colorstyle the cells. - lod
Heatmap (): the plane path's level of detail —
auto/point/area. - areaReduce
Heatmap / spectrogram (): how the area LOD folds the cells a pixel covers —
mean(the heatmap default) ormax(the spectrogram default, peak-hold).
Export & branding
- brandLogo
The default is the Syidax symbol and wordmark. With the Pro chart.branding entitlement, set none to remove it or provide a PNG, JPEG, or WebP data URL to replace it.
- brandPosition
The corner where the logo is anchored. Community and Pro both support all four corners, using the same position on screen and in image exports.
- contextmenu
Enables the shared right-click context menu on empty chart area. Default
false. - contextMenuItems
Append custom menu items after the built-in image and data export items. This array does not replace the default menu. Pass objects with action callbacks as a JavaScript property.
- exportFilename
Base filename (no extension) for exports; falls back to the title or type.
- exportScale
Output pixel scale for PNG export (1–8). Default 2 (retina).
- exportBackground
Backdrop painted behind PNG/SVG exports; falls back to the theme background.
Chart-specific options
- barPadding
Set as an HTML attribute or JavaScript property. type: number.
- baseline
Reference value for cartesian charts. Column / bar / area use it as the visual anchor; line uses it as a value-axis reference marker. Always explicit (default
0) so the baseline stays visible regardless oftype. - stacking
Allowed values: normal, percent. Default: undefined.
- innerSize
Pass as a JavaScript property. type: number | string.
- startAngleProp
Pie/gauge/item start angle; Chord uses degrees with a default of -90 (top).
- endAngleProp
Set as an HTML attribute or JavaScript property. type: number.
- centerText
Set as an HTML attribute or JavaScript property. type: string.
- centerSubtext
Set as an HTML attribute or JavaScript property. type: string.
- slicedOffset
Set as an HTML attribute or JavaScript property. type: number.
- activeSliceIndex
Set as an HTML attribute or JavaScript property. type: number.
- size
Pie outer diameter. Number = px; '%' = fraction of the smaller plot side.
- centerX
Pass as a JavaScript property. type: number | string.
- centerY
Pass as a JavaScript property. type: number | string.
- minSize
Set as an HTML attribute or JavaScript property. type: number.
- donutThickness
Donut ring thickness in px. Named
donutThicknessto avoid the cartesianthicknessprop. - symbol
Item dot symbol —
circle(default) /square/diamond; per-datumsymboloverrides. - rows
Item concentric ring count; auto (smallest that fits) when unset.
- itemPadding
Item cell whitespace fraction around each dot, 0..0.9 (Highcharts itemPadding).
- minFontSize
Word cloud: smallest rendered font in px (Highcharts minFontSize).
- maxFontSize
Word cloud: font px of the heaviest word (Highcharts maxFontSize).
- weightScale
Word cloud: weight→fontSize curve —
linear(default) /sqrt/log. - spiral
Word cloud: spiral search pattern —
rectangular(default) /archimedean. - orientations
Word cloud: number of distinct orientations in the rotation cycle (default 2).
- rotationFrom
Word cloud: rotation cycle start in degrees (default 0).
- rotationTo
Word cloud: rotation cycle end in degrees (default 90).
- wordPadding
Word cloud: empty px kept between word boxes (default 2).
- paths
Pictorial: SVG path definitions the icons cycle through per category. Property-only.
- iconPadding
Pictorial: fraction of each band kept as whitespace around its icon, 0..0.9.
- trackOpacity
Pictorial: opacity of the unfilled remainder silhouette (0 hides the track).
- tileShape
Tilemap: tile glyph —
hexagon(default) /square; circle/diamond land . - showLabels
Tilemap: render each tile's label inside the tile when it fits.
- matrix
Heatmap: a dense matrix —
{ columns, rows, values }(row-major) or rows of columns. Property-only. - xCategories
Heatmap: column labels (array, or a comma list). Given explicitly, they fix the column count.
- yCategories
Heatmap: row labels (row 0 is the top row).
- headerHeight
Treemap branch header band in CSS pixels.
- drilldown
Enable Treemap branch navigation and accessible hierarchy controls.
- dendrogramDirection
Dendrogram depth direction; sibling order remains in normalized input order.
- icicleDirection
Icicle depth direction; sibling order remains in normalized input order.
- parallelCoordinatesAxes
Independent axis ticks, captions, local guides and label styles.
- parallelCoordinatesBrush
Pass as a JavaScript property. type: ParallelCoordinatesBrushInput.
- parallelCoordinatesDimensions
Numeric dimensions in display order. Omit to infer them from row values.
- parallelCoordinatesLineWidth
Set as an HTML attribute or JavaScript property. type: number.
- parallelCoordinatesLineOpacity
Set as an HTML attribute or JavaScript property. type: number.
- parallelCoordinatesInactiveRowOpacity
Set as an HTML attribute or JavaScript property. type: number.
- parallelCoordinatesAxisLabels
Set as an HTML attribute or JavaScript property. type: boolean.
- lighting3d
Pass as a JavaScript property. type: Scene3DLightingOptions.
- material3d
Pass as a JavaScript property. type: Scene3DMaterialOptions.
- flowLinesStyle
FlowLines route widths, colors, arrows and endpoint markers.
- flowLinesPath
Allowed values: great-circle, straight. Default: 'great-circle'.
- flowLinesLocationLabels
Allowed values: auto, show, hide. Default: 'auto'.
- flowLinesLabels
Allowed values: auto, show, hide. Default: 'hide'.
- flowLinesLabelValue
Set as an HTML attribute or JavaScript property. type: boolean.
- bar3dAxes
Pass as a JavaScript property. type: Bar3DAxesOptions|boolean|string.
- scatter3dAxes
Pass as a JavaScript property. type: Scatter3DAxesOptions|boolean|string.
- bar3dSize
Pass as a JavaScript property. type: Scene3DVector.
- scatter3dSize
Pass as a JavaScript property. type: Scene3DVector.
- bar3dColors
Pass as a JavaScript property. type: HeatmapColorInput.
- scatter3dColors
Pass as a JavaScript property. type: HeatmapColorInput.
- bar3dColorDomain
Pass as a JavaScript property. type: Bar3DDomain.
- scatter3dColorDomain
Pass as a JavaScript property. type: Scatter3DDomain.
- bar3dMissingColor
Set as an HTML attribute or JavaScript property. type: string.
- scatter3dMissingColor
Set as an HTML attribute or JavaScript property. type: string.
- bar3dOpacity
Set as an HTML attribute or JavaScript property. type: number.
- bar3dWidth
Set as an HTML attribute or JavaScript property. type: number.
- bar3dDepth
Set as an HTML attribute or JavaScript property. type: number.
- bar3dXCategories
Pass as a JavaScript property. type: ReadonlyArray<Bar3DCategory>.
- bar3dYCategories
Pass as a JavaScript property. type: ReadonlyArray<Bar3DCategory>.
- scatter3dOpacity
Set as an HTML attribute or JavaScript property. type: number.
- scatter3dMarker
Allowed values: sphere, cube. Default: 'sphere'.
- scatter3dMarkerRadius
Set as an HTML attribute or JavaScript property. type: number.
- scatter3dMarkerDetail
Set as an HTML attribute or JavaScript property. type: 0|1|2.
- surface3dAxes
Pass as a JavaScript property. type: Surface3DAxesOptions|boolean|string.
- surface3dSize
Pass as a JavaScript property. type: Scene3DVector.
- surface3dColors
Pass as a JavaScript property. type: HeatmapColorInput.
- surface3dColorDomain
Pass as a JavaScript property. type: Surface3DDomain.
- surface3dMissingColor
Set as an HTML attribute or JavaScript property. type: string.
- surface3dOpacity
Set as an HTML attribute or JavaScript property. type: number.
- surface3dWireframe
Set as an HTML attribute or JavaScript property. type: boolean.
- surface3dWireWidth
Set as an HTML attribute or JavaScript property. type: number.
- surface3dWireColor
Set as an HTML attribute or JavaScript property. type: string.
- ganttBarHeight
Maximum Gantt task bar height in CSS pixels.
- ganttRowGap
Gantt row gap in CSS pixels.
- ganttTimeDomain
Explicit full Gantt time domain in epoch milliseconds.
- ganttCriticalPath
Pass as a JavaScript property. type: GanttCriticalPathInput.
- ganttTaskEditing
Gantt task move/resize with elapsed-time snapping and optional bounds. Disabled by default.
- ganttBaseline
Gantt reference-date strips and automatic domain inclusion. Visible by default when supplied.
- ganttDependencies
Pass as a JavaScript property. type: ReadonlyArray<GanttDependencyInput>.
- ganttDependencyStyle
Pass as a JavaScript property. type: GanttDependencyStyleInput.
- ganttTimeAxis
Pass as a JavaScript property. type: GanttTimeAxisInput.
- ganttCrosshairTimeUnit
Gantt crosshair time badge precision; default hour. Uses ganttTimeAxis.utc.
- ganttBarRadius
Set as an HTML attribute or JavaScript property. type: number.
- ganttProgressShow
Set as an HTML attribute or JavaScript property. type: boolean.
- ganttProgressColor
Set as an HTML attribute or JavaScript property. type: string.
- taskLabelFormat
Pass as a JavaScript property. type: (task:GanttTask)=>string.
- taskLabels
Allowed values: auto, show, hide. Default: undefined.
- kernel
Density map: the kernel profile (
gaussian,epanechnikov,quartic,triangular,uniform). - bandwidth
Density map: the bandwidth — a number (both axes),
"x,y",{ x, y }, orauto(Silverman's rule). - bandwidthUnit
Density map: the unit of an explicit bandwidth —
data(default) orpx. - cellSize
Density map: CSS px per estimate cell (the grid follows the plot).
- threshold
Density map: cells under this fraction of the peak density are empty.
- computePath
Density map: where the estimate runs —
auto(the GPU once the renderer is up),cpu,gpu. - fade
Density map: the fade band above the threshold cut, as a fraction of the peak ().
- densityUnit
Density map: how densities read — the cell's mass, or mass per unit area ().
- sampleRate
Spectrogram: the sampling rate in Hz — the frequency axis spans 0 … sample-rate / 2.
- freqMin
Spectrogram: the frequency axis ends in Hz (they win over
sample-rate). - freqMax
Set as an HTML attribute or JavaScript property. type: number.
- hopSeconds
Spectrogram: seconds per frame (the hop) — the time axis.
- timeOrigin
Spectrogram: seconds at the first frame.
- valueScale
Spectrogram:
db(the frames are decibels) orlinear(magnitudes, converted with 20 · log10). - dbFloor
Spectrogram: the dB a zero magnitude reads on the linear scale (default −120).
- year
Calendar heatmap: the year (Jan 1 … Dec 31) unless
start-date/end-datesay otherwise. - startDate
Calendar heatmap: the range ends (ISO dates); they win over
year; neither → the entries' span. - endDate
Set as an HTML attribute or JavaScript property. type: string.
- weekStart
Calendar heatmap: the first day of the week (the top row) —
mondayorsunday. - aggregate
Calendar heatmap: how several entries on one day fold —
sum,max,min,mean,last. - noDataValue
Calendar heatmap: what a day without entries reads — a number (default 0 → the ramp's first colour) or
nan(→empty-color). - monthLabels
Calendar heatmap: month labels along the top.
- weekdayLabels
Calendar heatmap: weekday labels down the left —
short(rows 0 / 2 / 4),all,none. - monthLines
Calendar heatmap: month boundaries as step lines between the cells.
- upColor
Candlestick: the colour of a rising bar (close > open).
- downColor
Candlestick: the colour of a falling bar (close < open).
- flatColor
Candlestick: the colour of a doji (close = open).
- candleWidth
Candlestick: the body's share of the bar pitch (0 … 1, default 0.7).
- wickWidth
Candlestick: the wick width in CSS px.
- bodyStyle
Candlestick ():
solid,hollow, orhollow-up(rising bars hollow, falling filled). - wickColor
Candlestick (): the wick colour;
autofollows the body colour. - timeScale
Candlestick ():
ordinal(one slot per bar — no weekend / holiday gaps; the default) orlinear(wall time). - session
Candlestick (): the exchange session the labels read —
24x7,us-equity, or a JSON object{ timezone, sessions, holidays, closedWeekdays }. - volume
Candlestick ():
paneadds a volume pane below the price (a feed without volumes gets none);offby default. - volumeHeight
Candlestick (): the volume pane's share of the plot height (0.05 … 0.8; default 0.25).
- volumeUpColor
Candlestick (): the volume bar colours (
auto= up-color / down-color) and their alpha (default 0.45). - volumeDownColor
Set as an HTML attribute or JavaScript property. type: string.
- volumeAlpha
Set as an HTML attribute or JavaScript property. type: number.
- barStyle
Candlestick / OHLC (): the bar style —
candle/ohlc/hlcon a candlestick,ohlc/hlcontype="ohlc". - overlays
Candlestick (): moving-average overlays — spec objects
{ kind, period, color?, width?, label? }, a JSON string, or the compact"sma:20 ema:50". - boxColor
Box plot: the box colour — the border, and at
box-fill-alphathe fill;autowhiskers / outliers follow it. - boxFillAlpha
Box plot: the fill's alpha (default 0.35).
- medianColor
Box plot: the median line colour.
- whiskerColor
Box plot: the whisker / outlier colours (
auto= the box colour). - outlierColor
Set as an HTML attribute or JavaScript property. type: string.
- boxWidth
Box plot: the box's share of the slot pitch (0 … 1, default 0.6).
- whiskerRule
Box plot:
tukey(1.5 × IQR, the default),min-max(no outliers), or a number of IQRs. - quantileMethod
Box plot (): the quantile method —
linear(R-7, the default),exclusive(R-6),nearest,lower,higher,midpoint. - whiskerPercentile
Box plot (): the
percentilewhisker rule's p (0 … 50, default 5). - notched
Box plot (): the stepped notch (median ± 1.57 × IQR / √n).
- showMean
Box plot (): the mean marker — a small square in
mean-color(auto= the median colour). - meanColor
Set as an HTML attribute or JavaScript property. type: string.
- capWidth
Box plot (): The whisker caps' share of the box (0 hides them).
- whiskerWidth
Box plot (): The whisker / border thickness in CSS px.
- medianWidth
Box plot (): The median line thickness in CSS px.
- outlierRadius
Box plot (): The outlier disc radius in CSS px.
- boxMinPx
Box plot (): The narrowest box in CSS px.
- boxMaxPx
Box plot (): The widest box in CSS px.
- notchWidth
Box plot (): The notch's share of the box width (notched).
- meanSize
Box plot (): The mean marker size in CSS px (show-mean).
- minRadius
The radius range in CSS px the z range maps onto.
- maxRadius
Set as an HTML attribute or JavaScript property. type: number.
- sizeScale
area(the disc area proportional to z; the default) orradius. - layout
Bubble:
xyorpack. Network Graph: deterministiccircular,force, or top-to-bottomhierarchicalplacement. - clustering
Network Graph:
noneorlouvaincommunity detection over the current graph; with the automatic palette, node colours follow the group. Independent oflayout. - bundling
Network Graph:
noneorforceedge bundling of the connecting lines toward compatible neighbours;bundle-strength0 … 1 scales the attraction (default 0.5). - bundleStrength
Set as an HTML attribute or JavaScript property. type: number.
- nodeDrag
Network Graph — nodes can be dragged with a pointer and nudged with Ctrl / ⌘ + arrows; a dragged node stays pinned.
node-drag="false"turns it off. - packPadding
Bubble pack gap in CSS px, and
contain(shrink only) orfillfitting. - packFit
Set as an HTML attribute or JavaScript property. type: string.
- shading
the bubble shading:
flatorsphere(a highlight and a darker rim), and its strength 0 … 1. - shadeStrength
Set as an HTML attribute or JavaScript property. type: number.
- totalColor
Waterfall: the subtotal / total bars' colour, the connectors' colour and thickness, their switch.
- connectorColor
Set as an HTML attribute or JavaScript property. type: string.
- connectorWidth
Set as an HTML attribute or JavaScript property. type: number.
- showConnectors
Set as an HTML attribute or JavaScript property. type: boolean.
- barWidth
Waterfall: the bar's share of the slot pitch (0.6), clamped between bar-min-px and bar-max-px.
- barMinPx
Set as an HTML attribute or JavaScript property. type: number.
- barMaxPx
Set as an HTML attribute or JavaScript property. type: number.
- showTotal
Waterfall (): append the auto grand total after the last step (unless it already is a total), named
total-label. - totalLabel
Set as an HTML attribute or JavaScript property. type: string.
- detectResult
Waterfall: recognise a last step given as a plain value equal to the running total as the result bar (default on).
- lastResult
Waterfall: true makes the last merged step a result using the preceding running total and total-color; false disables auto detection; omitted uses detect-result. Explicit datum kinds remain effective when false.
- nodeRadius
Network Graph: circle marker radius and connection width in CSS px.
- projection
Geo Map: identity keeps the coordinate frame; mercator selects spherical Mercator.
- features
Geo Map: polygon FeatureCollection below the point layer.
- polygonColor
Set as an HTML attribute or JavaScript property. type: string.
- polygonOpacity
Set as an HTML attribute or JavaScript property. type: number.
- mapColorAxis
Geo Map choropleth domain, feature property and palette.
- mapBubble
Value-scaled geographic point bubbles.
- mapHeat
Pass as a JavaScript property. type: GeoMapHeatInput.
- mapLayers
Geo Map presentation masks; omitted layers remain visible.
- mapLegend
Set as an HTML attribute or JavaScript property. type: boolean.
- featureLabels
Geo Map: region/connection name visibility and optional numeric values.
- featureLabelValue
Set as an HTML attribute or JavaScript property. type: boolean.
- featureTooltipFormat
Geo Map: custom region/connection tooltip text from owned feature metadata.
- connectionWidth
Set as an HTML attribute or JavaScript property. type: number.
- connectionColor
Set as an HTML attribute or JavaScript property. type: string.
- connectionOpacity
Set as an HTML attribute or JavaScript property. type: number.
- connectionPath
Geo Map: great-circle arcs or flat-map straight routes; on globes, straight lifts the equirectangular route onto the surface.
- mapRegion
Geo Map: fit a continent in 2D, or face it on an orthographic globe.
- mapBackground
Geo Map: bundled Natural Earth land/coastlines, or no background.
- mapFixed
Geo Map: lock geographic dragging inside the fixed map frame. Flat maps wrap longitude; Albers/Orthographic rotate. Zoom is separate. Default false.
- linkWidth
Set as an HTML attribute or JavaScript property. type: number.
- linkDistance
Network Graph force layout: spring rest distance in CSS px (default 80).
- repulsion
Network Graph force layout: non-negative node repulsion strength (default 2400).
- padAngle
Chord: the gap between neighbouring node arcs in degrees (default 2).
- nodeWidth
The nodes' width and the gap between stacked nodes (CSS px).
- nodePadding
Set as an HTML attribute or JavaScript property. type: number.
- nodeAlign
Where a node without a forward path stands: justify / left / right / center.
- linkColor
The ribbons' colour (source / target / a CSS colour) and opacity.
- linkOpacity
Set as an HTML attribute or JavaScript property. type: number.
- layoutIterations
Sankey relaxation passes (default 6) or Network Graph force steps (default 200). Zero keeps the initial placement.
- linkCurvature
the ribbons' centre line: 0 straight … 1 the full S-curve.
- nodeLabels
the node labels (auto / show / hide) and the throughput suffix.
- nodeLabelValue
Set as an HTML attribute or JavaScript property. type: boolean.
- neighbourDim
with a hovered / focused node, the ribbons touching neither of its ends fade to this alpha factor (1 = no dim).
- showBars
Set as an HTML attribute or JavaScript property. type: boolean.
- showCaps
Set as an HTML attribute or JavaScript property. type: boolean.
- samples
Spectrogram (): raw samples (a property) — the FFT pipeline frames them; ignored while
datais set. - fftSize
Spectrogram (): the FFT size, a power of two (default 1,024).
- fftHop
Spectrogram (): samples between frame starts (default fft-size / 2).
- fftWindow
Spectrogram (): the analysis window —
hann,hamming,blackman,rect. - stemUnit
Stem-leaf: stem unit — one stem spans this much (default 10).
- stemSplit
Stem-leaf: 1 (default) or 2 — each stem splits into 0–4 / 5–9 half-rows.
- activeColor
Stem-leaf: accent for the hovered/focused leaf.
- showKey
Stem-leaf: show the reading key (
2 | 3 = 23) under the plot. - bins
Histogram: bin rule —
square-root(default) /sturges/rice/ literal count. - measure
Histogram (): what a bar's height means — count / percent / density.
- cumulative
Histogram (): running sums (the empirical CDF for density).
- barGap
Histogram (): a CSS-px gap between the bars.
- binWidth
Histogram: explicit bin width — wins over
bins. - domainMin
Histogram: domain overrides (outside observations clamp into the edge bins).
- domainMax
Set as an HTML attribute or JavaScript property. type: number.
- edgeColor
Histogram: 1px separator between gapless bars.
- diameter
Wafer map: wafer diameter in mm.
- edgeExclusion
Wafer map: unusable edge band in mm.
- indicator
Wafer map: orientation-mark kind (
notch/flat/none). - waferOrientation
Wafer map: where the orientation mark points.
- dieWidth
Wafer map: die size in mm.
- dieHeight
Set as an HTML attribute or JavaScript property. type: number.
- scribeX
Wafer map: scribe-street widths in mm.
- scribeY
Set as an HTML attribute or JavaScript property. type: number.
- showPartial
Wafer map: draw edge (partial) dies.
- dieIndexOrigin
Wafer map: die-index convention (
top-leftbounding-box corner /centersigned). - dieIndexBase
Wafer map: first index value (0 or 1).
- showDieIndex
Wafer map: print
ix,iyinside each die (auto-hides on small dies). - mode
Wafer map: colouring mode (
gridaccent /bincategorical bin map). - binColors
Wafer map: explicit per-bin colours (
{ [bin]: colour }, property). - passBin
Wafer map: the pass bin code (default 1).
- passColor
Wafer map: pass-bin fill.
- failColor
Wafer map: fail fill for
mode="binary". - showStats
Wafer map: show the statistics line under the value legend.
- overlay
Wafer map: overlay layer (
none/defect). - defects
Wafer map: inspection defects (
{x, y, class?, size?}, wafer mm, property). - defectColor
Wafer map: dot colour for unclassified defects.
- grid
Wafer map: grid chrome —
die(scribe only) orshot(+ reticle boundaries). - shotCols
Wafer map: dies per exposure shot.
- shotRows
Set as an HTML attribute or JavaScript property. type: number.
- shotOffsetX
Wafer map: shot-grid alignment shift in whole dies.
- shotOffsetY
Set as an HTML attribute or JavaScript property. type: number.
- shotColor
Wafer map: shot boundary stroke.
- binLegend
Wafer map: show the bin legend under the wafer.
- sectorPadding
Polar rose: fraction of each angular slot kept as whitespace, 0..0.8.
- variableRadius
Pie variable-radius mode — each datum's
zdrives the slice's outer radius (Highcharts variablepie). - sizeBy
Variable-radius z→radius mapping:
'area'(default, radius ∝ √z̄) or'radius'(linear). - zMin
Variable-radius z-domain lower bound (defaults to the data minimum).
- zMax
Variable-radius z-domain upper bound (defaults to the data maximum).
- minPointSize
Smallest slice outer DIAMETER — px number or '%' of the full outer diameter (Highcharts minPointSize).
- maxPointSize
Largest slice outer DIAMETER — px number or '%' of the full outer diameter (Highcharts maxPointSize).
- gridShape
Radar grid web shape —
polygon(spider) orcircle. - gridColor
Radar grid ring/spoke stroke colour.
- lineWidth
Radar polygon outline width in px.
- showMarkers
Shows radar vertex markers.
- showRingLabels
Shows labels beside radar rings.
- ringLabelColor
Radar ring label colour.
- ringLabelFontSize
Radar ring label font size in px.
- ringLabelFormat
Radar ring label format string.
- categoryLabelColor
Radar category spoke label colour.
- categoryLabelFontSize
Radar category spoke label font size in px.
- editable
Enables drag-to-edit radar points.
- neckWidth
Funnel neck width as a fraction of the full width (funnel only).
- neckHeight
Funnel neck height as a fraction of the total height (the straight bottom band).
- gap
Vertical gap between funnel/pyramid sections (px).
- showPercent
Show the percentage in funnel/pyramid labels.
- activeSectionIndex
Controlled active funnel/pyramid section index. Negative/undefined falls back to hover/focus.
- lineColor
Cumulative-line colour (pareto only).
- referenceValue
80/20 reference percentage on the cumulative axis (pareto only).
- showReference
Show the pareto reference line.
- referenceColor
Pareto reference-line colour.
- sortDescending
Sort pareto categories by value, largest first. Default true.
- valueAxisLabel
Left value-axis label (pareto).
- cumulativeAxisLabel
Right cumulative-axis label (pareto).
- orientation
Lollipop layout direction:
horizontal(Cleveland, default) orvertical. - lowName
Dumbbell legend label for the low-end markers.
- highName
Dumbbell legend label for the high-end markers.
- lowColor
Dumbbell low-end marker colour.
- highColor
Dumbbell high-end marker colour.
- weights
Variwide column width metric (the 2nd dimension), one per category.
- columnGap
Variwide gap between columns as a fraction of each slot (0..0.45).
- leftValues
Deprecated fallback: prefer
datarows withvalues[0]andvalues[1]. - rightValues
Deprecated fallback: prefer
datarows withvalues[0]andvalues[1]. - leftColor
Tornado left-series bar colour.
- rightColor
Tornado right-series bar colour.
- leftLabel
Tornado left-series label.
- rightLabel
Tornado right-series label.
- showColumnShare
Marimekko: show the per-column total percentage under each column.
- groups
Comparison series = legend labels + colour order (one per value index).
- showRowLines
Dot-plot: draw a faint guide line across each row between its min and max dot.
- value
Gauge primary scalar value.
- min
Set as an HTML attribute or JavaScript property. type: number.
- max
Set as an HTML attribute or JavaScript property. type: number.
- needles
Multi-needle override (dial variant). Property-only.
- rings
Gauge activity-variant rings — each with its own value/max (property-only).
- time
Gauge clock-variant time — 'now' (live) or 'HH:MM(:SS)'.
- showSeconds
Gauge clock-variant second hand.
- variant
Allowed values: solid, dial, activity, vuMeter, speedometer, clock. Default: undefined.
- innerRadius
Solid-variant inner radius. Number = px;
'%'= fraction of outerRadius. - stops
Solid-variant colour stops. Property-only.
- needleShape
Allowed values: needle, arrow, line, wedge. Default: undefined.
- needleLength
Pass as a JavaScript property. type: number | string.
- needleRearLength
Pass as a JavaScript property. type: number | string.
- needleWidth
Set as an HTML attribute or JavaScript property. type: number.
- pivotRadius
Set as an HTML attribute or JavaScript property. type: number.
- pivotColor
Set as an HTML attribute or JavaScript property. type: string.
- plotBands
Gauge plot bands — an array (property), or
'auto'for %-of-max zones. - bandThickness
Set as an HTML attribute or JavaScript property. type: number.
- bandTrackColor
Set as an HTML attribute or JavaScript property. type: string.
- valueDisplay
Allowed values: percent, value. Default: undefined.
- rounded
Set as an HTML attribute or JavaScript property. type: boolean.
- trackColor
Set as an HTML attribute or JavaScript property. type: string.
- showTicks
Set as an HTML attribute or JavaScript property. type: boolean.
- tickInterval
Allowed values: auto. Default: undefined.
- minorTicks
Set as an HTML attribute or JavaScript property. type: number.
- tickLength
Set as an HTML attribute or JavaScript property. type: number.
- minorTickLength
Set as an HTML attribute or JavaScript property. type: number.
- tickWidth
Set as an HTML attribute or JavaScript property. type: number.
- minorTickWidth
Set as an HTML attribute or JavaScript property. type: number.
- tickColor
Set as an HTML attribute or JavaScript property. type: string.
- showTickLabels
Set as an HTML attribute or JavaScript property. type: boolean.
- tickLabelDistance
Set as an HTML attribute or JavaScript property. type: number.
- tickLabelColor
Set as an HTML attribute or JavaScript property. type: string.
- tickLabelFontSize
Set as an HTML attribute or JavaScript property. type: number.
- tickLabelFormat
Set as an HTML attribute or JavaScript property. type: string.
- showValue
Set as an HTML attribute or JavaScript property. type: boolean.
- valueFormat
Set as an HTML attribute or JavaScript property. type: string.
- valueColor
Set as an HTML attribute or JavaScript property. type: string.
- valueFontSize
Set as an HTML attribute or JavaScript property. type: number.
- unit
Set as an HTML attribute or JavaScript property. type: string.
- analogDamping
Gauge
analogneedle settle shaping (forwarded to <sy-gauge-chart>). - analogFrequency
Set as an HTML attribute or JavaScript property. type: number.
- analogOvershootAngle
Set as an HTML attribute or JavaScript property. type: number.