createVBI

Creates an independent VBI instance.

Each instance has its own resource registry, suitable for isolating different reports, dashboards, or test contexts within the same application.

Function Signature

function createVBI(): VBIInstance<DefaultVBIQueryDSL, DefaultVBISeedDSL>
function createVBI<TQueryDSL, TSeedDSL>(defaultBuilderOptions: VBIChartBuilderOptions<TQueryDSL, TSeedDSL>): VBIInstance<TQueryDSL, TSeedDSL>

Parameters

ParameterTypeDescription
defaultBuilderOptionsVBIChartBuilderOptions<TQueryDSL, TSeedDSL>Default chart Builder configuration, passed to chart Builders created in chart, report, and dashboard.

VBI

The default VBI instance, suitable for directly using globally shared Builder and resource capabilities.

Type: VBIInstance

Definition:

const VBI: VBIInstance = createVBI()

VBIInstance

The VBI instance returned by createVBI, serving as the unified entry point for chart, insight, dashboard, report, and other capabilities.

Properties

PropertyTypeDescription
connectorsVBIConnectorNamespaceConnector registration, retrieval, and release APIs.
resourcesVBIResourceNamespaceChart and insight resource registration APIs, used by dashboard/report to reference shared resources.
chartVBIChartNamespace<TQueryDSL, TSeedDSL>Chart Builder creation API.
insightVBIInsightNamespaceInsight Builder creation API.
dashboardVBIDashboardNamespace<TQueryDSL, TSeedDSL>Dashboard Builder creation API.
reportVBIReportNamespace<TQueryDSL, TSeedDSL>Report Builder creation API.