BarChartWidget implements WidgetInterface, RequestAwareWidgetInterface, EventDataInterface, AdditionalCssInterface, JavaScriptInterface
Concrete Bar Chart widget implementation
Shows a widget with a bar chart. The data for this chart will be provided by the data provider you will set. You can add a button to the widget by defining a button provider.
There are no options available for this widget
Tags
Table of Contents
Interfaces
- WidgetInterface
- The WidgetInterface is the base interface for all kind of widgets.
- RequestAwareWidgetInterface
- Interface for widgets that need the ServerRequestInterface Request.
- EventDataInterface
- In case a widget should provide additional data as JSON payload, the widget must implement this interface.
- AdditionalCssInterface
- In case a widget should provide additional CSS files, the widget must implement this interface.
- JavaScriptInterface
- Provides potential JavaScript declarations to be loaded/initialized for a particular widget.
Methods
- __construct() : mixed
- getCssFiles() : array<string|int, mixed>
- This method returns an array with paths to required CSS files.
- getEventData() : array<string|int, mixed>
- This method returns data which should be sent to the widget as JSON encoded value.
- getJavaScriptModuleInstructions() : array<int, JavaScriptModuleInstruction>
- getOptions() : array<string|int, mixed>
- This method returns the options of the widget as set in the registration.
- renderWidgetContent() : string
- This method returns the content of a widget. The returned markup will be delivered by an AJAX call and will not be escaped.
- setRequest() : void
Methods
__construct()
public
__construct(WidgetConfigurationInterface $configuration, ChartDataProviderInterface $dataProvider, BackendViewFactory $backendViewFactory[, ButtonProviderInterface|null $buttonProvider = null ][, array<string|int, mixed> $options = [] ]) : mixed
Parameters
- $configuration : WidgetConfigurationInterface
- $dataProvider : ChartDataProviderInterface
- $backendViewFactory : BackendViewFactory
- $buttonProvider : ButtonProviderInterface|null = null
- $options : array<string|int, mixed> = []
getCssFiles()
This method returns an array with paths to required CSS files.
public
getCssFiles() : array<string|int, mixed>
e.g. ['EXT:myext/Resources/Public/Css/my_widget.css']
Return values
array<string|int, mixed>getEventData()
This method returns data which should be sent to the widget as JSON encoded value.
public
getEventData() : array<string|int, mixed>
Return values
array<string|int, mixed>getJavaScriptModuleInstructions()
public
getJavaScriptModuleInstructions() : array<int, JavaScriptModuleInstruction>
Return values
array<int, JavaScriptModuleInstruction>getOptions()
This method returns the options of the widget as set in the registration.
public
getOptions() : array<string|int, mixed>
Return values
array<string|int, mixed>renderWidgetContent()
This method returns the content of a widget. The returned markup will be delivered by an AJAX call and will not be escaped.
public
renderWidgetContent() : string
Be aware of XSS and ensure that the content is well encoded.
Return values
stringsetRequest()
public
setRequest(ServerRequestInterface $request) : void
Parameters
- $request : ServerRequestInterface