• English
  • DashboardChartBuilder

    Methods

    constructor

    Definition:

    constructor(widget: Y.Map<any>, options?: DashboardChartBuilderOptions<TQueryDSL, TSeedDSL>)

    Parameters:

    ParameterTypeDescription
    widgetY.Map-
    options? = {}DashboardChartBuilderOptions<TQueryDSL, TSeedDSL>-

    getId

    Definition:

    getId(): string

    Returns: string

    getBuilder

    Definition:

    getBuilder(): VBIChartBuilder<TQueryDSL, TSeedDSL> | undefined

    Returns: VBIChartBuilder<TQueryDSL, TSeedDSL> \| undefined

    setTitle

    Definition:

    setTitle(title: string): this

    Returns: this

    Parameters:

    ParameterTypeDescription
    titlestring-

    setDescription

    Definition:

    setDescription(description: string): this

    Returns: this

    Parameters:

    ParameterTypeDescription
    descriptionstring-

    setChart

    Definition:

    setChart(chart: ResourceReference): this

    Returns: this

    Parameters:

    ParameterTypeDescription
    chartResourceReference-

    setLayouts

    Definition:

    setLayouts(layouts: DashboardWidgetLayouts): this

    Returns: this

    Parameters:

    ParameterTypeDescription
    layoutsDashboardWidgetLayouts-

    getLayouts

    Definition:

    getLayouts(): DashboardWidgetLayouts

    Returns: DashboardWidgetLayouts

    toJSON

    Definition:

    toJSON(): VBIDashboardWidget

    Returns: VBIDashboardWidget