@finchart

Appearance

Documentation / @finchart/core / ConfigurablePluginApi

Interface: ConfigurablePluginApi<Options> ​

Defined in: packages/core/src/plot/plugin.ts:55

옵션을 다시 줄 수 있는 플러그인의 API. 이게 없으면 옵션 하나를 바꾸려고 뗐다 다시 붙여야 하는데, 드로잉 도구함에서는 그게 사용자가 그린 선을 전부 지우는 일이다. 패치의 모양은 플러그인마다 다르므로 타입 매개변수로 받는다.

병합은 한 겹이다. 준 자리만 바뀌고, 준 자리는 통째로 교체된다 — applyOptions({ format: { x } }) 다음에 { format: { y } }를 주면 x는 사라진다. { key: undefined }는 기본값으로 되돌린다(생략과 다르다).

정리된 뒤에 부르면 던진다 — 조용히 성공하면 옵션이 반영된 줄 알고 화면을 기다리게 된다. 선택 계약이다: 설치 시점에 굳어도 되는 플러그인은 PluginApi로 남는다.

Extends ​

Type Parameters ​

Options ​

Options

Properties ​

disposed ​

readonly disposed: boolean

Defined in: packages/core/src/plot/plugin.ts:25

Inherited from ​

PluginApi.disposed

Methods ​

applyOptions() ​

applyOptions(patch): void

Defined in: packages/core/src/plot/plugin.ts:56

Parameters ​

patch ​

Partial<Options>

Returns ​

void

dispose() ​

dispose(): void

Defined in: packages/core/src/plot/plugin.ts:24

Returns ​

void

Inherited from ​

PluginApi.dispose