Documentation / @finchart/core / Pane

Interface: Pane

Defined in: packages/core/src/plot/pane.ts:487

밖에서 보는 pane. 공개되는 이름은 이쪽이다 (index.ts가 Pane으로 낸다).

Omit<Pane, …>처럼 뺄셈으로 적으면 클래스에 메서드가 하나 늘 때마다 아무 결정 없이 공개되므로, 덧셈으로 적는다. Pane implements PaneApi라 컴파일러가 짝을 지킨다.

여기 없는 것은 무대가 프레임마다 쓰는 배선이다 — 세로 자리를 심고 (setValueRange·setArea), 그리고(draw), 배지를 모으고 (collectAxisBadges), 봉 번호 매핑에 x를 넘긴다(xValuesPerSeries). 밖에서 부르면 다음 프레임이 덮거나 커밋 밖에서 명령이 샌다.

확장이 요구할 것은 이 타입 전체가 아니라 아래 조각들이다 — SeriesHost·PaneDecorationHost·ValueCoordinates·DataProbe (→ capabilities.ts). 지표는 SeriesHost 하나면 된다.

Extends

• SeriesHost.PaneDecorationHost.ValueCoordinates.DataProbe.ValueFormatSource.PluginHost<PaneApi>

Properties

area

readonly area: PlotArea

Defined in: packages/core/src/plot/capabilities.ts:230

이 pane이 배분받은 자리. 히트 판정이 "안인가"를 묻는 기준이다.

Inherited from

ValueCoordinates.area

---

autoScale

readonly autoScale: boolean

Defined in: packages/core/src/plot/pane.ts:495

값 축이 보이는 구간을 따라가는가..

---

axis

readonly axis: Readonly<AxisOptions>

Defined in: packages/core/src/plot/pane.ts:501

이 pane의 값 축 설정. 바꾸려면 applyOptions({ axis })다.

---

flex

readonly flex: number

Defined in: packages/core/src/plot/pane.ts:497

남는 세로 공간을 나눠 갖는 비율. 구분자를 끌면 갱신된다.

---

invert

readonly invert: boolean

Defined in: packages/core/src/plot/pane.ts:503

값 축 반전 여부 → PaneOptions.invert

---

minHeight

readonly minHeight: number

Defined in: packages/core/src/plot/pane.ts:499

이 아래로는 줄어들지 않는다 (px).

---

yScale

readonly yScale: Scale

Defined in: packages/core/src/plot/pane.ts:505

값 축. 교체될 수 있다 — 로그 ↔ 선형 토글이 setYScale로 온다.

Methods

addDecoration()

addDecoration(decoration, options?): () => void

Defined in: packages/core/src/plot/capabilities.ts:260

Parameters

decoration

PaneDecoration

options?

DecorationOptions

Returns

() => void

Inherited from

PaneDecorationHost.addDecoration

---

addSeries()

addSeries<TSource, TPoint>(registration): SeriesHandle<TSource, TPoint>

Defined in: packages/core/src/plot/capabilities.ts:246

Type Parameters

TSource

TSource extends BaseDataPoint

TPoint

TPoint extends BaseDataPoint = TSource

Parameters

registration

SeriesRegistration<TSource, TPoint> | Series<TSource>

Returns

SeriesHandle<TSource, TPoint>

Inherited from

SeriesHost.addSeries

---

applyOptions()

applyOptions(options): void

Defined in: packages/core/src/plot/pane.ts:520

준 것만 바꾼다. 생략은 "그대로"다.

Parameters

options

PaneOptions

Returns

void

---

clearSeries()

clearSeries(): void

Defined in: packages/core/src/plot/pane.ts:517

Returns

void

---

fitValueDomain()

fitValueDomain(visible?): void

Defined in: packages/core/src/plot/pane.ts:526

소속 시리즈 전체가 보이도록 이 pane의 값 축을 맞춘다.

Parameters

visible?

Viewport | null

Returns

void

---

formatValue()

formatValue(value): string

Defined in: packages/core/src/plot/capabilities.ts:148

Parameters

value

number

Returns

string

Inherited from

ValueFormatSource.formatValue

---

getSeries()

getSeries(): readonly unknown[]

Defined in: packages/core/src/plot/pane.ts:518

Returns

readonly unknown[]

---

pixelAtValue()

pixelAtValue(value): number

Defined in: packages/core/src/plot/capabilities.ts:234

값이 놓이는 화면 y(px).

Parameters

value

number

Returns

number

Inherited from

ValueCoordinates.pixelAtValue

---

probe()

probe(x): SeriesSample[]

Defined in: packages/core/src/plot/capabilities.ts:275

Parameters

x

number

Returns

SeriesSample[]

Inherited from

DataProbe.probe

---

setSeries()

setSeries<TSource, TPoint>(registration): SeriesHandle<TSource, TPoint>

Defined in: packages/core/src/plot/pane.ts:514

얹혀 있던 것을 모두 버리고 하나만 남긴다.

Type Parameters

TSource

TSource extends BaseDataPoint

TPoint

TPoint extends BaseDataPoint = TSource

Parameters

registration

SeriesRegistration<TSource, TPoint> | Series<TSource>

Returns

SeriesHandle<TSource, TPoint>

---

setValueDomain()

setValueDomain(min, max): void

Defined in: packages/core/src/plot/pane.ts:524

값 구간을 직접 정한다. autoScale을 끈다.

Parameters

min

number

max

number

Returns

void

---

setYScale()

setYScale(next): void

Defined in: packages/core/src/plot/pane.ts:508

값 축을 갈아 끼운다. 보던 값 구간은 새 스케일에 옮겨 심는다.

Parameters

next

Scale

Returns

void

---

subscribe()

subscribe(listener): () => void

Defined in: packages/core/src/plot/pane.ts:510

시리즈나 옵션이 바뀌면 알려 준다. 해제 함수를 돌려준다.

Parameters

listener

(change) => void

Returns

() => void

---

syncSeries()

syncSeries(specs): void

Defined in: packages/core/src/plot/pane.ts:512

배열이 말하는 대로 시리즈 목록을 맞춘다. 목록 전체를 소유한다.

Parameters

specs

readonly SeriesSpec<BaseDataPoint>[]

Returns

void

---

use()

use<Api>(plugin): Api

Defined in: packages/core/src/plot/capabilities.ts:286

Type Parameters

Api

Api extends PluginApi

Parameters

plugin

Plugin<PaneApi, Api>

Returns

Api

Inherited from

PluginHost.use

---

valueAt()

valueAt(pixel): number

Defined in: packages/core/src/plot/capabilities.ts:232

화면 y(px)의 값.

Parameters

pixel

number

Returns

number

Inherited from

ValueCoordinates.valueAt

---

valueExtent()

valueExtent(visible?): Range | null

Defined in: packages/core/src/plot/pane.ts:522

소속 시리즈가 모두 들어가는 값 범위. 잴 것이 없으면 null.

Parameters

visible?

Viewport | null

Returns

Range | null

---

xRange()

xRange(): Range | null

Defined in: packages/core/src/plot/capabilities.ts:277

그리는 점들의 x 범위. 비었으면 null — 레전드의 "마지막 값"이 이걸 쓴다.

Returns

Range | null

Inherited from

DataProbe.xRange