VisActor VBI
  • English

      • VBIDashboardBuilder

      Properties

      PropertyTypeDescription
      docY.Doc-
      dslY.Map<any>-
      undoManagerUndoManager-
      themeDashboardThemeBuilder-
      chartDashboardChartCollectionBuilder<TQueryDSL, TSeedDSL, VBIDashboardBuilder<TQueryDSL, TSeedDSL>>-
      insightDashboardInsightCollectionBuilder<TQueryDSL, TSeedDSL, VBIDashboardBuilder<TQueryDSL, TSeedDSL>>-

      Methods

      constructor

      Definition:

      constructor(doc: Y.Doc, dependencies?: VBIDashboardBuilderDependencies<TQueryDSL, TSeedDSL>)

      Parameters:

      ParameterTypeDescription
      docY.Doc-
      dependencies? = {}VBIDashboardBuilderDependencies<TQueryDSL, TSeedDSL>-

      applyUpdate

      Definition:

      applyUpdate(update: Uint8Array, transactionOrigin?: any): any

      Returns: any

      Parameters:

      ParameterTypeDescription
      updateUint8Array-
      transactionOrigin?any-

      encodeStateAsUpdate

      Definition:

      encodeStateAsUpdate(targetStateVector?: Uint8Array): any

      Returns: any

      Parameters:

      ParameterTypeDescription
      targetStateVector?Uint8Array-

      getUUID

      Definition:

      getUUID(): string

      Returns: string

      getChartBuilder

      Definition:

      getChartBuilder(chartId: string): VBIChartBuilder<TQueryDSL, TSeedDSL> | undefined

      Returns: VBIChartBuilder<TQueryDSL, TSeedDSL> \| undefined

      Parameters:

      ParameterTypeDescription
      chartIdstring-

      getInsightBuilder

      Definition:

      getInsightBuilder(insightId: string): VBIInsightBuilder | undefined

      Returns: VBIInsightBuilder \| undefined

      Parameters:

      ParameterTypeDescription
      insightIdstring-

      build

      Definition:

      build(): VBIDashboardDSL

      Returns: VBIDashboardDSL

      isEmpty

      Definition:

      isEmpty(): boolean

      Returns: boolean