sy-surface-3d
Surface 3d
격자 위의 측정값을 연속된 3차원 표면으로 보여줍니다.
sy-surface-3d
온도·높이·반응면처럼 두 좌표에 대응하는 수치를 탐색하세요.
원근과 가림에 주의하세요. 카메라를 바꿔 확인하고 정확한 수치는 데이터로 보완하세요.
기본 차트 등급: Pro. 추가 렌더러·커스텀 브랜딩 등 기능의 권한은 별도입니다.
| 입력 | 데이터 설명 |
|---|---|
data | { x, y, z } 격자. z[row][column]은 x[column], y[row]의 높이입니다. null은 구멍입니다. |
- 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-surface-3d.js';
define0();
// Pro: 앱 시작 시 발급받은 인증서로 registerLicense를 완료하세요.
// 홈페이지 미리보기의 인증서는 고객 앱에서 사용하지 않습니다.
const specs = [
{
"id": "example-chart",
"tag": "sy-surface-3d",
"props": {
"data": {
"x": [-2, -1, 0, 1, 2],
"y": [-2, -1, 0, 1, 2],
"z": [
[0, 3, 4, 3, 0],
[3, 6, 7, 6, 3],
[4, 7, 8, 7, 4],
[3, 6, 7, 6, 3],
[0, 3, 4, 3, 0]
]
},
"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', 'surface-3d 예제 차트');
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, z } 격자. z[row][column]은 x[column], y[row]의 높이입니다. null은 구멍입니다.
| 항목 | 값 |
|---|---|
| JavaScript 프로퍼티 | data |
| HTML attribute | 객체·배열·콜백은 JavaScript 프로퍼티로 전달 |
| 타입 | Surface3DData |
| 기본값 | undefined |
undefined는 이 속성을 명시하지 않은 상태입니다. 실제 표시 값은 차트 종류와 다른 설정에 따라 결정될 수 있습니다.
- Surface3DData
타입 정의
width
차트의 너비를 px 단위로 지정합니다. 컨테이너 너비가 변하는 앱에서는 ResizeObserver에서 width를 갱신하세요.
| 항목 | 값 |
|---|---|
| JavaScript 프로퍼티 | width |
| HTML attribute | width |
| 타입 | number |
| 기본값 | 800 |
height
차트의 높이를 px 단위로 지정합니다. 축, 제목과 범례가 차지하는 공간을 함께 고려하세요.
| 항목 | 값 |
|---|---|
| JavaScript 프로퍼티 | height |
| HTML attribute | height |
| 타입 | number |
| 기본값 | 480 |
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
JavaScript 프로퍼티로 전달합니다. 타입: HeatmapColorInput.
| 항목 | 값 |
|---|---|
| JavaScript 프로퍼티 | colors |
| HTML attribute | 객체·배열·콜백은 JavaScript 프로퍼티로 전달 |
| 타입 | HeatmapColorInput |
| 기본값 | 'viridis' |
- HeatmapColorInput
타입 정의
colorDomain
JavaScript 프로퍼티로 전달합니다. 타입: Surface3DDomain.
| 항목 | 값 |
|---|---|
| JavaScript 프로퍼티 | colorDomain |
| HTML attribute | 객체·배열·콜백은 JavaScript 프로퍼티로 전달 |
| 타입 | Surface3DDomain |
| 기본값 | undefined |
undefined는 이 속성을 명시하지 않은 상태입니다. 실제 표시 값은 차트 종류와 다른 설정에 따라 결정될 수 있습니다.
- Surface3DDomain
타입 정의
missingColor
HTML attribute 또는 JavaScript 프로퍼티로 설정합니다. 타입: string.
| 항목 | 값 |
|---|---|
| JavaScript 프로퍼티 | missingColor |
| HTML attribute | missing-color |
| 타입 | string |
| 기본값 | '#94a3b8' |
surfaceSize
JavaScript 프로퍼티로 전달합니다. 타입: Scene3DVector.
| 항목 | 값 |
|---|---|
| JavaScript 프로퍼티 | surfaceSize |
| HTML attribute | 객체·배열·콜백은 JavaScript 프로퍼티로 전달 |
| 타입 | Scene3DVector |
| 기본값 | [2,2,2] |
- Scene3DVector
타입 정의
opacity
HTML attribute 또는 JavaScript 프로퍼티로 설정합니다. 타입: number.
| 항목 | 값 |
|---|---|
| JavaScript 프로퍼티 | opacity |
| HTML attribute | opacity |
| 타입 | number |
| 기본값 | 1 |
legend
시리즈 또는 항목의 범례 표시 여부입니다.
| 항목 | 값 |
|---|---|
| JavaScript 프로퍼티 | legend |
| HTML attribute | legend |
| 타입 | boolean |
| 기본값 | false |
locale
HTML attribute 또는 JavaScript 프로퍼티로 설정합니다. 타입: string.
| 항목 | 값 |
|---|---|
| JavaScript 프로퍼티 | locale |
| HTML attribute | locale |
| 타입 | string |
| 기본값 | 'en-US' |
axes
JavaScript 프로퍼티로 전달합니다. 타입: Surface3DAxesOptions|boolean|string.
| 항목 | 값 |
|---|---|
| JavaScript 프로퍼티 | axes |
| HTML attribute | 객체·배열·콜백은 JavaScript 프로퍼티로 전달 |
| 타입 | Surface3DAxesOptions|boolean|string |
| 기본값 | undefined |
undefined는 이 속성을 명시하지 않은 상태입니다. 실제 표시 값은 차트 종류와 다른 설정에 따라 결정될 수 있습니다.
- Surface3DAxesOptions
타입 정의
wireframe
HTML attribute 또는 JavaScript 프로퍼티로 설정합니다. 타입: boolean.
| 항목 | 값 |
|---|---|
| JavaScript 프로퍼티 | wireframe |
| HTML attribute | wireframe |
| 타입 | boolean |
| 기본값 | false |
wireWidth
HTML attribute 또는 JavaScript 프로퍼티로 설정합니다. 타입: number.
| 항목 | 값 |
|---|---|
| JavaScript 프로퍼티 | wireWidth |
| HTML attribute | wire-width |
| 타입 | number |
| 기본값 | .8 |
wireColor
HTML attribute 또는 JavaScript 프로퍼티로 설정합니다. 타입: string.
| 항목 | 값 |
|---|---|
| JavaScript 프로퍼티 | wireColor |
| HTML attribute | wire-color |
| 타입 | string |
| 기본값 | '#475569' |
material
JavaScript 프로퍼티로 전달합니다. 타입: Scene3DMaterialOptions.
| 항목 | 값 |
|---|---|
| JavaScript 프로퍼티 | material |
| HTML attribute | 객체·배열·콜백은 JavaScript 프로퍼티로 전달 |
| 타입 | Scene3DMaterialOptions |
| 기본값 | undefined |
undefined는 이 속성을 명시하지 않은 상태입니다. 실제 표시 값은 차트 종류와 다른 설정에 따라 결정될 수 있습니다.
lighting
JavaScript 프로퍼티로 전달합니다. 타입: Scene3DLightingOptions.
| 항목 | 값 |
|---|---|
| JavaScript 프로퍼티 | lighting |
| HTML attribute | 객체·배열·콜백은 JavaScript 프로퍼티로 전달 |
| 타입 | Scene3DLightingOptions |
| 기본값 | undefined |
undefined는 이 속성을 명시하지 않은 상태입니다. 실제 표시 값은 차트 종류와 다른 설정에 따라 결정될 수 있습니다.
camera
JavaScript 프로퍼티로 전달합니다. 타입: Scene3DCameraOptions|string.
| 항목 | 값 |
|---|---|
| JavaScript 프로퍼티 | camera |
| HTML attribute | 객체·배열·콜백은 JavaScript 프로퍼티로 전달 |
| 타입 | Scene3DCameraOptions|string |
| 기본값 | undefined |
undefined는 이 속성을 명시하지 않은 상태입니다. 실제 표시 값은 차트 종류와 다른 설정에 따라 결정될 수 있습니다.
- Scene3DCameraOptions
타입 정의
orbit
JavaScript 프로퍼티로 전달합니다. 타입: Orbit3DOptions|boolean|string.
| 항목 | 값 |
|---|---|
| JavaScript 프로퍼티 | orbit |
| HTML attribute | 객체·배열·콜백은 JavaScript 프로퍼티로 전달 |
| 타입 | Orbit3DOptions|boolean|string |
| 기본값 | undefined |
undefined는 이 속성을 명시하지 않은 상태입니다. 실제 표시 값은 차트 종류와 다른 설정에 따라 결정될 수 있습니다.
- Orbit3DOptions
타입 정의
showEmpty
Whether the component shows its own empty-geometry notice.
| 항목 | 값 |
|---|---|
| JavaScript 프로퍼티 | showEmpty |
| HTML attribute | show-empty |
| 타입 | boolean |
| 기본값 | true |
chartTitle
차트 내부 제목입니다. 데이터의 단위와 의미를 함께 설명하세요.
| 항목 | 값 |
|---|---|
| JavaScript 프로퍼티 | chartTitle |
| HTML attribute | chart-title |
| 타입 | string |
| 기본값 | undefined |
undefined는 이 속성을 명시하지 않은 상태입니다. 실제 표시 값은 차트 종류와 다른 설정에 따라 결정될 수 있습니다.
chartSubtitle
차트 내부 부제목입니다.
| 항목 | 값 |
|---|---|
| JavaScript 프로퍼티 | chartSubtitle |
| HTML attribute | chart-subtitle |
| 타입 | string |
| 기본값 | undefined |
undefined는 이 속성을 명시하지 않은 상태입니다. 실제 표시 값은 차트 종류와 다른 설정에 따라 결정될 수 있습니다.
activeColor
HTML attribute 또는 JavaScript 프로퍼티로 설정합니다. 타입: string.
| 항목 | 값 |
|---|---|
| JavaScript 프로퍼티 | activeColor |
| HTML attribute | active-color |
| 타입 | string |
| 기본값 | '#f59e0b' |
enableMouseTracking
HTML attribute 또는 JavaScript 프로퍼티로 설정합니다. 타입: boolean.
| 항목 | 값 |
|---|---|
| JavaScript 프로퍼티 | enableMouseTracking |
| HTML attribute | enable-mouse-tracking |
| 타입 | boolean |
| 기본값 | true |
tooltip
포인터에 따라 표시할 값, 위치, 내용의 툴팁 설정입니다.
| 항목 | 값 |
|---|---|
| JavaScript 프로퍼티 | tooltip |
| HTML attribute | 객체·배열·콜백은 JavaScript 프로퍼티로 전달 |
| 타입 | CartesianTooltipInput |
| 기본값 | undefined |
| 타입에 포함된 리터럴 | auto, off |
undefined는 이 속성을 명시하지 않은 상태입니다. 실제 표시 값은 차트 종류와 다른 설정에 따라 결정될 수 있습니다.
tooltipEnabled
HTML attribute 또는 JavaScript 프로퍼티로 설정합니다. 타입: boolean.
| 항목 | 값 |
|---|---|
| JavaScript 프로퍼티 | tooltipEnabled |
| HTML attribute | tooltip-show |
| 타입 | boolean |
| 기본값 | true |
tooltipFormat
JavaScript 프로퍼티로 전달합니다. 타입: (detail:Surface3DHitDetail)=>string.
| 항목 | 값 |
|---|---|
| JavaScript 프로퍼티 | tooltipFormat |
| HTML attribute | 객체·배열·콜백은 JavaScript 프로퍼티로 전달 |
| 타입 | (detail:Surface3DHitDetail)=>string |
| 기본값 | undefined |
undefined는 이 속성을 명시하지 않은 상태입니다. 실제 표시 값은 차트 종류와 다른 설정에 따라 결정될 수 있습니다.
- Surface3DHitDetail
타입 정의
crosshair
JavaScript 프로퍼티로 전달합니다. 타입: CartesianCrosshairInput.
| 항목 | 값 |
|---|---|
| JavaScript 프로퍼티 | crosshair |
| HTML attribute | 객체·배열·콜백은 JavaScript 프로퍼티로 전달 |
| 타입 | CartesianCrosshairInput |
| 기본값 | undefined |
undefined는 이 속성을 명시하지 않은 상태입니다. 실제 표시 값은 차트 종류와 다른 설정에 따라 결정될 수 있습니다.
crosshairSnapDistance
HTML attribute 또는 JavaScript 프로퍼티로 설정합니다. 타입: number.
| 항목 | 값 |
|---|---|
| JavaScript 프로퍼티 | crosshairSnapDistance |
| HTML attribute | crosshair-snap-distance |
| 타입 | number |
| 기본값 | 12 |
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 |
| 타입 | Surface3DEasing |
| 기본값 | 'ease-out' |
| 허용값 | linear, ease-out, ease-in, ease-in-out |
- Surface3DEasing
타입 정의
animationType
허용값: initial, update. 기본값: undefined.
| 항목 | 값 |
|---|---|
| JavaScript 프로퍼티 | animationType |
| HTML attribute | animation-type |
| 타입 | HeatmapAnimationType |
| 기본값 | undefined |
| 허용값 | initial, update |
undefined는 이 속성을 명시하지 않은 상태입니다. 실제 표시 값은 차트 종류와 다른 설정에 따라 결정될 수 있습니다.
- HeatmapAnimationType
타입 정의
streamSource
실시간 데이터를 전달하는 스트림 소스입니다. 해당 타입의 계약을 확인하세요.
| 항목 | 값 |
|---|---|
| JavaScript 프로퍼티 | streamSource |
| HTML attribute | 객체·배열·콜백은 JavaScript 프로퍼티로 전달 |
| 타입 | Surface3DStreamSource |
| 기본값 | undefined |
undefined는 이 속성을 명시하지 않은 상태입니다. 실제 표시 값은 차트 종류와 다른 설정에 따라 결정될 수 있습니다.
streamMax
보관할 스트리밍 데이터의 최대 수입니다.
| 항목 | 값 |
|---|---|
| JavaScript 프로퍼티 | streamMax |
| HTML attribute | stream-max |
| 타입 | number |
| 기본값 | undefined |
undefined는 이 속성을 명시하지 않은 상태입니다. 실제 표시 값은 차트 종류와 다른 설정에 따라 결정될 수 있습니다.
engine
auto·standard·pro 렌더러 선택입니다. 엔진 선택은 차트 종류의 Pro 사용 권한과 별개입니다.
| 항목 | 값 |
|---|---|
| JavaScript 프로퍼티 | engine |
| HTML attribute | engine |
| 타입 | Surface3DEngineMode |
| 기본값 | 'auto' |
| 허용값 | auto, standard, pro |
- Surface3DEngineMode
타입 정의
Events
rendered
차트 그리기가 완료되면 렌더링 결과를 detail로 전달합니다.
이벤트 이름: rendered. 대소문자를 구분합니다. payload는 CustomEvent<Surface3DRenderResult&{tier:Surface3DEngineTier}>의 detail에서 읽습니다.
chart.addEventListener('rendered', event => {
console.log(event.detail); // Surface3DRenderResult&{tier:Surface3DEngineTier}
});- Surface3DRenderResult
타입 정의
- Surface3DEngineTier
타입 정의
pointClick
점 선택 이벤트입니다. CustomEvent.detail에서 선택한 데이터와 인덱스를 읽습니다.
이벤트 이름: pointClick. 대소문자를 구분합니다. payload는 CustomEvent<Surface3DHitDetail>의 detail에서 읽습니다.
chart.addEventListener('pointClick', event => {
console.log(event.detail); // Surface3DHitDetail
});- Surface3DHitDetail
타입 정의
pointHover
CustomEvent.detail 타입: Surface3DHitDetail|null. 이벤트 이름은 대소문자를 구분합니다.
이벤트 이름: pointHover. 대소문자를 구분합니다. payload는 CustomEvent<Surface3DHitDetail|null>의 detail에서 읽습니다.
chart.addEventListener('pointHover', event => {
console.log(event.detail); // Surface3DHitDetail|null
});- Surface3DHitDetail
타입 정의
selectionChanged
CustomEvent.detail 타입: Surface3DSelectionChangeEventDetail. 이벤트 이름은 대소문자를 구분합니다.
이벤트 이름: selectionChanged. 대소문자를 구분합니다. payload는 CustomEvent<Surface3DSelectionChangeEventDetail>의 detail에서 읽습니다.
chart.addEventListener('selectionChanged', event => {
console.log(event.detail); // Surface3DSelectionChangeEventDetail
});pointContextMenu
CustomEvent.detail 타입: ChartPointContextMenuEventDetail<Surface3DHitDetail>. 이벤트 이름은 대소문자를 구분합니다.
이벤트 이름: pointContextMenu. 대소문자를 구분합니다. payload는 CustomEvent<ChartPointContextMenuEventDetail<Surface3DHitDetail>>의 detail에서 읽습니다.
chart.addEventListener('pointContextMenu', event => {
console.log(event.detail); // ChartPointContextMenuEventDetail<Surface3DHitDetail>
});cameraChange
CustomEvent.detail 타입: Surface3DCameraChangeEventDetail. 이벤트 이름은 대소문자를 구분합니다.
이벤트 이름: cameraChange. 대소문자를 구분합니다. payload는 CustomEvent<Surface3DCameraChangeEventDetail>의 detail에서 읽습니다.
chart.addEventListener('cameraChange', event => {
console.log(event.detail); // Surface3DCameraChangeEventDetail
});crosshairMove
CustomEvent.detail 타입: Surface3DCrosshairDetail|null. 이벤트 이름은 대소문자를 구분합니다.
이벤트 이름: crosshairMove. 대소문자를 구분합니다. payload는 CustomEvent<Surface3DCrosshairDetail|null>의 detail에서 읽습니다.
chart.addEventListener('crosshairMove', event => {
console.log(event.detail); // Surface3DCrosshairDetail|null
});appended
CustomEvent.detail 타입: {count:number;replaced:number}. 이벤트 이름은 대소문자를 구분합니다.
이벤트 이름: appended. 대소문자를 구분합니다. payload는 CustomEvent<{count:number;replaced:number}>의 detail에서 읽습니다.
chart.addEventListener('appended', event => {
console.log(event.detail); // {count:number;replaced:number}
});windowSlid
CustomEvent.detail 타입: {dropped:number}. 이벤트 이름은 대소문자를 구분합니다.
이벤트 이름: windowSlid. 대소문자를 구분합니다. payload는 CustomEvent<{dropped:number}>의 detail에서 읽습니다.
chart.addEventListener('windowSlid', event => {
console.log(event.detail); // {dropped:number}
});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
});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
});dataValidationError
CustomEvent.detail 타입: {message:string}. 이벤트 이름은 대소문자를 구분합니다.
이벤트 이름: dataValidationError. 대소문자를 구분합니다. payload는 CustomEvent<{message:string}>의 detail에서 읽습니다.
chart.addEventListener('dataValidationError', event => {
console.log(event.detail); // {message:string}
});Methods
appendPoint
스트림에 값 하나를 추가합니다. 메서드 인수 타입과 스트리밍 기능의 라이선스 조건을 확인하세요.
appendPoint(row: Surface3DRowInput): Promise<void>| 인수 | 타입 | 필수 여부 |
|---|---|---|
row | Surface3DRowInput | 필수 |
반환 타입: Promise<void>. 요소 등록이 끝난 뒤 메서드를 호출하고 Promise 결과를 await로 기다리세요.
- Surface3DRowInput
타입 정의
appendPoints
비동기 메서드입니다. 아래 인수 타입과 반환 타입을 확인하세요.
appendPoints(rows: ReadonlyArray<Surface3DRowInput>): Promise<void>| 인수 | 타입 | 필수 여부 |
|---|---|---|
rows | ReadonlyArray<Surface3DRowInput> | 필수 |
반환 타입: Promise<void>. 요소 등록이 끝난 뒤 메서드를 호출하고 Promise 결과를 await로 기다리세요.
- Surface3DRowInput
타입 정의
appendBatch
스트림에 여러 값을 한 번에 추가합니다. 메서드 인수 타입과 스트리밍 기능의 라이선스 조건을 확인하세요.
appendBatch(rows: ReadonlyArray<Surface3DRowInput>): Promise<void>| 인수 | 타입 | 필수 여부 |
|---|---|---|
rows | ReadonlyArray<Surface3DRowInput> | 필수 |
반환 타입: Promise<void>. 요소 등록이 끝난 뒤 메서드를 호출하고 Promise 결과를 await로 기다리세요.
- Surface3DRowInput
타입 정의
shiftPoints
비동기 메서드입니다. 아래 인수 타입과 반환 타입을 확인하세요.
shiftPoints(count: number): Promise<void>| 인수 | 타입 | 필수 여부 |
|---|---|---|
count | number | 필수 |
반환 타입: 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로 기다리세요.
clearStream
비동기 메서드입니다. 아래 인수 타입과 반환 타입을 확인하세요.
clearStream(): Promise<void>반환 타입: 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(rows: ReadonlyArray<Surface3DRowInput>): Promise<void>| 인수 | 타입 | 필수 여부 |
|---|---|---|
rows | ReadonlyArray<Surface3DRowInput> | 필수 |
반환 타입: Promise<void>. 요소 등록이 끝난 뒤 메서드를 호출하고 Promise 결과를 await로 기다리세요.
- Surface3DRowInput
타입 정의
getStreamSource
The stream session's source (Chart Pro): like the stream methods it waits for a license still being confirmed.
getStreamSource(): Promise<Surface3DStreamSource|undefined>반환 타입: Promise<Surface3DStreamSource|undefined>. 요소 등록이 끝난 뒤 메서드를 호출하고 Promise 결과를 await로 기다리세요.
setData
Replace the bar set.
setData(data: Surface3DData): Promise<void>| 인수 | 타입 | 필수 여부 |
|---|---|---|
data | Surface3DData | 필수 |
반환 타입: Promise<void>. 요소 등록이 끝난 뒤 메서드를 호출하고 Promise 결과를 await로 기다리세요.
- Surface3DData
타입 정의
getData
비동기 메서드입니다. 아래 인수 타입과 반환 타입을 확인하세요.
getData(): Promise<Surface3DGrid>반환 타입: Promise<Surface3DGrid>. 요소 등록이 끝난 뒤 메서드를 호출하고 Promise 결과를 await로 기다리세요.
- Surface3DGrid
타입 정의
getDiagnostics
Normalization diagnostics for the effective base and stream source.
getDiagnostics(): Promise<{ missingHeights: number; invalidHeights: number; missingValues: number; invalidValues: number; }>반환 타입: Promise<{ missingHeights: number; invalidHeights: number; missingValues: number; invalidValues: number; }>. 요소 등록이 끝난 뒤 메서드를 호출하고 Promise 결과를 await로 기다리세요.
getLayout
Host-local geometry as shown. Scale fields preserve ellipses under non-uniform viewport zoom.
getLayout(): Promise<Surface3DGeometry>반환 타입: Promise<Surface3DGeometry>. 요소 등록이 끝난 뒤 메서드를 호출하고 Promise 결과를 await로 기다리세요.
- Surface3DGeometry
타입 정의
pauseAnimation
진행 중인 애니메이션을 일시 정지합니다.
pauseAnimation(): Promise<void>반환 타입: Promise<void>. 요소 등록이 끝난 뒤 메서드를 호출하고 Promise 결과를 await로 기다리세요.
resumeAnimation
일시 정지한 애니메이션을 다시 진행합니다.
resumeAnimation(): Promise<void>반환 타입: Promise<void>. 요소 등록이 끝난 뒤 메서드를 호출하고 Promise 결과를 await로 기다리세요.
setAnimation
비동기 메서드입니다. 아래 인수 타입과 반환 타입을 확인하세요.
setAnimation(options: {enabled?:boolean;duration?:number;easing?:Surface3DEasing;type?:HeatmapAnimationType}): Promise<void>| 인수 | 타입 | 필수 여부 |
|---|---|---|
options | {enabled?:boolean;duration?:number;easing?:Surface3DEasing;type?:HeatmapAnimationType} | 필수 |
반환 타입: Promise<void>. 요소 등록이 끝난 뒤 메서드를 호출하고 Promise 결과를 await로 기다리세요.
- Surface3DEasing
타입 정의
- HeatmapAnimationType
타입 정의
replayAnimation
Replay the initial sweep from min → value(s). No-op when animation is off / reduced.
replayAnimation(): Promise<void>반환 타입: Promise<void>. 요소 등록이 끝난 뒤 메서드를 호출하고 Promise 결과를 await로 기다리세요.
getCamera
비동기 메서드입니다. 아래 인수 타입과 반환 타입을 확인하세요.
getCamera(): Promise<Scene3DCameraOptions>반환 타입: Promise<Scene3DCameraOptions>. 요소 등록이 끝난 뒤 메서드를 호출하고 Promise 결과를 await로 기다리세요.
- Scene3DCameraOptions
타입 정의
setCamera
비동기 메서드입니다. 아래 인수 타입과 반환 타입을 확인하세요.
setCamera(options: Scene3DCameraOptions): Promise<void>| 인수 | 타입 | 필수 여부 |
|---|---|---|
options | Scene3DCameraOptions | 필수 |
반환 타입: Promise<void>. 요소 등록이 끝난 뒤 메서드를 호출하고 Promise 결과를 await로 기다리세요.
- Scene3DCameraOptions
타입 정의
setProjection
비동기 메서드입니다. 아래 인수 타입과 반환 타입을 확인하세요.
setProjection(projection: Scene3DProjection): Promise<void>| 인수 | 타입 | 필수 여부 |
|---|---|---|
projection | Scene3DProjection | 필수 |
반환 타입: Promise<void>. 요소 등록이 끝난 뒤 메서드를 호출하고 Promise 결과를 await로 기다리세요.
- Scene3DProjection
타입 정의
resetCamera
비동기 메서드입니다. 아래 인수 타입과 반환 타입을 확인하세요.
resetCamera(): Promise<void>반환 타입: Promise<void>. 요소 등록이 끝난 뒤 메서드를 호출하고 Promise 결과를 await로 기다리세요.
saveCamera
비동기 메서드입니다. 아래 인수 타입과 반환 타입을 확인하세요.
saveCamera(): Promise<void>반환 타입: Promise<void>. 요소 등록이 끝난 뒤 메서드를 호출하고 Promise 결과를 await로 기다리세요.
fitSurface
비동기 메서드입니다. 아래 인수 타입과 반환 타입을 확인하세요.
fitSurface(padding?: number): Promise<void>| 인수 | 타입 | 필수 여부 |
|---|---|---|
padding | number | 선택 |
반환 타입: Promise<void>. 요소 등록이 끝난 뒤 메서드를 호출하고 Promise 결과를 await로 기다리세요.
zoomBy
A factor below one moves closer. Perspective changes distance; orthographic changes zoom.
zoomBy(factor: number): Promise<void>| 인수 | 타입 | 필수 여부 |
|---|---|---|
factor | number | 필수 |
반환 타입: Promise<void>. 요소 등록이 끝난 뒤 메서드를 호출하고 Promise 결과를 await로 기다리세요.
rotateBy
비동기 메서드입니다. 아래 인수 타입과 반환 타입을 확인하세요.
rotateBy(azimuth: number, polar?: number): Promise<void>| 인수 | 타입 | 필수 여부 |
|---|---|---|
azimuth | number | 필수 |
polar | number | 선택 |
반환 타입: Promise<void>. 요소 등록이 끝난 뒤 메서드를 호출하고 Promise 결과를 await로 기다리세요.
panBy
slide the zoomed windows by data units ({ x?, y? }); a no-op at the full extent.
panBy(x: number, y: number): Promise<void>| 인수 | 타입 | 필수 여부 |
|---|---|---|
x | number | 필수 |
y | number | 필수 |
반환 타입: Promise<void>. 요소 등록이 끝난 뒤 메서드를 호출하고 Promise 결과를 await로 기다리세요.
resetZoom
확대·이동한 범위를 초기 데이터 범위로 되돌립니다.
resetZoom(): Promise<void>반환 타입: Promise<void>. 요소 등록이 끝난 뒤 메서드를 호출하고 Promise 결과를 await로 기다리세요.
redraw
현재 데이터와 옵션으로 차트를 다시 그립니다. 반환되는 Promise가 완료되면 렌더링 결과를 확인할 수 있습니다.
redraw(): Promise<Surface3DRenderResult>반환 타입: Promise<Surface3DRenderResult>. 요소 등록이 끝난 뒤 메서드를 호출하고 Promise 결과를 await로 기다리세요.
getActiveTier
비동기 메서드입니다. 아래 인수 타입과 반환 타입을 확인하세요.
getActiveTier(): Promise<Surface3DEngineTier>반환 타입: Promise<Surface3DEngineTier>. 요소 등록이 끝난 뒤 메서드를 호출하고 Promise 결과를 await로 기다리세요.
- Surface3DEngineTier
타입 정의
getEngineStatus
Requested engine vs what runs, and why (CHART-ADD-08); a frozen or unlicensed chart reports the license outcome.
getEngineStatus(): Promise<ChartEngineStatus>반환 타입: Promise<ChartEngineStatus>. 요소 등록이 끝난 뒤 메서드를 호출하고 Promise 결과를 await로 기다리세요.
- ChartEngineStatus
타입 정의
recycleGpu
Without the grant (or while frozen) nothing is recycled: no GPU work starts.
recycleGpu(): Promise<void>반환 타입: Promise<void>. 요소 등록이 끝난 뒤 메서드를 호출하고 Promise 결과를 await로 기다리세요.
hitTest
The box under a host-local CSS point (the nearest slot, within half a pitch), or null.
hitTest(cssX: number, cssY: number): Promise<Surface3DHitDetail|null>| 인수 | 타입 | 필수 여부 |
|---|---|---|
cssX | number | 필수 |
cssY | number | 필수 |
반환 타입: Promise<Surface3DHitDetail|null>. 요소 등록이 끝난 뒤 메서드를 호출하고 Promise 결과를 await로 기다리세요.
- Surface3DHitDetail
타입 정의
selectPointAt
비동기 메서드입니다. 아래 인수 타입과 반환 타입을 확인하세요.
selectPointAt(row: number, column: number): Promise<Surface3DHitDetail|null>| 인수 | 타입 | 필수 여부 |
|---|---|---|
row | number | 필수 |
column | number | 필수 |
반환 타입: Promise<Surface3DHitDetail|null>. 요소 등록이 끝난 뒤 메서드를 호출하고 Promise 결과를 await로 기다리세요.
- Surface3DHitDetail
타입 정의
clearSelection
Release the selection (emits selectionChanged when there was one).
clearSelection(): Promise<void>반환 타입: Promise<void>. 요소 등록이 끝난 뒤 메서드를 호출하고 Promise 결과를 await로 기다리세요.
getSelection
The selection: the selected node's / link's detail (null = none); its anchors are Pro-derived, refused without a valid license.
getSelection(): Promise<Surface3DSelection>반환 타입: Promise<Surface3DSelection>. 요소 등록이 끝난 뒤 메서드를 호출하고 Promise 결과를 await로 기다리세요.
- Surface3DSelection
타입 정의
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(row: number, column: number): Promise<CartesianTooltipEventDetail|null>| 인수 | 타입 | 필수 여부 |
|---|---|---|
row | number | 필수 |
column | number | 필수 |
반환 타입: Promise<CartesianTooltipEventDetail|null>. 요소 등록이 끝난 뒤 메서드를 호출하고 Promise 결과를 await로 기다리세요.
showTooltipAtIndex
open the tooltip on a box (the facade's showTooltipAtPoint routes here); null off the boxes or with the tooltip off.
showTooltipAtIndex(index: number): Promise<CartesianTooltipEventDetail|null>| 인수 | 타입 | 필수 여부 |
|---|---|---|
index | number | 필수 |
반환 타입: Promise<CartesianTooltipEventDetail|null>. 요소 등록이 끝난 뒤 메서드를 호출하고 Promise 결과를 await로 기다리세요.
hideTooltip
현재 표시 중인 툴팁을 닫습니다.
hideTooltip(): Promise<void>반환 타입: Promise<void>. 요소 등록이 끝난 뒤 메서드를 호출하고 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(row: number, column: number): Promise<boolean>| 인수 | 타입 | 필수 여부 |
|---|---|---|
row | number | 필수 |
column | number | 필수 |
반환 타입: Promise<boolean>. 요소 등록이 끝난 뒤 메서드를 호출하고 Promise 결과를 await로 기다리세요.
showCrosshairAtData
Quiet cross-chart synchronization in data units, including positions between grid samples.
showCrosshairAtData(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로 기다리세요.
getDataTable
Current normalized table, including the retained stream; independent of GPU availability.
getDataTable(): Promise<ChartDataTable>반환 타입: Promise<ChartDataTable>. 요소 등록이 끝난 뒤 메서드를 호출하고 Promise 결과를 await로 기다리세요.
- ChartDataTable
타입 정의
getCSV
The tape as a CSV table (ISO time, OHLC, volume).
getCSV(options?: CsvOptions): Promise<string>| 인수 | 타입 | 필수 여부 |
|---|---|---|
options | CsvOptions | 선택 |
반환 타입: Promise<string>. 요소 등록이 끝난 뒤 메서드를 호출하고 Promise 결과를 await로 기다리세요.
- CsvOptions
타입 정의
getTable
비동기 메서드입니다. 아래 인수 타입과 반환 타입을 확인하세요.
getTable(): Promise<string>반환 타입: Promise<string>. 요소 등록이 끝난 뒤 메서드를 호출하고 Promise 결과를 await로 기다리세요.