Chord.

PRO

Show connection volumes between groups as ribbons inside a circle.

Live preview23 feature examples

LIVE EXAMPLE

Movement between regions

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 style5
Legend and interaction11
Title and dimensions3

Show groups around a circle and movement between them. 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-pro/components/sy-chord.js';
  define0();

  // Pro: complete registerLicense at app startup using your issued certificate.
  // The website preview certificate is not for use in customer apps.
  const specs = [
    {
      "id": "example-chart",
      "tag": "sy-chord",
      "props": {
        "data": {
          "links": [
            {
              "source": "Seoul",
              "target": "Busan",
              "value": 24
            },
            {
              "source": "Busan",
              "target": "Daegu",
              "value": 18
            },
            {
              "source": "Daegu",
              "target": "Seoul",
              "value": 30
            },
            {
              "source": "Seoul",
              "target": "Jeju",
              "value": 12
            },
            {
              "source": "Jeju",
              "target": "Busan",
              "value": 9
            }
          ]
        },
        "nodeLabels": "show",
        "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', 'chord example chart');
    return element;
  });
  container.replaceChildren(...elements);
  const chart = elements.at(-1);
  const onEvent = event => {
    console.log('nodeClick', event.detail);
  };
  chart.addEventListener('nodeClick', 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('nodeClick', onEvent);
    container.replaceChildren();
  }
</script>

Usage and data

#

Compare relationships such as movement between regions or collaboration between departments.

Many connections cause ribbon overlap. Focus on key relationships or use a Network Graph alongside it.

Data contract

PropertyInput format
data{ links: [{ source, target, value }] } or a link array.

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

Key properties

Attribute / PropertyType / DefaultDescription
ChordDataDefault: undefined{ links: [{ source, target, value }] } or a link array.
numberDefault: 900Chart width in pixels. Update with ResizeObserver when the container changes.
numberDefault: 400Chart 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.
nodeWidthnumberDefault: CHORD_DEFAULT_NODE_WIDTHThe perimeter band's thickness in CSS px.
linkOpacitynumberDefault: DEFAULT_LINK_OPACITYThe ribbons' opacity (0 … 1).
linkCurvaturenumberDefault: CHORD_DEFAULT_CURVATUREThe ribbon bend: 0 straight between ports, 1 pulled through the circle interior.
nodeLabelsChordLabelModeDefault: 'auto'the node labels beside the nodes: `auto` (hidden where they would overlap), `show`, `hide`; `node-label-value` appends the throughput.
nodeLabelValuebooleanDefault: falseSet as an HTML attribute or JavaScript property. type: boolean.
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.
tooltipEnabledbooleanDefault: trueSet as an HTML attribute or JavaScript property. type: boolean.
animatedbooleanDefault: falseWhether to animate initial display and data changes.
animationDurationnumberDefault: 600Animation duration in milliseconds.
animationEasingChordEasingDefault: 'ease-out'Allowed values: linear, ease-out, ease-in, ease-in-out. Default: 'ease-out'.
animationTypeChordAnimationTypeDefault: undefinedAllowed values: initial, update. Default: undefined.
CartesianZoomInputDefault: undefinedSettings for zooming and the visible range.
Other properties 13
Attribute / PropertyType / DefaultDescription
padAnglenumberDefault: CHORD_DEFAULT_PAD_ANGLEThe gap between perimeter groups, in degrees.
startAnglenumberDefault: CHORD_DEFAULT_START_ANGLEClockwise start angle in degrees from the positive x axis; -90 starts at the top.
stringDefault: AUTO_COLORThe nodes' fill: `auto` (the palette by index) or a CSS colour; a node's own `color` wins.
linkColorstringDefault: 'source'The links' colour: `source` / `target` (the node's colour at that end) or a CSS colour; a link's own `color` wins.
neighbourDimnumberDefault: DEFAULT_NEIGHBOUR_DIMwith a hovered / focused node, the ribbons touching neither of its ends fade to this alpha factor (0 … 1; 1 = no dim).
activeColorstringDefault: DEFAULT_ACTIVE_COLORThe hovered / focused node or link.
enableMouseTrackingbooleanDefault: trueSet as an HTML attribute or JavaScript property. type: boolean.
tooltipFormat(detail: ChordHitDetail) => stringDefault: undefinedPass as a JavaScript property. type: (detail: ChordHitDetail) => string.
streamSourceChordStreamSourceDefault: undefinedA stream source for live data. Check the contract for the specific type.
streamMaxnumberDefault: undefinedThe maximum number of streaming data points to retain.
streamWindownumberDefault: undefinedThe streaming data range to keep visible.
ChordEngineModeDefault: 'auto'Renderer selection: auto, standard, or pro. Engine selection is separate from permission to use a Pro chart type.
ChordUnavailableBehaviourDefault: 'fallback'Allowed values: fallback, error. Default: 'fallback'.
Events 16
EventsDetail typeDescription
ChordRenderResult & { tier: ChordEngineTier }Emits rendering results in detail when chart drawing completes.
ChordNodeEventDetailCustomEvent.detail type: ChordNodeEventDetail. Event names are case-sensitive.
ChordNodeEventDetail | nullCustomEvent.detail type: ChordNodeEventDetail | null. Event names are case-sensitive.
ChordLinkEventDetailCustomEvent.detail type: ChordLinkEventDetail. Event names are case-sensitive.
ChordLinkEventDetail | nullCustomEvent.detail type: ChordLinkEventDetail | null. Event names are case-sensitive.
ChordSelectionChangeEventDetailthe selection (the pinned highlight) changed: a node or a link (never both) or nothing, and what changed it.
ChartPointContextMenuEventDetail<ChordHitDetail>CustomEvent.detail type: ChartPointContextMenuEventDetail<ChordHitDetail>. Event names are case-sensitive.
{ count: number; replaced: number }CustomEvent.detail type: { count: number; replaced: number }. Event names are case-sensitive.
{ dropped: number }CustomEvent.detail type: { dropped: number }. 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.
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.
CartesianZoomChangeEventDetailFired after every zoom change (drag / pan / wheel / pinch / keyboard / api / reset) with the new state.
Methods 38

