• English
  • VBI.resources.chart

    The chart resource namespace on a VBI instance.

    Methods

    register

    Registers a single chart resource.

    Definition:

    register(chart: VBIChartDSLInput): VBIChartDSL

    Returns: VBIChartDSL

    Parameters:

    ParameterTypeDescription
    chartVBIChartDSLInput-

    get

    Gets a registered chart resource DSL.

    Definition:

    get(uuid: string): VBIChartDSL | undefined

    Returns: VBIChartDSL \| undefined

    Parameters:

    ParameterTypeDescription
    uuidstring-

    list

    Gets all registered chart resource DSLs.

    Definition:

    list(): VBIChartDSL[]

    Returns: VBIChartDSL[]

    has

    Checks whether the specified chart resource has been registered.

    Definition:

    has(uuid: string): boolean

    Returns: boolean

    Parameters:

    ParameterTypeDescription
    uuidstring-

    unregister

    Unregisters the specified chart resource.

    Definition:

    unregister(uuid: string): boolean

    Returns: boolean

    Parameters:

    ParameterTypeDescription
    uuidstring-