sy-chord
Chord
그룹 사이의 연결량을 원 안의 띠로 표현합니다.
sy-chord
지역 간 이동·부서 간 교류처럼 상호 관계를 비교하세요.
연결이 많으면 띠가 겹칩니다. 중요한 관계만 남기거나 Network Graph와 함께 사용하세요.
기본 차트 등급: Pro. 추가 렌더러·커스텀 브랜딩 등 기능의 권한은 별도입니다.
| 입력 | 데이터 설명 |
|---|---|
data | { links: [{ source, target, value }] } 또는 링크 배열입니다. |
- Components에서 실행하기
옵션 변경과 프레임워크별 코드
- 공통 설치와 연결
전체 적용 예제
<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: 앱 시작 시 발급받은 인증서로 registerLicense를 완료하세요.
// 홈페이지 미리보기의 인증서는 고객 앱에서 사용하지 않습니다.
const specs = [
{
"id": "example-chart",
"tag": "sy-chord",
"props": {
"data": {
"links": [
{
"source": "서울",
"target": "부산",
"value": 24
},
{
"source": "부산",
"target": "대구",
"value": 18
},
{
"source": "대구",
"target": "서울",
"value": 30
},
{
"source": "서울",
"target": "제주",
"value": 12
},
{
"source": "제주",
"target": "부산",
"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 예제 차트');
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);
// SPA에서는 화면이 해제될 때 이 함수를 호출하세요.
function disposeChart() {
observer.disconnect();
chart.removeEventListener('nodeClick', onEvent);
container.replaceChildren();
}
</script>Properties
data
{ links: [{ source, target, value }] } 또는 링크 배열입니다.
| 항목 | 값 |
|---|---|
| JavaScript 프로퍼티 | data |
| HTML attribute | 객체·배열·콜백은 JavaScript 프로퍼티로 전달 |
| 타입 | ChordData |
| 기본값 | undefined |
undefined는 이 속성을 명시하지 않은 상태입니다. 실제 표시 값은 차트 종류와 다른 설정에 따라 결정될 수 있습니다.
- ChordData
타입 정의
width
차트의 너비를 px 단위로 지정합니다. 컨테이너 너비가 변하는 앱에서는 ResizeObserver에서 width를 갱신하세요.
| 항목 | 값 |
|---|---|
| JavaScript 프로퍼티 | width |
| HTML attribute | width |
| 타입 | number |
| 기본값 | 900 |
height
차트의 높이를 px 단위로 지정합니다. 축, 제목과 범례가 차지하는 공간을 함께 고려하세요.
| 항목 | 값 |
|---|---|
| JavaScript 프로퍼티 | height |
| HTML attribute | height |
| 타입 | number |
| 기본값 | 400 |
brandLogo
기본값은 Syidax 심볼과 워드마크입니다. Pro의 chart.branding 권한으로 none을 지정해 제거하거나 PNG·JPEG·WebP data URL로 교체할 수 있습니다.
| 항목 | 값 |
|---|---|
| JavaScript 프로퍼티 | brandLogo |
| HTML attribute | brand-logo |
| 타입 | string |
| 기본값 | undefined |
undefined는 이 속성을 명시하지 않은 상태입니다. 실제 표시 값은 차트 종류와 다른 설정에 따라 결정될 수 있습니다.
brandPosition
로고를 고정할 코너입니다. Community·Pro 모두 네 코너 중 하나를 선택할 수 있으며 화면과 이미지 내보내기에 같은 위치를 사용합니다.
| 항목 | 값 |
|---|---|
| JavaScript 프로퍼티 | brandPosition |
| HTML attribute | brand-position |
| 타입 | 'top-left' | 'top-right' | 'bottom-left' | 'bottom-right' |
| 기본값 | 'bottom-right' |
| 허용값 | top-left, top-right, bottom-left, bottom-right |
nodeWidth
The perimeter band's thickness in CSS px.
| 항목 | 값 |
|---|---|
| JavaScript 프로퍼티 | nodeWidth |
| HTML attribute | node-width |
| 타입 | number |
| 기본값 | CHORD_DEFAULT_NODE_WIDTH |
padAngle
The gap between perimeter groups, in degrees.
| 항목 | 값 |
|---|---|
| JavaScript 프로퍼티 | padAngle |
| HTML attribute | pad-angle |
| 타입 | number |
| 기본값 | CHORD_DEFAULT_PAD_ANGLE |
startAngle
Clockwise start angle in degrees from the positive x axis; -90 starts at the top.
| 항목 | 값 |
|---|---|
| JavaScript 프로퍼티 | startAngle |
| HTML attribute | start-angle |
| 타입 | number |
| 기본값 | CHORD_DEFAULT_START_ANGLE |
color
The nodes' fill: auto (the palette by index) or a CSS colour; a node's own color wins.
| 항목 | 값 |
|---|---|
| JavaScript 프로퍼티 | color |
| HTML attribute | color |
| 타입 | string |
| 기본값 | AUTO_COLOR |
linkColor
The links' colour: source / target (the node's colour at that end) or a CSS colour; a link's own color wins.
| 항목 | 값 |
|---|---|
| JavaScript 프로퍼티 | linkColor |
| HTML attribute | link-color |
| 타입 | string |
| 기본값 | 'source' |
linkOpacity
The ribbons' opacity (0 … 1).
| 항목 | 값 |
|---|---|
| JavaScript 프로퍼티 | linkOpacity |
| HTML attribute | link-opacity |
| 타입 | number |
| 기본값 | DEFAULT_LINK_OPACITY |
linkCurvature
The ribbon bend: 0 straight between ports, 1 pulled through the circle interior.
| 항목 | 값 |
|---|---|
| JavaScript 프로퍼티 | linkCurvature |
| HTML attribute | link-curvature |
| 타입 | number |
| 기본값 | CHORD_DEFAULT_CURVATURE |
nodeLabels
the node labels beside the nodes: auto (hidden where they would overlap), show, hide; node-label-value appends the throughput.
| 항목 | 값 |
|---|---|
| JavaScript 프로퍼티 | nodeLabels |
| HTML attribute | node-labels |
| 타입 | ChordLabelMode |
| 기본값 | 'auto' |
| 허용값 | auto, show, hide |
- ChordLabelMode
타입 정의
nodeLabelValue
HTML attribute 또는 JavaScript 프로퍼티로 설정합니다. 타입: boolean.
| 항목 | 값 |
|---|---|
| JavaScript 프로퍼티 | nodeLabelValue |
| HTML attribute | node-label-value |
| 타입 | boolean |
| 기본값 | false |
neighbourDim
with a hovered / focused node, the ribbons touching neither of its ends fade to this alpha factor (0 … 1; 1 = no dim).
| 항목 | 값 |
|---|---|
| JavaScript 프로퍼티 | neighbourDim |
| HTML attribute | neighbour-dim |
| 타입 | number |
| 기본값 | DEFAULT_NEIGHBOUR_DIM |
activeColor
The hovered / focused node or link.
| 항목 | 값 |
|---|---|
| JavaScript 프로퍼티 | activeColor |
| HTML attribute | active-color |
| 타입 | string |
| 기본값 | DEFAULT_ACTIVE_COLOR |
chartTitle
차트 내부 제목입니다. 데이터의 단위와 의미를 함께 설명하세요.
| 항목 | 값 |
|---|---|
| JavaScript 프로퍼티 | chartTitle |
| HTML attribute | chart-title |
| 타입 | string |
| 기본값 | undefined |
undefined는 이 속성을 명시하지 않은 상태입니다. 실제 표시 값은 차트 종류와 다른 설정에 따라 결정될 수 있습니다.
chartSubtitle
차트 내부 부제목입니다.
| 항목 | 값 |
|---|---|
| JavaScript 프로퍼티 | chartSubtitle |
| HTML attribute | chart-subtitle |
| 타입 | string |
| 기본값 | undefined |
undefined는 이 속성을 명시하지 않은 상태입니다. 실제 표시 값은 차트 종류와 다른 설정에 따라 결정될 수 있습니다.
enableMouseTracking
HTML attribute 또는 JavaScript 프로퍼티로 설정합니다. 타입: boolean.
| 항목 | 값 |
|---|---|
| JavaScript 프로퍼티 | enableMouseTracking |
| HTML attribute | enable-mouse-tracking |
| 타입 | boolean |
| 기본값 | true |
tooltip
The tooltip (the shared cartesian tooltip input: trigger, format, html, connector …), its switch, a formatter of the default text.
| 항목 | 값 |
|---|---|
| JavaScript 프로퍼티 | tooltip |
| HTML attribute | 객체·배열·콜백은 JavaScript 프로퍼티로 전달 |
| 타입 | CartesianTooltipInput |
| 기본값 | undefined |
| 타입에 포함된 리터럴 | auto, off |
undefined는 이 속성을 명시하지 않은 상태입니다. 실제 표시 값은 차트 종류와 다른 설정에 따라 결정될 수 있습니다.
tooltipEnabled
HTML attribute 또는 JavaScript 프로퍼티로 설정합니다. 타입: boolean.
| 항목 | 값 |
|---|---|
| JavaScript 프로퍼티 | tooltipEnabled |
| HTML attribute | tooltip-show |
| 타입 | boolean |
| 기본값 | true |
tooltipFormat
JavaScript 프로퍼티로 전달합니다. 타입: (detail: ChordHitDetail) => string.
| 항목 | 값 |
|---|---|
| JavaScript 프로퍼티 | tooltipFormat |
| HTML attribute | 객체·배열·콜백은 JavaScript 프로퍼티로 전달 |
| 타입 | (detail: ChordHitDetail) => string |
| 기본값 | undefined |
undefined는 이 속성을 명시하지 않은 상태입니다. 실제 표시 값은 차트 종류와 다른 설정에 따라 결정될 수 있습니다.
- ChordHitDetail
타입 정의
animated
초기 표시와 데이터 변경의 애니메이션 사용 여부입니다.
| 항목 | 값 |
|---|---|
| JavaScript 프로퍼티 | animated |
| HTML attribute | animate |
| 타입 | boolean |
| 기본값 | false |
animationDuration
애니메이션 지속 시간(ms).
| 항목 | 값 |
|---|---|
| JavaScript 프로퍼티 | animationDuration |
| HTML attribute | animation-duration |
| 타입 | number |
| 기본값 | 600 |
animationEasing
허용값: linear, ease-out, ease-in, ease-in-out. 기본값: 'ease-out'.
| 항목 | 값 |
|---|---|
| JavaScript 프로퍼티 | animationEasing |
| HTML attribute | animation-easing |
| 타입 | ChordEasing |
| 기본값 | 'ease-out' |
| 허용값 | linear, ease-out, ease-in, ease-in-out |
- ChordEasing
타입 정의
animationType
허용값: initial, update. 기본값: undefined.
| 항목 | 값 |
|---|---|
| JavaScript 프로퍼티 | animationType |
| HTML attribute | animation-type |
| 타입 | ChordAnimationType |
| 기본값 | undefined |
| 허용값 | initial, update |
undefined는 이 속성을 명시하지 않은 상태입니다. 실제 표시 값은 차트 종류와 다른 설정에 따라 결정될 수 있습니다.
- ChordAnimationType
타입 정의
streamSource
§3.6: an external stream source (link upserts); without one the chart keeps its own on the first push.
| 항목 | 값 |
|---|---|
| JavaScript 프로퍼티 | streamSource |
| HTML attribute | 객체·배열·콜백은 JavaScript 프로퍼티로 전달 |
| 타입 | ChordStreamSource |
| 기본값 | undefined |
undefined는 이 속성을 명시하지 않은 상태입니다. 실제 표시 값은 차트 종류와 다른 설정에 따라 결정될 수 있습니다.
- ChordStreamSource
타입 정의
streamMax
Links tracked by the internal stream at most (the oldest leave as windowSlid).
| 항목 | 값 |
|---|---|
| JavaScript 프로퍼티 | streamMax |
| HTML attribute | stream-max |
| 타입 | number |
| 기본값 | undefined |
undefined는 이 속성을 명시하지 않은 상태입니다. 실제 표시 값은 차트 종류와 다른 설정에 따라 결정될 수 있습니다.
streamWindow
The newest N streamed links the chart renders (the whole buffer when unset).
| 항목 | 값 |
|---|---|
| JavaScript 프로퍼티 | streamWindow |
| HTML attribute | stream-window |
| 타입 | number |
| 기본값 | undefined |
undefined는 이 속성을 명시하지 않은 상태입니다. 실제 표시 값은 차트 종류와 다른 설정에 따라 결정될 수 있습니다.
zoom
Zoom: 'x' | 'y' | 'xy' | true (x) enable the drag rectangle, the pan, the wheel, the pinch and the keyboard over the diagram's unit extents (x 0 → 1 left → right, y 0 → 1 bottom → top — the hidden frame's extents); an object refines mode / drag / keyboard / minRangePx / resetButton / pan / wheel / pinch / inside. Off by default. zoomTo / zoomBy / panBy / resetZoom work regardless of the gesture switches.
| 항목 | 값 |
|---|---|
| JavaScript 프로퍼티 | zoom |
| HTML attribute | 객체·배열·콜백은 JavaScript 프로퍼티로 전달 |
| 타입 | CartesianZoomInput |
| 기본값 | undefined |
| 타입에 포함된 리터럴 | auto, off, true, false, x, y, xy, inside |
undefined는 이 속성을 명시하지 않은 상태입니다. 실제 표시 값은 차트 종류와 다른 설정에 따라 결정될 수 있습니다.
- CartesianZoomInput
타입 정의
engine
auto·standard·pro 렌더러 선택입니다. 엔진 선택은 차트 종류의 Pro 사용 권한과 별개입니다.
| 항목 | 값 |
|---|---|
| JavaScript 프로퍼티 | engine |
| HTML attribute | engine |
| 타입 | ChordEngineMode |
| 기본값 | 'auto' |
| 허용값 | auto, standard, pro |
- ChordEngineMode
타입 정의
Events
rendered
차트 그리기가 완료되면 렌더링 결과를 detail로 전달합니다.
이벤트 이름: rendered. 대소문자를 구분합니다. payload는 CustomEvent<ChordRenderResult & { tier: ChordEngineTier }>의 detail에서 읽습니다.
chart.addEventListener('rendered', event => {
console.log(event.detail); // ChordRenderResult & { tier: ChordEngineTier }
});- ChordRenderResult
타입 정의
- ChordEngineTier
타입 정의
nodeClick
CustomEvent.detail 타입: ChordNodeEventDetail. 이벤트 이름은 대소문자를 구분합니다.
이벤트 이름: nodeClick. 대소문자를 구분합니다. payload는 CustomEvent<ChordNodeEventDetail>의 detail에서 읽습니다.
chart.addEventListener('nodeClick', event => {
console.log(event.detail); // ChordNodeEventDetail
});- ChordNodeEventDetail
타입 정의
nodeHover
CustomEvent.detail 타입: ChordNodeEventDetail | null. 이벤트 이름은 대소문자를 구분합니다.
이벤트 이름: nodeHover. 대소문자를 구분합니다. payload는 CustomEvent<ChordNodeEventDetail | null>의 detail에서 읽습니다.
chart.addEventListener('nodeHover', event => {
console.log(event.detail); // ChordNodeEventDetail | null
});- ChordNodeEventDetail
타입 정의
linkClick
CustomEvent.detail 타입: ChordLinkEventDetail. 이벤트 이름은 대소문자를 구분합니다.
이벤트 이름: linkClick. 대소문자를 구분합니다. payload는 CustomEvent<ChordLinkEventDetail>의 detail에서 읽습니다.
chart.addEventListener('linkClick', event => {
console.log(event.detail); // ChordLinkEventDetail
});- ChordLinkEventDetail
타입 정의
linkHover
CustomEvent.detail 타입: ChordLinkEventDetail | null. 이벤트 이름은 대소문자를 구분합니다.
이벤트 이름: linkHover. 대소문자를 구분합니다. payload는 CustomEvent<ChordLinkEventDetail | null>의 detail에서 읽습니다.
chart.addEventListener('linkHover', event => {
console.log(event.detail); // ChordLinkEventDetail | null
});- ChordLinkEventDetail
타입 정의
selectionChanged
the selection (the pinned highlight) changed: a node or a link (never both) or nothing, and what changed it.
이벤트 이름: selectionChanged. 대소문자를 구분합니다. payload는 CustomEvent<ChordSelectionChangeEventDetail>의 detail에서 읽습니다.
chart.addEventListener('selectionChanged', event => {
console.log(event.detail); // ChordSelectionChangeEventDetail
});pointContextMenu
CustomEvent.detail 타입: ChartPointContextMenuEventDetail<ChordHitDetail>. 이벤트 이름은 대소문자를 구분합니다.
이벤트 이름: pointContextMenu. 대소문자를 구분합니다. payload는 CustomEvent<ChartPointContextMenuEventDetail<ChordHitDetail>>의 detail에서 읽습니다.
chart.addEventListener('pointContextMenu', event => {
console.log(event.detail); // ChartPointContextMenuEventDetail<ChordHitDetail>
});appended
CustomEvent.detail 타입: { count: number; replaced: number }. 이벤트 이름은 대소문자를 구분합니다.
이벤트 이름: appended. 대소문자를 구분합니다. payload는 CustomEvent<{ count: number; replaced: number }>의 detail에서 읽습니다.
chart.addEventListener('appended', event => {
console.log(event.detail); // { count: number; replaced: number }
});windowSlid
CustomEvent.detail 타입: { dropped: number }. 이벤트 이름은 대소문자를 구분합니다.
이벤트 이름: windowSlid. 대소문자를 구분합니다. payload는 CustomEvent<{ dropped: number }>의 detail에서 읽습니다.
chart.addEventListener('windowSlid', event => {
console.log(event.detail); // { dropped: number }
});tooltipShow
The shared tooltip events (the controller emits them).
이벤트 이름: tooltipShow. 대소문자를 구분합니다. payload는 CustomEvent<CartesianTooltipEventDetail>의 detail에서 읽습니다.
chart.addEventListener('tooltipShow', event => {
console.log(event.detail); // CartesianTooltipEventDetail
});tooltipHide
CustomEvent.detail 타입: void. 이벤트 이름은 대소문자를 구분합니다.
이벤트 이름: tooltipHide. 대소문자를 구분합니다. payload는 CustomEvent<void>의 detail에서 읽습니다.
chart.addEventListener('tooltipHide', event => {
console.log(event.detail); // void
});tooltipAction
CustomEvent.detail 타입: CartesianTooltipActionEventDetail. 이벤트 이름은 대소문자를 구분합니다.
이벤트 이름: tooltipAction. 대소문자를 구분합니다. payload는 CustomEvent<CartesianTooltipActionEventDetail>의 detail에서 읽습니다.
chart.addEventListener('tooltipAction', event => {
console.log(event.detail); // CartesianTooltipActionEventDetail
});chartAnimationStart
CustomEvent.detail 타입: void. 이벤트 이름은 대소문자를 구분합니다.
이벤트 이름: chartAnimationStart. 대소문자를 구분합니다. payload는 CustomEvent<void>의 detail에서 읽습니다.
chart.addEventListener('chartAnimationStart', event => {
console.log(event.detail); // void
});chartAnimationEnd
CustomEvent.detail 타입: void. 이벤트 이름은 대소문자를 구분합니다.
이벤트 이름: chartAnimationEnd. 대소문자를 구분합니다. payload는 CustomEvent<void>의 detail에서 읽습니다.
chart.addEventListener('chartAnimationEnd', event => {
console.log(event.detail); // void
});chartAnimationInterrupted
CustomEvent.detail 타입: void. 이벤트 이름은 대소문자를 구분합니다.
이벤트 이름: chartAnimationInterrupted. 대소문자를 구분합니다. payload는 CustomEvent<void>의 detail에서 읽습니다.
chart.addEventListener('chartAnimationInterrupted', event => {
console.log(event.detail); // void
});zoomChange
Fired after every zoom change (drag / pan / wheel / pinch / keyboard / api / reset) with the new state.
이벤트 이름: zoomChange. 대소문자를 구분합니다. payload는 CustomEvent<CartesianZoomChangeEventDetail>의 detail에서 읽습니다.
chart.addEventListener('zoomChange', event => {
console.log(event.detail); // CartesianZoomChangeEventDetail
});Methods
redraw
현재 데이터와 옵션으로 차트를 다시 그립니다. 반환되는 Promise가 완료되면 렌더링 결과를 확인할 수 있습니다.
redraw(): Promise<ChordRenderResult>반환 타입: Promise<ChordRenderResult>. 요소 등록이 끝난 뒤 메서드를 호출하고 Promise 결과를 await로 기다리세요.
- ChordRenderResult
타입 정의
getActiveTier
비동기 메서드입니다. 아래 인수 타입과 반환 타입을 확인하세요.
getActiveTier(): Promise<ChordEngineTier>반환 타입: Promise<ChordEngineTier>. 요소 등록이 끝난 뒤 메서드를 호출하고 Promise 결과를 await로 기다리세요.
- ChordEngineTier
타입 정의
setData
Replace the bar set.
setData(data: ChordData): Promise<void>| 인수 | 타입 | 필수 여부 |
|---|---|---|
data | ChordData | 필수 |
반환 타입: Promise<void>. 요소 등록이 끝난 뒤 메서드를 호출하고 Promise 결과를 await로 기다리세요.
- ChordData
타입 정의
appendPoint
스트림에 값 하나를 추가합니다. 메서드 인수 타입과 스트리밍 기능의 라이선스 조건을 확인하세요.
appendPoint(link: ChordLinkInput): Promise<void>| 인수 | 타입 | 필수 여부 |
|---|---|---|
link | ChordLinkInput | 필수 |
반환 타입: Promise<void>. 요소 등록이 끝난 뒤 메서드를 호출하고 Promise 결과를 await로 기다리세요.
- ChordLinkInput
타입 정의
appendBatch
스트림에 여러 값을 한 번에 추가합니다. 메서드 인수 타입과 스트리밍 기능의 라이선스 조건을 확인하세요.
appendBatch(links: ReadonlyArray<ChordLinkInput>): Promise<void>| 인수 | 타입 | 필수 여부 |
|---|---|---|
links | ReadonlyArray<ChordLinkInput> | 필수 |
반환 타입: Promise<void>. 요소 등록이 끝난 뒤 메서드를 호출하고 Promise 결과를 await로 기다리세요.
- ChordLinkInput
타입 정의
shift
Drop the oldest streamed links (the data links are not the stream).
shift(count: number): Promise<void>| 인수 | 타입 | 필수 여부 |
|---|---|---|
count | number | 필수 |
반환 타입: Promise<void>. 요소 등록이 끝난 뒤 메서드를 호출하고 Promise 결과를 await로 기다리세요.
replace
Swap the streamed set (replace([]) clears it); the base values never leave. Without chart.streaming the dies upsert into the base like a batch (quietly: no appended, no binChanged, as a ring replace).
replace(links: ReadonlyArray<ChordLinkInput>): Promise<void>| 인수 | 타입 | 필수 여부 |
|---|---|---|
links | ReadonlyArray<ChordLinkInput> | 필수 |
반환 타입: Promise<void>. 요소 등록이 끝난 뒤 메서드를 호출하고 Promise 결과를 await로 기다리세요.
- ChordLinkInput
타입 정의
getStreamSource
The stream session's source (Chart Pro): like the stream methods it waits for a license still being confirmed.
getStreamSource(): Promise<ChordStreamSource | undefined>반환 타입: Promise<ChordStreamSource | undefined>. 요소 등록이 끝난 뒤 메서드를 호출하고 Promise 결과를 await로 기다리세요.
- ChordStreamSource
타입 정의
getEngineStatus
Requested vs effective engine and why (CHART-ADD-08), with the chart.type.chord license state.
getEngineStatus(): Promise<ChartEngineStatus>반환 타입: Promise<ChartEngineStatus>. 요소 등록이 끝난 뒤 메서드를 호출하고 Promise 결과를 await로 기다리세요.
- ChartEngineStatus
타입 정의
setAnimation
비동기 메서드입니다. 아래 인수 타입과 반환 타입을 확인하세요.
setAnimation(options: { duration?: number; easing?: ChordEasing; enabled?: boolean; type?: ChordAnimationType }): Promise<void>| 인수 | 타입 | 필수 여부 |
|---|---|---|
options | { duration?: number; easing?: ChordEasing; enabled?: boolean; type?: ChordAnimationType } | 필수 |
반환 타입: Promise<void>. 요소 등록이 끝난 뒤 메서드를 호출하고 Promise 결과를 await로 기다리세요.
- ChordEasing
타입 정의
- ChordAnimationType
타입 정의
pauseAnimation
진행 중인 애니메이션을 일시 정지합니다.
pauseAnimation(): Promise<void>반환 타입: Promise<void>. 요소 등록이 끝난 뒤 메서드를 호출하고 Promise 결과를 await로 기다리세요.
resumeAnimation
일시 정지한 애니메이션을 다시 진행합니다.
resumeAnimation(): Promise<void>반환 타입: Promise<void>. 요소 등록이 끝난 뒤 메서드를 호출하고 Promise 결과를 await로 기다리세요.
replayAnimation
Replay the initial sweep from min → value(s). No-op when animation is off / reduced.
replayAnimation(): Promise<void>반환 타입: Promise<void>. 요소 등록이 끝난 뒤 메서드를 호출하고 Promise 결과를 await로 기다리세요.
hitTest
The node or link under a host-local CSS point (a node first, else the topmost ribbon), or null (always without a valid license).
hitTest(cssX: number, cssY: number): Promise<ChordHitDetail | null>| 인수 | 타입 | 필수 여부 |
|---|---|---|
cssX | number | 필수 |
cssY | number | 필수 |
반환 타입: Promise<ChordHitDetail | null>. 요소 등록이 끝난 뒤 메서드를 호출하고 Promise 결과를 await로 기다리세요.
- ChordHitDetail
타입 정의
getNode
비동기 메서드입니다. 아래 인수 타입과 반환 타입을 확인하세요.
getNode(index: number): Promise<ChordNode | null>| 인수 | 타입 | 필수 여부 |
|---|---|---|
index | number | 필수 |
반환 타입: Promise<ChordNode | null>. 요소 등록이 끝난 뒤 메서드를 호출하고 Promise 결과를 await로 기다리세요.
- ChordNode
타입 정의
getNodeById
비동기 메서드입니다. 아래 인수 타입과 반환 타입을 확인하세요.
getNodeById(id: string): Promise<ChordNode | null>| 인수 | 타입 | 필수 여부 |
|---|---|---|
id | string | 필수 |
반환 타입: Promise<ChordNode | null>. 요소 등록이 끝난 뒤 메서드를 호출하고 Promise 결과를 await로 기다리세요.
- ChordNode
타입 정의
getNodes
비동기 메서드입니다. 아래 인수 타입과 반환 타입을 확인하세요.
getNodes(): Promise<ChordNode[]>반환 타입: Promise<ChordNode[]>. 요소 등록이 끝난 뒤 메서드를 호출하고 Promise 결과를 await로 기다리세요.
- ChordNode
타입 정의
getLinks
비동기 메서드입니다. 아래 인수 타입과 반환 타입을 확인하세요.
getLinks(): Promise<ChordLink[]>반환 타입: Promise<ChordLink[]>. 요소 등록이 끝난 뒤 메서드를 호출하고 Promise 결과를 await로 기다리세요.
- ChordLink
타입 정의
getNodeCount
비동기 메서드입니다. 아래 인수 타입과 반환 타입을 확인하세요.
getNodeCount(): Promise<number>반환 타입: Promise<number>. 요소 등록이 끝난 뒤 메서드를 호출하고 Promise 결과를 await로 기다리세요.
getLinkCount
비동기 메서드입니다. 아래 인수 타입과 반환 타입을 확인하세요.
getLinkCount(): Promise<number>반환 타입: Promise<number>. 요소 등록이 끝난 뒤 메서드를 호출하고 Promise 결과를 await로 기다리세요.
getExtent
비동기 메서드입니다. 아래 인수 타입과 반환 타입을 확인하세요.
getExtent(): Promise<ChordExtent>반환 타입: Promise<ChordExtent>. 요소 등록이 끝난 뒤 메서드를 호출하고 Promise 결과를 await로 기다리세요.
- ChordExtent
타입 정의
getLayoutStats
Settled perimeter geometry and directed relationship totals.
getLayoutStats(): Promise<{ nodes: number; links: number; total: number; dropped: number; radius: number; nodeWidth: number; padAngle: number; curvature: number }>반환 타입: Promise<{ nodes: number; links: number; total: number; dropped: number; radius: number; nodeWidth: number; padAngle: number; curvature: number }>. 요소 등록이 끝난 뒤 메서드를 호출하고 Promise 결과를 await로 기다리세요.
getLabels
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.
getLabels(): Promise<ChordNodeLabel[]>반환 타입: Promise<ChordNodeLabel[]>. 요소 등록이 끝난 뒤 메서드를 호출하고 Promise 결과를 await로 기다리세요.
- ChordNodeLabel
타입 정의
getLayout
Host-local geometry as shown. Scale fields preserve ellipses under non-uniform viewport zoom.
getLayout(): Promise<ChordLayoutResult>반환 타입: Promise<ChordLayoutResult>. 요소 등록이 끝난 뒤 메서드를 호출하고 Promise 결과를 await로 기다리세요.
- ChordLayoutResult
타입 정의
showTooltipAtIndex
Open a tooltip by point index: perimeter nodes first, then ribbons.
showTooltipAtIndex(index: number): Promise<CartesianTooltipEventDetail | null>| 인수 | 타입 | 필수 여부 |
|---|---|---|
index | number | 필수 |
반환 타입: Promise<CartesianTooltipEventDetail | null>. 요소 등록이 끝난 뒤 메서드를 호출하고 Promise 결과를 await로 기다리세요.
hideTooltip
현재 표시 중인 툴팁을 닫습니다.
hideTooltip(): Promise<void>반환 타입: Promise<void>. 요소 등록이 끝난 뒤 메서드를 호출하고 Promise 결과를 await로 기다리세요.
focusNodeAt
Move the keyboard focus ring to a node (null off the nodes); emits nodeHover like the walk.
focusNodeAt(index: number): Promise<ChordNodeEventDetail | null>| 인수 | 타입 | 필수 여부 |
|---|---|---|
index | number | 필수 |
반환 타입: Promise<ChordNodeEventDetail | null>. 요소 등록이 끝난 뒤 메서드를 호출하고 Promise 결과를 await로 기다리세요.
- ChordNodeEventDetail
타입 정의
selectNodeAt
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.
selectNodeAt(index: number): Promise<ChordNodeEventDetail | null>| 인수 | 타입 | 필수 여부 |
|---|---|---|
index | number | 필수 |
반환 타입: Promise<ChordNodeEventDetail | null>. 요소 등록이 끝난 뒤 메서드를 호출하고 Promise 결과를 await로 기다리세요.
- ChordNodeEventDetail
타입 정의
selectLinkAt
Select (pin) a link: its ribbon keeps the accent after the pointer leaves; a negative or unknown index releases the selection.
selectLinkAt(index: number): Promise<ChordLinkEventDetail | null>| 인수 | 타입 | 필수 여부 |
|---|---|---|
index | number | 필수 |
반환 타입: Promise<ChordLinkEventDetail | null>. 요소 등록이 끝난 뒤 메서드를 호출하고 Promise 결과를 await로 기다리세요.
- ChordLinkEventDetail
타입 정의
clearSelection
Release the selection (emits selectionChanged when there was one).
clearSelection(): Promise<void>반환 타입: Promise<void>. 요소 등록이 끝난 뒤 메서드를 호출하고 Promise 결과를 await로 기다리세요.
getSelection
The selection: the selected node's / link's detail (null = none); its anchors are Pro-derived, refused without a valid license.
getSelection(): Promise<ChordSelection>반환 타입: Promise<ChordSelection>. 요소 등록이 끝난 뒤 메서드를 호출하고 Promise 결과를 await로 기다리세요.
- ChordSelection
타입 정의
zoomTo
Zoom to explicit windows over the unit extents: x / y as { min, max } or [min, max] (null clears that orientation).
zoomTo(request: CartesianZoomRequest): Promise<CartesianZoomChangeEventDetail | null>| 인수 | 타입 | 필수 여부 |
|---|---|---|
request | CartesianZoomRequest | 필수 |
반환 타입: Promise<CartesianZoomChangeEventDetail | null>. 요소 등록이 끝난 뒤 메서드를 호출하고 Promise 결과를 await로 기다리세요.
zoomBy
Scale the current windows by factor (< 1 zooms in) around anchorFraction (0..1, default centre).
zoomBy(factor: number, anchorFraction?: number): Promise<CartesianZoomChangeEventDetail | null>| 인수 | 타입 | 필수 여부 |
|---|---|---|
factor | number | 필수 |
anchorFraction | number | 선택 |
반환 타입: Promise<CartesianZoomChangeEventDetail | null>. 요소 등록이 끝난 뒤 메서드를 호출하고 Promise 결과를 await로 기다리세요.
panBy
Slide the zoomed windows by unit-extent units ({ x?, y? }); a no-op at the full extent.
panBy(delta: { x?: number; y?: number }): Promise<CartesianZoomChangeEventDetail | null>| 인수 | 타입 | 필수 여부 |
|---|---|---|
delta | { x?: number; y?: number } | 필수 |
반환 타입: Promise<CartesianZoomChangeEventDetail | null>. 요소 등록이 끝난 뒤 메서드를 호출하고 Promise 결과를 await로 기다리세요.
resetZoom
확대·이동한 범위를 초기 데이터 범위로 되돌립니다.
resetZoom(): Promise<CartesianZoomChangeEventDetail | null>반환 타입: Promise<CartesianZoomChangeEventDetail | null>. 요소 등록이 끝난 뒤 메서드를 호출하고 Promise 결과를 await로 기다리세요.
getZoom
현재 확대 범위를 읽습니다. 반환 타입의 null 허용 여부와 축별 범위를 확인하세요.
getZoom(): Promise<CartesianZoomState | null>반환 타입: Promise<CartesianZoomState | null>. 요소 등록이 끝난 뒤 메서드를 호출하고 Promise 결과를 await로 기다리세요.
- CartesianZoomState
타입 정의
getZoomExtent
The full extent (0 … 1) and key of the diagram's orientations (null before the first layout).
getZoomExtent(request?: CartesianZoomExtentRequest): Promise<CartesianZoomExtentDetail | null>| 인수 | 타입 | 필수 여부 |
|---|---|---|
request | CartesianZoomExtentRequest | 선택 |
반환 타입: Promise<CartesianZoomExtentDetail | null>. 요소 등록이 끝난 뒤 메서드를 호출하고 Promise 결과를 await로 기다리세요.