Sankey.

PRO

노드 사이를 이동하는 양을 링크 너비로 표현합니다.

Live preview기능별 예제 23개

LIVE EXAMPLE

전환 흐름

페이지 테마에 맞춰 표시
차트를 조작하면 선택·범위 변경 결과가 여기에 표시됩니다.
옵션변경 사항이 미리보기와 코드에 반영됩니다.
표현과 스타일7
범례와 상호작용11
제목과 크기3

링크 너비로 단계 사이의 이동량을 표시합니다. 모든 값은 예시 데이터입니다.

코드 보기
현재 미리보기
<div id="chart-container" style="width: 100%; min-width: 0;"></div>

<script type="module">
  import { defineCustomElement as define0 } from '@syidax/advanced-pro/components/sy-sankey.js';
  define0();

  // Pro: 앱 시작 시 발급받은 인증서로 registerLicense를 완료하세요.
  // 홈페이지 미리보기의 인증서는 고객 앱에서 사용하지 않습니다.
  const specs = [
    {
      "id": "example-chart",
      "tag": "sy-sankey",
      "props": {
        "data": {
          "links": [
            {
              "source": "유입",
              "target": "제품 A",
              "value": 42
            },
            {
              "source": "유입",
              "target": "제품 B",
              "value": 28
            },
            {
              "source": "제품 A",
              "target": "구매",
              "value": 30
            },
            {
              "source": "제품 A",
              "target": "이탈",
              "value": 12
            },
            {
              "source": "제품 B",
              "target": "구매",
              "value": 18
            },
            {
              "source": "제품 B",
              "target": "이탈",
              "value": 10
            }
          ]
        },
        "nodeAlign": "justify",
        "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', 'sankey 예제 차트');
    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>

사용과 데이터

#

에너지·사용자·자금 흐름의 분기와 합류를 설명하세요.

링크의 단위를 통일하세요. 유입과 유출이 맞지 않는 경우 실제 의미를 별도로 설명하세요.

데이터 계약

프로퍼티입력 형식
data{ nodes?, links: [{ source, target, value }] }입니다.
nodeAlign단계에서 노드를 정렬하는 방식입니다.

데이터를 갱신할 때

배열 안의 값을 직접 바꾸기보다 새 배열·객체를 프로퍼티에 할당하세요. 차트의 이벤트는 event.detail로 선택 결과를 전달합니다. 화면을 해제할 때 ResizeObserver와 앱에서 등록한 이벤트 리스너를 정리하세요.

화면에 적용하기

#

미리보기 아래 코드 탭에서 현재 예제의 전체 데이터, 옵션, 이벤트 연결과 반응형 크기 처리를 확인하고 복사할 수 있습니다. 설치된 패키지를 해석할 수 있는 Vite 등의 앱 프로젝트에서 사용하세요.

공통 sy-chart API와 직접 태그의 차이

API 레퍼런스

#

sy-sankey의 전체 공개 API입니다. 객체와 배열은 JavaScript 프로퍼티로 전달하세요. 이름을 선택하면 적용 코드와 타입 계약을 확인할 수 있습니다.

주요 속성

속성 / 프로퍼티타입 / 기본값설명
SankeyData기본값 undefined{ nodes?, links: [{ source, target, value }] }입니다.
number기본값 900차트의 너비(px). 컨테이너가 바뀌면 ResizeObserver로 갱신합니다.
number기본값 400차트의 높이(px).
brandLogostring기본값 undefined기본값은 Syidax 로고입니다. Pro의 chart.branding 권한으로 none 또는 PNG·JPEG·WebP data URL을 사용할 수 있습니다.
brandPosition'top-left' | 'top-right' | 'bottom-left' | 'bottom-right'기본값 'bottom-right'로고를 고정할 코너입니다. Community·Pro, 화면과 이미지 내보내기에 동일하게 적용됩니다.
nodeWidthnumber기본값 SANKEY_DEFAULT_NODE_WIDTHThe nodes' width and the gap between stacked nodes (CSS px).
nodePaddingnumber기본값 SANKEY_DEFAULT_NODE_PADDINGHTML attribute 또는 JavaScript 프로퍼티로 설정합니다. 타입: number.
nodeAlignSankeyAlign기본값 'justify'단계에서 노드를 정렬하는 방식입니다.
linkOpacitynumber기본값 DEFAULT_LINK_OPACITYThe ribbons' opacity (0 … 1).
linkCurvaturenumber기본값 SANKEY_DEFAULT_CURVATUREHTML attribute 또는 JavaScript 프로퍼티로 설정합니다. 타입: number.
nodeLabelsSankeyLabelMode기본값 'auto'허용값: auto, show, hide. 기본값: 'auto'.
nodeLabelValueboolean기본값 falseHTML attribute 또는 JavaScript 프로퍼티로 설정합니다. 타입: boolean.
chartTitlestring기본값 undefined차트 내부 제목입니다. 데이터의 단위와 의미를 함께 설명하세요.
chartSubtitlestring기본값 undefined차트 내부 부제목입니다.
CartesianTooltipInput기본값 undefined포인터에 따라 표시할 값, 위치, 내용의 툴팁 설정입니다.
tooltipEnabledboolean기본값 trueHTML attribute 또는 JavaScript 프로퍼티로 설정합니다. 타입: boolean.
animatedboolean기본값 false초기 표시와 데이터 변경의 애니메이션 사용 여부입니다.
animationDurationnumber기본값 600애니메이션 지속 시간(ms).
animationEasingSankeyEasing기본값 'ease-out'허용값: linear, ease-out, ease-in, ease-in-out. 기본값: 'ease-out'.
animationTypeSankeyAnimationType기본값 undefined허용값: initial, update. 기본값: undefined.
CartesianZoomInput기본값 undefined확대·축소와 표시 범위의 동작 설정입니다.
나머지 속성 12
속성 / 프로퍼티타입 / 기본값설명
layoutIterationsnumber기본값 SANKEY_DEFAULT_ITERATIONSHTML attribute 또는 JavaScript 프로퍼티로 설정합니다. 타입: number.
string기본값 AUTO_COLORThe nodes' fill: `auto` (the palette by index) or a CSS colour; a node's own `color` wins.
linkColorstring기본값 'source'The links' colour: `source` / `target` (the node's colour at that end) or a CSS colour; a link's own `color` wins.
neighbourDimnumber기본값 DEFAULT_NEIGHBOUR_DIMHTML attribute 또는 JavaScript 프로퍼티로 설정합니다. 타입: number.
activeColorstring기본값 DEFAULT_ACTIVE_COLORThe hovered / focused node or link.
enableMouseTrackingboolean기본값 trueHTML attribute 또는 JavaScript 프로퍼티로 설정합니다. 타입: boolean.
tooltipFormat(detail: SankeyHitDetail) => string기본값 undefinedJavaScript 프로퍼티로 전달합니다. 타입: (detail: SankeyHitDetail) => string.
streamSourceSankeyStreamSource기본값 undefined실시간 데이터를 전달하는 스트림 소스입니다. 해당 타입의 계약을 확인하세요.
streamMaxnumber기본값 undefined보관할 스트리밍 데이터의 최대 수입니다.
streamWindownumber기본값 undefined화면에 유지할 스트리밍 데이터 구간입니다.
SankeyEngineMode기본값 'auto'auto·standard·pro 렌더러 선택입니다. 엔진 선택은 차트 종류의 Pro 사용 권한과 별개입니다.
SankeyUnavailableBehaviour기본값 'fallback'허용값: fallback, error. 기본값: 'fallback'.
이벤트 16
이벤트detail 타입설명
SankeyRenderResult & { tier: SankeyEngineTier }차트 그리기가 완료되면 렌더링 결과를 detail로 전달합니다.
SankeyNodeEventDetailCustomEvent.detail 타입: SankeyNodeEventDetail. 이벤트 이름은 대소문자를 구분합니다.
SankeyNodeEventDetail | nullCustomEvent.detail 타입: SankeyNodeEventDetail | null. 이벤트 이름은 대소문자를 구분합니다.
SankeyLinkEventDetailCustomEvent.detail 타입: SankeyLinkEventDetail. 이벤트 이름은 대소문자를 구분합니다.
SankeyLinkEventDetail | nullCustomEvent.detail 타입: SankeyLinkEventDetail | null. 이벤트 이름은 대소문자를 구분합니다.
SankeySelectionChangeEventDetailCustomEvent.detail 타입: SankeySelectionChangeEventDetail. 이벤트 이름은 대소문자를 구분합니다.
ChartPointContextMenuEventDetail<SankeyHitDetail>CustomEvent.detail 타입: ChartPointContextMenuEventDetail<SankeyHitDetail>. 이벤트 이름은 대소문자를 구분합니다.
{ count: number; replaced: number }CustomEvent.detail 타입: { count: number; replaced: number }. 이벤트 이름은 대소문자를 구분합니다.
{ dropped: number }CustomEvent.detail 타입: { dropped: number }. 이벤트 이름은 대소문자를 구분합니다.
CartesianTooltipEventDetail내장 툴팁 표시 여부입니다.
voidCustomEvent.detail 타입: void. 이벤트 이름은 대소문자를 구분합니다.
CartesianTooltipActionEventDetailCustomEvent.detail 타입: CartesianTooltipActionEventDetail. 이벤트 이름은 대소문자를 구분합니다.
voidCustomEvent.detail 타입: void. 이벤트 이름은 대소문자를 구분합니다.
voidCustomEvent.detail 타입: void. 이벤트 이름은 대소문자를 구분합니다.
voidCustomEvent.detail 타입: void. 이벤트 이름은 대소문자를 구분합니다.
CartesianZoomChangeEventDetailFired after every zoom change (drag / pan / wheel / pinch / keyboard / api / reset) with the new state.
메서드 38

Stencil 메서드는 Promise를 반환합니다. async 함수에서 await로 결과를 받으세요.

메서드 / 인수반환 타입설명
Promise<SankeyRenderResult>비동기 메서드입니다. 아래 인수 타입과 반환 타입을 확인하세요.
Promise<SankeyEngineTier>비동기 메서드입니다. 아래 인수 타입과 반환 타입을 확인하세요.
Promise<string | undefined>비동기 메서드입니다. 아래 인수 타입과 반환 타입을 확인하세요.
data: SankeyDataPromise<void>비동기 메서드입니다. 아래 인수 타입과 반환 타입을 확인하세요.
link: SankeyLinkInputPromise<void>Upsert one link (a tracked source → target pair replaces its link).
links: ReadonlyArray<SankeyLinkInput>Promise<void>비동기 메서드입니다. 아래 인수 타입과 반환 타입을 확인하세요.
count: numberPromise<void>Drop the oldest streamed links (the `data` links are not the stream).
links: ReadonlyArray<SankeyLinkInput>Promise<void>비동기 메서드입니다. 아래 인수 타입과 반환 타입을 확인하세요.
Promise<SankeyStreamSource | undefined>비동기 메서드입니다. 아래 인수 타입과 반환 타입을 확인하세요.
Promise<ChartEngineStatus>Requested vs effective engine and why (CHART-ADD-08), with the chart.type.sankey license state.
options: { duration?: number; easing?: SankeyEasing; enabled?: boolean; type?: SankeyAnimationType }Promise<void>비동기 메서드입니다. 아래 인수 타입과 반환 타입을 확인하세요.
Promise<void>비동기 메서드입니다. 아래 인수 타입과 반환 타입을 확인하세요.
Promise<void>비동기 메서드입니다. 아래 인수 타입과 반환 타입을 확인하세요.
Promise<void>비동기 메서드입니다. 아래 인수 타입과 반환 타입을 확인하세요.
cssX: number, cssY: numberPromise<SankeyHitDetail | 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<SankeyNode | null>비동기 메서드입니다. 아래 인수 타입과 반환 타입을 확인하세요.
id: stringPromise<SankeyNode | null>비동기 메서드입니다. 아래 인수 타입과 반환 타입을 확인하세요.
Promise<SankeyNode[]>비동기 메서드입니다. 아래 인수 타입과 반환 타입을 확인하세요.
Promise<SankeyLink[]>비동기 메서드입니다. 아래 인수 타입과 반환 타입을 확인하세요.
Promise<number>비동기 메서드입니다. 아래 인수 타입과 반환 타입을 확인하세요.
Promise<number>비동기 메서드입니다. 아래 인수 타입과 반환 타입을 확인하세요.
Promise<SankeyExtent>비동기 메서드입니다. 아래 인수 타입과 반환 타입을 확인하세요.
Promise<{ iterations: number; crossings: number; energy: number; curvature: number; crossingsComputed: boolean }>비동기 메서드입니다. 아래 인수 타입과 반환 타입을 확인하세요.
Promise<SankeyNodeLabel[]>비동기 메서드입니다. 아래 인수 타입과 반환 타입을 확인하세요.
Promise<SankeyLayoutResult>The layout in HOST-local CSS px as shown (the plot offset added; under a zoom, the viewport transform applied; while an update morph runs, its current frame): the node rects, the ribbons, the scale.
index: numberPromise<CartesianTooltipEventDetail | null>Open a tooltip by point index: nodes first, then directed links; null outside the graph or with the tooltip off.
Promise<void>Close every tooltip.
index: numberPromise<SankeyNodeEventDetail | null>Move the keyboard focus ring to a node (null off the nodes); emits nodeHover like the walk.
index: numberPromise<SankeyNodeEventDetail | 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<SankeyLinkEventDetail | 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<SankeySelection>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).