DynamicDataProvider class

动态数据提供程序允许组件使用动态数据。 它允许组件请求动态数据源并注册/注销这些数据源。

属性

isDisposed

如果释放了动态数据提供程序,则返回 true。

方法

dispose()

释放动态数据提供程序。

getAvailableSources()

返回包含所有可用动态数据源的列表。

registerAvailableSourcesChanged(callback)

注册对更新可用动态数据源列表时引发的事件的回调。

registerPropertyChanged(sourceId, propertyId, callback)

在动态数据源中更改属性时,注册更新的回调。

registerSourceChanged(sourceId, callback)

在动态数据源发生更改时注册更新的回调。 在源中更新任何属性时,都会发生这种情况。

tryGetSource(id)

按 ID 返回动态数据源。如果源不存在,则返回未定义。

unregisterAvailableSourcesChanged(callback)

取消注册对更新可用动态数据源列表时引发的事件的回调。

unregisterPropertyChanged(sourceId, propertyId, callback)

当动态数据源中的属性发生更改时,取消注册更新的回调。

unregisterSourceChanged(sourceId, callback)

在动态数据源发生更改时取消注册更新的回调。

属性详细信息

isDisposed

如果释放了动态数据提供程序,则返回 true。

get isDisposed(): boolean;

属性值

boolean

方法详细信息

dispose()

释放动态数据提供程序。

dispose(): void;

返回

void

getAvailableSources()

返回包含所有可用动态数据源的列表。

getAvailableSources(): ReadonlyArray<IDynamicDataSource>;

返回

ReadonlyArray<IDynamicDataSource>

包含所有可用源的只读数组。

registerAvailableSourcesChanged(callback)

注册对更新可用动态数据源列表时引发的事件的回调。

registerAvailableSourcesChanged(callback: () => void): void;

参数

callback

() => void

更新源时要执行的函数。

返回

void

registerPropertyChanged(sourceId, propertyId, callback)

在动态数据源中更改属性时,注册更新的回调。

registerPropertyChanged(sourceId: string, propertyId: string, callback: () => void): void;

参数

sourceId

string

动态数据源的 ID。

propertyId

string

源属性的 ID。

callback

() => void

源更新其数据时要执行的函数。

返回

void

registerSourceChanged(sourceId, callback)

在动态数据源发生更改时注册更新的回调。 在源中更新任何属性时,都会发生这种情况。

registerSourceChanged(sourceId: string, callback: () => void): void;

参数

sourceId

string

动态数据源的 ID。

callback

() => void

源更新其数据时要执行的函数。

返回

void

tryGetSource(id)

按 ID 返回动态数据源。如果源不存在,则返回未定义。

tryGetSource(id: string): IDynamicDataSource | undefined;

参数

id

string

动态数据源的 ID。

返回

IDynamicDataSource | undefined

unregisterAvailableSourcesChanged(callback)

取消注册对更新可用动态数据源列表时引发的事件的回调。

unregisterAvailableSourcesChanged(callback: () => void): void;

参数

callback

() => void

要从注册中删除的函数。 必须与注册时相同。

返回

void

unregisterPropertyChanged(sourceId, propertyId, callback)

当动态数据源中的属性发生更改时,取消注册更新的回调。

unregisterPropertyChanged(sourceId: string, propertyId: string, callback: () => void): void;

参数

sourceId

string

动态数据源的 ID。

propertyId

string

源属性的 ID。

callback

() => void

要从注册中删除的函数。 必须与注册时相同。

返回

void

unregisterSourceChanged(sourceId, callback)

在动态数据源发生更改时取消注册更新的回调。

unregisterSourceChanged(sourceId: string, callback: () => void): void;

参数

sourceId

string

动态数据源的 ID。

callback

() => void

要从注册中删除的函数。 必须与注册时相同。

返回

void