Stencil methods return Promises. Use await within an async function to read the result.

Method / ArgumentsReturn typeDescription
Promise<ChordRenderResult>An asynchronous method. Check the argument and return types below.
Promise<ChordEngineTier>An asynchronous method. Check the argument and return types below.
Promise<string | undefined>An asynchronous method. Check the argument and return types below.
data: ChordDataPromise<void>An asynchronous method. Check the argument and return types below.
link: ChordLinkInputPromise<void>Upsert one link (a tracked source → target pair replaces its link).
links: ReadonlyArray<ChordLinkInput>Promise<void>An asynchronous method. Check the argument and return types below.
count: numberPromise<void>Drop the oldest streamed links (the `data` links are not the stream).
links: ReadonlyArray<ChordLinkInput>Promise<void>An asynchronous method. Check the argument and return types below.
Promise<ChordStreamSource | undefined>An asynchronous method. Check the argument and return types below.
Promise<ChartEngineStatus>Requested vs effective engine and why (CHART-ADD-08), with the chart.type.chord license state.
options: { duration?: number; easing?: ChordEasing; enabled?: boolean; type?: ChordAnimationType }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.
Promise<void>An asynchronous method. Check the argument and return types below.
cssX: number, cssY: numberPromise<ChordHitDetail | null>The node or link under a host-local CSS point (a node first, else the topmost ribbon), or null (always without a valid license).
index: numberPromise<ChordNode | null>An asynchronous method. Check the argument and return types below.
id: stringPromise<ChordNode | null>An asynchronous method. Check the argument and return types below.
Promise<ChordNode[]>An asynchronous method. Check the argument and return types below.
Promise<ChordLink[]>An asynchronous method. Check the argument and return types below.
Promise<number>An asynchronous method. Check the argument and return types below.
Promise<number>An asynchronous method. Check the argument and return types below.
Promise<ChordExtent>An asynchronous method. Check the argument and return types below.
Promise<{ nodes: number; links: number; total: number; dropped: number; radius: number; nodeWidth: number; padAngle: number; curvature: number }>Settled perimeter geometry and directed relationship totals.
Promise<ChordNodeLabel[]>the placed node labels in HOST-local CSS px as shown (the plot offset added; under a zoom the labels of the nodes outside the window are left out), shown or hidden with the reason.
Promise<ChordLayoutResult>Host-local geometry as shown. Scale fields preserve ellipses under non-uniform viewport zoom.
index: numberPromise<CartesianTooltipEventDetail | null>Open a tooltip by point index: perimeter nodes first, then ribbons.
Promise<void>Close every tooltip.
index: numberPromise<ChordNodeEventDetail | null>Move the keyboard focus ring to a node (null off the nodes); emits nodeHover like the walk.
index: numberPromise<ChordNodeEventDetail | null>Select (pin) a node: its neighbourhood stays highlighted after the pointer leaves; a negative or unknown index releases the selection. Emits selectionChanged when it changes.
index: numberPromise<ChordLinkEventDetail | null>Select (pin) a link: its ribbon keeps the accent after the pointer leaves; a negative or unknown index releases the selection.
Promise<void>Release the selection (emits selectionChanged when there was one).
Promise<ChordSelection>The selection: the selected node's / link's detail (`null` = none); its anchors are Pro-derived, refused without a valid license.
request: CartesianZoomRequestPromise<CartesianZoomChangeEventDetail | null>Zoom to explicit windows over the unit extents: `x` / `y` as `{ min, max }` or `[min, max]` (`null` clears that orientation).
factor: number, anchorFraction?: numberPromise<CartesianZoomChangeEventDetail | null>Scale the current windows by `factor` (< 1 zooms in) around `anchorFraction` (0..1, default centre).
delta: { x?: number; y?: number }Promise<CartesianZoomChangeEventDetail | null>Slide the zoomed windows by unit-extent units (`{ x?, y? }`); a no-op at the full extent.
Promise<CartesianZoomChangeEventDetail | null>Back to the full diagram.
Promise<CartesianZoomState | null>The current zoom state (`null` = the full diagram).
request?: CartesianZoomExtentRequestPromise<CartesianZoomExtentDetail | null>The full extent (0 … 1) and key of the diagram's orientations (`null` before the first layout).