Interface IDashboardPanelStore
Interface for dashboard panel store, which manages the storage and retrieval of user dashboard panels.
Namespace: DataWeb.Dashboard
Assembly: DataWeb.Core.dll
Syntax
public interface IDashboardPanelStore
Properties
Name
Gets the name of the panel store.
Declaration
string Name { get; }
Property Value
Type |
---|
string |
Methods
GetPanelAsync(PanelFilter)
Retrieves a single PanelData object matching the provided filter asynchronously.
Declaration
Task<PanelData> GetPanelAsync(PanelFilter filter)
Parameters
Type | Name | Description |
---|---|---|
PanelFilter | filter | The PanelFilter object to filter the panels. |
Returns
Type | Description |
---|---|
Task<PanelData> | Returns a System.Threading.Tasks.Task<TResult> representing the filtered panel, or null if no panel matches the filter. |
GetPanelsAsync(PanelFilter)
Retrieves a collection of PanelData objects matching the provided filter asynchronously.
Declaration
Task<IEnumerable<PanelData>> GetPanelsAsync(PanelFilter filter)
Parameters
Type | Name | Description |
---|---|---|
PanelFilter | filter | The PanelFilter object to filter the panels. |
Returns
Type | Description |
---|---|
Task<IEnumerable<PanelData>> | Returns a System.Threading.Tasks.Task<TResult> representing the collection of filtered panels. |
RemoveAsync(string)
Removes a panel with the specified panel Id asynchronously.
Declaration
Task RemoveAsync(string panelId)
Parameters
Type | Name | Description |
---|---|---|
string | panelId | The panel Id of the panel to be removed. |
Returns
Type | Description |
---|---|
Task | A System.Threading.Tasks.Task representing the asynchronous remove operation. |
SetAsync(PanelData)
Saves or updates a PanelData object asynchronously.
Declaration
Task SetAsync(PanelData panel)
Parameters
Type | Name | Description |
---|---|---|
PanelData | panel | The PanelData object to be saved or updated. |
Returns
Type | Description |
---|---|
Task | A System.Threading.Tasks.Task representing the asynchronous save or update operation. |