@finchart

Appearance

Documentation / @finchart/react / UsePlotOptions

Interface: UsePlotOptions<T> ​

Defined in: hooks/use-chart.ts:16

Type Parameters ​

T ​

T extends BaseDataPoint

Properties ​

data? ​

optional data?: T[]

Defined in: hooks/use-chart.ts:33

그 시리즈가 그릴 데이터. series와 짝이다.

<ChartContainer>는 여기 안 주고 자식들에게 내린다 — 시리즈마다 다른 데이터를 그려야 하기 때문이다.

deps ​

deps: PlotDeps | BrowserDeps

Defined in: hooks/use-chart.ts:24

완성 배선, 또는 browserDeps()가 돌려주는 레시피.

필수다. 기본값을 두려면 이 파일이 browserDeps를 정적으로 import해야 하고, 그러면 명시 배선으로 세운 소비자까지 브라우저 셸 전체(+21.6KB raw / +6.5KB gzip)를 싣는다 — 배선에서 빼면 코드도 안 들어온다는 원칙(PRINCIPLES 21) 위반.

gridStyle? ​

optional gridStyle?: Partial<LineStyle>

Defined in: hooks/use-chart.ts:37

height? ​

optional height?: number

Defined in: hooks/use-chart.ts:35

onCrosshair? ​

optional onCrosshair?: (crosshair) => void

Defined in: hooks/use-chart.ts:44

포인터가 차트 위를 지날 때. 드래그 중에는 오지 않는다. 어느 pane 위인지와 그 pane의 값까지 함께 온다.

Parameters ​

crosshair ​

CrosshairPayload

Returns ​

void

onStateChange? ​

optional onStateChange?: (state) => void

Defined in: hooks/use-chart.ts:69

보는 상태가 바뀔 때 (pan·zoom·구분자 드래그·pane 옵션). URL 저장·undo· 차트 동기화가 여기서 시작한다.

드래그 중 pointermove마다 오므로, 저장이 비싸면 받는 쪽이 미룬다.

Parameters ​

state ​

ChartState

Returns ​

void

onXDomainChange? ​

optional onXDomainChange?: (change) => void

Defined in: hooks/use-chart.ts:52

보고 있는 x 구간이 바뀔 때. 무한 스크롤이 이걸 듣는다 (ADR-0009).

plotRef.current.on(...)으로 직접 구독하지 말 것 — StrictMode 이중 마운트 시 바깥 effect가 파괴된 첫 plot에 걸린 채 남는다. 이 prop은 plot 생성 effect와 같이 다시 걸리므로 안전하다.

Parameters ​

change ​

XDomainChangePayload

Returns ​

void

paneGap? ​

optional paneGap?: number

Defined in: hooks/use-chart.ts:39

pane 사이 간격(px). 구분자가 여기 놓인다.

series? ​

optional series?: Series<T>

Defined in: hooks/use-chart.ts:26

생략하면 무엇을 그릴지는 나중에 정한다 — <ChartContainer>가 그렇게 쓴다.

showGrid? ​

optional showGrid?: boolean

Defined in: hooks/use-chart.ts:36

state? ​

optional state?: Partial<ChartState>

Defined in: hooks/use-chart.ts:62

보는 상태(ChartState)를 밖에서 준다. 참조가 바뀔 때마다 반영된다 (applyState) — 안 주면 내부 소유다.

소유권 이전이 아니라 지시다: 코어는 거울 + 되먹임(상태 원천을 옮기면 60fps pan이 한 프레임 늦는다). controlled 모양은 이 prop과 onStateChange의 짝이 만든다 — 내부 변이를 거부하려면 onStateChange에서 바뀌지 않은 상태를 새 참조로 돌려주면 된다.

width? ​

optional width?: number

Defined in: hooks/use-chart.ts:34