Click or drag to resize

IDashboard Interface

The interface IDashboard defines dashboard model

Namespace:  Dynamicweb.Dashboards
Assembly:  Dynamicweb.Dashboards (in Dynamicweb.Dashboards.dll) Version: 2.9.4
Syntax
Copy
[InheritedExportAttribute(typeof(IDashboard))]
public interface IDashboard

The IDashboard type exposes the following members.

Properties
  NameDescription
Public propertyTitle
Gets or sets the Dashboard title
Public propertyWidgets
Gets or sets collection of widgets to show
Top
Methods
  NameDescription
Public methodGetAllAvailableWidgets
Gets widget types for the Dashboard
Public methodLoad
Loads the widgets to the Dashboard.
Public methodSave
Save the Dashboard to storage
Top
Extension Methods
  NameDescription
Public Extension MethodId
Return Id of the dashboard
(Defined by DashboardExtensions.)
Public Extension MethodIsDashboardReadOnly
Return true if dashboard is read only
(Defined by DashboardExtensions.)
Public Extension MethodIsVisibleOnInsightsPublisher
Return true if dashboard visible on Insights Publisher App
(Defined by DashboardExtensions.)
Top
Remarks
Used as main component for implementing a custom dashboard page embed to the application. The customer should mark interface implementation with Export" attribute to specify dashboard unique Id. Customer can use Export attribute without parameters in this case class fully qualified name be used as dashboard id. After interface implementation user dashboard page will be available for backed user by URL:
Copy
[site]/Admin/Dashboard/[DashboardId]/View/[path*]
.

You may inherit your dashboard from simple to use default save/load methods.

See Also