Builder

Methods

prepare

prepare(): Promise<void>

Menjalankan kode filter dinamis secara asinkron. Dipanggil sebelum build() untuk menjalankan code di dalam dynamicFilter. Ini adalah metode idempotent; pemanggilan berkali-kali tidak akan menjalankan ulang kode.

build

build<T = S>(): T

Menghasilkan konfigurasi diagram final (Spec). Ini adalah metode inti yang paling sering digunakan. Jika konfigurasi berisi code di dalam dynamicFilter, panggil prepare() terlebih dahulu.

buildSpec

buildSpec<T = S>(advanced: AdvancedVSeed): T

Mengubah konfigurasi lapisan tengah (AdvancedVSeed) menjadi Spec final. Gunakan hanya ketika perlu melakukan kustomisasi mendalam pada konfigurasi lapisan tengah.

buildAdvanced

buildAdvanced(): AdvancedVSeed | null

Menghasilkan konfigurasi lapisan tengah (AdvancedVSeed), yaitu templat diagram. Lebih detail daripada VSeed asli dan mengekspos lebih banyak detail diagram.

getColorItems

getColorItems(): __type[]

Mengambil informasi field yang terkait dengan warna dalam data. Sering digunakan untuk membuat legenda diagram atau UI filter warna.

getColorIdMap

getColorIdMap(): Record

Mengambil tabel pemetaan detail untuk field warna. Kunci adalah ID warna, sedangkan nilai berisi informasi detail.

getColorValueMap

getColorValueMap(): undefined | Record

Mengambil pemetaan dari colorId ke nilai warna final dalam peta warna diskret.

Static Methods

getAdvancedPipeline

static getAdvancedPipeline(chartType: ChartType): Pipe[]

[Metode internal] Mengambil pipeline pembuatan templat untuk tipe diagram tertentu, digunakan untuk men-debug proses konversi dari VSeed ke AdvancedVSeed.

getSpecPipeline

static getSpecPipeline(chartType: ChartType): SpecPipe[]

[Metode internal] Mengambil pipeline pembuatan Spec untuk tipe diagram tertentu, digunakan untuk men-debug proses konversi dari AdvancedVSeed ke Spec.

getTheme

static getTheme(themeKey?: string): CustomThemeConfig

Mengambil konfigurasi tema tertentu. Jika themeKey tidak diberikan, secara default mengembalikan tema 'light'.

getThemeMap

static getThemeMap(): Record<string, CustomThemeConfig>

Mengambil semua konfigurasi tema yang sudah terdaftar.

from

static from<T extends Spec = Spec>(vseed: VSeed): Builder<T>

Metode pabrik statis untuk membuat instance Builder dengan mudah.

registerAdvancedPipeline

static registerAdvancedPipeline(chartType: ChartType, pipeline: AdvancedPipeline): void

[Metode ekstensi] Mendaftarkan pipeline pembuatan templat untuk tipe diagram baru.

registerSpecPipeline

static registerSpecPipeline(chartType: ChartType, pipeline: SpecPipeline): void

[Metode ekstensi] Mendaftarkan pipeline pembuatan Spec untuk tipe diagram baru.

updateAdvanced

static updateAdvanced(chartType: ChartType, pipe: AdvancedPipe): void

[Metode ekstensi] Mengubah logika pembuatan templat diagram yang sudah ada, menyisipkan Pipe kustom untuk memengaruhi AdvancedVSeed yang dihasilkan.

updateSpec

static updateSpec(chartType: ChartType, pipe: SpecPipe): void

[Metode ekstensi] Mengubah logika pembuatan Spec diagram yang sudah ada, menyisipkan Pipe kustom untuk memengaruhi Spec final yang dihasilkan.

registerTheme

static registerTheme(key: string, theme: CustomThemeConfig): void

[Metode ekstensi] Mendaftarkan tema kustom.

Properties

get locale

get locale()

Mengambil locale yang digunakan Builder saat ini.

get vseed

get vseed()

Mengambil data input VSeed saat ini.

set vseed

set vseed(value)

Memperbarui data input VSeed. Setelah diperbarui, status tembolok dari prepare() akan dihapus.

get isPrepared

get isPrepared()

Mengambil status prepare().

set isPrepared

set isPrepared(value: boolean)

Mengatur status prepare().

get advancedVSeed

get advancedVSeed()

Mengambil objek konfigurasi tengah AdvancedVSeed saat ini.

set advancedVSeed

set advancedVSeed(value)

Mengatur objek konfigurasi tengah AdvancedVSeed. Biasanya digunakan untuk tembolok atau menggunakan ulang konfigurasi tengah yang sudah ada.

get spec

get spec()

Mengambil objek Spec final yang saat ini dihasilkan.

set spec

set spec(value)

Mengatur objek Spec. Biasanya digunakan untuk tembolok.

get performance

get performance()

Mengambil informasi statistik performa selama proses build. Mencakup waktu tiap tahap (satuan: ms).

set performance

set performance(value)

Mengatur informasi statistik performa.