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