heatmap

피벗 테이블의 셀에 적용되는 히트맵(Heatmap) 설정 옵션.
값의 크기에 따라 셀 배경색을 단계적으로 변경한다.

Options

visible: boolean

표시 가능 여부.

default: true

cellScope: 'value'|'subtotal'|'total'|'all'|('value'|'subtotal'|'total')[]

overlay를 적용할 셀 타입.

기본값은 'value'(상세 셀에만 적용). 소계/총계는 값이 커서 정규화 기준을 왜곡하기 쉬우므로 주의가 필요하다. 소계에도 적용하려면 보통 compareScope: ['level', ...]을 같이 쓴다.

default: 'value'

compareScope: 'all'|'row'|'column'|'level'|'rowGroup'|'columnGroup'|('row'|'column'|'level'|'rowGroup'|'columnGroup')[]

값을 비교(정규화)할 범위.

어느 셀들을 "한 그룹"으로 보고 해당 그룹의 min/max로 정규화할지 결정한다. 이 값에 따라 같은 셀의 색상/막대 폭이 달라진다.

배열로 조합 가능하며, 조합된 축들의 교차 그룹별로 분리된다.

default: 'all'

boundsMode: 'auto'|'value'|'percent'|'percentile'

minValue/maxValue(+ heatmap midValue) 해석 방식. overlay의 모든 경계 옵션은 이 한 가지 방식으로 통일 해석된다.

default: 'auto'

maxValue: number

최대값. boundsMode에 따라 해석된다. boundsMode: 'auto'이거나 미지정이면 데이터의 실제 최대값이 사용된다.

minValue: number

최소값. boundsMode에 따라 해석된다. boundsMode: 'auto'이거나 미지정이면 데이터의 실제 최소값이 사용된다.

outOfRange: 'clamp'|'hide'

사용자가 설정한 minValue/maxValue 범위를 벗어난 값의 처리 방식.

• 'clamp' (기본): 범위 경계값으로 클래핑해서 overlay를 계속 그린다 (heatmap: 끝색, dataBar: 0%/100%).
• 'hide' : 범위 밖 셀은 overlay를 적용하지 않는다 (값 자체는 표시).

boundsMode: 'auto'이거나 min/max를 지정하지 않으면 범위 밖 셀이 존재할 수 없으므로 이 옵션은 무의미하다.

default: 'clamp'

logBase: number

로그 스케일 밑(base).

• > 1 이면 해당 밑의 로그 스케일로 정규화한다 (예: 2, Math.E, 10).
• <= 1 이거나 미지정/비유한값이면 무시되어 선형 스케일로 처리된다. (base = 1은 정의 불가, 0 < base < 1은 정규화 방향이 뒤집혀 의미가 없다.)

default: 10

colors: string[]

최소값에서 최대값 사이의 색상 목록.
2개 또는 3개 색상을 지정할 수 있으며, 값이 낮을수록 앞쪽 색상이 사용된다. 지정하지 않으면 내부 기본 색상 배열에서 측정값(measure) 인덱스 순서에 해당하는 색상 세트를 사용한다. 기본값은 3단계 그라데이션으로, 낮은 값부터 빨강-노랑-초록 순이다.

nullColor: string

값이 null 또는 undefined인 경우 사용할 색상.
지정하지 않으면 투명하게 처리한다.

midValue: number

중간값. boundsBy에 따라 해석된다. 미지정이면 (min+max)/2 (또는 boundsBy별 균등 중점)이 사용된다. midColor가 지정된 경우에만 의미가 있으며, 이 값을 기준으로 색상이 결정된다.

colorPicker: ( cell: IPivotValueCellInfo, stats: ScopedStats ) => string

셀별 색상을 직접 결정하는 콜백. 정의되면 boundsBy/minValue/maxValue/midValue/colors/logBase 등 내부 색상 결정 파이프라인을 전부 우회한다.

• 문자열(CSS 색) 반환 → 그 색을 그대로 사용.
• undefined 반환 → 해당 셀에 한해 기본 그라데이션 경로로 폴백.

stats는 overlay 자신의 cellScope/compareScope로 prepare된 분포 통계.