Waterfall.
PRO증감이 누적되어 최종값이 되는 과정을 보여줍니다.
LIVE EXAMPLE
매출 증감
표현과 스타일9
축과 격자14
범례와 상호작용13
제목과 크기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-waterfall-chart.js';
define0();
// Pro: 앱 시작 시 발급받은 인증서로 registerLicense를 완료하세요.
// 홈페이지 미리보기의 인증서는 고객 앱에서 사용하지 않습니다.
const specs = [
{
"id": "example-chart",
"tag": "sy-waterfall-chart",
"props": {
"data": [
{
"category": "기초",
"value": 100
},
{
"category": "신규",
"value": 45
},
{
"category": "해지",
"value": -20
},
{
"category": "추가",
"value": 15
},
{
"category": "합계",
"kind": "total"
}
],
"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', 'waterfall 예제 차트');
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);
// SPA에서는 화면이 해제될 때 이 함수를 호출하세요.
function disposeChart() {
observer.disconnect();
chart.removeEventListener('pointClick', onEvent);
container.replaceChildren();
}
</script>사용과 데이터
#매출·비용·재고의 시작값, 변화, 합계를 설명하세요.
total·subtotal은 일반 증감과 의미가 다릅니다. 합계를 delta로 한 번 더 더하지 마세요.
데이터 계약
| 프로퍼티 | 입력 형식 |
|---|---|
data | { category, value?, kind? } 배열입니다. kind는 delta·subtotal·total입니다. |
데이터를 갱신할 때
배열 안의 값을 직접 바꾸기보다 새 배열·객체를 프로퍼티에 할당하세요. 차트의 이벤트는 event.detail로 선택 결과를 전달합니다. 화면을 해제할 때 ResizeObserver와 앱에서 등록한 이벤트 리스너를 정리하세요.
기능별 예제
#20개의 기능 예제를 직접 조작하고 코드를 확인하세요. ‘미리보기에서 편집’을 누르면 위 설정 패널에서 옵션을 더 조합할 수 있습니다.
변화량 레이블PRO
증가·감소·합계의 값을 차트 안에서 확인합니다.
코드 보기
증감 색상PRO
증가·감소·합계를 서로 다른 색으로 표시합니다.
코드 보기
포인터와 값 확인PRO
데이터를 가리키면 해당 지점의 값을 확인할 수 있습니다.
코드 보기
십자선 추적PRO
포인터를 움직여 가로·세로 좌표와 값을 함께 읽습니다.
코드 보기
드래그 확대와 이동PRO
드래그로 확대하고 Shift를 누른 채 이동합니다. Ctrl + 휠로 확대하거나 축소할 수 있습니다.
코드 보기
애니메이션 재생PRO
같은 예제를 다시 그려 초기 표시 애니메이션을 확인합니다.
코드 보기
애니메이션PRO
애니메이션의 1가지 예제를 비교합니다. 예제 안의 버튼과 아래 옵션을 조작하면 실행 결과와 적용 코드가 함께 바뀝니다.
코드 보기
AxisPRO
Axis의 6가지 예제를 비교합니다. 예제 안의 버튼과 아래 옵션을 조작하면 실행 결과와 적용 코드가 함께 바뀝니다.
코드 보기
십자선PRO
십자선의 5가지 예제를 비교합니다. 예제 안의 버튼과 아래 옵션을 조작하면 실행 결과와 적용 코드가 함께 바뀝니다.
코드 보기
데이터 입력PRO
데이터 입력의 1가지 예제를 비교합니다. 예제 안의 버튼과 아래 옵션을 조작하면 실행 결과와 적용 코드가 함께 바뀝니다.
코드 보기
대용량 데이터PRO
대용량 데이터의 1가지 예제를 비교합니다. 예제 안의 버튼과 아래 옵션을 조작하면 실행 결과와 적용 코드가 함께 바뀝니다.
코드 보기
크기PRO
크기의 1가지 예제를 비교합니다. 예제 안의 버튼과 아래 옵션을 조작하면 실행 결과와 적용 코드가 함께 바뀝니다.
코드 보기
StylePRO
Style의 4가지 예제를 비교합니다. 예제 안의 버튼과 아래 옵션을 조작하면 실행 결과와 적용 코드가 함께 바뀝니다.
코드 보기
툴팁PRO
툴팁의 13가지 예제를 비교합니다. 예제 안의 버튼과 아래 옵션을 조작하면 실행 결과와 적용 코드가 함께 바뀝니다.
코드 보기
확대와 이동PRO
확대와 이동의 6가지 예제를 비교합니다. 예제 안의 버튼과 아래 옵션을 조작하면 실행 결과와 적용 코드가 함께 바뀝니다.
코드 보기
컨텍스트 메뉴PRO
컨텍스트 메뉴의 1가지 예제를 비교합니다. 예제 안의 버튼과 아래 옵션을 조작하면 실행 결과와 적용 코드가 함께 바뀝니다.
코드 보기
데이터 컨텍스트 메뉴PRO
데이터 컨텍스트 메뉴의 1가지 예제를 비교합니다. 예제 안의 버튼과 아래 옵션을 조작하면 실행 결과와 적용 코드가 함께 바뀝니다.
코드 보기
좌표와 데이터 조회PRO
좌표와 데이터 조회의 1가지 예제를 비교합니다. 예제 안의 버튼과 아래 옵션을 조작하면 실행 결과와 적용 코드가 함께 바뀝니다.
코드 보기
OverviewPRO
Overview의 4가지 예제를 비교합니다. 예제 안의 버튼과 아래 옵션을 조작하면 실행 결과와 적용 코드가 함께 바뀝니다.
코드 보기
Streaming · 실시간 데이터 추가와 갱신PRO
실시간 데이터 추가와 갱신의 5가지 예제를 비교합니다. 예제 안의 버튼과 아래 옵션을 조작하면 실행 결과와 적용 코드가 함께 바뀝니다.
코드 보기
화면에 적용하기
#미리보기 아래 코드 탭에서 현재 예제의 전체 데이터, 옵션, 이벤트 연결과 반응형 크기 처리를 확인하고 복사할 수 있습니다. 설치된 패키지를 해석할 수 있는 Vite 등의 앱 프로젝트에서 사용하세요.
API 레퍼런스
#sy-waterfall-chart의 전체 공개 API입니다. 객체와 배열은 JavaScript 프로퍼티로 전달하세요. 이름을 선택하면 적용 코드와 타입 계약을 확인할 수 있습니다.
주요 속성
| 속성 / 프로퍼티 | 타입 / 기본값 | 설명 |
|---|---|---|
WaterfallData기본값 undefined | { category, value?, kind? } 배열입니다. kind는 delta·subtotal·total입니다. | |
number기본값 900 | 차트의 너비(px). 컨테이너가 바뀌면 ResizeObserver로 갱신합니다. | |
number기본값 360 | 차트의 높이(px). | |
| brandLogo | string기본값 undefined | 기본값은 Syidax 로고입니다. Pro의 chart.branding 권한으로 none 또는 PNG·JPEG·WebP data URL을 사용할 수 있습니다. |
| brandPosition | 'top-left' | 'top-right' | 'bottom-left' | 'bottom-right'기본값 'bottom-right' | 로고를 고정할 코너입니다. Community·Pro, 화면과 이미지 내보내기에 동일하게 적용됩니다. |
| xAxis | XAxisInput기본값 undefined | The category axis (its `label` / `show` / `format`; the slots are one per bar), or `[bottom, top, …]` slots (the multi x-axis: every slot a category axis over the bars — `position`, `linkedTo`, `format` per the shared contract). |
| yAxis | YAxisInput기본값 undefined | The value axis: one input, or `[left, right, …]` slots (the dual / multi y-axis; `kind: 'log' | 'time'` and `linkedTo` per the shared contract). |
| gridLines | CartesianGridLinesInput기본값 undefined | Grid lines: the value axis's on by default, the category axis's off. |
CartesianCrosshairInput기본값 undefined | Crosshair that follows the cursor across the plot. | |
CartesianZoomInput기본값 undefined | 확대·축소와 표시 범위의 동작 설정입니다. | |
| upColor | string기본값 DEFAULT_UP_COLOR | The bar colours: a rising delta, a falling delta, a total / subtotal; the connectors; the hovered / focused bar. |
| downColor | string기본값 DEFAULT_DOWN_COLOR | HTML attribute 또는 JavaScript 프로퍼티로 설정합니다. 타입: string. |
| totalColor | string기본값 DEFAULT_TOTAL_COLOR | HTML attribute 또는 JavaScript 프로퍼티로 설정합니다. 타입: string. |
| connectorWidth | number기본값 1 | The connector's thickness in CSS px, and its switch. |
| showConnectors | boolean기본값 true | HTML attribute 또는 JavaScript 프로퍼티로 설정합니다. 타입: boolean. |
| showTotal | boolean기본값 false | HTML attribute 또는 JavaScript 프로퍼티로 설정합니다. 타입: boolean. |
| totalLabel | string기본값 WATERFALL_DEFAULT_TOTAL_LABEL | HTML attribute 또는 JavaScript 프로퍼티로 설정합니다. 타입: string. |
| showLabels | boolean기본값 false | The value labels (off by default): `label-mode` value (a delta's signed change, a total's running total) / running / both; `labelFormat(bar)` replaces the text. |
| labelMode | WaterfallLabelMode기본값 'value' | 허용값: value, running, both. 기본값: 'value'. |
| chartTitle | string기본값 undefined | 차트 내부 제목입니다. 데이터의 단위와 의미를 함께 설명하세요. |
| chartSubtitle | string기본값 undefined | 차트 내부 부제목입니다. |
CartesianTooltipInput기본값 undefined | 포인터에 따라 표시할 값, 위치, 내용의 툴팁 설정입니다. | |
| tooltipEnabled | boolean기본값 true | HTML attribute 또는 JavaScript 프로퍼티로 설정합니다. 타입: boolean. |
| animated | boolean기본값 false | 초기 표시와 데이터 변경의 애니메이션 사용 여부입니다. |
| animationDuration | number기본값 600 | 애니메이션 지속 시간(ms). |
| animationEasing | WaterfallEasing기본값 'ease-out' | 허용값: linear, ease-out, ease-in, ease-in-out. 기본값: 'ease-out'. |
| animationType | WaterfallAnimationType기본값 undefined | 허용값: initial, update. 기본값: undefined. |
나머지 속성 18
| 속성 / 프로퍼티 | 타입 / 기본값 | 설명 |
|---|---|---|
| yMin | number기본값 undefined | HTML attribute 또는 JavaScript 프로퍼티로 설정합니다. 타입: number. |
| yMax | number기본값 undefined | HTML attribute 또는 JavaScript 프로퍼티로 설정합니다. 타입: number. |
number기본값 0.05 | The automatic domain pads the value span by this share (default 5 %); zero is always inside. | |
| connectorColor | string기본값 DEFAULT_CONNECTOR_COLOR | HTML attribute 또는 JavaScript 프로퍼티로 설정합니다. 타입: string. |
| activeColor | string기본값 DEFAULT_ACTIVE_COLOR | HTML attribute 또는 JavaScript 프로퍼티로 설정합니다. 타입: string. |
| barWidth | number기본값 WATERFALL_DEFAULT_WIDTH_RATIO | The bar's share of the slot pitch (0.6), clamped between `bar-min-px` and `bar-max-px`. |
| barMinPx | number기본값 WATERFALL_DEFAULT_MIN_PX | HTML attribute 또는 JavaScript 프로퍼티로 설정합니다. 타입: number. |
| barMaxPx | number기본값 WATERFALL_DEFAULT_MAX_PX | HTML attribute 또는 JavaScript 프로퍼티로 설정합니다. 타입: number. |
| detectResult | boolean기본값 true | Recognise a last step given as a plain value equal to the running total as the RESULT bar (a total from zero; `detected: true`); off → it stays a delta. |
| lastResult | boolean기본값 undefined | True: the last merged step is a result spanning zero and the preceding running total, ignoring its value/colour. False: disable detection, preserving explicit datum kinds. Omitted: use detect-result. |
| labelFormat | (bar: WaterfallBar) => string기본값 undefined | JavaScript 프로퍼티로 전달합니다. 타입: (bar: WaterfallBar) => string. |
| enableMouseTracking | boolean기본값 true | HTML attribute 또는 JavaScript 프로퍼티로 설정합니다. 타입: boolean. |
| tooltipFormat | (detail: WaterfallPointEventDetail) => string기본값 undefined | JavaScript 프로퍼티로 전달합니다. 타입: (detail: WaterfallPointEventDetail) => string. |
| streamSource | WaterfallStreamSource기본값 undefined | 실시간 데이터를 전달하는 스트림 소스입니다. 해당 타입의 계약을 확인하세요. |
| streamMax | number기본값 undefined | 보관할 스트리밍 데이터의 최대 수입니다. |
| streamWindow | number기본값 undefined | 화면에 유지할 스트리밍 데이터 구간입니다. |
WaterfallEngineMode기본값 'auto' | auto·standard·pro 렌더러 선택입니다. 엔진 선택은 차트 종류의 Pro 사용 권한과 별개입니다. | |
WaterfallUnavailableBehaviour기본값 'fallback' | 허용값: fallback, error. 기본값: 'fallback'. |
이벤트 14
| 이벤트 | detail 타입 | 설명 |
|---|---|---|
WaterfallRenderResult & { tier: WaterfallEngineTier; engine?: ChartEngineStatus } | 차트 그리기가 완료되면 렌더링 결과를 detail로 전달합니다. | |
WaterfallPointEventDetail | 점 선택 이벤트입니다. CustomEvent.detail에서 선택한 데이터와 인덱스를 읽습니다. | |
WaterfallPointEventDetail | null | CustomEvent.detail 타입: WaterfallPointEventDetail | null. 이벤트 이름은 대소문자를 구분합니다. | |
CartesianCrosshairEventDetail | null | CustomEvent.detail 타입: CartesianCrosshairEventDetail | null. 이벤트 이름은 대소문자를 구분합니다. | |
ChartPointContextMenuEventDetail<WaterfallPointEventDetail> | CustomEvent.detail 타입: ChartPointContextMenuEventDetail<WaterfallPointEventDetail>. 이벤트 이름은 대소문자를 구분합니다. | |
{ count: number; replaced: number } | CustomEvent.detail 타입: { count: number; replaced: number }. 이벤트 이름은 대소문자를 구분합니다. | |
{ dropped: number } | CustomEvent.detail 타입: { dropped: number }. 이벤트 이름은 대소문자를 구분합니다. | |
CartesianTooltipEventDetail | 내장 툴팁 표시 여부입니다. | |
void | CustomEvent.detail 타입: void. 이벤트 이름은 대소문자를 구분합니다. | |
CartesianTooltipActionEventDetail | CustomEvent.detail 타입: CartesianTooltipActionEventDetail. 이벤트 이름은 대소문자를 구분합니다. | |
void | CustomEvent.detail 타입: void. 이벤트 이름은 대소문자를 구분합니다. | |
void | CustomEvent.detail 타입: void. 이벤트 이름은 대소문자를 구분합니다. | |
void | CustomEvent.detail 타입: void. 이벤트 이름은 대소문자를 구분합니다. | |
CartesianZoomChangeEventDetail | Fired after every zoom change (drag / pan / wheel / pinch / keyboard / api / reset) with the new state. |
메서드 33
Stencil 메서드는 Promise를 반환합니다. async 함수에서 await로 결과를 받으세요.
| 메서드 / 인수 | 반환 타입 | 설명 |
|---|---|---|
Promise<ChartDataTable> | Current normalized table, including the retained stream; independent of GPU availability. | |
Promise<WaterfallRenderResult> | Draws a frame now; rejects with the SyidaxLicenseError while the type is not entitled or the chart is frozen. | |
Promise<WaterfallEngineTier> | 비동기 메서드입니다. 아래 인수 타입과 반환 타입을 확인하세요. | |
Promise<string | undefined> | 비동기 메서드입니다. 아래 인수 타입과 반환 타입을 확인하세요. | |
| data: WaterfallData | Promise<void> | 비동기 메서드입니다. 아래 인수 타입과 반환 타입을 확인하세요. |
| datum: WaterfallDatumInput | Promise<void> | Upsert one step (a tracked category replaces its step; the running total re-tells). |
| data: ReadonlyArray<WaterfallDatumInput> | Promise<void> | 비동기 메서드입니다. 아래 인수 타입과 반환 타입을 확인하세요. |
| count: number | Promise<void> | Drop the oldest streamed steps (the `data` bars are not the stream). |
| data: ReadonlyArray<WaterfallDatumInput> | Promise<void> | 비동기 메서드입니다. 아래 인수 타입과 반환 타입을 확인하세요. |
Promise<WaterfallStreamSource | undefined> | 비동기 메서드입니다. 아래 인수 타입과 반환 타입을 확인하세요. | |
| options: { duration?: number; easing?: WaterfallEasing; enabled?: boolean; type?: WaterfallAnimationType } | Promise<void> | 비동기 메서드입니다. 아래 인수 타입과 반환 타입을 확인하세요. |
Promise<void> | 비동기 메서드입니다. 아래 인수 타입과 반환 타입을 확인하세요. | |
Promise<void> | 비동기 메서드입니다. 아래 인수 타입과 반환 타입을 확인하세요. | |
Promise<void> | 비동기 메서드입니다. 아래 인수 타입과 반환 타입을 확인하세요. | |
| cssX: number, cssY: number | Promise<WaterfallPointEventDetail | null> | The bar under a host-local CSS point (the nearest slot, within half a pitch), or null. |
| index: number | Promise<WaterfallBar | null> | 비동기 메서드입니다. 아래 인수 타입과 반환 타입을 확인하세요. |
| category: string | Promise<WaterfallBar | null> | 비동기 메서드입니다. 아래 인수 타입과 반환 타입을 확인하세요. |
Promise<number> | 비동기 메서드입니다. 아래 인수 타입과 반환 타입을 확인하세요. | |
Promise<WaterfallBar[]> | 비동기 메서드입니다. 아래 인수 타입과 반환 타입을 확인하세요. | |
Promise<string[]> | 비동기 메서드입니다. 아래 인수 타입과 반환 타입을 확인하세요. | |
Promise<WaterfallExtent> | 비동기 메서드입니다. 아래 인수 타입과 반환 타입을 확인하세요. | |
Promise<WaterfallDomain> | 비동기 메서드입니다. 아래 인수 타입과 반환 타입을 확인하세요. | |
Promise<number> | The running total after the last bar (0 without bars). | |
| index: number | Promise<CartesianTooltipEventDetail | null> | Open the tooltip on a bar (the facade's `showTooltipAtPoint` routes here); null off the bars or with the tooltip off. |
Promise<void> | Close every tooltip. | |
| index: number | Promise<WaterfallPointEventDetail | null> | Move the keyboard focus ring to a bar (null off the bars); emits pointHover like the walk. |
| request: CartesianZoomRequest | Promise<CartesianZoomChangeEventDetail | null> | Zoom to explicit windows: `x` / `y` as `{ min, max }` or `[min, max]` (`null` clears that orientation; x is in slots — bar i sits at i); `xAxis` / `yAxis` name the axis by id or slot index (default: the primary axis). |
| 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 data units (`{ x?, y? }` — x in slots); a no-op at the full extent. |
Promise<CartesianZoomChangeEventDetail | null> | Back to the full extent. | |
Promise<CartesianZoomState | null> | The current zoom state (`null` = full extent). | |
| request?: CartesianZoomExtentRequest | Promise<CartesianZoomExtentDetail | null> | The full extent (and key) of the primary — or the named — master axes (x: the slot range −0.5 … n − 0.5). |
Promise<ChartEngineStatus> | Requested engine vs what runs, and why (CHART-ADD-08): the decision for the current inputs, read without side effects (ProChartLicense.engineStatus); a renderer that failed at run time reports engine-unsupported. |
일치하는 API가 없습니다.