du.widgets.multibarchart.MultiBarChart(name[, parent])

The bar chart widget class.

arg	type	description
name	string	Identifier of the widget.
parent	object	Parent element to append widget to. If not specified, widget is appended to body. optional

du.widgets.multibarchart.MultiBarChart.barWidth(barWidth)

Sets the total bar width (all plots together) relative to the default. Default is an almost tight-packed bar chart.

arg	type	description
barWidth	boolean	The bar width relative to the default.

return	description
du.widgets.multibarchart.MultiBarChart	Reference to the current BarChart.

du.widgets.multibarchart.MultiBarChart.sortByX(sort)

Enables sorting of data by the X axis. Default is false.

arg	type	description
sort	boolean	Whether to sort data by the X values.

return	description
du.widgets.multibarchart.MultiBarChart	Reference to the current BarChart.

du.widgets.multibarchart.MultiBarChart.xDomain(domain)

Sets X domain for the multi bar chart. The order of the values specified in the domain are used to sort the data in the chart. Default is off.

arg	type	description
domain	number[] string[]	Array containing the domain values.

return	description
du.widgets.multibarchart.MultiBarChart	Reference to the current BarChart.

du.widgets.multibarchart.MultiBarChart.data(data)

Binds data to the bar chart. Expected data format: array containing an object for each plot. A plot object has a name property with the name of the plot and a values property which is the array of (x, y) coordinates. Each data point can have two optional values lo, hi representing the error of the y value. Default values of lo and hi for all data points are 0. Note that the data is sorted by the X values assuming they are strings.

arg	type	description
data	object	Data to plot.

return	description
du.widgets.multibarchart.MultiBarChart	Reference to the current BarChart.

du.widgets.multibarchart.MultiBarChart.highlight(key, duration)

Highlights the specified plot.

arg	type	description
key	string string[]	Single key or an array of keys of the bar(s) to highlight.
duration	number	Duration of the highlight animation.

return	description
du.widgets.multibarchart.MultiBarChart	Reference to the current BarChart.

du.widgets.multibarchart.MultiBarChart.highlightRange(range, duration)

Highlights the sepcified range.

arg	type	description
range	number[]	Array containing the lower and upper boundary of the range to highlight.
duration	number	Duration of the highlight animation. nullable

return	description
du.widgets.multibarchart.MultiBarChart	Reference to the current BarChart.

du.widgets.multibarchart.MultiBarChart.addMarker(id, value, label, pos, color, anchor)

Adds a marker to the chart. A marker is a horizontal line with a label. If a marker with the specified identifier already exists, the marker is ignored.

arg	type	description
id	string	Marker identifier.
value	number string	Y value (height) of the marker line.
label	string	Label of the marker.
pos	string	Position of the label relative to the marker line. Default is 0.
color	string	Color of the marker. Default is the font color.
anchor	string	Text anchor. Supported values: start, middle, right. Default is start.

return	description
object	D3 selection of the marker if it could be added, null otherwise.

du.widgets.multibarchart.MultiBarChart.removeMarker(id)

Removes a marker from the plot.

arg	type	description
id	string	Identifier of the marker to remove.

return	description
boolean	True if marker exists and could be removed, false otherwise.