Chord.
PROShow connection volumes between groups as ribbons inside a circle.
LIVE EXAMPLE
Movement between regions
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
<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
| Property | Input 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.
Feature examples
#Try 23 interactive feature examples and inspect their code. Select “Edit in preview” to combine more options in the settings panel above.
Emphasize connectionsPRO
Adjust the thickness of nodes and connections around the circle.
View code
Relationship valuesPRO
Show each node's name and value together.
View code
Inspect values with the pointerPRO
Point to data to view the value at that location.
View code
Drag to zoom and panPRO
Drag to zoom and hold Shift to pan. Use Ctrl + wheel to zoom in or out.
View code
Replay animationPRO
Redraw the same example to inspect its initial display animation.
View code
AnimationPRO
Compare 2 examples of Animation. Buttons and options update both the live result and source code.
View code
Data inputPRO
Compare 1 examples of Data input. Buttons and options update both the live result and source code.
View code
LabelPRO
Compare 4 examples of Label. Buttons and options update both the live result and source code.
View code
LayoutPRO
Compare 4 examples of Layout. Buttons and options update both the live result and source code.
View code
LinksPRO
Compare 8 examples of Links. Buttons and options update both the live result and source code.
View code
Large datasetsPRO
Compare 1 examples of Large datasets. Buttons and options update both the live result and source code.
View code
SizePRO
Compare 1 examples of Size. Buttons and options update both the live result and source code.
View code
TooltipPRO
Compare 12 examples of Tooltip. Buttons and options update both the live result and source code.
View code
Zoom and panPRO
Compare 6 examples of Zoom and pan. Buttons and options update both the live result and source code.
View code
Context menuPRO
Compare 1 examples of Context menu. Buttons and options update both the live result and source code.
View code
HoverPRO
Compare 2 examples of Hover. Buttons and options update both the live result and source code.
View code
Link ClickPRO
Compare 3 examples of Link Click. Buttons and options update both the live result and source code.
View code
Node ClickPRO
Compare 2 examples of Node Click. Buttons and options update both the live result and source code.
View code
Data context menuPRO
Compare 1 examples of Data context menu. Buttons and options update both the live result and source code.
View code
Read coordinates and dataPRO
Compare 1 examples of Read coordinates and data. Buttons and options update both the live result and source code.
View code
OptionalPRO
Compare 2 examples of Optional. Buttons and options update both the live result and source code.
View code
OverviewPRO
Compare 3 examples of Overview. Buttons and options update both the live result and source code.
View code
Streaming · Add and update live dataPRO
Compare 5 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-chord. Pass objects and arrays as JavaScript properties. Select a name to view usage code and type definitions.
Key properties
| Attribute / Property | Type / Default | Description |
|---|---|---|
ChordDataDefault: undefined | { links: [{ source, target, value }] } or a link array. | |
numberDefault: 900 | Chart width in pixels. Update with ResizeObserver when the container changes. | |
numberDefault: 400 | 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. |
| nodeWidth | numberDefault: CHORD_DEFAULT_NODE_WIDTH | The perimeter band's thickness in CSS px. |
| linkOpacity | numberDefault: DEFAULT_LINK_OPACITY | The ribbons' opacity (0 … 1). |
| linkCurvature | numberDefault: CHORD_DEFAULT_CURVATURE | The ribbon bend: 0 straight between ports, 1 pulled through the circle interior. |
| nodeLabels | ChordLabelModeDefault: 'auto' | the node labels beside the nodes: `auto` (hidden where they would overlap), `show`, `hide`; `node-label-value` appends the throughput. |
| nodeLabelValue | booleanDefault: false | Set as an HTML attribute or JavaScript property. type: boolean. |
| 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. | |
| tooltipEnabled | booleanDefault: true | Set as an HTML attribute or JavaScript property. type: boolean. |
| animated | booleanDefault: false | Whether to animate initial display and data changes. |
| animationDuration | numberDefault: 600 | Animation duration in milliseconds. |
| animationEasing | ChordEasingDefault: 'ease-out' | Allowed values: linear, ease-out, ease-in, ease-in-out. Default: 'ease-out'. |
| animationType | ChordAnimationTypeDefault: undefined | Allowed values: initial, update. Default: undefined. |
CartesianZoomInputDefault: undefined | Settings for zooming and the visible range. |
Other properties 13
| Attribute / Property | Type / Default | Description |
|---|---|---|
| padAngle | numberDefault: CHORD_DEFAULT_PAD_ANGLE | The gap between perimeter groups, in degrees. |
| startAngle | numberDefault: CHORD_DEFAULT_START_ANGLE | Clockwise start angle in degrees from the positive x axis; -90 starts at the top. |
stringDefault: AUTO_COLOR | The nodes' fill: `auto` (the palette by index) or a CSS colour; a node's own `color` wins. | |
| linkColor | stringDefault: 'source' | The links' colour: `source` / `target` (the node's colour at that end) or a CSS colour; a link's own `color` wins. |
| neighbourDim | numberDefault: DEFAULT_NEIGHBOUR_DIM | with a hovered / focused node, the ribbons touching neither of its ends fade to this alpha factor (0 … 1; 1 = no dim). |
| activeColor | stringDefault: DEFAULT_ACTIVE_COLOR | The hovered / focused node or link. |
| enableMouseTracking | booleanDefault: true | Set as an HTML attribute or JavaScript property. type: boolean. |
| tooltipFormat | (detail: ChordHitDetail) => stringDefault: undefined | Pass as a JavaScript property. type: (detail: ChordHitDetail) => string. |
| streamSource | ChordStreamSourceDefault: undefined | A stream source for live data. Check the contract for the specific type. |
| streamMax | numberDefault: undefined | The maximum number of streaming data points to retain. |
| streamWindow | numberDefault: undefined | The 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
| Events | Detail type | Description |
|---|---|---|
ChordRenderResult & { tier: ChordEngineTier } | Emits rendering results in detail when chart drawing completes. | |
ChordNodeEventDetail | CustomEvent.detail type: ChordNodeEventDetail. Event names are case-sensitive. | |
ChordNodeEventDetail | null | CustomEvent.detail type: ChordNodeEventDetail | null. Event names are case-sensitive. | |
ChordLinkEventDetail | CustomEvent.detail type: ChordLinkEventDetail. Event names are case-sensitive. | |
ChordLinkEventDetail | null | CustomEvent.detail type: ChordLinkEventDetail | null. Event names are case-sensitive. | |
ChordSelectionChangeEventDetail | the 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. | |
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. | |
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. | |
CartesianZoomChangeEventDetail | Fired 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 / Arguments | Return type | Description |
|---|---|---|
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: ChordData | Promise<void> | An asynchronous method. Check the argument and return types below. |
| link: ChordLinkInput | Promise<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: number | Promise<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: number | Promise<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: number | Promise<ChordNode | null> | An asynchronous method. Check the argument and return types below. |
| id: string | Promise<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: number | Promise<CartesianTooltipEventDetail | null> | Open a tooltip by point index: perimeter nodes first, then ribbons. |
Promise<void> | Close every tooltip. | |
| index: number | Promise<ChordNodeEventDetail | null> | Move the keyboard focus ring to a node (null off the nodes); emits nodeHover like the walk. |
| index: number | Promise<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: number | Promise<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: CartesianZoomRequest | Promise<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?: number | Promise<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?: CartesianZoomExtentRequest | Promise<CartesianZoomExtentDetail | null> | The full extent (0 … 1) and key of the diagram's orientations (`null` before the first layout). |
No matching APIs.