Moodle PHP Documentation 4.2
Moodle 4.2.8 (Build: 20240610) (2d41ac46f45)
core\chart_bar Class Reference

Chart bar class. More...

Inheritance diagram for core\chart_bar:
core\chart_base renderable

Public Member Functions

 add_series (chart_series $serie)
 Add a series to the chart.
 
 get_horizontal ()
 Get whether the bars should be displayed horizontally or not.
 
 get_labels ()
 Get the labels of the X axis.
 
 get_legend_options ()
 Get an array of options for the chart legend.
 
 get_series ()
 Get the series.
 
 get_stacked ()
 Get whether the bars should be stacked or not.
 
 get_title ()
 Get the title.
 
 get_type ()
 Get the chart type.
 
 get_xaxes ()
 Get the X axes.
 
 get_xaxis ($index=0, $createifnotexists=false)
 Get an X axis.
 
 get_yaxes ()
 Get the Y axes.
 
 get_yaxis ($index=0, $createifnotexists=false)
 Get a Y axis.
 
 jsonSerialize ()
 Add the horizontal to the parent and return the serialized data.
 
 set_horizontal ($horizontal)
 Set whether the bars should be displayed horizontally or not.
 
 set_labels (array $labels)
 Set the chart labels.
 
 set_legend_options (array $legendoptions)
 Set options for the chart legend.
 
 set_stacked ($stacked)
 Set whether the bars should be stacked or not.
 
 set_title ($title)
 Set the title.
 
 set_xaxis (chart_axis $axis, $index=0)
 Set an X axis.
 
 set_yaxis (chart_axis $axis, $index=0)
 Set an Y axis.
 

Protected Member Functions

 set_defaults ()
 Set the defaults.
 
 validate_axis ($xy, chart_axis $axis, $index=0)
 Validate an axis.
 

Protected Attributes

bool $horizontal = false
 Whether the bars should be displayed horizontally or not.
 
string[] $labels = []
 The labels for the X axis when categorised.
 
array $legendoptions = []
 Options for the chart legend.
 
chart_series[] $series = []
 The series constituting this chart.
 
bool $stacked = null
 Whether the chart should be stacked or not.
 
string $title = null
 The title of the chart.
 
chart_axis[] $xaxes = []
 The X axes.
 
chart_axis[] $yaxes = []
 The Y axes.
 

Detailed Description

Chart bar class.

License
http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later

Member Function Documentation

◆ add_series()

core\chart_base::add_series ( chart_series $serie)
inherited

Add a series to the chart.

Parameters
chart_series$serieThe serie.

◆ get_horizontal()

core\chart_bar::get_horizontal ( )

Get whether the bars should be displayed horizontally or not.

Return values
bool

◆ get_labels()

core\chart_base::get_labels ( )
inherited

Get the labels of the X axis.

Return values
string[]

◆ get_legend_options()

core\chart_base::get_legend_options ( )
inherited

Get an array of options for the chart legend.

Return values
array

◆ get_series()

core\chart_base::get_series ( )
inherited

Get the series.

Return values
chart_series[]

◆ get_stacked()

core\chart_bar::get_stacked ( )

Get whether the bars should be stacked or not.

Return values
bool

◆ get_title()

core\chart_base::get_title ( )
inherited

Get the title.

Return values
string

◆ get_type()

core\chart_base::get_type ( )
inherited

Get the chart type.

Return values
string

◆ get_xaxes()

core\chart_base::get_xaxes ( )
inherited

Get the X axes.

Return values
chart_axis[]

◆ get_xaxis()

core\chart_base::get_xaxis ( $index = 0,
$createifnotexists = false )
inherited

Get an X axis.

Parameters
int$indexThe index of the axis.
bool$createifnotexistsWhen true, create an instance of the axis if none exist at this index yet.
Return values
chart_axis

◆ get_yaxes()

core\chart_base::get_yaxes ( )
inherited

Get the Y axes.

Return values
chart_axis[]

◆ get_yaxis()

core\chart_base::get_yaxis ( $index = 0,
$createifnotexists = false )
inherited

Get a Y axis.

Parameters
int$indexThe index of the axis.
bool$createifnotexistsWhen true, create an instance of the axis if none exist at this index yet.
Return values
chart_axis

◆ jsonSerialize()

core\chart_bar::jsonSerialize ( )

Add the horizontal to the parent and return the serialized data.

Return values
array

Reimplemented from core\chart_base.

◆ set_defaults()

core\chart_bar::set_defaults ( )
protected

Set the defaults.

Reimplemented from core\chart_base.

◆ set_horizontal()

core\chart_bar::set_horizontal ( $horizontal)

Set whether the bars should be displayed horizontally or not.

Parameters
bool$horizontalTrue if the bars should be displayed horizontally, false otherwise.

◆ set_labels()

core\chart_base::set_labels ( array $labels)
inherited

Set the chart labels.

Parameters
string[]$labelsThe labels.

◆ set_legend_options()

core\chart_base::set_legend_options ( array $legendoptions)
inherited

Set options for the chart legend.

See https://www.chartjs.org/docs/2.7.0/configuration/legend.html for options.

Note: Setting onClick and onHover events is not directly supported through this method. These config options must be set directly within Javascript on the page.

Parameters
array$legendoptionsWhether or not to display the chart's legend.

◆ set_stacked()

core\chart_bar::set_stacked ( $stacked)

Set whether the bars should be stacked or not.

Parameters
bool$stackedTrue if the chart should be stacked or false otherwise.

◆ set_title()

core\chart_base::set_title ( $title)
inherited

Set the title.

Parameters
string$titleThe title.

◆ set_xaxis()

core\chart_base::set_xaxis ( chart_axis $axis,
$index = 0 )
inherited

Set an X axis.

Note that this will override any predefined axis without warning.

Parameters
chart_axis$axisThe axis.
int$indexThe index of the axis.

◆ set_yaxis()

core\chart_base::set_yaxis ( chart_axis $axis,
$index = 0 )
inherited

Set an Y axis.

Note that this will override any predefined axis without warning.

Parameters
chart_axis$axisThe axis.
int$indexThe index of the axis.

◆ validate_axis()

core\chart_base::validate_axis ( $xy,
chart_axis $axis,
$index = 0 )
protectedinherited

Validate an axis.

We validate this from PHP because not doing it here could result in errors being hard to trace down. For instance, if we were to add axis at keys without another axis preceding, we would effectively contain the axes in an associative array rather than a simple array, and that would have consequences on serialisation.

Parameters
string$xyAccepts x or y.
chart_axis$axisThe axis to validate.
index$indexThe index of the axis.

The documentation for this class was generated from the following file: