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	Description
string

Methods

GetPanelAsync(PanelFilter, CancellationToken)

Retrieves a single PanelData object matching the provided filter asynchronously.

Declaration

Task<PanelData> GetPanelAsync(PanelFilter filter, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
PanelFilter	filter	The PanelFilter object to filter the panels.
CancellationToken	cancellationToken

Returns

Type	Description
Task<PanelData>	Returns a Task<TResult> representing the filtered panel, or null if no panel matches the filter.

GetPanelsAsync(PanelFilter, CancellationToken)

Retrieves a collection of PanelData objects matching the provided filter asynchronously.

Declaration

Task<IEnumerable<PanelData>> GetPanelsAsync(PanelFilter filter, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
PanelFilter	filter	The PanelFilter object to filter the panels.
CancellationToken	cancellationToken

Returns

Type	Description
Task<IEnumerable<PanelData>>	Returns a Task<TResult> representing the collection of filtered panels.

RemoveAsync(string, CancellationToken)

Removes a panel with the specified panel Id asynchronously.

Declaration

Task RemoveAsync(string panelId, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	panelId	The panel Id of the panel to be removed.
CancellationToken	cancellationToken

Returns

Type	Description
Task	A Task representing the asynchronous remove operation.

SetAsync(PanelData, CancellationToken)

Saves or updates a PanelData object asynchronously.

Declaration

Task SetAsync(PanelData panel, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
PanelData	panel	The PanelData object to be saved or updated.
CancellationToken	cancellationToken

Returns

Type	Description
Task	A Task representing the asynchronous save or update operation.