sy-heatmap
Heatmap
두 좌표에 대응하는 값을 색으로 표시합니다.
sy-heatmap
시간·제품·센서 위치 등 행렬의 패턴을 탐색하세요.
색만으로 정확한 수치를 읽기 어렵습니다. 범례와 툴팁·표를 제공하세요.
기본 차트 등급: Pro. 추가 렌더러·커스텀 브랜딩 등 기능의 권한은 별도입니다.
| 입력 | 데이터 설명 |
|---|---|
data | { x, y, value } 배열입니다. x·y는 수치 또는 범주 좌표입니다. |
- 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-heatmap.js';
define0();
// Pro: 앱 시작 시 발급받은 인증서로 registerLicense를 완료하세요.
// 홈페이지 미리보기의 인증서는 고객 앱에서 사용하지 않습니다.
const specs = [
{
"id": "example-chart",
"tag": "sy-heatmap",
"props": {
"data": [
{
"x": 0,
"y": 0,
"value": 10
},
{
"x": 1,
"y": 0,
"value": 27
},
{
"x": 2,
"y": 0,
"value": 44
},
{
"x": 3,
"y": 0,
"value": 61
},
{
"x": 4,
"y": 0,
"value": 78
},
{
"x": 5,
"y": 0,
"value": 95
},
{
"x": 0,
"y": 1,
"value": 22
},
{
"x": 1,
"y": 1,
"value": 39
},
{
"x": 2,
"y": 1,
"value": 56
},
{
"x": 3,
"y": 1,
"value": 73
},
{
"x": 4,
"y": 1,
"value": 90
},
{
"x": 5,
"y": 1,
"value": 17
},
{
"x": 0,
"y": 2,
"value": 34
},
{
"x": 1,
"y": 2,
"value": 51
},
{
"x": 2,
"y": 2,
"value": 68
},
{
"x": 3,
"y": 2,
"value": 85
},
{
"x": 4,
"y": 2,
"value": 12
},
{
"x": 5,
"y": 2,
"value": 29
},
{
"x": 0,
"y": 3,
"value": 46
},
{
"x": 1,
"y": 3,
"value": 63
},
{
"x": 2,
"y": 3,
"value": 80
},
{
"x": 3,
"y": 3,
"value": 97
},
{
"x": 4,
"y": 3,
"value": 24
},
{
"x": 5,
"y": 3,
"value": 41
},
{
"x": 0,
"y": 4,
"value": 58
},
{
"x": 1,
"y": 4,
"value": 75
},
{
"x": 2,
"y": 4,
"value": 92
},
{
"x": 3,
"y": 4,
"value": 19
},
{
"x": 4,
"y": 4,
"value": 36
},
{
"x": 5,
"y": 4,
"value": 53
}
],
"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', 'heatmap 예제 차트');
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
data
{ x, y, value } 배열입니다. x·y는 수치 또는 범주 좌표입니다.
| 항목 | 값 |
|---|---|
| JavaScript 프로퍼티 | data |
| HTML attribute | 객체·배열·콜백은 JavaScript 프로퍼티로 전달 |
| 타입 | HeatmapData |
| 기본값 | undefined |
undefined는 이 속성을 명시하지 않은 상태입니다. 실제 표시 값은 차트 종류와 다른 설정에 따라 결정될 수 있습니다.
- HeatmapData
타입 정의
matrix
A dense matrix: { columns, rows, values } (row-major) or rows of columns.
| 항목 | 값 |
|---|---|
| JavaScript 프로퍼티 | matrix |
| HTML attribute | 객체·배열·콜백은 JavaScript 프로퍼티로 전달 |
| 타입 | HeatmapMatrixInput |
| 기본값 | undefined |
undefined는 이 속성을 명시하지 않은 상태입니다. 실제 표시 값은 차트 종류와 다른 설정에 따라 결정될 수 있습니다.
- HeatmapMatrixInput
타입 정의
xCategories
Column labels (array, or a comma list attribute). Given explicitly, they fix the column count.
| 항목 | 값 |
|---|---|
| JavaScript 프로퍼티 | xCategories |
| HTML attribute | 객체·배열·콜백은 JavaScript 프로퍼티로 전달 |
| 타입 | HeatmapCategoriesInput |
| 기본값 | undefined |
undefined는 이 속성을 명시하지 않은 상태입니다. 실제 표시 값은 차트 종류와 다른 설정에 따라 결정될 수 있습니다.
yCategories
Row labels (row 0 is the top row).
| 항목 | 값 |
|---|---|
| JavaScript 프로퍼티 | yCategories |
| HTML attribute | 객체·배열·콜백은 JavaScript 프로퍼티로 전달 |
| 타입 | HeatmapCategoriesInput |
| 기본값 | undefined |
undefined는 이 속성을 명시하지 않은 상태입니다. 실제 표시 값은 차트 종류와 다른 설정에 따라 결정될 수 있습니다.
width
차트의 너비를 px 단위로 지정합니다. 컨테이너 너비가 변하는 앱에서는 ResizeObserver에서 width를 갱신하세요.
| 항목 | 값 |
|---|---|
| JavaScript 프로퍼티 | width |
| HTML attribute | width |
| 타입 | number |
| 기본값 | 640 |
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 |
colors
The colour ramp: a scheme name (viridis, blues, …), a colour list / comma list, or [t, colour] stops.
| 항목 | 값 |
|---|---|
| JavaScript 프로퍼티 | colors |
| HTML attribute | 객체·배열·콜백은 JavaScript 프로퍼티로 전달 |
| 타입 | HeatmapColorInput |
| 기본값 | undefined |
undefined는 이 속성을 명시하지 않은 상태입니다. 실제 표시 값은 차트 종류와 다른 설정에 따라 결정될 수 있습니다.
- HeatmapColorInput
타입 정의
valueMin
Domain ends; an omitted end follows the data extent.
| 항목 | 값 |
|---|---|
| JavaScript 프로퍼티 | valueMin |
| HTML attribute | value-min |
| 타입 | number |
| 기본값 | undefined |
undefined는 이 속성을 명시하지 않은 상태입니다. 실제 표시 값은 차트 종류와 다른 설정에 따라 결정될 수 있습니다.
valueMax
HTML attribute 또는 JavaScript 프로퍼티로 설정합니다. 타입: number.
| 항목 | 값 |
|---|---|
| JavaScript 프로퍼티 | valueMax |
| HTML attribute | value-max |
| 타입 | number |
| 기본값 | undefined |
undefined는 이 속성을 명시하지 않은 상태입니다. 실제 표시 값은 차트 종류와 다른 설정에 따라 결정될 수 있습니다.
emptyColor
The colour of an empty cell (default transparent — the host background shows).
| 항목 | 값 |
|---|---|
| JavaScript 프로퍼티 | emptyColor |
| HTML attribute | empty-color |
| 타입 | string |
| 기본값 | 'transparent' |
cellGap
Gap between cells in CSS px.
| 항목 | 값 |
|---|---|
| JavaScript 프로퍼티 | cellGap |
| HTML attribute | cell-gap |
| 타입 | number |
| 기본값 | 0 |
renderPath
the draw path: auto (the cells path from 3 device px per cell, else the plane), or a forced plane / cells.
| 항목 | 값 |
|---|---|
| JavaScript 프로퍼티 | renderPath |
| HTML attribute | render-path |
| 타입 | HeatmapRenderPath |
| 기본값 | 'auto' |
| 허용값 | auto, plane, cells |
- HeatmapRenderPath
타입 정의
cellRadius
cell corner radius in CSS px (the cells path).
| 항목 | 값 |
|---|---|
| JavaScript 프로퍼티 | cellRadius |
| HTML attribute | cell-radius |
| 타입 | number |
| 기본값 | 0 |
cellBorder
cell border width in CSS px (the cells path).
| 항목 | 값 |
|---|---|
| JavaScript 프로퍼티 | cellBorder |
| HTML attribute | cell-border |
| 타입 | number |
| 기본값 | 0 |
cellBorderColor
cell border colour.
| 항목 | 값 |
|---|---|
| JavaScript 프로퍼티 | cellBorderColor |
| HTML attribute | cell-border-color |
| 타입 | string |
| 기본값 | 'rgba(17,24,39,0.35)' |
lod
the plane path's level of detail: auto (area-averaged once a cell is under a device px), point, area.
| 항목 | 값 |
|---|---|
| JavaScript 프로퍼티 | lod |
| HTML attribute | lod |
| 타입 | HeatmapLodMode |
| 기본값 | 'auto' |
| 허용값 | auto, point, area, smooth |
- HeatmapLodMode
타입 정의
areaReduce
how the area LOD folds the cells a pixel covers: mean (default) or max (peak-hold).
| 항목 | 값 |
|---|---|
| JavaScript 프로퍼티 | areaReduce |
| HTML attribute | area-reduce |
| 타입 | 'mean' | 'max' |
| 기본값 | 'mean' |
| 허용값 | max, mean |
xAxis
가로축의 종류, 범주, 범위와 표시 형식을 설정합니다. category 축은 categories의 순서를 값 배열의 인덱스와 맞추세요. 여러 축을 받는 경우 축 배열로 전달할 수 있습니다.
| 항목 | 값 |
|---|---|
| JavaScript 프로퍼티 | xAxis |
| HTML attribute | 객체·배열·콜백은 JavaScript 프로퍼티로 전달 |
| 타입 | CartesianAxisInput |
| 기본값 | undefined |
| 타입에 포함된 리터럴 | auto, off |
undefined는 이 속성을 명시하지 않은 상태입니다. 실제 표시 값은 차트 종류와 다른 설정에 따라 결정될 수 있습니다.
- CartesianAxisInput
타입 정의
yAxis
세로축의 범위, 눈금, 레이블과 방향을 설정합니다. 비교하는 값의 단위를 맞추고, 막대의 길이를 비교할 때는 0 기준을 고려하세요.
| 항목 | 값 |
|---|---|
| JavaScript 프로퍼티 | yAxis |
| HTML attribute | 객체·배열·콜백은 JavaScript 프로퍼티로 전달 |
| 타입 | YAxisInput |
| 기본값 | undefined |
| 타입에 포함된 리터럴 | auto, off |
undefined는 이 속성을 명시하지 않은 상태입니다. 실제 표시 값은 차트 종류와 다른 설정에 따라 결정될 수 있습니다.
- YAxisInput
타입 정의
gridLines
Grid lines default OFF (the cells tile the plot).
| 항목 | 값 |
|---|---|
| JavaScript 프로퍼티 | gridLines |
| HTML attribute | 객체·배열·콜백은 JavaScript 프로퍼티로 전달 |
| 타입 | CartesianGridLinesInput |
| 기본값 | undefined |
| 타입에 포함된 리터럴 | auto, off |
undefined는 이 속성을 명시하지 않은 상태입니다. 실제 표시 값은 차트 종류와 다른 설정에 따라 결정될 수 있습니다.
crosshair
Crosshair that follows the cursor across the plot.
| 항목 | 값 |
|---|---|
| JavaScript 프로퍼티 | crosshair |
| HTML attribute | 객체·배열·콜백은 JavaScript 프로퍼티로 전달 |
| 타입 | CartesianCrosshairInput |
| 기본값 | undefined |
undefined는 이 속성을 명시하지 않은 상태입니다. 실제 표시 값은 차트 종류와 다른 설정에 따라 결정될 수 있습니다.
zoom
Zoom (2026-09-10) — the shared cartesian zoom on the column / row indexes: a mode ('x' | 'y' | 'xy'), true, 'inside' or the object (drag rectangle, pan, wheel, pinch, keyboard, reset button). Off by default.
| 항목 | 값 |
|---|---|
| JavaScript 프로퍼티 | zoom |
| HTML attribute | 객체·배열·콜백은 JavaScript 프로퍼티로 전달 |
| 타입 | CartesianZoomInput |
| 기본값 | undefined |
| 타입에 포함된 리터럴 | auto, off, true, false, x, y, xy, inside |
undefined는 이 속성을 명시하지 않은 상태입니다. 실제 표시 값은 차트 종류와 다른 설정에 따라 결정될 수 있습니다.
- CartesianZoomInput
타입 정의
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 cell tooltip (the shared cartesian tooltip input: show / trigger / format / html / connector / draggable …).
| 항목 | 값 |
|---|---|
| JavaScript 프로퍼티 | tooltip |
| HTML attribute | 객체·배열·콜백은 JavaScript 프로퍼티로 전달 |
| 타입 | CartesianTooltipInput |
| 기본값 | undefined |
| 타입에 포함된 리터럴 | auto, off |
undefined는 이 속성을 명시하지 않은 상태입니다. 실제 표시 값은 차트 종류와 다른 설정에 따라 결정될 수 있습니다.
tooltipEnabled
HTML attribute 또는 JavaScript 프로퍼티로 설정합니다. 타입: boolean.
| 항목 | 값 |
|---|---|
| JavaScript 프로퍼티 | tooltipEnabled |
| HTML attribute | tooltip-show |
| 타입 | boolean |
| 기본값 | true |
tooltipFormat
a plain-text formatter of the default tooltip (tooltip.format wins).
| 항목 | 값 |
|---|---|
| JavaScript 프로퍼티 | tooltipFormat |
| HTML attribute | 객체·배열·콜백은 JavaScript 프로퍼티로 전달 |
| 타입 | (detail: HeatmapPointEventDetail) => string |
| 기본값 | undefined |
undefined는 이 속성을 명시하지 않은 상태입니다. 실제 표시 값은 차트 종류와 다른 설정에 따라 결정될 수 있습니다.
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 |
| 타입 | HeatmapEasing |
| 기본값 | 'ease-out' |
| 허용값 | linear, ease-out, ease-in, ease-in-out |
- HeatmapEasing
타입 정의
animationType
허용값: initial, update. 기본값: undefined.
| 항목 | 값 |
|---|---|
| JavaScript 프로퍼티 | animationType |
| HTML attribute | animation-type |
| 타입 | HeatmapAnimationType |
| 기본값 | undefined |
| 허용값 | initial, update |
undefined는 이 속성을 명시하지 않은 상태입니다. 실제 표시 값은 차트 종류와 다른 설정에 따라 결정될 수 있습니다.
- HeatmapAnimationType
타입 정의
streamSource
실시간 데이터를 전달하는 스트림 소스입니다. 해당 타입의 계약을 확인하세요.
| 항목 | 값 |
|---|---|
| JavaScript 프로퍼티 | streamSource |
| HTML attribute | 객체·배열·콜백은 JavaScript 프로퍼티로 전달 |
| 타입 | HeatmapStreamSource |
| 기본값 | undefined |
undefined는 이 속성을 명시하지 않은 상태입니다. 실제 표시 값은 차트 종류와 다른 설정에 따라 결정될 수 있습니다.
- HeatmapStreamSource
타입 정의
streamMax
Cells the internal stream source tracks at most (oldest cells empty first).
| 항목 | 값 |
|---|---|
| JavaScript 프로퍼티 | streamMax |
| HTML attribute | stream-max |
| 타입 | number |
| 기본값 | undefined |
undefined는 이 속성을 명시하지 않은 상태입니다. 실제 표시 값은 차트 종류와 다른 설정에 따라 결정될 수 있습니다.
streamWindow
The newest N streamed upserts the chart renders (the whole buffer when unset); older tracked cells revert to the base plane.
| 항목 | 값 |
|---|---|
| JavaScript 프로퍼티 | streamWindow |
| HTML attribute | stream-window |
| 타입 | number |
| 기본값 | undefined |
undefined는 이 속성을 명시하지 않은 상태입니다. 실제 표시 값은 차트 종류와 다른 설정에 따라 결정될 수 있습니다.
visualMap
a visual-map binding (a sy-visual-map snapshot + dimension); it overrides colors / value-min / value-max while bound.
| 항목 | 값 |
|---|---|
| JavaScript 프로퍼티 | visualMap |
| HTML attribute | 객체·배열·콜백은 JavaScript 프로퍼티로 전달 |
| 타입 | VisualMapBinding | null |
| 기본값 | undefined |
undefined는 이 속성을 명시하지 않은 상태입니다. 실제 표시 값은 차트 종류와 다른 설정에 따라 결정될 수 있습니다.
- VisualMapBinding
타입 정의
engine
auto, standard and pro all run the one WebGPU renderer (a Pro-only type has no other); switching never tears it down.
| 항목 | 값 |
|---|---|
| JavaScript 프로퍼티 | engine |
| HTML attribute | engine |
| 타입 | HeatmapEngineMode |
| 기본값 | 'auto' |
| 허용값 | auto, standard, pro |
- HeatmapEngineMode
타입 정의
Events
rendered
Every drawn frame; engine is the engine status (requested / effective / code / the governing license feature).
이벤트 이름: rendered. 대소문자를 구분합니다. payload는 CustomEvent<HeatmapRenderResult & { tier: HeatmapEngineTier; engine?: ChartEngineStatus }>의 detail에서 읽습니다.
chart.addEventListener('rendered', event => {
console.log(event.detail); // HeatmapRenderResult & { tier: HeatmapEngineTier; engine?: ChartEngineStatus }
});- HeatmapRenderResult
타입 정의
- HeatmapEngineTier
타입 정의
- ChartEngineStatus
타입 정의
pointClick
점 선택 이벤트입니다. CustomEvent.detail에서 선택한 데이터와 인덱스를 읽습니다.
이벤트 이름: pointClick. 대소문자를 구분합니다. payload는 CustomEvent<HeatmapPointEventDetail>의 detail에서 읽습니다.
chart.addEventListener('pointClick', event => {
console.log(event.detail); // HeatmapPointEventDetail
});pointHover
CustomEvent.detail 타입: HeatmapPointEventDetail | null. 이벤트 이름은 대소문자를 구분합니다.
이벤트 이름: pointHover. 대소문자를 구분합니다. payload는 CustomEvent<HeatmapPointEventDetail | null>의 detail에서 읽습니다.
chart.addEventListener('pointHover', event => {
console.log(event.detail); // HeatmapPointEventDetail | null
});crosshairMove
CustomEvent.detail 타입: CartesianCrosshairEventDetail | null. 이벤트 이름은 대소문자를 구분합니다.
이벤트 이름: crosshairMove. 대소문자를 구분합니다. payload는 CustomEvent<CartesianCrosshairEventDetail | null>의 detail에서 읽습니다.
chart.addEventListener('crosshairMove', event => {
console.log(event.detail); // CartesianCrosshairEventDetail | null
});pointContextMenu
CustomEvent.detail 타입: ChartPointContextMenuEventDetail<HeatmapPointEventDetail>. 이벤트 이름은 대소문자를 구분합니다.
이벤트 이름: pointContextMenu. 대소문자를 구분합니다. payload는 CustomEvent<ChartPointContextMenuEventDetail<HeatmapPointEventDetail>>의 detail에서 읽습니다.
chart.addEventListener('pointContextMenu', event => {
console.log(event.detail); // ChartPointContextMenuEventDetail<HeatmapPointEventDetail>
});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
});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
Zoom — every zoom / pan change (drag, keyboard, wheel, pinch, API, reset); null zoom = the full extent.
이벤트 이름: zoomChange. 대소문자를 구분합니다. payload는 CustomEvent<CartesianZoomChangeEventDetail>의 detail에서 읽습니다.
chart.addEventListener('zoomChange', event => {
console.log(event.detail); // CartesianZoomChangeEventDetail
});Methods
getDataTable
Current normalized table, including the retained stream; independent of GPU availability.
getDataTable(): Promise<ChartDataTable>반환 타입: Promise<ChartDataTable>. 요소 등록이 끝난 뒤 메서드를 호출하고 Promise 결과를 await로 기다리세요.
- ChartDataTable
타입 정의
redraw
현재 데이터와 옵션으로 차트를 다시 그립니다. 반환되는 Promise가 완료되면 렌더링 결과를 확인할 수 있습니다.
redraw(): Promise<HeatmapRenderResult>반환 타입: Promise<HeatmapRenderResult>. 요소 등록이 끝난 뒤 메서드를 호출하고 Promise 결과를 await로 기다리세요.
- HeatmapRenderResult
타입 정의
getActiveTier
비동기 메서드입니다. 아래 인수 타입과 반환 타입을 확인하세요.
getActiveTier(): Promise<HeatmapEngineTier>반환 타입: Promise<HeatmapEngineTier>. 요소 등록이 끝난 뒤 메서드를 호출하고 Promise 결과를 await로 기다리세요.
- HeatmapEngineTier
타입 정의
setData
Replace the bar set.
setData(data: HeatmapData): Promise<void>| 인수 | 타입 | 필수 여부 |
|---|---|---|
data | HeatmapData | 필수 |
반환 타입: Promise<void>. 요소 등록이 끝난 뒤 메서드를 호출하고 Promise 결과를 await로 기다리세요.
- HeatmapData
타입 정의
setMatrix
비동기 메서드입니다. 아래 인수 타입과 반환 타입을 확인하세요.
setMatrix(matrix: HeatmapMatrixInput): Promise<void>| 인수 | 타입 | 필수 여부 |
|---|---|---|
matrix | HeatmapMatrixInput | 필수 |
반환 타입: Promise<void>. 요소 등록이 끝난 뒤 메서드를 호출하고 Promise 결과를 await로 기다리세요.
- HeatmapMatrixInput
타입 정의
appendPoint
스트림에 값 하나를 추가합니다. 메서드 인수 타입과 스트리밍 기능의 라이선스 조건을 확인하세요.
appendPoint(cell: HeatmapDatum | HeatmapTuple): Promise<void>| 인수 | 타입 | 필수 여부 |
|---|---|---|
cell | HeatmapDatum | HeatmapTuple | 필수 |
반환 타입: Promise<void>. 요소 등록이 끝난 뒤 메서드를 호출하고 Promise 결과를 await로 기다리세요.
- HeatmapDatum
타입 정의
- HeatmapTuple
타입 정의
appendBatch
스트림에 여러 값을 한 번에 추가합니다. 메서드 인수 타입과 스트리밍 기능의 라이선스 조건을 확인하세요.
appendBatch(cells: ReadonlyArray<HeatmapDatum | HeatmapTuple>): Promise<void>| 인수 | 타입 | 필수 여부 |
|---|---|---|
cells | ReadonlyArray<HeatmapDatum | HeatmapTuple> | 필수 |
반환 타입: Promise<void>. 요소 등록이 끝난 뒤 메서드를 호출하고 Promise 결과를 await로 기다리세요.
- HeatmapDatum
타입 정의
- HeatmapTuple
타입 정의
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(cells: ReadonlyArray<HeatmapDatum | HeatmapTuple>): Promise<void>| 인수 | 타입 | 필수 여부 |
|---|---|---|
cells | ReadonlyArray<HeatmapDatum | HeatmapTuple> | 필수 |
반환 타입: Promise<void>. 요소 등록이 끝난 뒤 메서드를 호출하고 Promise 결과를 await로 기다리세요.
- HeatmapDatum
타입 정의
- HeatmapTuple
타입 정의
getStreamSource
The stream session's source (Chart Pro): like the stream methods it waits for a license still being confirmed.
getStreamSource(): Promise<HeatmapStreamSource | undefined>반환 타입: Promise<HeatmapStreamSource | undefined>. 요소 등록이 끝난 뒤 메서드를 호출하고 Promise 결과를 await로 기다리세요.
- HeatmapStreamSource
타입 정의
setAnimation
비동기 메서드입니다. 아래 인수 타입과 반환 타입을 확인하세요.
setAnimation(options: { duration?: number; easing?: HeatmapEasing; enabled?: boolean; type?: HeatmapAnimationType }): Promise<void>| 인수 | 타입 | 필수 여부 |
|---|---|---|
options | { duration?: number; easing?: HeatmapEasing; enabled?: boolean; type?: HeatmapAnimationType } | 필수 |
반환 타입: Promise<void>. 요소 등록이 끝난 뒤 메서드를 호출하고 Promise 결과를 await로 기다리세요.
- HeatmapEasing
타입 정의
- HeatmapAnimationType
타입 정의
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로 기다리세요.
showTooltipAtCell
open the tooltip on a cell (col / row), honouring the tooltip input; null when the tooltip is off or the cell is outside.
showTooltipAtCell(col: number, row: number): Promise<CartesianTooltipEventDetail | null>| 인수 | 타입 | 필수 여부 |
|---|---|---|
col | number | 필수 |
row | number | 필수 |
반환 타입: Promise<CartesianTooltipEventDetail | null>. 요소 등록이 끝난 뒤 메서드를 호출하고 Promise 결과를 await로 기다리세요.
showTooltipAtIndex
open the tooltip on a cell by its index (row * columns + col; the facade's showTooltipAtPoint).
showTooltipAtIndex(index: number): Promise<CartesianTooltipEventDetail | null>| 인수 | 타입 | 필수 여부 |
|---|---|---|
index | number | 필수 |
반환 타입: Promise<CartesianTooltipEventDetail | null>. 요소 등록이 끝난 뒤 메서드를 호출하고 Promise 결과를 await로 기다리세요.
hideTooltip
현재 표시 중인 툴팁을 닫습니다.
hideTooltip(): Promise<void>반환 타입: Promise<void>. 요소 등록이 끝난 뒤 메서드를 호출하고 Promise 결과를 await로 기다리세요.
focusCellAt
move the keyboard focus to a cell (the arrow-key state); null clears it.
focusCellAt(col: number, row: number): Promise<HeatmapPointEventDetail | null>| 인수 | 타입 | 필수 여부 |
|---|---|---|
col | number | 필수 |
row | number | 필수 |
반환 타입: Promise<HeatmapPointEventDetail | null>. 요소 등록이 끝난 뒤 메서드를 호출하고 Promise 결과를 await로 기다리세요.
hitTest
The cell under host-relative CSS coordinates (inside the plot, through the zoomed matrix), or null.
hitTest(cssX: number, cssY: number): Promise<HeatmapPointEventDetail | null>| 인수 | 타입 | 필수 여부 |
|---|---|---|
cssX | number | 필수 |
cssY | number | 필수 |
반환 타입: Promise<HeatmapPointEventDetail | null>. 요소 등록이 끝난 뒤 메서드를 호출하고 Promise 결과를 await로 기다리세요.
getCellValue
The value of a cell (null when empty or outside the grid).
getCellValue(col: number, row: number): Promise<number | null>| 인수 | 타입 | 필수 여부 |
|---|---|---|
col | number | 필수 |
row | number | 필수 |
반환 타입: Promise<number | null>. 요소 등록이 끝난 뒤 메서드를 호출하고 Promise 결과를 await로 기다리세요.
getValueExtent
Min / max / finite count of the current values (null when nothing is finite).
getValueExtent(): Promise<HeatmapValueExtent | null>반환 타입: Promise<HeatmapValueExtent | null>. 요소 등록이 끝난 뒤 메서드를 호출하고 Promise 결과를 await로 기다리세요.
- HeatmapValueExtent
타입 정의
getGridSize
Columns × rows of the current grid.
getGridSize(): Promise<{ columns: number; rows: number; cells: number }>반환 타입: Promise<{ columns: number; rows: number; cells: number }>. 요소 등록이 끝난 뒤 메서드를 호출하고 Promise 결과를 await로 기다리세요.
zoomTo
Zoom to explicit windows in index units: 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 index 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 — axes: -0.5 … columns - 0.5 / -0.5 … rows - 0.5.
getZoomExtent(request?: CartesianZoomExtentRequest): Promise<CartesianZoomExtentDetail | null>| 인수 | 타입 | 필수 여부 |
|---|---|---|
request | CartesianZoomExtentRequest | 선택 |
반환 타입: Promise<CartesianZoomExtentDetail | null>. 요소 등록이 끝난 뒤 메서드를 호출하고 Promise 결과를 await로 기다리세요.
setVisualMap
Bind (or clear) a visual map: every cell is coloured through it on the next frame.
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 a bound sy-visual-map adopts as its domain: the finite cell values (value), or the index ranges (x = columns, y = rows, index = cells).
getVisualExtent(request?: VisualMapExtentRequest): Promise<VisualMapExtent | null>| 인수 | 타입 | 필수 여부 |
|---|---|---|
request | VisualMapExtentRequest | 선택 |
반환 타입: Promise<VisualMapExtent | null>. 요소 등록이 끝난 뒤 메서드를 호출하고 Promise 결과를 await로 기다리세요.
- VisualMapExtent
타입 정의
- VisualMapExtentRequest
타입 정의
getEngineStatus
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.
getEngineStatus(): Promise<ChartEngineStatus>반환 타입: Promise<ChartEngineStatus>. 요소 등록이 끝난 뒤 메서드를 호출하고 Promise 결과를 await로 기다리세요.
- ChartEngineStatus
타입 정의