VisActor VBI
  • 简体中文

      • VBIChartBuilder

      属性

      属性类型说明
      docY.Doc-
      dslY.Map<any>-
      adaptersVBIChartBuilderAdapters<TQueryDSL, TSeedDSL>-
      chartTypeChartTypeBuilder-
      instanceChartInstanceBuilder图表运行时实例的绑定、获取与原生事件代理。
      measuresMeasuresBuilder-
      dimensionsDimensionsBuilder-
      havingFilterHavingFilterBuilder-
      whereFilterWhereFilterBuilder-
      themeThemeBuilder-
      localeLocaleBuilder-
      limitLimitBuilder-
      undoManagerUndoManager图表撤销历史，每个 Yjs 事务独立成一步；连续 add / update 不按时间合并，doc.transact 可显式合并多个修改。

      方法

      constructor

      定义:

      constructor(doc: Y.Doc, options?: VBIChartBuilderOptions<TQueryDSL, TSeedDSL>, dsl?: Y.Map<any>)

      参数:

      参数类型说明
      docY.Doc-
      options?VBIChartBuilderOptions<TQueryDSL, TSeedDSL>-
      dsl?Y.Map-

      observe

      订阅图表 DSL 顶层字段变化，与 dsl.observe 语义一致；不包含嵌套字段修改，也不触发首次渲染。

      定义:

      observe(callback: ObserveCallback): void

      返回: void

      参数:

      参数类型说明
      callbackObserveCallback-

      unobserve

      取消指定的图表 DSL 顶层订阅，传入 observe 时使用的同一回调。

      定义:

      unobserve(callback: ObserveCallback): void

      返回: void

      参数:

      参数类型说明
      callbackObserveCallback-

      observeDeep

      订阅整个图表 DSL 的深层变化，包括嵌套筛选、字段、本地编辑、撤销重做及协同更新；同一事务通知一次，不包含运行时实例变化，也不触发首次渲染。

      定义:

      observeDeep(callback: ObserveDeepCallback): void

      返回: void

      参数:

      参数类型说明
      callbackObserveDeepCallback-

      unobserveDeep

      取消指定的图表 DSL 深层订阅，传入 observeDeep 时使用的同一回调。

      定义:

      unobserveDeep(callback: ObserveDeepCallback): void

      返回: void

      参数:

      参数类型说明
      callbackObserveDeepCallback-

      applyUpdate

      定义:

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

      返回: void

      参数:

      参数类型说明
      updateUint8Array-
      transactionOrigin?any-

      encodeStateAsUpdate

      定义:

      encodeStateAsUpdate(targetStateVector?: Uint8Array): Uint8Array<ArrayBufferLike>

      返回: Uint8Array<ArrayBufferLike>

      参数:

      参数类型说明
      targetStateVector?Uint8Array-

      getUUID

      定义:

      getUUID(): string

      返回: string

      buildVSeed

      定义:

      buildVSeed(options?: BuildVSeedOptions): Promise<TSeedDSL>

      返回: Promise<TSeedDSL>

      参数:

      参数类型说明
      options? = {}BuildVSeedOptions-

      buildVQuery

      定义:

      buildVQuery(): TQueryDSL

      返回: TQueryDSL

      build

      定义:

      build(): VBIChartDSL

      返回: VBIChartDSL

      isEmpty

      定义:

      isEmpty(): boolean

      返回: boolean

      getSchema

      定义:

      getSchema(): Promise<{ name: string; type: string; }[]>

      返回: Promise<{ name: string; type: string; }[]>