Area.

COMMUNITY

Show trends and magnitude with filled areas.

Live preview28 feature examples

LIVE EXAMPLE

Trends by channel

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 style10
Axes and grid lines11
Legend and interaction15
Title and dimensions3

Show the magnitude and change of two series on a shared time axis. 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-area-chart.js';
  define0();

  const specs = [
    {
      "id": "example-chart",
      "tag": "sy-area-chart",
      "props": {
        "engine": "standard",
        "series": [
          {
            "name": "Online",
            "values": [24, 29, 27, 38, 43, 40],
            "color": "#8263d9"
          },
          {
            "name": "Store",
            "values": [15, 19, 17, 24, 22, 29],
            "color": "#239c91"
          }
        ],
        "xAxis": {
          "kind": "category",
          "categories": ["Jan", "Feb", "Mar", "Apr", "May", "Jun"]
        },
        "yAxis": {
          "kind": "linear",
          "min": 0
        },
        "legend": true,
        "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', 'area 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

#

Use for traffic, revenue, and other measures whose magnitude changes over time.

Overlapping areas may hide series behind them. Provide tooltips and a data table for precise comparisons.

Data contract

PropertyInput format
seriesEach series contains values in chronological order.
xAxisProvide categories with the same length as the series.
yAxisThe value axis that defines the area's baseline.

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-area-chart. Pass objects and arrays as JavaScript properties. Select a name to view usage code and type definitions.

Key properties

Attribute / PropertyType / DefaultDescription
AreaChartSeries[]Default: undefinedEach series contains values in chronological order.
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.
fillOpacitynumberDefault: undefinedSet as an HTML attribute or JavaScript property. type: number.
patternKindAreaChartPatternKindDefault: undefinedAllowed values: dots, diagonal, cross-hatch, diagonal-forward, diagonal-backward, fill. Default: undefined.
patternSizenumberDefault: undefinedSet as an HTML attribute or JavaScript property. type: number.
patternThicknessnumberDefault: undefinedSet as an HTML attribute or JavaScript property. type: number.
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.
animatedbooleanDefault: falseWhether to animate initial display and data changes.
animationDurationnumberDefault: 200Animation duration in milliseconds.
animationEasingAreaChartEasingDefault: 'ease-out'Allowed values: linear, ease-out, ease-in, ease-in-out. Default: 'ease-out'.
animationTypeAreaChartAnimationTypeDefault: undefinedAllowed values: initial, update. Default: undefined.
booleanDefault: falseWhether to show a legend for series or items.
legendPositionAreaChartLegendPositionDefault: 'bottom'Where the legend is positioned.
xAxisCartesianAxisInput | ReadonlyArray<CartesianAxisInput>Default: undefinedProvide categories with the same length as the series.
yAxisCartesianYAxisInputDefault: undefinedThe value axis that defines the area's baseline.
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 29
Attribute / PropertyType / DefaultDescription
activeSeriesIndexnumberDefault: undefinedSet as an HTML attribute or JavaScript property. type: number.
seriesStateAreaChartSeriesStateOptionsDefault: undefinedPass as a JavaScript property. type: AreaChartSeriesStateOptions.
seriesActiveTriggerAreaChartSeriesActiveTriggerDefault: 'hover'Allowed values: hover, click, custom. Default: 'hover'.
AreaChartValuesDefault: new Float32Array(0)Pass as a JavaScript property. type: AreaChartValues.
stringDefault: '#2563eb'Set as an HTML attribute or JavaScript property. type: string.
fillColorstringDefault: undefinedSet as an HTML attribute or JavaScript property. type: string.
fillGradientAreaChartFillGradientDefault: undefinedPass as a JavaScript property. type: AreaChartFillGradient.
fillPatternAreaChartFillPatternDefault: undefinedPass as a JavaScript property. type: AreaChartFillPattern.
patternColorstringDefault: undefinedSet as an HTML attribute or JavaScript property. type: string.
patternBackgroundstringDefault: undefinedSet as an HTML attribute or JavaScript property. type: string.
markerFilterLineChartMarkerFilterDefault: undefinedPass as a JavaScript property. type: LineChartMarkerFilter.
numberDefault: 0Value the area is anchored to (line at `yScale(baseline)`). Always explicit (default `0`) so the rendered start point is never ambiguous.
AreaChartEngineModeDefault: '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.
AreaChartUnavailableBehaviourDefault: 'fallback'Allowed values: fallback, error. Default: 'fallback'.
streamSourceAreaChartStreamSourceDefault: 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.
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 23
EventsDetail typeDescription
AreaChartRenderResult & { tier: AreaChartEngineTier }Emits rendering results in detail when chart drawing completes.
{ 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.
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.
CartesianPointEventDetail | nullCustomEvent.detail type: CartesianPointEventDetail | null. Event names are case-sensitive.
CartesianPointEventDetailA point selection event. Read the selected data and index from CustomEvent.detail.
ChartPointContextMenuEventDetail<CartesianPointEventDetail>CustomEvent.detail type: ChartPointContextMenuEventDetail<CartesianPointEventDetail>. Event names are case-sensitive.
CartesianSeriesOutsideClickEventDetailCustomEvent.detail type: CartesianSeriesOutsideClickEventDetail. Event names are case-sensitive.
AreaChartLegendItemEventDetailCustomEvent.detail type: AreaChartLegendItemEventDetail. Event names are case-sensitive.
AreaChartSeriesToggledEventDetailCustomEvent.detail type: AreaChartSeriesToggledEventDetail. Event names are case-sensitive.
Methods 50

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<AreaChartStreamSource | undefined>An asynchronous method. Check the argument and return types below.
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?: AreaChartEasing; enabled?: boolean; type?: AreaChartAnimationType }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.
Promise<AreaChartRenderResult>An asynchronous method. Check the argument and return types below.
Promise<AreaChartEngineTier>An asynchronous method. Check the argument and return types below.
options: AreaChartSeries, 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<AreaChartSeries>, opts?: { redraw?: boolean }Promise<boolean>An asynchronous method. Check the argument and return types below.
idOrIndex: string | number, data: AreaChartValues, 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.