Interface IDashboardWidgetStore
Represents a store for dashboard widgets.
Namespace: DataWeb.Dashboard
Assembly: DataWeb.Core.dll
Syntax
public interface IDashboardWidgetStoreProperties
Name
Gets the name of the store.
Declaration
string Name { get; }Property Value
| Type | Description |
|---|---|
| string |
Methods
GetWidgetAsync(WidgetFilter, CancellationToken)
Gets the widget data that matches the specified filter.
Declaration
Task<WidgetData> GetWidgetAsync(WidgetFilter filter, CancellationToken cancellationToken = default)Parameters
| Type | Name | Description |
|---|---|---|
| WidgetFilter | filter | The WidgetFilter to apply to the widget. |
| CancellationToken | cancellationToken |
Returns
| Type | Description |
|---|---|
| Task<WidgetData> | The widget data. |
GetWidgetCachedAsync(string, CancellationToken)
Gets the cached widget data with the specified name.
Declaration
Task<WidgetData> GetWidgetCachedAsync(string name, CancellationToken cancellationToken = default)Parameters
| Type | Name | Description |
|---|---|---|
| string | name | The name of the widget. |
| CancellationToken | cancellationToken |
Returns
| Type | Description |
|---|---|
| Task<WidgetData> | The widget data. |
GetWidgetsAsync(WidgetFilter, CancellationToken)
Gets a collection of widget data that matches the specified filter.
Declaration
Task<IEnumerable<WidgetData>> GetWidgetsAsync(WidgetFilter filter, CancellationToken cancellationToken = default)Parameters
| Type | Name | Description |
|---|---|---|
| WidgetFilter | filter | The WidgetFilter to apply to the widgets. |
| CancellationToken | cancellationToken |
Returns
| Type | Description |
|---|---|
| Task<IEnumerable<WidgetData>> | A collection of widget data. |