OverviewWidget
in package
Class representing a widget.
Table of Contents
- $category : WidgetCategory
- Category.
- $data : WidgetData
- Data.
- $id : WidgetId
- ID.
- $names : WidgetNames
- Multilingual titles.
- $options : WidgetOptions
- Options.
- $visualization : WidgetVisualization
- Visualization type.
- category() : WidgetCategory
- Return category.
- create() : OverviewWidget
- Create instance.
- data() : WidgetData
- Return data.
- id() : WidgetId
- Return ID.
- names() : WidgetNames
- Return multilingual titles.
- options() : WidgetOptions
- Return options.
- visualization() : WidgetVisualization
- Return visualization type.
- __construct() : mixed
- Constructor.
Properties
$category
Category.
private
WidgetCategory
$category
$data
Data.
private
WidgetData
$data
$id
ID.
private
WidgetId
$id
$names
Multilingual titles.
private
WidgetNames
$names
$options
Options.
private
WidgetOptions
$options
$visualization
Visualization type.
private
WidgetVisualization
$visualization
Methods
category()
Return category.
public
category() : WidgetCategory
Return values
WidgetCategory —Category.
create()
Create instance.
public
static create(WidgetId $id, WidgetNames $names, WidgetCategory $category, WidgetVisualization $visualization, WidgetOptions $options, WidgetData $data) : OverviewWidget
Parameters
- $id : WidgetId
-
ID.
- $names : WidgetNames
-
Multilingual titles.
- $category : WidgetCategory
-
Category.
- $visualization : WidgetVisualization
-
Visualization type.
- $options : WidgetOptions
-
Options.
- $data : WidgetData
-
Data.
Return values
OverviewWidget —Instance.
data()
Return data.
public
data() : WidgetData
Return values
WidgetData —Data.
id()
Return ID.
public
id() : WidgetId
Return values
WidgetId —ID.
names()
Return multilingual titles.
public
names() : WidgetNames
Return values
WidgetNames —Multilingual titles.
options()
Return options.
public
options() : WidgetOptions
Return values
WidgetOptions —Options.
visualization()
Return visualization type.
public
visualization() : WidgetVisualization
Return values
WidgetVisualization —Visualization type.
__construct()
Constructor.
private
__construct(WidgetId $id, WidgetNames $names, WidgetCategory $category, WidgetVisualization $visualization, WidgetOptions $options, WidgetData $data) : mixed
Parameters
- $id : WidgetId
-
ID.
- $names : WidgetNames
-
Multilingual titles.
- $category : WidgetCategory
-
Category.
- $visualization : WidgetVisualization
-
Visualization type.
- $options : WidgetOptions
-
Options.
- $data : WidgetData
-
Data.