Builder

Methods

prepare

prepare(): Promise<void>

Thực thi mã bộ lọc động theo cách bất đồng bộ. Gọi trước build() để thực thi code trong dynamicFilter. Đây là phương thức lũy đẳng; gọi nhiều lần sẽ không thực thi lặp lại.

build

build<T = S>(): T

Sinh cấu hình biểu đồ cuối cùng (Spec). Đây là phương thức lõi được dùng phổ biến nhất. Nếu cấu hình chứa code trong dynamicFilter, cần gọi prepare() trước.

buildSpec

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

Chuyển đổi cấu hình tầng trung gian (AdvancedVSeed) thành Spec cuối cùng. Chỉ dùng khi bạn cần tùy chỉnh sâu cấu hình tầng trung gian.

buildAdvanced

buildAdvanced(): AdvancedVSeed | null

Sinh cấu hình tầng trung gian (AdvancedVSeed), tức là mẫu biểu đồ. Chi tiết hơn VSeed gốc và bộc lộ nhiều chi tiết biểu đồ hơn.

getColorItems

getColorItems(): __type[]

Lấy thông tin các trường liên quan đến màu trong dữ liệu. Thường dùng để sinh chú giải biểu đồ hoặc UI bộ lọc màu.

getColorIdMap

getColorIdMap(): Record

Lấy bảng ánh xạ chi tiết của trường màu. Khóa là ID màu, giá trị là thông tin chi tiết.

getColorValueMap

getColorValueMap(): undefined | Record

Lấy ánh xạ từ colorId đến giá trị màu cuối cùng trong bản đồ màu rời rạc.

Static Methods

getAdvancedPipeline

static getAdvancedPipeline(chartType: ChartType): Pipe[]

[Phương thức nội bộ] Lấy pipeline xây dựng mẫu cho loại biểu đồ được chỉ định, dùng để debug quá trình chuyển đổi từ VSeed sang AdvancedVSeed.

getSpecPipeline

static getSpecPipeline(chartType: ChartType): SpecPipe[]

[Phương thức nội bộ] Lấy pipeline xây dựng Spec cho loại biểu đồ được chỉ định, dùng để debug quá trình chuyển đổi từ AdvancedVSeed sang Spec.

getTheme

static getTheme(themeKey?: string): CustomThemeConfig

Lấy cấu hình của chủ đề được chỉ định. Nếu không truyền themeKey, mặc định trả về chủ đề 'light'.

getThemeMap

static getThemeMap(): Record<string, CustomThemeConfig>

Lấy tất cả cấu hình chủ đề đã đăng ký.

from

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

Phương thức tạo tĩnh để tạo thực thể Builder một cách thuận tiện.

registerAdvancedPipeline

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

[Phương thức mở rộng] Đăng ký pipeline xây dựng mẫu cho loại biểu đồ mới.

registerSpecPipeline

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

[Phương thức mở rộng] Đăng ký pipeline xây dựng Spec cho loại biểu đồ mới.

updateAdvanced

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

[Phương thức mở rộng] Sửa logic xây dựng mẫu của biểu đồ hiện có, chèn Pipe tùy chỉnh để ảnh hưởng đến AdvancedVSeed được sinh ra.

updateSpec

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

[Phương thức mở rộng] Sửa logic xây dựng Spec của biểu đồ hiện có, chèn Pipe tùy chỉnh để ảnh hưởng đến Spec cuối cùng được sinh ra.

registerTheme

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

[Phương thức mở rộng] Đăng ký chủ đề tùy chỉnh.

Properties

get locale

get locale()

Lấy locale mà Builder hiện tại đang sử dụng.

get vseed

get vseed()

Lấy dữ liệu đầu vào VSeed hiện tại.

set vseed

set vseed(value)

Cập nhật dữ liệu đầu vào VSeed. Sau khi cập nhật, trạng thái bộ nhớ đệm của prepare() sẽ bị xóa.

get isPrepared

get isPrepared()

Lấy trạng thái prepare().

set isPrepared

set isPrepared(value: boolean)

Thiết lập trạng thái prepare().

get advancedVSeed

get advancedVSeed()

Lấy đối tượng cấu hình trung gian AdvancedVSeed hiện tại.

set advancedVSeed

set advancedVSeed(value)

Thiết lập đối tượng cấu hình trung gian AdvancedVSeed. Thường dùng để bộ nhớ đệm hoặc tái sử dụng cấu hình trung gian đã có.

get spec

get spec()

Lấy đối tượng Spec cuối cùng hiện đang được sinh ra.

set spec

set spec(value)

Thiết lập đối tượng Spec. Thường dùng để bộ nhớ đệm.

get performance

get performance()

Lấy thông tin thống kê hiệu năng trong quá trình build. Bao gồm thời gian của từng giai đoạn (đơn vị: ms).

set performance

set performance(value)

Thiết lập thông tin thống kê hiệu năng.