sy-calendar-heatmap
Calendar Heatmap
날짜별 활동을 달력 위의 색으로 표시합니다.
sy-calendar-heatmap
일일 사용량·성과·출석 등 주간 패턴을 확인하세요.
비어 있는 날짜와 실제 0을 구분하세요. 날짜 표기와 주 시작일을 일관되게 유지하세요.
기본 차트 등급: Pro. 추가 렌더러·커스텀 브랜딩 등 기능의 권한은 별도입니다.
| 입력 | 데이터 설명 |
|---|---|
data | { date, value } 배열. 예제는 YYYY-MM-DD 날짜를 사용합니다. |
weekStart | monday 또는 sunday입니다. |
- 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-calendar-heatmap.js';
define0();
// Pro: 앱 시작 시 발급받은 인증서로 registerLicense를 완료하세요.
// 홈페이지 미리보기의 인증서는 고객 앱에서 사용하지 않습니다.
const specs = [
{
"id": "example-chart",
"tag": "sy-calendar-heatmap",
"props": {
"data": [
{
"date": "2026-01-01",
"value": 0
},
{
"date": "2026-01-02",
"value": 13
},
{
"date": "2026-01-03",
"value": 26
},
{
"date": "2026-01-04",
"value": 39
},
{
"date": "2026-01-05",
"value": 52
},
{
"date": "2026-01-06",
"value": 65
},
{
"date": "2026-01-07",
"value": 78
},
{
"date": "2026-01-08",
"value": 91
},
{
"date": "2026-01-09",
"value": 4
},
{
"date": "2026-01-10",
"value": 17
},
{
"date": "2026-01-11",
"value": 30
},
{
"date": "2026-01-12",
"value": 43
},
{
"date": "2026-01-13",
"value": 56
},
{
"date": "2026-01-14",
"value": 69
},
{
"date": "2026-01-15",
"value": 82
},
{
"date": "2026-01-16",
"value": 95
},
{
"date": "2026-01-17",
"value": 8
},
{
"date": "2026-01-18",
"value": 21
},
{
"date": "2026-01-19",
"value": 34
},
{
"date": "2026-01-20",
"value": 47
},
{
"date": "2026-01-21",
"value": 60
},
{
"date": "2026-01-22",
"value": 73
},
{
"date": "2026-01-23",
"value": 86
},
{
"date": "2026-01-24",
"value": 99
},
{
"date": "2026-01-25",
"value": 12
},
{
"date": "2026-01-26",
"value": 25
},
{
"date": "2026-01-27",
"value": 38
},
{
"date": "2026-01-28",
"value": 51
},
{
"date": "2026-01-29",
"value": 64
},
{
"date": "2026-01-30",
"value": 77
},
{
"date": "2026-01-31",
"value": 90
},
{
"date": "2026-02-01",
"value": 3
},
{
"date": "2026-02-02",
"value": 16
},
{
"date": "2026-02-03",
"value": 29
},
{
"date": "2026-02-04",
"value": 42
},
{
"date": "2026-02-05",
"value": 55
},
{
"date": "2026-02-06",
"value": 68
},
{
"date": "2026-02-07",
"value": 81
},
{
"date": "2026-02-08",
"value": 94
},
{
"date": "2026-02-09",
"value": 7
},
{
"date": "2026-02-10",
"value": 20
},
{
"date": "2026-02-11",
"value": 33
},
{
"date": "2026-02-12",
"value": 46
},
{
"date": "2026-02-13",
"value": 59
},
{
"date": "2026-02-14",
"value": 72
},
{
"date": "2026-02-15",
"value": 85
},
{
"date": "2026-02-16",
"value": 98
},
{
"date": "2026-02-17",
"value": 11
},
{
"date": "2026-02-18",
"value": 24
},
{
"date": "2026-02-19",
"value": 37
},
{
"date": "2026-02-20",
"value": 50
},
{
"date": "2026-02-21",
"value": 63
},
{
"date": "2026-02-22",
"value": 76
},
{
"date": "2026-02-23",
"value": 89
},
{
"date": "2026-02-24",
"value": 2
},
{
"date": "2026-02-25",
"value": 15
},
{
"date": "2026-02-26",
"value": 28
},
{
"date": "2026-02-27",
"value": 41
},
{
"date": "2026-02-28",
"value": 54
},
{
"date": "2026-03-01",
"value": 67
},
{
"date": "2026-03-02",
"value": 80
},
{
"date": "2026-03-03",
"value": 93
},
{
"date": "2026-03-04",
"value": 6
},
{
"date": "2026-03-05",
"value": 19
},
{
"date": "2026-03-06",
"value": 32
},
{
"date": "2026-03-07",
"value": 45
},
{
"date": "2026-03-08",
"value": 58
},
{
"date": "2026-03-09",
"value": 71
},
{
"date": "2026-03-10",
"value": 84
},
{
"date": "2026-03-11",
"value": 97
},
{
"date": "2026-03-12",
"value": 10
},
{
"date": "2026-03-13",
"value": 23
},
{
"date": "2026-03-14",
"value": 36
},
{
"date": "2026-03-15",
"value": 49
},
{
"date": "2026-03-16",
"value": 62
},
{
"date": "2026-03-17",
"value": 75
},
{
"date": "2026-03-18",
"value": 88
},
{
"date": "2026-03-19",
"value": 1
},
{
"date": "2026-03-20",
"value": 14
},
{
"date": "2026-03-21",
"value": 27
},
{
"date": "2026-03-22",
"value": 40
},
{
"date": "2026-03-23",
"value": 53
},
{
"date": "2026-03-24",
"value": 66
},
{
"date": "2026-03-25",
"value": 79
},
{
"date": "2026-03-26",
"value": 92
},
{
"date": "2026-03-27",
"value": 5
},
{
"date": "2026-03-28",
"value": 18
},
{
"date": "2026-03-29",
"value": 31
},
{
"date": "2026-03-30",
"value": 44
},
{
"date": "2026-03-31",
"value": 57
}
],
"weekStart": "monday",
"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', 'calendar-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
{ date, value } 배열. 예제는 YYYY-MM-DD 날짜를 사용합니다.
| 항목 | 값 |
|---|---|
| JavaScript 프로퍼티 | data |
| HTML attribute | 객체·배열·콜백은 JavaScript 프로퍼티로 전달 |
| 타입 | CalendarHeatmapData |
| 기본값 | undefined |
undefined는 이 속성을 명시하지 않은 상태입니다. 실제 표시 값은 차트 종류와 다른 설정에 따라 결정될 수 있습니다.
- CalendarHeatmapData
타입 정의
width
차트의 너비를 px 단위로 지정합니다. 컨테이너 너비가 변하는 앱에서는 ResizeObserver에서 width를 갱신하세요.
| 항목 | 값 |
|---|---|
| JavaScript 프로퍼티 | width |
| HTML attribute | width |
| 타입 | number |
| 기본값 | 900 |
height
차트의 높이를 px 단위로 지정합니다. 축, 제목과 범례가 차지하는 공간을 함께 고려하세요.
| 항목 | 값 |
|---|---|
| JavaScript 프로퍼티 | height |
| HTML attribute | height |
| 타입 | number |
| 기본값 | 180 |
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 |
year
The range: a year (Jan 1 … Dec 31); start-date / end-date win over it; neither → the data's span.
| 항목 | 값 |
|---|---|
| JavaScript 프로퍼티 | year |
| HTML attribute | year |
| 타입 | number |
| 기본값 | undefined |
undefined는 이 속성을 명시하지 않은 상태입니다. 실제 표시 값은 차트 종류와 다른 설정에 따라 결정될 수 있습니다.
startDate
HTML attribute 또는 JavaScript 프로퍼티로 설정합니다. 타입: string.
| 항목 | 값 |
|---|---|
| JavaScript 프로퍼티 | startDate |
| HTML attribute | start-date |
| 타입 | string |
| 기본값 | undefined |
undefined는 이 속성을 명시하지 않은 상태입니다. 실제 표시 값은 차트 종류와 다른 설정에 따라 결정될 수 있습니다.
endDate
HTML attribute 또는 JavaScript 프로퍼티로 설정합니다. 타입: string.
| 항목 | 값 |
|---|---|
| JavaScript 프로퍼티 | endDate |
| HTML attribute | end-date |
| 타입 | string |
| 기본값 | undefined |
undefined는 이 속성을 명시하지 않은 상태입니다. 실제 표시 값은 차트 종류와 다른 설정에 따라 결정될 수 있습니다.
weekStart
monday 또는 sunday입니다.
| 항목 | 값 |
|---|---|
| JavaScript 프로퍼티 | weekStart |
| HTML attribute | week-start |
| 타입 | CalendarWeekStart |
| 기본값 | 'monday' |
| 허용값 | monday, sunday |
- CalendarWeekStart
타입 정의
aggregate
How several entries on one day fold: sum (default), max, min, mean, last.
| 항목 | 값 |
|---|---|
| JavaScript 프로퍼티 | aggregate |
| HTML attribute | aggregate |
| 타입 | CalendarAggregate |
| 기본값 | 'sum' |
| 허용값 | sum, max, min, mean, last |
- CalendarAggregate
타입 정의
noDataValue
What a day without entries reads on the plane: a number (default 0 → the ramp's first colour) or nan (→ empty-color).
| 항목 | 값 |
|---|---|
| JavaScript 프로퍼티 | noDataValue |
| HTML attribute | 객체·배열·콜백은 JavaScript 프로퍼티로 전달 |
| 타입 | number | 'nan' |
| 기본값 | 0 |
| 타입에 포함된 리터럴 | nan |
colors
The colour ramp (a scheme name, a colour list / comma list, or [t, colour] stops); default GitHub's greens.
| 항목 | 값 |
|---|---|
| JavaScript 프로퍼티 | colors |
| HTML attribute | 객체·배열·콜백은 JavaScript 프로퍼티로 전달 |
| 타입 | string | ReadonlyArray<string> | ReadonlyArray<readonly [number, string]> |
| 기본값 | undefined |
undefined는 이 속성을 명시하지 않은 상태입니다. 실제 표시 값은 차트 종류와 다른 설정에 따라 결정될 수 있습니다.
valueMin
Domain ends; an omitted end follows the data (the min includes the fill, so 0 is the ramp start).
| 항목 | 값 |
|---|---|
| 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 a NaN cell (the strip's corners outside the range, and no-data days under no-data-value="nan") — transparent by default.
| 항목 | 값 |
|---|---|
| JavaScript 프로퍼티 | emptyColor |
| HTML attribute | empty-color |
| 타입 | string |
| 기본값 | 'transparent' |
cellGap
CSS px between cells.
| 항목 | 값 |
|---|---|
| JavaScript 프로퍼티 | cellGap |
| HTML attribute | cell-gap |
| 타입 | number |
| 기본값 | 2 |
cellRadius
The cell corner radius in CSS px.
| 항목 | 값 |
|---|---|
| JavaScript 프로퍼티 | cellRadius |
| HTML attribute | cell-radius |
| 타입 | number |
| 기본값 | 2 |
cellBorder
HTML attribute 또는 JavaScript 프로퍼티로 설정합니다. 타입: number.
| 항목 | 값 |
|---|---|
| JavaScript 프로퍼티 | cellBorder |
| HTML attribute | cell-border |
| 타입 | number |
| 기본값 | 0 |
cellBorderColor
HTML attribute 또는 JavaScript 프로퍼티로 설정합니다. 타입: string.
| 항목 | 값 |
|---|---|
| JavaScript 프로퍼티 | cellBorderColor |
| HTML attribute | cell-border-color |
| 타입 | string |
| 기본값 | 'rgba(17,24,39,0.35)' |
renderPath
The draw path: auto (the cells path from 3 device px per cell — the usual case), or a forced plane / cells.
| 항목 | 값 |
|---|---|
| JavaScript 프로퍼티 | renderPath |
| HTML attribute | render-path |
| 타입 | CalendarHeatmapRenderPath |
| 기본값 | 'auto' |
| 허용값 | auto, plane, cells |
lod
허용값: auto, point, area, smooth. 기본값: 'auto'.
| 항목 | 값 |
|---|---|
| JavaScript 프로퍼티 | lod |
| HTML attribute | lod |
| 타입 | HeatmapLodMode |
| 기본값 | 'auto' |
| 허용값 | auto, point, area, smooth |
- HeatmapLodMode
타입 정의
monthLabels
Month labels along the top (a month whose label would overlap the previous one is skipped).
| 항목 | 값 |
|---|---|
| JavaScript 프로퍼티 | monthLabels |
| HTML attribute | month-labels |
| 타입 | boolean |
| 기본값 | true |
weekdayLabels
Weekday labels down the left: short (rows 0 / 2 / 4), all, none.
| 항목 | 값 |
|---|---|
| JavaScript 프로퍼티 | weekdayLabels |
| HTML attribute | weekday-labels |
| 타입 | CalendarWeekdayLabels |
| 기본값 | 'short' |
| 허용값 | none, short, all |
monthLines
Month boundaries as step lines between the cells.
| 항목 | 값 |
|---|---|
| JavaScript 프로퍼티 | monthLines |
| HTML attribute | month-lines |
| 타입 | boolean |
| 기본값 | true |
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: CalendarHeatmapPointEventDetail) => 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 |
| 타입 | CalendarHeatmapEasing |
| 기본값 | 'ease-out' |
| 허용값 | linear, ease-out, ease-in, ease-in-out |
animationType
허용값: initial, update. 기본값: undefined.
| 항목 | 값 |
|---|---|
| JavaScript 프로퍼티 | animationType |
| HTML attribute | animation-type |
| 타입 | CalendarHeatmapAnimationType |
| 기본값 | undefined |
| 허용값 | initial, update |
undefined는 이 속성을 명시하지 않은 상태입니다. 실제 표시 값은 차트 종류와 다른 설정에 따라 결정될 수 있습니다.
streamSource
실시간 데이터를 전달하는 스트림 소스입니다. 해당 타입의 계약을 확인하세요.
| 항목 | 값 |
|---|---|
| JavaScript 프로퍼티 | streamSource |
| HTML attribute | 객체·배열·콜백은 JavaScript 프로퍼티로 전달 |
| 타입 | CalendarHeatmapStreamSource |
| 기본값 | undefined |
undefined는 이 속성을 명시하지 않은 상태입니다. 실제 표시 값은 차트 종류와 다른 설정에 따라 결정될 수 있습니다.
streamMax
Streamed entries kept at most (default 10,000): the oldest leave first.
| 항목 | 값 |
|---|---|
| JavaScript 프로퍼티 | streamMax |
| HTML attribute | stream-max |
| 타입 | number |
| 기본값 | undefined |
undefined는 이 속성을 명시하지 않은 상태입니다. 실제 표시 값은 차트 종류와 다른 설정에 따라 결정될 수 있습니다.
streamWindow
The newest N streamed entries the chart folds in (the whole buffer when unset): the upserts of older entries revert to the data entries.
| 항목 | 값 |
|---|---|
| JavaScript 프로퍼티 | streamWindow |
| HTML attribute | stream-window |
| 타입 | number |
| 기본값 | undefined |
undefined는 이 속성을 명시하지 않은 상태입니다. 실제 표시 값은 차트 종류와 다른 설정에 따라 결정될 수 있습니다.
visualMap
A visual-map binding; it overrides colors / value-min / value-max while bound.
| 항목 | 값 |
|---|---|
| JavaScript 프로퍼티 | visualMap |
| HTML attribute | 객체·배열·콜백은 JavaScript 프로퍼티로 전달 |
| 타입 | VisualMapBinding | null |
| 기본값 | undefined |
undefined는 이 속성을 명시하지 않은 상태입니다. 실제 표시 값은 차트 종류와 다른 설정에 따라 결정될 수 있습니다.
- VisualMapBinding
타입 정의
zoom
Viewport zoom (Storybook parity, 2026-09-10) — the zoom attribute the cartesian charts carry: a mode ('x' | 'y' | 'xy'), true (x) or an object (mode / drag / keyboard / minRangePx / resetButton / pan / wheel / pinch / inside); off by default. The strip (the plot between the label bands) is the drawing rectangle — x runs 0 → 1 left to right over the weeks, y 0 → 1 bottom to top over the weekday rows — and the day cells are magnified into the window (their gap keeps its screen size); weeks and rows outside it leave the strip, the month lines, the labels and the hover / focus rings follow the visible cells. zoomTo / zoomBy / panBy / resetZoom work regardless of the gesture switches. Property-only (a mode string also works as an attribute).
| 항목 | 값 |
|---|---|
| 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 |
| 타입 | CalendarHeatmapEngineMode |
| 기본값 | 'auto' |
| 허용값 | auto, standard, pro |
Events
rendered
Every drawn frame; engine is the engine status (requested / effective / code / the governing license feature).
이벤트 이름: rendered. 대소문자를 구분합니다. payload는 CustomEvent<CalendarHeatmapRenderResult & { tier: CalendarHeatmapEngineTier; engine?: ChartEngineStatus }>의 detail에서 읽습니다.
chart.addEventListener('rendered', event => {
console.log(event.detail); // CalendarHeatmapRenderResult & { tier: CalendarHeatmapEngineTier; engine?: ChartEngineStatus }
});pointClick
점 선택 이벤트입니다. CustomEvent.detail에서 선택한 데이터와 인덱스를 읽습니다.
이벤트 이름: pointClick. 대소문자를 구분합니다. payload는 CustomEvent<CalendarHeatmapPointEventDetail>의 detail에서 읽습니다.
chart.addEventListener('pointClick', event => {
console.log(event.detail); // CalendarHeatmapPointEventDetail
});pointHover
CustomEvent.detail 타입: CalendarHeatmapPointEventDetail | null. 이벤트 이름은 대소문자를 구분합니다.
이벤트 이름: pointHover. 대소문자를 구분합니다. payload는 CustomEvent<CalendarHeatmapPointEventDetail | null>의 detail에서 읽습니다.
chart.addEventListener('pointHover', event => {
console.log(event.detail); // CalendarHeatmapPointEventDetail | null
});pointContextMenu
CustomEvent.detail 타입: ChartPointContextMenuEventDetail<CalendarHeatmapPointEventDetail>. 이벤트 이름은 대소문자를 구분합니다.
이벤트 이름: pointContextMenu. 대소문자를 구분합니다. payload는 CustomEvent<ChartPointContextMenuEventDetail<CalendarHeatmapPointEventDetail>>의 detail에서 읽습니다.
chart.addEventListener('pointContextMenu', event => {
console.log(event.detail); // ChartPointContextMenuEventDetail<CalendarHeatmapPointEventDetail>
});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
Every zoom / pan change (drag, pan, wheel, pinch, keyboard, API, reset).
이벤트 이름: 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<CalendarHeatmapRenderResult>반환 타입: Promise<CalendarHeatmapRenderResult>. 요소 등록이 끝난 뒤 메서드를 호출하고 Promise 결과를 await로 기다리세요.
getActiveTier
비동기 메서드입니다. 아래 인수 타입과 반환 타입을 확인하세요.
getActiveTier(): Promise<CalendarHeatmapEngineTier>반환 타입: Promise<CalendarHeatmapEngineTier>. 요소 등록이 끝난 뒤 메서드를 호출하고 Promise 결과를 await로 기다리세요.
setData
Replace the bar set.
setData(data: CalendarHeatmapData): Promise<void>| 인수 | 타입 | 필수 여부 |
|---|---|---|
data | CalendarHeatmapData | 필수 |
반환 타입: Promise<void>. 요소 등록이 끝난 뒤 메서드를 호출하고 Promise 결과를 await로 기다리세요.
- CalendarHeatmapData
타입 정의
appendPoint
스트림에 값 하나를 추가합니다. 메서드 인수 타입과 스트리밍 기능의 라이선스 조건을 확인하세요.
appendPoint(entry: CalendarHeatmapEntry): Promise<void>| 인수 | 타입 | 필수 여부 |
|---|---|---|
entry | CalendarHeatmapEntry | 필수 |
반환 타입: Promise<void>. 요소 등록이 끝난 뒤 메서드를 호출하고 Promise 결과를 await로 기다리세요.
- CalendarHeatmapEntry
타입 정의
appendBatch
스트림에 여러 값을 한 번에 추가합니다. 메서드 인수 타입과 스트리밍 기능의 라이선스 조건을 확인하세요.
appendBatch(entries: ReadonlyArray<CalendarHeatmapEntry>): Promise<void>| 인수 | 타입 | 필수 여부 |
|---|---|---|
entries | ReadonlyArray<CalendarHeatmapEntry> | 필수 |
반환 타입: Promise<void>. 요소 등록이 끝난 뒤 메서드를 호출하고 Promise 결과를 await로 기다리세요.
- CalendarHeatmapEntry
타입 정의
shift
Drop the count oldest STREAMED entries (the data prop's entries are not a 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(entries: ReadonlyArray<CalendarHeatmapEntry>): Promise<void>| 인수 | 타입 | 필수 여부 |
|---|---|---|
entries | ReadonlyArray<CalendarHeatmapEntry> | 필수 |
반환 타입: Promise<void>. 요소 등록이 끝난 뒤 메서드를 호출하고 Promise 결과를 await로 기다리세요.
- CalendarHeatmapEntry
타입 정의
getStreamSource
The stream session's source (Chart Pro): like the stream methods it waits for a license still being confirmed.
getStreamSource(): Promise<CalendarHeatmapStreamSource | undefined>반환 타입: Promise<CalendarHeatmapStreamSource | undefined>. 요소 등록이 끝난 뒤 메서드를 호출하고 Promise 결과를 await로 기다리세요.
setAnimation
비동기 메서드입니다. 아래 인수 타입과 반환 타입을 확인하세요.
setAnimation(options: { duration?: number; easing?: CalendarHeatmapEasing; enabled?: boolean; type?: CalendarHeatmapAnimationType }): Promise<void>| 인수 | 타입 | 필수 여부 |
|---|---|---|
options | { duration?: number; easing?: CalendarHeatmapEasing; enabled?: boolean; type?: CalendarHeatmapAnimationType } | 필수 |
반환 타입: Promise<void>. 요소 등록이 끝난 뒤 메서드를 호출하고 Promise 결과를 await로 기다리세요.
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 day under host-relative CSS coordinates, or null (outside the strip, or a corner cell outside the range).
hitTest(cssX: number, cssY: number): Promise<CalendarHeatmapPointEventDetail | null>| 인수 | 타입 | 필수 여부 |
|---|---|---|
cssX | number | 필수 |
cssY | number | 필수 |
반환 타입: Promise<CalendarHeatmapPointEventDetail | null>. 요소 등록이 끝난 뒤 메서드를 호출하고 Promise 결과를 await로 기다리세요.
getCellValue
The folded value of a day (null for a day without entries or outside the range).
getCellValue(date: CalendarDateInput): Promise<number | null>| 인수 | 타입 | 필수 여부 |
|---|---|---|
date | CalendarDateInput | 필수 |
반환 타입: Promise<number | null>. 요소 등록이 끝난 뒤 메서드를 호출하고 Promise 결과를 await로 기다리세요.
- CalendarDateInput
타입 정의
getValueExtent
The data's extent (the fill never counts).
getValueExtent(): Promise<CalendarHeatmapValueExtent | null>반환 타입: Promise<CalendarHeatmapValueExtent | null>. 요소 등록이 끝난 뒤 메서드를 호출하고 Promise 결과를 await로 기다리세요.
getGridSize
Columns × rows of the current grid.
getGridSize(): Promise<{ weeks: number; rows: number; cells: number; days: number; valued: number; entries: number; dropped: number }>반환 타입: Promise<{ weeks: number; rows: number; cells: number; days: number; valued: number; entries: number; dropped: number }>. 요소 등록이 끝난 뒤 메서드를 호출하고 Promise 결과를 await로 기다리세요.
getRange
The resolved range.
getRange(): Promise<CalendarHeatmapRange>반환 타입: Promise<CalendarHeatmapRange>. 요소 등록이 끝난 뒤 메서드를 호출하고 Promise 결과를 await로 기다리세요.
- CalendarHeatmapRange
타입 정의
getMonthMarks
The month marks (labels + boundary anchors).
getMonthMarks(): Promise<CalendarMonthMark[]>반환 타입: Promise<CalendarMonthMark[]>. 요소 등록이 끝난 뒤 메서드를 호출하고 Promise 결과를 await로 기다리세요.
- CalendarMonthMark
타입 정의
showTooltipAtCell
open the tooltip on a cell (week / weekday), honouring the tooltip input; null when the tooltip is off or the cell has no day.
showTooltipAtCell(week: number, weekday: number): Promise<CartesianTooltipEventDetail | null>| 인수 | 타입 | 필수 여부 |
|---|---|---|
week | number | 필수 |
weekday | number | 필수 |
반환 타입: Promise<CartesianTooltipEventDetail | null>. 요소 등록이 끝난 뒤 메서드를 호출하고 Promise 결과를 await로 기다리세요.
showTooltipAtDate
open the tooltip on a day (null outside the range).
showTooltipAtDate(date: CalendarDateInput): Promise<CartesianTooltipEventDetail | null>| 인수 | 타입 | 필수 여부 |
|---|---|---|
date | CalendarDateInput | 필수 |
반환 타입: Promise<CartesianTooltipEventDetail | null>. 요소 등록이 끝난 뒤 메서드를 호출하고 Promise 결과를 await로 기다리세요.
showTooltipAtIndex
open the tooltip on a cell by its public index (week * 7 + weekday; 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 ring to a cell and announce it (null for a cell without a day).
focusCellAt(week: number, weekday: number): Promise<CalendarHeatmapPointEventDetail | null>| 인수 | 타입 | 필수 여부 |
|---|---|---|
week | number | 필수 |
weekday | number | 필수 |
반환 타입: Promise<CalendarHeatmapPointEventDetail | null>. 요소 등록이 끝난 뒤 메서드를 호출하고 Promise 결과를 await로 기다리세요.
focusDate
move the keyboard focus ring to a day (null outside the range).
focusDate(date: CalendarDateInput): Promise<CalendarHeatmapPointEventDetail | null>| 인수 | 타입 | 필수 여부 |
|---|---|---|
date | CalendarDateInput | 필수 |
반환 타입: Promise<CalendarHeatmapPointEventDetail | null>. 요소 등록이 끝난 뒤 메서드를 호출하고 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: value = the day values, x = the week columns, y = the weekday rows, index = the cells.
getVisualExtent(request?: VisualMapExtentRequest): Promise<VisualMapExtent | null>| 인수 | 타입 | 필수 여부 |
|---|---|---|
request | VisualMapExtentRequest | 선택 |
반환 타입: Promise<VisualMapExtent | null>. 요소 등록이 끝난 뒤 메서드를 호출하고 Promise 결과를 await로 기다리세요.
- VisualMapExtent
타입 정의
- VisualMapExtentRequest
타입 정의
zoomTo
Zoom to explicit windows of the strip (x / y as { min, max } or [min, max] fractions 0 … 1; 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 fractions of the strip ({ 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 of the viewport axes ([0, 1] each, key '0').
getZoomExtent(request?: CartesianZoomExtentRequest): Promise<CartesianZoomExtentDetail | null>| 인수 | 타입 | 필수 여부 |
|---|---|---|
request | CartesianZoomExtentRequest | 선택 |
반환 타입: Promise<CartesianZoomExtentDetail | null>. 요소 등록이 끝난 뒤 메서드를 호출하고 Promise 결과를 await로 기다리세요.
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
타입 정의