Class WidgetGoalTrends

Represents the WidgetGoalTrends class which extends the DashboardWidget class.

Inheritance

object

DashboardWidget

WidgetTrends

WidgetGoalTrends

Inherited Members

WidgetTrends.GetDefaultSettingsAsync(DashboardPanel, IUser, CancellationToken)

WidgetTrends.GetOptionsAsync(DashboardPanel, Dictionary<string, object>, IUser, CancellationToken)

WidgetTrends.ValidateSettingsAsync(DashboardPanel, Dictionary<string, object>, Dictionary<string, object>, IUser, CancellationToken)

WidgetTrends.UpdateSettingsAsync(DashboardPanel, Dictionary<string, object>, Dictionary<string, object>, IUser, CancellationToken)

WidgetTrends.GetPeriodModes()

WidgetTrends.GetPeriodData(string, DateTime?, DateTime?)

DashboardWidget.serviceProvider

DashboardWidget.IdMaster

DashboardWidget.Name

DashboardWidget.Title

DashboardWidget.Type

DashboardWidget.Settings

DashboardWidget.WidgetComponent

DashboardWidget.WidgetClass

DashboardWidget.VisibleRoles

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: DataWeb.Dashboard.Widgets

Assembly: DataWeb.Core.dll

Syntax

public class WidgetGoalTrends : WidgetTrends

Constructors

WidgetGoalTrends(IServiceProvider)

Represents the WidgetGoalTrends class which extends the DashboardWidget class.

Declaration

public WidgetGoalTrends(IServiceProvider serviceProvider)

Parameters

Type	Name	Description
IServiceProvider	serviceProvider

Methods

GetDataAsync(DashboardPanel, Dictionary<string, object>, IUser, CancellationToken)

Gets the data for the widget.

Declaration

public override Task<DashboardWidgetContentData> GetDataAsync(DashboardPanel panel, Dictionary<string, object> widgetSettings, IUser user, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
DashboardPanel	panel	The DashboardPanel that the widget belongs to.
Dictionary<string, object>	widgetSettings	The widget settings.
IUser	user	The IUser who is viewing the widget.
CancellationToken	cancellationToken

Returns

Type	Description
Task<DashboardWidgetContentData>	The widget data.

Overrides

WidgetTrends.GetDataAsync(DashboardPanel, Dictionary<string, object>, IUser, CancellationToken)

GetGoalData(PeriodData, string, string, string, string, string, CancellationToken)

Asynchronously retrieves goal data for a given period.

Declaration

public virtual Task<WidgetGoalTrends.GoalData> GetGoalData(PeriodData periodData, string chartType = "Bar", string goalName = null, string goalCategory = null, string goalReferenceId = null, string goalColor = "Blue", CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
PeriodData	periodData	The widget period data to base the goal data on.
string	chartType	The type of chart to display (e.g., "Bar").
string	goalName	The name of the goal to retrieve data for.
string	goalCategory	The category of the goal to retrieve data for.
string	goalReferenceId	The reference Id of the goal to retrieve data for.
string	goalColor	The color of the goal data in the chart.
CancellationToken	cancellationToken

Returns

Type	Description
Task<WidgetGoalTrends.GoalData>	The goal data.

Extension Methods

DashboardMapperExtension.ToDashboardWidgetInfo(DashboardWidget)