VisActor VBI
  • English

      • DashboardInsightCollectionBuilder

      Methods

      constructor

      Definition:

      constructor(doc: Y.Doc, dsl: Y.Map<any>, dashboardBuilder: TDashboardBuilder)

      Parameters:

      ParameterTypeDescription
      docY.Doc-
      dslY.Map-
      dashboardBuilderTDashboardBuilder-

      add

      Definition:

      add(callback: (insight: DashboardInsightBuilder<TQueryDSL, TSeedDSL>) => void): TDashboardBuilder

      Returns: TDashboardBuilder

      Parameters:

      ParameterTypeDescription
      callback(insight: DashboardInsightBuilder<TQueryDSL, TSeedDSL>) => void-

      update

      Definition:

      update(widgetId: string, callback: (insight: DashboardInsightBuilder<TQueryDSL, TSeedDSL>) => void): TDashboardBuilder

      Returns: TDashboardBuilder

      Parameters:

      ParameterTypeDescription
      widgetIdstring-
      callback(insight: DashboardInsightBuilder<TQueryDSL, TSeedDSL>) => void-

      remove

      Definition:

      remove(widgetId: string): TDashboardBuilder

      Returns: TDashboardBuilder

      Parameters:

      ParameterTypeDescription
      widgetIdstring-

      get

      Definition:

      get(widgetId: string): DashboardInsightBuilder<TQueryDSL, TSeedDSL> | undefined

      Returns: DashboardInsightBuilder<TQueryDSL, TSeedDSL> \| undefined

      Parameters:

      ParameterTypeDescription
      widgetIdstring-

      find

      Definition:

      find(id: string): DashboardInsightBuilder<TQueryDSL, TSeedDSL> | undefined

      Returns: DashboardInsightBuilder<TQueryDSL, TSeedDSL> \| undefined

      Parameters:

      ParameterTypeDescription
      idstring-

      findAll

      Definition:

      findAll(): DashboardInsightBuilder<TQueryDSL, TSeedDSL>[]

      Returns: DashboardInsightBuilder<TQueryDSL, TSeedDSL>[]

      toJSON

      Definition:

      toJSON(): VBIDashboardWidget[]

      Returns: VBIDashboardWidget[]