Volcano

API 참조

Kotlin/Compose API와 별도의 React TypeScript API 문서를 안내합니다.

이 페이지는 Kotlin/Compose 아티팩트용입니다. npm 패키지의 타입과 props는 별도 React API 참조에 있습니다. Kotlin 타입이나 Compose 상태를 React에 그대로 적용하지 마세요.

상세한 타입·함수·프로퍼티는 Dokka API 참조에서 확인하세요. API 참조는 라이브러리 소스의 KDoc에서 생성되므로, 사용 중인 배포 버전의 문서와 맞춰 확인해야 합니다.

주요 진입점

  • HeatmapNode: ID, 라벨, 면적 값, 지표, 선택 이미지 URL, 자식 노드를 담는 불변 모델. 생성 시 자식 목록을 복사하며 변경 시 copy(children = ...)를 사용합니다.
  • rememberHeatmapState: 현재 그룹 경로와 탐색 상태를 보유
  • Heatmap: 제약된 Compose 영역에 계층형 사각형을 렌더링
  • HeatmapInteraction: 탭, long press, hover, tooltip 같은 입력 정책
  • PercentageMetricFormatter: 부호 있는 백분율 지표의 기본 포맷터

공개 API를 사용할 때는 nullable 이미지, 0 이하의 면적 값, 작은 셀에서의 콘텐츠 생략을 정상 입력·정상 동작으로 다루세요.

이 페이지에서