sy-bar-chart
Bar
항목의 크기를 가로 막대로 비교합니다.
sy-bar-chart
긴 범주 이름이나 순위 목록을 보여줄 때 사용하세요.
지표의 단위를 통일하고 순서를 의도적으로 정하세요. 방향이 달라도 값의 차이는 길이로 읽습니다.
기본 차트 등급: Community. 추가 렌더러·커스텀 브랜딩 등 기능의 권한은 별도입니다.
| 입력 | 데이터 설명 |
|---|---|
series | 비교할 그룹의 values 배열입니다. |
values | 단일 목록의 수치입니다. |
xAxis | 값의 범위를 지정하는 linear 축입니다. |
yAxis | categories로 가로 막대의 범주 이름을 지정합니다. |
- Components에서 실행하기
옵션 변경과 프레임워크별 코드
- 공통 설치와 연결
전체 적용 예제
<div id="chart-container" style="width: 100%; min-width: 0;"></div>
<script type="module">
import { defineCustomElement as define0 } from '@syidax/advanced/components/sy-bar-chart.js';
define0();
const specs = [
{
"id": "example-chart",
"tag": "sy-bar-chart",
"props": {
"engine": "standard",
"series": [
{
"name": "온라인",
"values": [24, 29, 27, 38, 43, 40],
"color": "#8263d9"
},
{
"name": "매장",
"values": [15, 19, 17, 24, 22, 29],
"color": "#239c91"
}
],
"xAxis": {
"kind": "linear",
"min": 0
},
"yAxis": {
"kind": "category",
"categories": ["1월", "2월", "3월", "4월", "5월", "6월"]
},
"legend": true,
"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', 'bar 예제 차트');
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>Properties
series
비교할 그룹의 values 배열입니다.
| 항목 | 값 |
|---|---|
| JavaScript 프로퍼티 | series |
| HTML attribute | 객체·배열·콜백은 JavaScript 프로퍼티로 전달 |
| 타입 | BarChartSeries[] |
| 기본값 | undefined |
undefined는 이 속성을 명시하지 않은 상태입니다. 실제 표시 값은 차트 종류와 다른 설정에 따라 결정될 수 있습니다.
- BarChartSeries
타입 정의
activeSeriesIndex
HTML attribute 또는 JavaScript 프로퍼티로 설정합니다. 타입: number.
| 항목 | 값 |
|---|---|
| JavaScript 프로퍼티 | activeSeriesIndex |
| HTML attribute | active-series-index |
| 타입 | number |
| 기본값 | undefined |
undefined는 이 속성을 명시하지 않은 상태입니다. 실제 표시 값은 차트 종류와 다른 설정에 따라 결정될 수 있습니다.
seriesState
JavaScript 프로퍼티로 전달합니다. 타입: BarChartSeriesStateOptions.
| 항목 | 값 |
|---|---|
| JavaScript 프로퍼티 | seriesState |
| HTML attribute | 객체·배열·콜백은 JavaScript 프로퍼티로 전달 |
| 타입 | BarChartSeriesStateOptions |
| 기본값 | undefined |
undefined는 이 속성을 명시하지 않은 상태입니다. 실제 표시 값은 차트 종류와 다른 설정에 따라 결정될 수 있습니다.
seriesActiveTrigger
허용값: hover, click, custom. 기본값: 'hover'.
| 항목 | 값 |
|---|---|
| JavaScript 프로퍼티 | seriesActiveTrigger |
| HTML attribute | series-active-trigger |
| 타입 | BarChartSeriesActiveTrigger |
| 기본값 | 'hover' |
| 허용값 | hover, click, custom |
values
단일 목록의 수치입니다.
| 항목 | 값 |
|---|---|
| JavaScript 프로퍼티 | values |
| HTML attribute | 객체·배열·콜백은 JavaScript 프로퍼티로 전달 |
| 타입 | BarChartValues |
| 기본값 | new Float32Array(0) |
- BarChartValues
타입 정의
width
차트의 너비를 px 단위로 지정합니다. 컨테이너 너비가 변하는 앱에서는 ResizeObserver에서 width를 갱신하세요.
| 항목 | 값 |
|---|---|
| JavaScript 프로퍼티 | width |
| HTML attribute | width |
| 타입 | number |
| 기본값 | 600 |
height
차트의 높이를 px 단위로 지정합니다. 축, 제목과 범례가 차지하는 공간을 함께 고려하세요.
| 항목 | 값 |
|---|---|
| JavaScript 프로퍼티 | height |
| HTML attribute | height |
| 타입 | number |
| 기본값 | 300 |
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 |
color
HTML attribute 또는 JavaScript 프로퍼티로 설정합니다. 타입: string.
| 항목 | 값 |
|---|---|
| JavaScript 프로퍼티 | color |
| HTML attribute | color |
| 타입 | string |
| 기본값 | '#2563eb' |
thickness
HTML attribute 또는 JavaScript 프로퍼티로 설정합니다. 타입: number.
| 항목 | 값 |
|---|---|
| JavaScript 프로퍼티 | thickness |
| HTML attribute | thickness |
| 타입 | number |
| 기본값 | 0 |
barPadding
HTML attribute 또는 JavaScript 프로퍼티로 설정합니다. 타입: number.
| 항목 | 값 |
|---|---|
| JavaScript 프로퍼티 | barPadding |
| HTML attribute | bar-padding |
| 타입 | number |
| 기본값 | 0.1 |
seriesPadding
HTML attribute 또는 JavaScript 프로퍼티로 설정합니다. 타입: number.
| 항목 | 값 |
|---|---|
| JavaScript 프로퍼티 | seriesPadding |
| HTML attribute | series-padding |
| 타입 | number |
| 기본값 | 0.1 |
baseline
Value the bars grow from. Always explicit (default 0) so the start point is never ambiguous — set to a non-zero anchor when the chart measures variance against something other than zero.
| 항목 | 값 |
|---|---|
| JavaScript 프로퍼티 | baseline |
| HTML attribute | baseline |
| 타입 | number |
| 기본값 | 0 |
stacking
허용값: normal, percent. 기본값: undefined.
| 항목 | 값 |
|---|---|
| JavaScript 프로퍼티 | stacking |
| HTML attribute | stacking |
| 타입 | CartesianSeriesStackingMode |
| 기본값 | undefined |
| 허용값 | normal, percent |
undefined는 이 속성을 명시하지 않은 상태입니다. 실제 표시 값은 차트 종류와 다른 설정에 따라 결정될 수 있습니다.
borderRadius
JavaScript 프로퍼티로 전달합니다. 타입: CartesianSeriesCornerRadiusValue.
| 항목 | 값 |
|---|---|
| JavaScript 프로퍼티 | borderRadius |
| HTML attribute | 객체·배열·콜백은 JavaScript 프로퍼티로 전달 |
| 타입 | CartesianSeriesCornerRadiusValue |
| 기본값 | undefined |
undefined는 이 속성을 명시하지 않은 상태입니다. 실제 표시 값은 차트 종류와 다른 설정에 따라 결정될 수 있습니다.
borderScope
허용값: point, stack, outline. 기본값: 'stack'.
| 항목 | 값 |
|---|---|
| JavaScript 프로퍼티 | borderScope |
| HTML attribute | border-scope |
| 타입 | BarBorderScope |
| 기본값 | 'stack' |
| 허용값 | point, stack, outline |
- BarBorderScope
타입 정의
borderColor
HTML attribute 또는 JavaScript 프로퍼티로 설정합니다. 타입: string.
| 항목 | 값 |
|---|---|
| JavaScript 프로퍼티 | borderColor |
| HTML attribute | border-color |
| 타입 | string |
| 기본값 | undefined |
undefined는 이 속성을 명시하지 않은 상태입니다. 실제 표시 값은 차트 종류와 다른 설정에 따라 결정될 수 있습니다.
borderWidth
HTML attribute 또는 JavaScript 프로퍼티로 설정합니다. 타입: number.
| 항목 | 값 |
|---|---|
| JavaScript 프로퍼티 | borderWidth |
| HTML attribute | border-width |
| 타입 | number |
| 기본값 | undefined |
undefined는 이 속성을 명시하지 않은 상태입니다. 실제 표시 값은 차트 종류와 다른 설정에 따라 결정될 수 있습니다.
borderDashStyle
허용값: Solid, Dash, Dot, DashDot, LongDash, LongDashDot. 기본값: undefined.
| 항목 | 값 |
|---|---|
| JavaScript 프로퍼티 | borderDashStyle |
| HTML attribute | border-dash-style |
| 타입 | CartesianSeriesBorderDashStyle |
| 기본값 | undefined |
| 허용값 | Solid, Dash, Dot, DashDot, LongDash, LongDashDot |
undefined는 이 속성을 명시하지 않은 상태입니다. 실제 표시 값은 차트 종류와 다른 설정에 따라 결정될 수 있습니다.
inactiveOtherPoints
HTML attribute 또는 JavaScript 프로퍼티로 설정합니다. 타입: boolean.
| 항목 | 값 |
|---|---|
| JavaScript 프로퍼티 | inactiveOtherPoints |
| HTML attribute | inactive-other-points |
| 타입 | boolean |
| 기본값 | false |
inactivePointOpacity
HTML attribute 또는 JavaScript 프로퍼티로 설정합니다. 타입: number.
| 항목 | 값 |
|---|---|
| JavaScript 프로퍼티 | inactivePointOpacity |
| HTML attribute | inactive-point-opacity |
| 타입 | number |
| 기본값 | 0.2 |
engine
auto·standard·pro 렌더러 선택입니다. 엔진 선택은 차트 종류의 Pro 사용 권한과 별개입니다.
| 항목 | 값 |
|---|---|
| JavaScript 프로퍼티 | engine |
| HTML attribute | engine |
| 타입 | BarChartEngineMode |
| 기본값 | 'auto' |
| 허용값 | auto, standard, pro |
- BarChartEngineMode
타입 정의
proThreshold
HTML attribute 또는 JavaScript 프로퍼티로 설정합니다. 타입: number.
| 항목 | 값 |
|---|---|
| JavaScript 프로퍼티 | proThreshold |
| HTML attribute | pro-threshold |
| 타입 | number |
| 기본값 | 50_000 |
streamSource
실시간 데이터를 전달하는 스트림 소스입니다. 해당 타입의 계약을 확인하세요.
| 항목 | 값 |
|---|---|
| JavaScript 프로퍼티 | streamSource |
| HTML attribute | 객체·배열·콜백은 JavaScript 프로퍼티로 전달 |
| 타입 | BarChartStreamSource |
| 기본값 | undefined |
undefined는 이 속성을 명시하지 않은 상태입니다. 실제 표시 값은 차트 종류와 다른 설정에 따라 결정될 수 있습니다.
- BarChartStreamSource
타입 정의
streamWindow
화면에 유지할 스트리밍 데이터 구간입니다.
| 항목 | 값 |
|---|---|
| JavaScript 프로퍼티 | streamWindow |
| HTML attribute | stream-window |
| 타입 | number |
| 기본값 | undefined |
undefined는 이 속성을 명시하지 않은 상태입니다. 실제 표시 값은 차트 종류와 다른 설정에 따라 결정될 수 있습니다.
streamMax
보관할 스트리밍 데이터의 최대 수입니다.
| 항목 | 값 |
|---|---|
| JavaScript 프로퍼티 | streamMax |
| HTML attribute | stream-max |
| 타입 | number |
| 기본값 | undefined |
undefined는 이 속성을 명시하지 않은 상태입니다. 실제 표시 값은 차트 종류와 다른 설정에 따라 결정될 수 있습니다.
animated
초기 표시와 데이터 변경의 애니메이션 사용 여부입니다.
| 항목 | 값 |
|---|---|
| JavaScript 프로퍼티 | animated |
| HTML attribute | animate |
| 타입 | boolean |
| 기본값 | false |
animationDuration
애니메이션 지속 시간(ms).
| 항목 | 값 |
|---|---|
| JavaScript 프로퍼티 | animationDuration |
| HTML attribute | animation-duration |
| 타입 | number |
| 기본값 | 200 |
animationEasing
허용값: linear, ease-out, ease-in, ease-in-out. 기본값: 'ease-out'.
| 항목 | 값 |
|---|---|
| JavaScript 프로퍼티 | animationEasing |
| HTML attribute | animation-easing |
| 타입 | BarChartEasing |
| 기본값 | 'ease-out' |
| 허용값 | linear, ease-out, ease-in, ease-in-out |
- BarChartEasing
타입 정의
animationType
허용값: initial, update. 기본값: undefined.
| 항목 | 값 |
|---|---|
| JavaScript 프로퍼티 | animationType |
| HTML attribute | animation-type |
| 타입 | BarChartAnimationType |
| 기본값 | undefined |
| 허용값 | initial, update |
undefined는 이 속성을 명시하지 않은 상태입니다. 실제 표시 값은 차트 종류와 다른 설정에 따라 결정될 수 있습니다.
legend
시리즈 또는 항목의 범례 표시 여부입니다.
| 항목 | 값 |
|---|---|
| JavaScript 프로퍼티 | legend |
| HTML attribute | legend |
| 타입 | boolean |
| 기본값 | false |
legendPosition
범례를 배치할 위치입니다.
| 항목 | 값 |
|---|---|
| JavaScript 프로퍼티 | legendPosition |
| HTML attribute | legend-position |
| 타입 | BarChartLegendPosition |
| 기본값 | 'bottom' |
| 허용값 | top, bottom, left, right, float |
legendItems
JavaScript 프로퍼티로 전달합니다. 타입: LegendItem[].
| 항목 | 값 |
|---|---|
| JavaScript 프로퍼티 | legendItems |
| HTML attribute | 객체·배열·콜백은 JavaScript 프로퍼티로 전달 |
| 타입 | LegendItem[] |
| 기본값 | undefined |
undefined는 이 속성을 명시하지 않은 상태입니다. 실제 표시 값은 차트 종류와 다른 설정에 따라 결정될 수 있습니다.
- LegendItem
타입 정의
seriesName
HTML attribute 또는 JavaScript 프로퍼티로 설정합니다. 타입: string.
| 항목 | 값 |
|---|---|
| JavaScript 프로퍼티 | seriesName |
| HTML attribute | series-name |
| 타입 | string |
| 기본값 | undefined |
undefined는 이 속성을 명시하지 않은 상태입니다. 실제 표시 값은 차트 종류와 다른 설정에 따라 결정될 수 있습니다.
legendFloatAlign
허용값: start, center, end. 기본값: 'end'.
| 항목 | 값 |
|---|---|
| JavaScript 프로퍼티 | legendFloatAlign |
| HTML attribute | legend-float-align |
| 타입 | 'start' | 'center' | 'end' |
| 기본값 | 'end' |
| 허용값 | start, center, end |
legendFloatVerticalAlign
허용값: top, bottom, middle. 기본값: 'top'.
| 항목 | 값 |
|---|---|
| JavaScript 프로퍼티 | legendFloatVerticalAlign |
| HTML attribute | legend-float-vertical-align |
| 타입 | 'top' | 'middle' | 'bottom' |
| 기본값 | 'top' |
| 허용값 | top, bottom, middle |
legendDraggable
HTML attribute 또는 JavaScript 프로퍼티로 설정합니다. 타입: boolean.
| 항목 | 값 |
|---|---|
| JavaScript 프로퍼티 | legendDraggable |
| HTML attribute | legend-draggable |
| 타입 | boolean |
| 기본값 | false |
xAxis
값의 범위를 지정하는 linear 축입니다.
| 항목 | 값 |
|---|---|
| JavaScript 프로퍼티 | xAxis |
| HTML attribute | 객체·배열·콜백은 JavaScript 프로퍼티로 전달 |
| 타입 | CartesianAxisInput | ReadonlyArray<CartesianAxisInput> |
| 기본값 | undefined |
| 타입에 포함된 리터럴 | auto, off |
undefined는 이 속성을 명시하지 않은 상태입니다. 실제 표시 값은 차트 종류와 다른 설정에 따라 결정될 수 있습니다.
- CartesianAxisInput
타입 정의
yAxis
categories로 가로 막대의 범주 이름을 지정합니다.
| 항목 | 값 |
|---|---|
| JavaScript 프로퍼티 | yAxis |
| HTML attribute | 객체·배열·콜백은 JavaScript 프로퍼티로 전달 |
| 타입 | CartesianYAxisInput |
| 기본값 | undefined |
| 타입에 포함된 리터럴 | auto, off |
undefined는 이 속성을 명시하지 않은 상태입니다. 실제 표시 값은 차트 종류와 다른 설정에 따라 결정될 수 있습니다.
- CartesianYAxisInput
타입 정의
chartTitle
차트 내부 제목입니다. 데이터의 단위와 의미를 함께 설명하세요.
| 항목 | 값 |
|---|---|
| JavaScript 프로퍼티 | chartTitle |
| HTML attribute | chart-title |
| 타입 | string |
| 기본값 | undefined |
undefined는 이 속성을 명시하지 않은 상태입니다. 실제 표시 값은 차트 종류와 다른 설정에 따라 결정될 수 있습니다.
chartSubtitle
차트 내부 부제목입니다.
| 항목 | 값 |
|---|---|
| JavaScript 프로퍼티 | chartSubtitle |
| HTML attribute | chart-subtitle |
| 타입 | string |
| 기본값 | undefined |
undefined는 이 속성을 명시하지 않은 상태입니다. 실제 표시 값은 차트 종류와 다른 설정에 따라 결정될 수 있습니다.
tooltip
포인터에 따라 표시할 값, 위치, 내용의 툴팁 설정입니다.
| 항목 | 값 |
|---|---|
| JavaScript 프로퍼티 | tooltip |
| HTML attribute | 객체·배열·콜백은 JavaScript 프로퍼티로 전달 |
| 타입 | CartesianTooltipInput |
| 기본값 | undefined |
| 타입에 포함된 리터럴 | auto, off |
undefined는 이 속성을 명시하지 않은 상태입니다. 실제 표시 값은 차트 종류와 다른 설정에 따라 결정될 수 있습니다.
crosshair
JavaScript 프로퍼티로 전달합니다. 타입: CartesianCrosshairInput.
| 항목 | 값 |
|---|---|
| JavaScript 프로퍼티 | crosshair |
| HTML attribute | 객체·배열·콜백은 JavaScript 프로퍼티로 전달 |
| 타입 | CartesianCrosshairInput |
| 기본값 | undefined |
undefined는 이 속성을 명시하지 않은 상태입니다. 실제 표시 값은 차트 종류와 다른 설정에 따라 결정될 수 있습니다.
gridLines
허용값: auto, off. 기본값: undefined.
| 항목 | 값 |
|---|---|
| JavaScript 프로퍼티 | gridLines |
| HTML attribute | 객체·배열·콜백은 JavaScript 프로퍼티로 전달 |
| 타입 | CartesianGridLinesInput |
| 기본값 | undefined |
| 타입에 포함된 리터럴 | auto, off |
undefined는 이 속성을 명시하지 않은 상태입니다. 실제 표시 값은 차트 종류와 다른 설정에 따라 결정될 수 있습니다.
zoom
zoom: 'x' | 'y' | 'xy' | true (x) enable the drag rectangle + keyboard (+ / - / Escape) on the primary axes (bar: x = the value axis, y = the category rows); an object refines mode / drag / keyboard / minRangePx / resetButton. Off by default. zoomTo / zoomBy / resetZoom work regardless of the gesture switches.
| 항목 | 값 |
|---|---|
| JavaScript 프로퍼티 | zoom |
| HTML attribute | 객체·배열·콜백은 JavaScript 프로퍼티로 전달 |
| 타입 | CartesianZoomInput |
| 기본값 | undefined |
| 타입에 포함된 리터럴 | auto, off, true, false, x, y, xy, inside |
undefined는 이 속성을 명시하지 않은 상태입니다. 실제 표시 값은 차트 종류와 다른 설정에 따라 결정될 수 있습니다.
- CartesianZoomInput
타입 정의
brush
brush selection: 'rect' | true | { type, mode, modifier, minSizePx, keyboard, clearOnClick }; off by default.
| 항목 | 값 |
|---|---|
| JavaScript 프로퍼티 | brush |
| HTML attribute | 객체·배열·콜백은 JavaScript 프로퍼티로 전달 |
| 타입 | CartesianBrushInput |
| 기본값 | undefined |
| 타입에 포함된 리터럴 | auto, off, true, false, rect, lasso |
undefined는 이 속성을 명시하지 않은 상태입니다. 실제 표시 값은 차트 종류와 다른 설정에 따라 결정될 수 있습니다.
- CartesianBrushInput
타입 정의
drawings
the drawing document: a list of drawings, a serialized envelope, or a JSON string of either (replaces the document; the history restarts).
| 항목 | 값 |
|---|---|
| JavaScript 프로퍼티 | drawings |
| HTML attribute | 객체·배열·콜백은 JavaScript 프로퍼티로 전달 |
| 타입 | ChartDrawingsInput |
| 기본값 | undefined |
undefined는 이 속성을 명시하지 않은 상태입니다. 실제 표시 값은 차트 종류와 다른 설정에 따라 결정될 수 있습니다.
- ChartDrawingsInput
타입 정의
drawingMode
the pointer disposition: 'none' (default), 'draw' (the plain drag places drawingTool; precedence drawing > brush > zoom > pan), 'select' ().
| 항목 | 값 |
|---|---|
| JavaScript 프로퍼티 | drawingMode |
| HTML attribute | 객체·배열·콜백은 JavaScript 프로퍼티로 전달 |
| 타입 | DrawingModeInput |
| 기본값 | undefined |
| 타입에 포함된 리터럴 | none, off, true, false, draw, select |
undefined는 이 속성을 명시하지 않은 상태입니다. 실제 표시 값은 차트 종류와 다른 설정에 따라 결정될 수 있습니다.
- DrawingModeInput
타입 정의
drawingTool
the tool drawingMode="draw" places (a registered tool name; default 'segment').
| 항목 | 값 |
|---|---|
| JavaScript 프로퍼티 | drawingTool |
| HTML attribute | drawing-tool |
| 타입 | string |
| 기본값 | undefined |
undefined는 이 속성을 명시하지 않은 상태입니다. 실제 표시 값은 차트 종류와 다른 설정에 따라 결정될 수 있습니다.
drawingSpace
the space new drawings are anchored in: 'data' (default — the primary axes) or 'pixel' (offsets from the plot's top-left; they stay put under zoom, pan and data changes).
| 항목 | 값 |
|---|---|
| JavaScript 프로퍼티 | drawingSpace |
| HTML attribute | drawing-space |
| 타입 | DrawingSpace |
| 기본값 | undefined |
| 허용값 | data, pixel |
undefined는 이 속성을 명시하지 않은 상태입니다. 실제 표시 값은 차트 종류와 다른 설정에 따라 결정될 수 있습니다.
- DrawingSpace
타입 정의
visualMap
a visual map binding (a sy-visual-map snapshot + the data dimension): every mark is coloured through it.
| 항목 | 값 |
|---|---|
| JavaScript 프로퍼티 | visualMap |
| HTML attribute | 객체·배열·콜백은 JavaScript 프로퍼티로 전달 |
| 타입 | VisualMapBinding | null |
| 기본값 | undefined |
undefined는 이 속성을 명시하지 않은 상태입니다. 실제 표시 값은 차트 종류와 다른 설정에 따라 결정될 수 있습니다.
- VisualMapBinding
타입 정의
Events
rendered
차트 그리기가 완료되면 렌더링 결과를 detail로 전달합니다.
이벤트 이름: rendered. 대소문자를 구분합니다. payload는 CustomEvent<BarChartRenderResult & { tier: BarChartEngineTier }>의 detail에서 읽습니다.
chart.addEventListener('rendered', event => {
console.log(event.detail); // BarChartRenderResult & { tier: BarChartEngineTier }
});- BarChartRenderResult
타입 정의
- BarChartEngineTier
타입 정의
appended
CustomEvent.detail 타입: { count: number }. 이벤트 이름은 대소문자를 구분합니다.
이벤트 이름: appended. 대소문자를 구분합니다. payload는 CustomEvent<{ count: number }>의 detail에서 읽습니다.
chart.addEventListener('appended', event => {
console.log(event.detail); // { count: number }
});windowSlid
CustomEvent.detail 타입: { dropped: number }. 이벤트 이름은 대소문자를 구분합니다.
이벤트 이름: windowSlid. 대소문자를 구분합니다. payload는 CustomEvent<{ dropped: number }>의 detail에서 읽습니다.
chart.addEventListener('windowSlid', event => {
console.log(event.detail); // { dropped: number }
});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
});crosshairMove
CustomEvent.detail 타입: CartesianCrosshairEventDetail | null. 이벤트 이름은 대소문자를 구분합니다.
이벤트 이름: crosshairMove. 대소문자를 구분합니다. payload는 CustomEvent<CartesianCrosshairEventDetail | null>의 detail에서 읽습니다.
chart.addEventListener('crosshairMove', event => {
console.log(event.detail); // CartesianCrosshairEventDetail | null
});tooltipShow
내장 툴팁 표시 여부입니다.
이벤트 이름: 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
});zoomChange
fired after every zoom change (drag / keyboard / api / reset) with the new state.
이벤트 이름: zoomChange. 대소문자를 구분합니다. payload는 CustomEvent<CartesianZoomChangeEventDetail>의 detail에서 읽습니다.
chart.addEventListener('zoomChange', event => {
console.log(event.detail); // CartesianZoomChangeEventDetail
});brushChange
the brush areas / selection changed (drag, api, clear, keyboard).
이벤트 이름: brushChange. 대소문자를 구분합니다. payload는 CustomEvent<CartesianBrushChangeEventDetail>의 detail에서 읽습니다.
chart.addEventListener('brushChange', event => {
console.log(event.detail); // CartesianBrushChangeEventDetail
});brushStart
a brush drag opened up (once per gesture).
이벤트 이름: brushStart. 대소문자를 구분합니다. payload는 CustomEvent<CartesianBrushStartEventDetail>의 detail에서 읽습니다.
chart.addEventListener('brushStart', event => {
console.log(event.detail); // CartesianBrushStartEventDetail
});brushMove
a live frame of the drag (throttled; the selection only with liveSelection).
이벤트 이름: brushMove. 대소문자를 구분합니다. payload는 CustomEvent<CartesianBrushMoveEventDetail>의 detail에서 읽습니다.
chart.addEventListener('brushMove', event => {
console.log(event.detail); // CartesianBrushMoveEventDetail
});brushEnd
the drag released (after brushChange), or was cancelled.
이벤트 이름: brushEnd. 대소문자를 구분합니다. payload는 CustomEvent<CartesianBrushEndEventDetail>의 detail에서 읽습니다.
chart.addEventListener('brushEnd', event => {
console.log(event.detail); // CartesianBrushEndEventDetail
});drawingsChange
the drawing document changed (a placement, the api, undo / redo, clear, the prop).
이벤트 이름: drawingsChange. 대소문자를 구분합니다. payload는 CustomEvent<DrawingsChangeEventDetail>의 detail에서 읽습니다.
chart.addEventListener('drawingsChange', event => {
console.log(event.detail); // DrawingsChangeEventDetail
});drawingSelectionChange
the drawing selection changed (a click, a marquee, the api, Escape, a document change pruning it).
이벤트 이름: drawingSelectionChange. 대소문자를 구분합니다. payload는 CustomEvent<DrawingSelectionChangeEventDetail>의 detail에서 읽습니다.
chart.addEventListener('drawingSelectionChange', event => {
console.log(event.detail); // DrawingSelectionChangeEventDetail
});pointHover
CustomEvent.detail 타입: CartesianPointEventDetail | null. 이벤트 이름은 대소문자를 구분합니다.
이벤트 이름: pointHover. 대소문자를 구분합니다. payload는 CustomEvent<CartesianPointEventDetail | null>의 detail에서 읽습니다.
chart.addEventListener('pointHover', event => {
console.log(event.detail); // CartesianPointEventDetail | null
});pointClick
점 선택 이벤트입니다. CustomEvent.detail에서 선택한 데이터와 인덱스를 읽습니다.
이벤트 이름: pointClick. 대소문자를 구분합니다. payload는 CustomEvent<CartesianPointEventDetail>의 detail에서 읽습니다.
chart.addEventListener('pointClick', event => {
console.log(event.detail); // CartesianPointEventDetail
});pointContextMenu
CustomEvent.detail 타입: ChartPointContextMenuEventDetail<CartesianPointEventDetail>. 이벤트 이름은 대소문자를 구분합니다.
이벤트 이름: pointContextMenu. 대소문자를 구분합니다. payload는 CustomEvent<ChartPointContextMenuEventDetail<CartesianPointEventDetail>>의 detail에서 읽습니다.
chart.addEventListener('pointContextMenu', event => {
console.log(event.detail); // ChartPointContextMenuEventDetail<CartesianPointEventDetail>
});seriesOutsideClick
CustomEvent.detail 타입: CartesianSeriesOutsideClickEventDetail. 이벤트 이름은 대소문자를 구분합니다.
이벤트 이름: seriesOutsideClick. 대소문자를 구분합니다. payload는 CustomEvent<CartesianSeriesOutsideClickEventDetail>의 detail에서 읽습니다.
chart.addEventListener('seriesOutsideClick', event => {
console.log(event.detail); // CartesianSeriesOutsideClickEventDetail
});legendItemClick
CustomEvent.detail 타입: BarChartLegendItemEventDetail. 이벤트 이름은 대소문자를 구분합니다.
이벤트 이름: legendItemClick. 대소문자를 구분합니다. payload는 CustomEvent<BarChartLegendItemEventDetail>의 detail에서 읽습니다.
chart.addEventListener('legendItemClick', event => {
console.log(event.detail); // BarChartLegendItemEventDetail
});seriesToggled
CustomEvent.detail 타입: BarChartSeriesToggledEventDetail. 이벤트 이름은 대소문자를 구분합니다.
이벤트 이름: seriesToggled. 대소문자를 구분합니다. payload는 CustomEvent<BarChartSeriesToggledEventDetail>의 detail에서 읽습니다.
chart.addEventListener('seriesToggled', event => {
console.log(event.detail); // BarChartSeriesToggledEventDetail
});Methods
redraw
현재 데이터와 옵션으로 차트를 다시 그립니다. 반환되는 Promise가 완료되면 렌더링 결과를 확인할 수 있습니다.
redraw(): Promise<BarChartRenderResult>반환 타입: Promise<BarChartRenderResult>. 요소 등록이 끝난 뒤 메서드를 호출하고 Promise 결과를 await로 기다리세요.
- BarChartRenderResult
타입 정의
getActiveTier
비동기 메서드입니다. 아래 인수 타입과 반환 타입을 확인하세요.
getActiveTier(): Promise<BarChartEngineTier>반환 타입: Promise<BarChartEngineTier>. 요소 등록이 끝난 뒤 메서드를 호출하고 Promise 결과를 await로 기다리세요.
- BarChartEngineTier
타입 정의
appendPoint
스트림에 값 하나를 추가합니다. 메서드 인수 타입과 스트리밍 기능의 라이선스 조건을 확인하세요.
appendPoint(value: number): Promise<void>| 인수 | 타입 | 필수 여부 |
|---|---|---|
value | number | 필수 |
반환 타입: Promise<void>. 요소 등록이 끝난 뒤 메서드를 호출하고 Promise 결과를 await로 기다리세요.
appendBatch
스트림에 여러 값을 한 번에 추가합니다. 메서드 인수 타입과 스트리밍 기능의 라이선스 조건을 확인하세요.
appendBatch(values: ReadonlyArray<number> | Float32Array): Promise<void>| 인수 | 타입 | 필수 여부 |
|---|---|---|
values | ReadonlyArray<number> | Float32Array | 필수 |
반환 타입: Promise<void>. 요소 등록이 끝난 뒤 메서드를 호출하고 Promise 결과를 await로 기다리세요.
shift
Drop the oldest streamed categories (the data boxes 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(values: ReadonlyArray<number> | Float32Array): Promise<void>| 인수 | 타입 | 필수 여부 |
|---|---|---|
values | ReadonlyArray<number> | Float32Array | 필수 |
반환 타입: Promise<void>. 요소 등록이 끝난 뒤 메서드를 호출하고 Promise 결과를 await로 기다리세요.
getStreamSource
The stream session's source (Chart Pro): like the stream methods it waits for a license still being confirmed.
getStreamSource(): Promise<BarChartStreamSource | undefined>반환 타입: Promise<BarChartStreamSource | undefined>. 요소 등록이 끝난 뒤 메서드를 호출하고 Promise 결과를 await로 기다리세요.
- BarChartStreamSource
타입 정의
getEngineStatus
The requested engine, the engine that draws and why . A Chart Pro license decision names chart.webgpu and its state; renderer causes (not in this build, no WebGPU, a failed GPU) stay apart.
getEngineStatus(): Promise<ChartEngineStatus>반환 타입: Promise<ChartEngineStatus>. 요소 등록이 끝난 뒤 메서드를 호출하고 Promise 결과를 await로 기다리세요.
- ChartEngineStatus
타입 정의
setAnimation
비동기 메서드입니다. 아래 인수 타입과 반환 타입을 확인하세요.
setAnimation(options: { duration?: number; easing?: BarChartEasing; enabled?: boolean; type?: BarChartAnimationType }): Promise<void>| 인수 | 타입 | 필수 여부 |
|---|---|---|
options | { duration?: number; easing?: BarChartEasing; enabled?: boolean; type?: BarChartAnimationType } | 필수 |
반환 타입: Promise<void>. 요소 등록이 끝난 뒤 메서드를 호출하고 Promise 결과를 await로 기다리세요.
- BarChartEasing
타입 정의
- BarChartAnimationType
타입 정의
pauseAnimation
진행 중인 애니메이션을 일시 정지합니다.
pauseAnimation(): Promise<void>반환 타입: Promise<void>. 요소 등록이 끝난 뒤 메서드를 호출하고 Promise 결과를 await로 기다리세요.
resumeAnimation
일시 정지한 애니메이션을 다시 진행합니다.
resumeAnimation(): Promise<void>반환 타입: Promise<void>. 요소 등록이 끝난 뒤 메서드를 호출하고 Promise 결과를 await로 기다리세요.
addSeries
비동기 메서드입니다. 아래 인수 타입과 반환 타입을 확인하세요.
addSeries(options: BarChartSeries, opts?: { redraw?: boolean; insertAt?: number }): Promise<number>| 인수 | 타입 | 필수 여부 |
|---|---|---|
options | BarChartSeries | 필수 |
opts | { redraw?: boolean; insertAt?: number } | 선택 |
반환 타입: Promise<number>. 요소 등록이 끝난 뒤 메서드를 호출하고 Promise 결과를 await로 기다리세요.
- BarChartSeries
타입 정의
removeSeries
비동기 메서드입니다. 아래 인수 타입과 반환 타입을 확인하세요.
removeSeries(idOrIndex: string | number, opts?: { redraw?: boolean }): Promise<boolean>| 인수 | 타입 | 필수 여부 |
|---|---|---|
idOrIndex | string | number | 필수 |
opts | { redraw?: boolean } | 선택 |
반환 타입: Promise<boolean>. 요소 등록이 끝난 뒤 메서드를 호출하고 Promise 결과를 await로 기다리세요.
updateSeries
비동기 메서드입니다. 아래 인수 타입과 반환 타입을 확인하세요.
updateSeries(idOrIndex: string | number, patch: Partial<BarChartSeries>, opts?: { redraw?: boolean }): Promise<boolean>| 인수 | 타입 | 필수 여부 |
|---|---|---|
idOrIndex | string | number | 필수 |
patch | Partial<BarChartSeries> | 필수 |
opts | { redraw?: boolean } | 선택 |
반환 타입: Promise<boolean>. 요소 등록이 끝난 뒤 메서드를 호출하고 Promise 결과를 await로 기다리세요.
- BarChartSeries
타입 정의
setSeriesData
비동기 메서드입니다. 아래 인수 타입과 반환 타입을 확인하세요.
setSeriesData(idOrIndex: string | number, data: BarChartValues, opts?: { redraw?: boolean }): Promise<boolean>| 인수 | 타입 | 필수 여부 |
|---|---|---|
idOrIndex | string | number | 필수 |
data | BarChartValues | 필수 |
opts | { redraw?: boolean } | 선택 |
반환 타입: Promise<boolean>. 요소 등록이 끝난 뒤 메서드를 호출하고 Promise 결과를 await로 기다리세요.
- BarChartValues
타입 정의
addPoint
비동기 메서드입니다. 아래 인수 타입과 반환 타입을 확인하세요.
addPoint(idOrIndex: string | number, point: number, opts?: { shift?: boolean; redraw?: boolean }): Promise<boolean>| 인수 | 타입 | 필수 여부 |
|---|---|---|
idOrIndex | string | number | 필수 |
point | number | 필수 |
opts | { shift?: boolean; redraw?: boolean } | 선택 |
반환 타입: Promise<boolean>. 요소 등록이 끝난 뒤 메서드를 호출하고 Promise 결과를 await로 기다리세요.
showSeries
비동기 메서드입니다. 아래 인수 타입과 반환 타입을 확인하세요.
showSeries(id: string | number, opts?: { redraw?: boolean }): Promise<boolean>| 인수 | 타입 | 필수 여부 |
|---|---|---|
id | string | number | 필수 |
opts | { redraw?: boolean } | 선택 |
반환 타입: Promise<boolean>. 요소 등록이 끝난 뒤 메서드를 호출하고 Promise 결과를 await로 기다리세요.
hideSeries
비동기 메서드입니다. 아래 인수 타입과 반환 타입을 확인하세요.
hideSeries(id: string | number, opts?: { redraw?: boolean }): Promise<boolean>| 인수 | 타입 | 필수 여부 |
|---|---|---|
id | string | number | 필수 |
opts | { redraw?: boolean } | 선택 |
반환 타입: Promise<boolean>. 요소 등록이 끝난 뒤 메서드를 호출하고 Promise 결과를 await로 기다리세요.
showTooltipAtPoint
Open the tooltip for a dot programmatically. pointIndex is the category (row) index; the optional seriesIndex selects a group within that row (defaults to the first visible group's dot in the row). Returns the emitted tooltip detail, or null when no dot resolves / the tooltip is disabled.
showTooltipAtPoint(pointIndex: number): Promise<CartesianTooltipEventDetail | null>| 인수 | 타입 | 필수 여부 |
|---|---|---|
pointIndex | number | 필수 |
반환 타입: Promise<CartesianTooltipEventDetail | null>. 요소 등록이 끝난 뒤 메서드를 호출하고 Promise 결과를 await로 기다리세요.
zoomTo
zoom to explicit windows: x / y as { min, max } or [min, max] (null clears that orientation); xAxis / yAxis name the axis by id or slot index (default: the primary axis).
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 data 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 (and key) of the primary — or the named — master axes (null before the first layout).
getZoomExtent(request?: CartesianZoomExtentRequest): Promise<CartesianZoomExtentDetail | null>| 인수 | 타입 | 필수 여부 |
|---|---|---|
request | CartesianZoomExtentRequest | 선택 |
반환 타입: Promise<CartesianZoomExtentDetail | null>. 요소 등록이 끝난 뒤 메서드를 호출하고 Promise 결과를 await로 기다리세요.
showCrosshairAt
show the crosshair at a data position (a linked chart's cursor) without emitting crosshairMove; false when it falls outside the plot.
showCrosshairAt(request: CartesianCrosshairShowRequest): Promise<boolean>| 인수 | 타입 | 필수 여부 |
|---|---|---|
request | CartesianCrosshairShowRequest | 필수 |
반환 타입: Promise<boolean>. 요소 등록이 끝난 뒤 메서드를 호출하고 Promise 결과를 await로 기다리세요.
hideCrosshair
hide the crosshair shown by showCrosshairAt (or the pointer's).
hideCrosshair(): Promise<void>반환 타입: Promise<void>. 요소 등록이 끝난 뒤 메서드를 호출하고 Promise 결과를 await로 기다리세요.
getDrawings
the drawings of the document (data-space anchors).
getDrawings(): Promise<ChartDrawing[]>반환 타입: Promise<ChartDrawing[]>. 요소 등록이 끝난 뒤 메서드를 호출하고 Promise 결과를 await로 기다리세요.
- ChartDrawing
타입 정의
setDrawings
replace the document from script (null clears); the history keeps the previous document as an undo step.
setDrawings(drawings: ReadonlyArray<ChartDrawingInput> | null): Promise<DrawingsChangeEventDetail | null>| 인수 | 타입 | 필수 여부 |
|---|---|---|
drawings | ReadonlyArray<ChartDrawingInput> | null | 필수 |
반환 타입: Promise<DrawingsChangeEventDetail | null>. 요소 등록이 끝난 뒤 메서드를 호출하고 Promise 결과를 await로 기다리세요.
addDrawing
add one drawing (an explicit id replaces); answers the resolved drawing, or null when the input was malformed.
addDrawing(drawing: ChartDrawingInput): Promise<ChartDrawing | null>| 인수 | 타입 | 필수 여부 |
|---|---|---|
drawing | ChartDrawingInput | 필수 |
반환 타입: Promise<ChartDrawing | null>. 요소 등록이 끝난 뒤 메서드를 호출하고 Promise 결과를 await로 기다리세요.
- ChartDrawing
타입 정의
- ChartDrawingInput
타입 정의
updateDrawing
merge a patch into one drawing (anchors, style, visible, locked, options, meta).
updateDrawing(id: string, patch: Partial<Omit<ChartDrawing, 'id'>>): Promise<ChartDrawing | null>| 인수 | 타입 | 필수 여부 |
|---|---|---|
id | string | 필수 |
patch | Partial<Omit<ChartDrawing, 'id'>> | 필수 |
반환 타입: Promise<ChartDrawing | null>. 요소 등록이 끝난 뒤 메서드를 호출하고 Promise 결과를 await로 기다리세요.
- ChartDrawing
타입 정의
removeDrawing
remove one drawing.
removeDrawing(id: string): Promise<boolean>| 인수 | 타입 | 필수 여부 |
|---|---|---|
id | string | 필수 |
반환 타입: Promise<boolean>. 요소 등록이 끝난 뒤 메서드를 호출하고 Promise 결과를 await로 기다리세요.
removeDrawings
remove several drawings in one undoable step (locked / unknown ids are skipped); the selection prunes itself.
removeDrawings(ids: ReadonlyArray<string>): Promise<DrawingsChangeEventDetail | null>| 인수 | 타입 | 필수 여부 |
|---|---|---|
ids | ReadonlyArray<string> | 필수 |
반환 타입: Promise<DrawingsChangeEventDetail | null>. 요소 등록이 끝난 뒤 메서드를 호출하고 Promise 결과를 await로 기다리세요.
setDrawingSpace
move a drawing to the other coordinate space at the current frame (its anchors convert, nothing moves on screen); one undoable step.
setDrawingSpace(id: string, space: DrawingSpace): Promise<ChartDrawing | null>| 인수 | 타입 | 필수 여부 |
|---|---|---|
id | string | 필수 |
space | DrawingSpace | 필수 |
반환 타입: Promise<ChartDrawing | null>. 요소 등록이 끝난 뒤 메서드를 호출하고 Promise 결과를 await로 기다리세요.
- ChartDrawing
타입 정의
- DrawingSpace
타입 정의
clearDrawings
clear the document (undoable).
clearDrawings(): Promise<DrawingsChangeEventDetail | null>반환 타입: Promise<DrawingsChangeEventDetail | null>. 요소 등록이 끝난 뒤 메서드를 호출하고 Promise 결과를 await로 기다리세요.
undoDrawing
undo the last document change; null when there is nothing to undo.
undoDrawing(): Promise<DrawingsChangeEventDetail | null>반환 타입: Promise<DrawingsChangeEventDetail | null>. 요소 등록이 끝난 뒤 메서드를 호출하고 Promise 결과를 await로 기다리세요.
redoDrawing
redo the last undone change; null when there is nothing to redo.
redoDrawing(): Promise<DrawingsChangeEventDetail | null>반환 타입: Promise<DrawingsChangeEventDetail | null>. 요소 등록이 끝난 뒤 메서드를 호출하고 Promise 결과를 await로 기다리세요.
getDrawingLayer
the drawing overlay as a standalone SVG layer in host pixels (selection chrome and the placement preview stripped; null without drawings) — what the facade composes into the image export.
getDrawingLayer(): Promise<DrawingLayerSnapshot | null>반환 타입: Promise<DrawingLayerSnapshot | null>. 요소 등록이 끝난 뒤 메서드를 호출하고 Promise 결과를 await로 기다리세요.
- DrawingLayerSnapshot
타입 정의
exportDrawings
the document as its versioned JSON envelope (feed it back through drawings or importDrawings).
exportDrawings(): Promise<string>반환 타입: Promise<string>. 요소 등록이 끝난 뒤 메서드를 호출하고 Promise 결과를 await로 기다리세요.
importDrawings
replace the document from an envelope / list / JSON string (undoable; malformed rows drop).
importDrawings(input: ChartDrawingsInput): Promise<DrawingsChangeEventDetail | null>| 인수 | 타입 | 필수 여부 |
|---|---|---|
input | ChartDrawingsInput | 필수 |
반환 타입: Promise<DrawingsChangeEventDetail | null>. 요소 등록이 끝난 뒤 메서드를 호출하고 Promise 결과를 await로 기다리세요.
selectDrawings
select drawings from script (null / [] clears); unknown ids are dropped.
selectDrawings(ids: ReadonlyArray<string> | null): Promise<DrawingSelectionChangeEventDetail | null>| 인수 | 타입 | 필수 여부 |
|---|---|---|
ids | ReadonlyArray<string> | null | 필수 |
반환 타입: Promise<DrawingSelectionChangeEventDetail | null>. 요소 등록이 끝난 뒤 메서드를 호출하고 Promise 결과를 await로 기다리세요.
getDrawingSelection
the selected drawing ids.
getDrawingSelection(): Promise<string[]>반환 타입: Promise<string[]>. 요소 등록이 끝난 뒤 메서드를 호출하고 Promise 결과를 await로 기다리세요.
setBrush
replace the brush areas from script (null clears); brushChange fires with source 'api'.
setBrush(areas: ReadonlyArray<CartesianBrushAreaInput> | null): Promise<CartesianBrushChangeEventDetail | null>| 인수 | 타입 | 필수 여부 |
|---|---|---|
areas | ReadonlyArray<CartesianBrushAreaInput> | null | 필수 |
반환 타입: Promise<CartesianBrushChangeEventDetail | null>. 요소 등록이 끝난 뒤 메서드를 호출하고 Promise 결과를 await로 기다리세요.
clearBrush
clear the brush areas (brushChange with source 'clear').
clearBrush(): Promise<CartesianBrushChangeEventDetail | null>반환 타입: Promise<CartesianBrushChangeEventDetail | null>. 요소 등록이 끝난 뒤 메서드를 호출하고 Promise 결과를 await로 기다리세요.
getBrush
the persisted brush areas (primary data space).
getBrush(): Promise<CartesianBrushArea[]>반환 타입: Promise<CartesianBrushArea[]>. 요소 등록이 끝난 뒤 메서드를 호출하고 Promise 결과를 await로 기다리세요.
- CartesianBrushArea
타입 정의
getBrushSelection
the points inside the brush areas, against the current layout.
getBrushSelection(): Promise<CartesianBrushSelectedSeries[]>반환 타입: Promise<CartesianBrushSelectedSeries[]>. 요소 등록이 끝난 뒤 메서드를 호출하고 Promise 결과를 await로 기다리세요.
setVisualMap
Bind (or clear) a visual map: every mark is coloured through it on the next paint.
setVisualMap(binding: VisualMapBinding | null): Promise<VisualMapBinding | null>| 인수 | 타입 | 필수 여부 |
|---|---|---|
binding | VisualMapBinding | null | 필수 |
반환 타입: Promise<VisualMapBinding | null>. 요소 등록이 끝난 뒤 메서드를 호출하고 Promise 결과를 await로 기다리세요.
- VisualMapBinding
타입 정의
getVisualMap
비동기 메서드입니다. 아래 인수 타입과 반환 타입을 확인하세요.
getVisualMap(): Promise<VisualMapBinding | null>반환 타입: Promise<VisualMapBinding | null>. 요소 등록이 끝난 뒤 메서드를 호출하고 Promise 결과를 await로 기다리세요.
- VisualMapBinding
타입 정의
getVisualExtent
The extent of a dimension over the visible points — what a bound sy-visual-map adopts as its domain.
getVisualExtent(request?: VisualMapExtentRequest): Promise<VisualMapExtent | null>| 인수 | 타입 | 필수 여부 |
|---|---|---|
request | VisualMapExtentRequest | 선택 |
반환 타입: Promise<VisualMapExtent | null>. 요소 등록이 끝난 뒤 메서드를 호출하고 Promise 결과를 await로 기다리세요.
- VisualMapExtent
타입 정의
- VisualMapExtentRequest
타입 정의
hideTooltip
현재 표시 중인 툴팁을 닫습니다.
hideTooltip(): Promise<void>반환 타입: Promise<void>. 요소 등록이 끝난 뒤 메서드를 호출하고 Promise 결과를 await로 기다리세요.
hitTestBar
비동기 메서드입니다. 아래 인수 타입과 반환 타입을 확인하세요.
hitTestBar(cssX: number, cssY: number): Promise<{ pointIndex: number; seriesIndex: number } | null>| 인수 | 타입 | 필수 여부 |
|---|---|---|
cssX | number | 필수 |
cssY | number | 필수 |
반환 타입: Promise<{ pointIndex: number; seriesIndex: number } | null>. 요소 등록이 끝난 뒤 메서드를 호출하고 Promise 결과를 await로 기다리세요.