Interface DashboardInterface

Defines a dashboard.

Dashboards are simply a collection of widgets, in a layout.

layout is a LayoutInterface object that can be created with a LayoutBuilder.
widgets is a collection of any UiItemInterface objects.

Charcoal\Ui\Dashboard\DashboardInterface implements Charcoal\Ui\UiItemInterface, Charcoal\Ui\Layout\LayoutAwareInterface

Direct known implementers

Charcoal\Ui\Dashboard\AbstractDashboard

Indirect known implementers

Charcoal\Ui\Dashboard\GenericDashboard

Namespace: Charcoal\Ui\Dashboard
Located at Charcoal/Ui/Dashboard/DashboardInterface.php

Methods summary
`public Charcoal\Ui\Dashboard\DashboardInterface`	# `setWidgets( array $widgets )` Set the dashboard's widgets. Set the dashboard's widgets. Parameters `$widgets` A collection of widgets. Returns `Charcoal\Ui\Dashboard\DashboardInterface` Chainable
`public Charcoal\Ui\Dashboard\DashboardInterface`	# `addWidget( string $widgetIdent, Charcoal\Ui\UiItemInterface\|array $widget )` Add a widget to the dashboard. Add a widget to the dashboard. Parameters `$widgetIdent` The widget identifier. `$widget` The widget object or structure. Returns `Charcoal\Ui\Dashboard\DashboardInterface` Chainable
`public Charcoal\Ui\UiItemInterface[]\|Generator`	# `widgets( )` Retrieve the dashboard's widgets. Retrieve the dashboard's widgets. Returns `Charcoal\Ui\UiItemInterface[]`\|Generator
`public boolean`	# `hasWidgets( )` Determine if the dashboard has any widgets. Determine if the dashboard has any widgets. Returns boolean
`public integer`	# `numWidgets( )` Count the number of widgets attached to the dashboard. Count the number of widgets attached to the dashboard. Returns integer

Methods inherited from Charcoal\Ui\UiItemInterface
`active(), description(), notes(), setActive(), setDescription(), setNotes(), setShowDescription(), setShowFooter(), setShowHeader(), setShowNotes(), setShowSubtitle(), setShowTitle(), setSubtitle(), setTemplate(), setTitle(), setType(), showDescription(), showFooter(), showHeader(), showNotes(), showSubtitle(), showTitle(), subtitle(), template(), title(), type()`

Methods inherited from Charcoal\Ui\Layout\LayoutAwareInterface
`layout(), setLayout(), setLayoutBuilder()`