Line.

COMMUNITY

Read changes over time as lines.

Live preview34 feature examples

LIVE EXAMPLE

Monthly visitors

Match the page theme
Interact with the chart to see selection and range-change results here.
OptionsChanges are reflected in the preview and code.
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
Current preview
<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

PropertyInput format
seriesAn array of series with names, colors, and values. Matching indices represent the same point in time.
xAxisMatch category axis categories to the values order.
yAxisUse 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.

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.

Shared sy-chart API versus direct tags

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 / PropertyType / DefaultDescription
LineChartSeries[]Default: undefinedAn array of series with names, colors, and values. Matching indices represent the same point in time.
numberDefault: 600Chart width in pixels. Update with ResizeObserver when the container changes.
numberDefault: 300Chart height in pixels.
brandLogostringDefault: undefinedThe 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: 1Set as an HTML attribute or JavaScript property. type: number.
LineChartMarkerDefault: 'none'Allowed values: none, circle, square, triangle, cross, diamond, star. Default: 'none'.
markerSizenumberDefault: 4Set as an HTML attribute or JavaScript property. type: number.
connectNullsbooleanDefault: falseSet as an HTML attribute or JavaScript property. type: boolean.
LineChartSmoothDefault: 'none'Allowed values: none, monotone, cardinal. Default: 'none'.
smoothTensionnumberDefault: 0.5Set as an HTML attribute or JavaScript property. type: number.
LineChartStepDefault: 'none'Allowed values: none, left, right, center. Default: 'none'.
animatedbooleanDefault: falseWhether to animate initial display and data changes.
animationDurationnumberDefault: 200Animation duration in milliseconds.
animationEasingLineChartEasingDefault: 'ease-out'Allowed values: linear, ease-out, ease-in, ease-in-out. Default: 'ease-out'.
animationTypeLineChartAnimationTypeDefault: undefinedAllowed values: initial, update. Default: undefined.
booleanDefault: falseWhether to show a legend for series or items.
legendPositionLineChartLegendPositionDefault: 'bottom'Where the legend is positioned.
xAxisCartesianAxisInput | ReadonlyArray<CartesianAxisInput>Default: undefinedMatch category axis categories to the values order.
yAxisCartesianYAxisInputDefault: undefinedUse consistent units and ranges for values being compared.
chartTitlestringDefault: undefinedThe title inside the chart. Explain the data's unit and meaning alongside it.
chartSubtitlestringDefault: undefinedThe subtitle inside the chart.
CartesianTooltipInputDefault: undefinedTooltip settings for pointer-driven values, position, and content.
CartesianCrosshairInputDefault: undefinedPass as a JavaScript property. type: CartesianCrosshairInput.
gridLinesCartesianGridLinesInputDefault: undefinedAllowed values: auto, off. Default: undefined.
CartesianZoomInputDefault: undefinedSettings for zooming and the visible range.
Other properties 30
Attribute / PropertyType / DefaultDescription
activeSeriesIndexnumberDefault: undefinedSet as an HTML attribute or JavaScript property. type: number.
seriesStateLineChartSeriesStateOptionsDefault: undefinedPass 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.
markerFilterLineChartMarkerFilterDefault: undefinedPass as a JavaScript property. type: LineChartMarkerFilter.
markerClickablebooleanDefault: trueSet as an HTML attribute or JavaScript property. type: boolean.
markerActiveTriggerLineChartMarkerActiveTriggerDefault: 'hover'Allowed values: hover, click, custom. Default: 'hover'.
seriesActiveTriggerLineChartMarkerActiveTriggerDefault: undefinedAllowed values: hover, click, custom. Default: undefined.
lineDashnumber[]Default: []Pass as a JavaScript property. type: number[].
numberDefault: 0Reference 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.
proThresholdnumberDefault: 100_000Set as an HTML attribute or JavaScript property. type: number.
LineChartUnavailableBehaviourDefault: 'fallback'Allowed values: fallback, error. Default: 'fallback'.
streamSourceLineChartStreamSourceDefault: undefinedA stream source for live data. Check the contract for the specific type.
streamWindownumberDefault: undefinedThe streaming data range to keep visible.
streamMaxnumberDefault: undefinedThe maximum number of streaming data points to retain.
frameBudgetnumberDefault: undefinedSet as an HTML attribute or JavaScript property. type: number.
streamWindowMsnumberDefault: undefinedSet as an HTML attribute or JavaScript property. type: number.
streamTimestamps'on' | 'off'Default: undefinedAllowed values: off, on. Default: undefined.
legendItemsLegendItem[]Default: undefinedPass as a JavaScript property. type: LegendItem[].
seriesNamestringDefault: undefinedSet 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'.
legendDraggablebooleanDefault: falseSet as an HTML attribute or JavaScript property. type: boolean.
CartesianBrushInputDefault: undefinedAllowed values: auto, off, true, false, rect, lasso. Default: undefined.
ChartDrawingsInputDefault: undefinedPass as a JavaScript property. type: ChartDrawingsInput.
drawingModeDrawingModeInputDefault: undefinedAllowed values: none, off, true, false, draw, select. Default: undefined.
drawingToolstringDefault: undefinedSet as an HTML attribute or JavaScript property. type: string.
drawingSpaceDrawingSpaceDefault: undefinedAllowed values: data, pixel. Default: undefined.
visualMapVisualMapBinding | nullDefault: undefinedPass as a JavaScript property. type: VisualMapBinding | null.
Events 25
EventsDetail typeDescription
LineChartRenderResult & { tier: LineChartEngineTier; budget?: LineChartFrameBudgetInfo; stream?: LineChartStreamFrameInfo }Emits rendering results in detail when chart drawing completes.
LineChartFrameBudgetEventDetailCustomEvent.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.
voidCustomEvent.detail type: void. Event names are case-sensitive.
voidCustomEvent.detail type: void. Event names are case-sensitive.
voidCustomEvent.detail type: void. Event names are case-sensitive.
LineChartPointEventDetail | nullCustomEvent.detail type: LineChartPointEventDetail | null. Event names are case-sensitive.
LineChartPointEventDetailA 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.
CartesianSeriesOutsideClickEventDetailCustomEvent.detail type: CartesianSeriesOutsideClickEventDetail. Event names are case-sensitive.
LineChartLegendItemEventDetailCustomEvent.detail type: LineChartLegendItemEventDetail. Event names are case-sensitive.
LineChartSeriesToggledEventDetailCustomEvent.detail type: LineChartSeriesToggledEventDetail. Event names are case-sensitive.
CartesianCrosshairEventDetail | nullCustomEvent.detail type: CartesianCrosshairEventDetail | null. Event names are case-sensitive.
CartesianTooltipEventDetailWhether to display the built-in tooltip.
voidCustomEvent.detail type: void. Event names are case-sensitive.
CartesianTooltipActionEventDetailCustomEvent.detail type: CartesianTooltipActionEventDetail. Event names are case-sensitive.
CartesianZoomChangeEventDetailCustomEvent.detail type: CartesianZoomChangeEventDetail. Event names are case-sensitive.
CartesianBrushChangeEventDetailCustomEvent.detail type: CartesianBrushChangeEventDetail. Event names are case-sensitive.
CartesianBrushStartEventDetailCustomEvent.detail type: CartesianBrushStartEventDetail. Event names are case-sensitive.
CartesianBrushMoveEventDetailCustomEvent.detail type: CartesianBrushMoveEventDetail. Event names are case-sensitive.
CartesianBrushEndEventDetailCustomEvent.detail type: CartesianBrushEndEventDetail. Event names are case-sensitive.
DrawingsChangeEventDetailCustomEvent.detail type: DrawingsChangeEventDetail. Event names are case-sensitive.
DrawingSelectionChangeEventDetailCustomEvent.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 / ArgumentsReturn typeDescription
value: numberPromise<void>An asynchronous method. Check the argument and return types below.
values: ReadonlyArray<number> | Float32ArrayPromise<void>An asynchronous method. Check the argument and return types below.
count: numberPromise<void>An asynchronous method. Check the argument and return types below.
values: ReadonlyArray<number> | Float32ArrayPromise<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: numberPromise<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: CartesianZoomRequestPromise<CartesianZoomChangeEventDetail | null>An asynchronous method. Check the argument and return types below.
factor: number, anchorFraction?: numberPromise<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?: CartesianZoomExtentRequestPromise<CartesianZoomExtentDetail | null>An asynchronous method. Check the argument and return types below.
request: CartesianCrosshairShowRequestPromise<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> | nullPromise<DrawingsChangeEventDetail | null>An asynchronous method. Check the argument and return types below.
drawing: ChartDrawingInputPromise<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: stringPromise<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: DrawingSpacePromise<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: ChartDrawingsInputPromise<DrawingsChangeEventDetail | null>An asynchronous method. Check the argument and return types below.
ids: ReadonlyArray<string> | nullPromise<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> | nullPromise<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 | nullPromise<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?: VisualMapExtentRequestPromise<VisualMapExtent | null>The extent of a dimension over the visible points — what a bound `sy-visual-map` adopts as its domain.
clientX: number, clientY: numberPromise<LineChartPointEventDetail | null>An asynchronous method. Check the argument and return types below.
clientX: number, clientY: numberPromise<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.