Line.
COMMUNITYRead changes over time as lines.
LIVE EXAMPLE
Monthly visitors
Appearance and style9
Axes and grid lines11
Legend and interaction15
Title and dimensions3
Compare monthly visitor trends across three channels. All values are sample data. All values are sample data.
View code
<div id="chart-container" style="width: 100%; min-width: 0;"></div>
<script type="module">
import { defineCustomElement as define0 } from '@syidax/advanced/components/sy-line-chart.js';
define0();
const specs = [
{
"id": "example-chart",
"tag": "sy-line-chart",
"props": {
"engine": "standard",
"series": [
{
"name": "Organic",
"color": "#8263d9",
"values": [24, 29, 27, 38, 43, 40, 52, 58, 53, 68, 76, 84]
},
{
"name": "Direct",
"color": "#239c91",
"values": [15, 19, 17, 24, 22, 29, 32, 30, 39, 42, 40, 51]
},
{
"name": "Referral",
"color": "#e99954",
"values": [8, 11, 9, 15, 13, 19, 17, 23, 22, 28, 25, 33]
}
],
"xAxis": {
"kind": "category",
"categories": ["Jan", "Feb", "Mar", "Apr", "May", "Jun", "Jul", "Aug", "Sep", "Oct", "Nov", "Dec"]
},
"yAxis": {
"kind": "linear",
"min": 0
},
"smooth": "none",
"thickness": 2.5,
"marker": "circle",
"markerSize": 4,
"legend": true,
"tooltip": {
"show": true,
"mode": "shared"
},
"width": 640,
"height": 360,
"brandPosition": "bottom-right",
"brandLogo": ""
}
}
];
const container = document.querySelector('#chart-container');
const elements = specs.map(({ tag, id, props }) => {
const element = document.createElement(tag);
element.id = id;
Object.assign(element, props);
element.setAttribute('aria-label', 'line example chart');
return element;
});
container.replaceChildren(...elements);
const chart = elements.at(-1);
const onEvent = event => {
console.log('pointClick', event.detail);
};
chart.addEventListener('pointClick', onEvent);
const observer = new ResizeObserver(([entry]) => {
const width = Math.max(160, Math.floor(entry.contentRect.width));
elements.forEach(element => { element.width = width; });
});
observer.observe(container);
// In an SPA, call this function when the view is disposed.
function disposeChart() {
observer.disconnect();
chart.removeEventListener('pointClick', onEvent);
container.replaceChildren();
}
</script>Usage and data
#Compare trends and differences between series with dates or an ordered sequence.
Use Column or Bar to compare unrelated categories. Distinguish interpolated curves from actual measurements.
Data contract
| Property | Input format |
|---|---|
series | An array of series with names, colors, and values. Matching indices represent the same point in time. |
xAxis | Match category axis categories to the values order. |
yAxis | Use consistent units and ranges for values being compared. |
Updating data
Assign a new array or object to the property instead of mutating values inside an array. Chart events provide selection results through event.detail. When disposing of the view, clean up ResizeObserver and event listeners registered by your app.
Feature examples
#Try 34 interactive feature examples and inspect their code. Select “Edit in preview” to combine more options in the settings panel above.
Smooth curve
Connect points smoothly with monotone interpolation.
Create a line chart with the website sample sample-1 (Monthly visitors). - smooth: "monotone"
View code
Step changes
Represent values that remain constant until the next time point.
Create a line chart with the website sample sample-1 (Monthly visitors). - marker: default - step: "left"
View code
Dashed lines and markers
Combine an 8–4 dash pattern with circular markers.
Create a line chart with the website sample sample-1 (Monthly visitors). - markerSize: 6 - lineDash: [8, 4]
View code
Click to highlight a series
Click a marker to keep its series highlighted. Click an empty area to clear it. The result below shows the clicked point's value.
Create a line chart with the website sample sample-1 (Monthly visitors). - marker: "diamond" - markerSize: 7 - markerActiveTrigger: "click" - seriesState: {enabled: true, inactive: {opacity: 0.2}}
View code
Connect missing values
Connect across missing measurements to show the overall trend.
Create a line chart with these properties. - engine: "standard" - xAxis: {kind: "category", categories: ["Jan", "Feb", "Mar", "Apr", "May", "Jun", "July", "August", "September", "October", "November", "December"]} - yAxis: {kind: "linear", min: 0} - thickness: 2.5 - marker: "circle" - tooltip: {show: true, mode: "shared"} - values: [18, 34, null, 52, 42, null, 58, 86, 68, 94, null, 76] - color: "#8263d9" - connectNulls: true
View code
Logarithmic axis
Compare values from 1 to 1,000 on a logarithmic scale.
Create a line chart with these properties. - engine: "standard" - xAxis: {kind: "category", categories: ["Jan", "Feb", "Mar", "Apr", "May", "Jun", "July", "August", "September", "October", "November", "December"]} - yAxis: {kind: "log", min: 1, max: 1000} - thickness: 2.5 - marker: "circle" - tooltip: {show: true, mode: "shared"} - values: [1, 3, 8, 14, 31, 68, 120, 260, 430, 690, 880, 1000] - color: "#8263d9"
View code
Control series visibility
Use buttons to hide or show the second series.
Create a line chart with the website sample sample-1 (Monthly visitors). Add buttons: "Hide second series" → hideSeries(1), "Show second series" → showSeries(1)
View code
Right-side legend
Place the legend on the right. Click items to hide or show series.
Create a line chart with the website sample sample-1 (Monthly visitors). - legendPosition: "right"
View code
Inspect values with the pointer
Point to data to view the value at that location.
Create a line chart with the website sample sample-1 (Monthly visitors).
View code
Crosshair tracking
Move the pointer to read horizontal and vertical coordinates alongside values.
Create a line chart with the website sample sample-1 (Monthly visitors). - crosshair: {show: true, mode: "cross", snap: "nearest"}
View code
Drag to zoom and pan
Drag to zoom and hold Shift to pan. Use Ctrl + wheel to zoom in or out.
Create a line chart with the website sample sample-1 (Monthly visitors). - zoom: {enabled: true, mode: "xy", drag: true, pan: "shift", wheel: "ctrl", pinch: true, resetButton: true} Add buttons: "Zoom in" → zoomBy(0.5), "Zoom out" → zoomBy(2), "View all" → resetZoom()
View code
Replay animation
Redraw the same example to inspect its initial display animation.
Create a line chart with the website sample sample-1 (Monthly visitors). - animated: true - animationDuration: 900 Add buttons: "Replay" → redraw
View code
Animation
Compare 1 examples of Animation. Buttons and options update both the live result and source code.
View code
Axis
Compare 10 examples of Axis. Buttons and options update both the live result and source code.
View code
Connect Nulls
Compare 1 examples of Connect Nulls. Buttons and options update both the live result and source code.
View code
Crosshair
Compare 5 examples of Crosshair. Buttons and options update both the live result and source code.
View code
Engine Compare
Compare 2 examples of Engine Compare. Buttons and options update both the live result and source code.
View code
Legend
Compare 3 examples of Legend. Buttons and options update both the live result and source code.
View code
Line Dash
Compare 4 examples of Line Dash. Buttons and options update both the live result and source code.
View code
Marker
Compare 6 examples of Marker. Buttons and options update both the live result and source code.
View code
Large datasets
Compare 1 examples of Large datasets. Buttons and options update both the live result and source code.
View code
Series
Compare 12 examples of Series. Buttons and options update both the live result and source code.
View code
Size
Compare 1 examples of Size. Buttons and options update both the live result and source code.
View code
Smooth
Compare 1 examples of Smooth. Buttons and options update both the live result and source code.
View code
Step
Compare 1 examples of Step. Buttons and options update both the live result and source code.
View code
Tooltip
Compare 12 examples of Tooltip. Buttons and options update both the live result and source code.
View code
Data input
Compare 1 examples of Data input. Buttons and options update both the live result and source code.
View code
Zoom and pan
Compare 6 examples of Zoom and pan. Buttons and options update both the live result and source code.
View code
Context menu
Compare 1 examples of Context menu. Buttons and options update both the live result and source code.
View code
Data context menu
Compare 1 examples of Data context menu. Buttons and options update both the live result and source code.
View code
Overview
Compare 1 examples of Overview. Buttons and options update both the live result and source code.
View code
Streaming · Live updatesPRO
Select Start to add one data point at a time. The latest 40 items are shown, with controls for update speed, pause, and reset.
View code
Streaming · Add batchesPRO
Select Start to add four data points at a time. The latest 40 items are shown, with controls for update speed, pause, and reset.
View code
Streaming · Add and update live dataPRO
Compare 2 examples of Add and update live data. Buttons and options update both the live result and source code.
View code
Add to your interface
#The code tabs below the preview contain the full data, options, event bindings, and responsive sizing for the current example. Copy them into an app project, such as Vite, that can resolve the installed packages.
API reference
#The full public API for sy-line-chart. Pass objects and arrays as JavaScript properties. Select a name to view usage code and type definitions.
Key properties
| Attribute / Property | Type / Default | Description |
|---|---|---|
LineChartSeries[]Default: undefined | An array of series with names, colors, and values. Matching indices represent the same point in time. | |
numberDefault: 600 | Chart width in pixels. Update with ResizeObserver when the container changes. | |
numberDefault: 300 | Chart height in pixels. | |
| brandLogo | stringDefault: undefined | The default is the Syidax logo. With the Pro chart.branding entitlement, use none or a PNG, JPEG, or WebP data URL. |
| brandPosition | 'top-left' | 'top-right' | 'bottom-left' | 'bottom-right'Default: 'bottom-right' | The corner where the logo is anchored. Applies equally to Community and Pro, on screen and in image exports. |
numberDefault: 1 | Set as an HTML attribute or JavaScript property. type: number. | |
LineChartMarkerDefault: 'none' | Allowed values: none, circle, square, triangle, cross, diamond, star. Default: 'none'. | |
| markerSize | numberDefault: 4 | Set as an HTML attribute or JavaScript property. type: number. |
| connectNulls | booleanDefault: false | Set as an HTML attribute or JavaScript property. type: boolean. |
LineChartSmoothDefault: 'none' | Allowed values: none, monotone, cardinal. Default: 'none'. | |
| smoothTension | numberDefault: 0.5 | Set as an HTML attribute or JavaScript property. type: number. |
LineChartStepDefault: 'none' | Allowed values: none, left, right, center. Default: 'none'. | |
| animated | booleanDefault: false | Whether to animate initial display and data changes. |
| animationDuration | numberDefault: 200 | Animation duration in milliseconds. |
| animationEasing | LineChartEasingDefault: 'ease-out' | Allowed values: linear, ease-out, ease-in, ease-in-out. Default: 'ease-out'. |
| animationType | LineChartAnimationTypeDefault: undefined | Allowed values: initial, update. Default: undefined. |
booleanDefault: false | Whether to show a legend for series or items. | |
| legendPosition | LineChartLegendPositionDefault: 'bottom' | Where the legend is positioned. |
| xAxis | CartesianAxisInput | ReadonlyArray<CartesianAxisInput>Default: undefined | Match category axis categories to the values order. |
| yAxis | CartesianYAxisInputDefault: undefined | Use consistent units and ranges for values being compared. |
| chartTitle | stringDefault: undefined | The title inside the chart. Explain the data's unit and meaning alongside it. |
| chartSubtitle | stringDefault: undefined | The subtitle inside the chart. |
CartesianTooltipInputDefault: undefined | Tooltip settings for pointer-driven values, position, and content. | |
CartesianCrosshairInputDefault: undefined | Pass as a JavaScript property. type: CartesianCrosshairInput. | |
| gridLines | CartesianGridLinesInputDefault: undefined | Allowed values: auto, off. Default: undefined. |
CartesianZoomInputDefault: undefined | Settings for zooming and the visible range. |
Other properties 30
| Attribute / Property | Type / Default | Description |
|---|---|---|
| activeSeriesIndex | numberDefault: undefined | Set as an HTML attribute or JavaScript property. type: number. |
| seriesState | LineChartSeriesStateOptionsDefault: undefined | Pass as a JavaScript property. type: LineChartSeriesStateOptions. |
LineChartValuesDefault: new Float32Array(0) | Pass as a JavaScript property. type: LineChartValues. | |
stringDefault: '#2563eb' | Set as an HTML attribute or JavaScript property. type: string. | |
| markerFilter | LineChartMarkerFilterDefault: undefined | Pass as a JavaScript property. type: LineChartMarkerFilter. |
| markerClickable | booleanDefault: true | Set as an HTML attribute or JavaScript property. type: boolean. |
| markerActiveTrigger | LineChartMarkerActiveTriggerDefault: 'hover' | Allowed values: hover, click, custom. Default: 'hover'. |
| seriesActiveTrigger | LineChartMarkerActiveTriggerDefault: undefined | Allowed values: hover, click, custom. Default: undefined. |
| lineDash | number[]Default: [] | Pass as a JavaScript property. type: number[]. |
numberDefault: 0 | Reference value on the y-axis. Lines do not grow from the baseline, but the baseline remains visible as a value-axis tick and marker so threshold comparisons stay explicit across all cartesian chart families. | |
LineChartEngineModeDefault: 'auto' | Renderer selection: auto, standard, or pro. Engine selection is separate from permission to use a Pro chart type. | |
| proThreshold | numberDefault: 100_000 | Set as an HTML attribute or JavaScript property. type: number. |
LineChartUnavailableBehaviourDefault: 'fallback' | Allowed values: fallback, error. Default: 'fallback'. | |
| streamSource | LineChartStreamSourceDefault: undefined | A stream source for live data. Check the contract for the specific type. |
| streamWindow | numberDefault: undefined | The streaming data range to keep visible. |
| streamMax | numberDefault: undefined | The maximum number of streaming data points to retain. |
| frameBudget | numberDefault: undefined | Set as an HTML attribute or JavaScript property. type: number. |
| streamWindowMs | numberDefault: undefined | Set as an HTML attribute or JavaScript property. type: number. |
| streamTimestamps | 'on' | 'off'Default: undefined | Allowed values: off, on. Default: undefined. |
| legendItems | LegendItem[]Default: undefined | Pass as a JavaScript property. type: LegendItem[]. |
| seriesName | stringDefault: undefined | Set as an HTML attribute or JavaScript property. type: string. |
| legendFloatAlign | 'start' | 'center' | 'end'Default: 'end' | Allowed values: start, center, end. Default: 'end'. |
| legendFloatVerticalAlign | 'top' | 'middle' | 'bottom'Default: 'top' | Allowed values: top, bottom, middle. Default: 'top'. |
| legendDraggable | booleanDefault: false | Set as an HTML attribute or JavaScript property. type: boolean. |
CartesianBrushInputDefault: undefined | Allowed values: auto, off, true, false, rect, lasso. Default: undefined. | |
ChartDrawingsInputDefault: undefined | Pass as a JavaScript property. type: ChartDrawingsInput. | |
| drawingMode | DrawingModeInputDefault: undefined | Allowed values: none, off, true, false, draw, select. Default: undefined. |
| drawingTool | stringDefault: undefined | Set as an HTML attribute or JavaScript property. type: string. |
| drawingSpace | DrawingSpaceDefault: undefined | Allowed values: data, pixel. Default: undefined. |
| visualMap | VisualMapBinding | nullDefault: undefined | Pass as a JavaScript property. type: VisualMapBinding | null. |
Events 25
| Events | Detail type | Description |
|---|---|---|
LineChartRenderResult & { tier: LineChartEngineTier; budget?: LineChartFrameBudgetInfo; stream?: LineChartStreamFrameInfo } | Emits rendering results in detail when chart drawing completes. | |
LineChartFrameBudgetEventDetail | CustomEvent.detail type: LineChartFrameBudgetEventDetail. Event names are case-sensitive. | |
{ count: number } | CustomEvent.detail type: { count: number }. Event names are case-sensitive. | |
{ dropped: number } | CustomEvent.detail type: { dropped: number }. Event names are case-sensitive. | |
void | CustomEvent.detail type: void. Event names are case-sensitive. | |
void | CustomEvent.detail type: void. Event names are case-sensitive. | |
void | CustomEvent.detail type: void. Event names are case-sensitive. | |
LineChartPointEventDetail | null | CustomEvent.detail type: LineChartPointEventDetail | null. Event names are case-sensitive. | |
LineChartPointEventDetail | A point selection event. Read the selected data and index from CustomEvent.detail. | |
ChartPointContextMenuEventDetail<LineChartPointEventDetail> | CustomEvent.detail type: ChartPointContextMenuEventDetail<LineChartPointEventDetail>. Event names are case-sensitive. | |
{ cssX: number; cssY: number } | CustomEvent.detail type: { cssX: number; cssY: number }. Event names are case-sensitive. | |
CartesianSeriesOutsideClickEventDetail | CustomEvent.detail type: CartesianSeriesOutsideClickEventDetail. Event names are case-sensitive. | |
LineChartLegendItemEventDetail | CustomEvent.detail type: LineChartLegendItemEventDetail. Event names are case-sensitive. | |
LineChartSeriesToggledEventDetail | CustomEvent.detail type: LineChartSeriesToggledEventDetail. Event names are case-sensitive. | |
CartesianCrosshairEventDetail | null | CustomEvent.detail type: CartesianCrosshairEventDetail | null. Event names are case-sensitive. | |
CartesianTooltipEventDetail | Whether to display the built-in tooltip. | |
void | CustomEvent.detail type: void. Event names are case-sensitive. | |
CartesianTooltipActionEventDetail | CustomEvent.detail type: CartesianTooltipActionEventDetail. Event names are case-sensitive. | |
CartesianZoomChangeEventDetail | CustomEvent.detail type: CartesianZoomChangeEventDetail. Event names are case-sensitive. | |
CartesianBrushChangeEventDetail | CustomEvent.detail type: CartesianBrushChangeEventDetail. Event names are case-sensitive. | |
CartesianBrushStartEventDetail | CustomEvent.detail type: CartesianBrushStartEventDetail. Event names are case-sensitive. | |
CartesianBrushMoveEventDetail | CustomEvent.detail type: CartesianBrushMoveEventDetail. Event names are case-sensitive. | |
CartesianBrushEndEventDetail | CustomEvent.detail type: CartesianBrushEndEventDetail. Event names are case-sensitive. | |
DrawingsChangeEventDetail | CustomEvent.detail type: DrawingsChangeEventDetail. Event names are case-sensitive. | |
DrawingSelectionChangeEventDetail | CustomEvent.detail type: DrawingSelectionChangeEventDetail. Event names are case-sensitive. |
Methods 52
Stencil methods return Promises. Use await within an async function to read the result.
| Method / Arguments | Return type | Description |
|---|---|---|
| value: number | Promise<void> | An asynchronous method. Check the argument and return types below. |
| values: ReadonlyArray<number> | Float32Array | Promise<void> | An asynchronous method. Check the argument and return types below. |
| count: number | Promise<void> | An asynchronous method. Check the argument and return types below. |
| values: ReadonlyArray<number> | Float32Array | Promise<void> | An asynchronous method. Check the argument and return types below. |
Promise<LineChartStreamSource | undefined> | The stream session's source (a Chart Pro feature): like the stream methods it waits for a license still being confirmed. | |
Promise<ChartEngineStatus> | The requested engine, the engine that draws and why (ROADMAP-loading §5.3). A Chart Pro license decision names `chart.webgpu` and its state; renderer causes (not in this build, no WebGPU, a failed GPU) stay apart. | |
| options: { duration?: number; easing?: LineChartEasing; enabled?: boolean; type?: LineChartAnimationType } | Promise<void> | An asynchronous method. Check the argument and return types below. |
Promise<void> | An asynchronous method. Check the argument and return types below. | |
Promise<void> | An asynchronous method. Check the argument and return types below. | |
| pointIndex: number | Promise<CartesianTooltipEventDetail | null> | An asynchronous method. Check the argument and return types below. |
Promise<void> | An asynchronous method. Check the argument and return types below. | |
| request: CartesianZoomRequest | Promise<CartesianZoomChangeEventDetail | null> | An asynchronous method. Check the argument and return types below. |
| factor: number, anchorFraction?: number | Promise<CartesianZoomChangeEventDetail | null> | An asynchronous method. Check the argument and return types below. |
| delta: { x?: number; y?: number } | Promise<CartesianZoomChangeEventDetail | null> | An asynchronous method. Check the argument and return types below. |
Promise<CartesianZoomChangeEventDetail | null> | An asynchronous method. Check the argument and return types below. | |
Promise<CartesianZoomState | null> | An asynchronous method. Check the argument and return types below. | |
| request?: CartesianZoomExtentRequest | Promise<CartesianZoomExtentDetail | null> | An asynchronous method. Check the argument and return types below. |
| request: CartesianCrosshairShowRequest | Promise<boolean> | An asynchronous method. Check the argument and return types below. |
Promise<void> | An asynchronous method. Check the argument and return types below. | |
Promise<ChartDrawing[]> | An asynchronous method. Check the argument and return types below. | |
| drawings: ReadonlyArray<ChartDrawingInput> | null | Promise<DrawingsChangeEventDetail | null> | An asynchronous method. Check the argument and return types below. |
| drawing: ChartDrawingInput | Promise<ChartDrawing | null> | An asynchronous method. Check the argument and return types below. |
| id: string, patch: Partial<Omit<ChartDrawing, 'id'>> | Promise<ChartDrawing | null> | An asynchronous method. Check the argument and return types below. |
| id: string | Promise<boolean> | An asynchronous method. Check the argument and return types below. |
| ids: ReadonlyArray<string> | Promise<DrawingsChangeEventDetail | null> | An asynchronous method. Check the argument and return types below. |
| id: string, space: DrawingSpace | Promise<ChartDrawing | null> | An asynchronous method. Check the argument and return types below. |
Promise<DrawingsChangeEventDetail | null> | An asynchronous method. Check the argument and return types below. | |
Promise<DrawingsChangeEventDetail | null> | An asynchronous method. Check the argument and return types below. | |
Promise<DrawingsChangeEventDetail | null> | An asynchronous method. Check the argument and return types below. | |
Promise<DrawingLayerSnapshot | null> | An asynchronous method. Check the argument and return types below. | |
Promise<string> | An asynchronous method. Check the argument and return types below. | |
| input: ChartDrawingsInput | Promise<DrawingsChangeEventDetail | null> | An asynchronous method. Check the argument and return types below. |
| ids: ReadonlyArray<string> | null | Promise<DrawingSelectionChangeEventDetail | null> | An asynchronous method. Check the argument and return types below. |
Promise<string[]> | An asynchronous method. Check the argument and return types below. | |
| areas: ReadonlyArray<CartesianBrushAreaInput> | null | Promise<CartesianBrushChangeEventDetail | null> | An asynchronous method. Check the argument and return types below. |
Promise<CartesianBrushChangeEventDetail | null> | An asynchronous method. Check the argument and return types below. | |
Promise<CartesianBrushArea[]> | An asynchronous method. Check the argument and return types below. | |
Promise<CartesianBrushSelectedSeries[]> | An asynchronous method. Check the argument and return types below. | |
| binding: VisualMapBinding | null | Promise<VisualMapBinding | null> | Bind (or clear) a visual map: every mark is coloured through it on the next paint. |
Promise<VisualMapBinding | null> | An asynchronous method. Check the argument and return types below. | |
| request?: VisualMapExtentRequest | Promise<VisualMapExtent | null> | The extent of a dimension over the visible points — what a bound `sy-visual-map` adopts as its domain. |
| clientX: number, clientY: number | Promise<LineChartPointEventDetail | null> | An asynchronous method. Check the argument and return types below. |
| clientX: number, clientY: number | Promise<LineChartPointEventDetail[]> | An asynchronous method. Check the argument and return types below. |
Promise<LineChartRenderResult> | An asynchronous method. Check the argument and return types below. | |
Promise<LineChartEngineTier> | An asynchronous method. Check the argument and return types below. | |
| options: LineChartSeries, opts?: { redraw?: boolean; insertAt?: number } | Promise<number> | An asynchronous method. Check the argument and return types below. |
| idOrIndex: string | number, opts?: { redraw?: boolean } | Promise<boolean> | An asynchronous method. Check the argument and return types below. |
| idOrIndex: string | number, patch: Partial<LineChartSeries>, opts?: { redraw?: boolean } | Promise<boolean> | An asynchronous method. Check the argument and return types below. |
| idOrIndex: string | number, data: LineChartValues, opts?: { redraw?: boolean } | Promise<boolean> | An asynchronous method. Check the argument and return types below. |
| idOrIndex: string | number, point: number, opts?: { shift?: boolean; redraw?: boolean } | Promise<boolean> | An asynchronous method. Check the argument and return types below. |
| idOrIndex: string | number, opts?: { redraw?: boolean } | Promise<boolean> | An asynchronous method. Check the argument and return types below. |
| idOrIndex: string | number, opts?: { redraw?: boolean } | Promise<boolean> | An asynchronous method. Check the argument and return types below. |
No matching APIs.