du.widgets.lineargauge

Module implementing a semi-circular gauge widget.

Requires: d3@v4 du.Widget

LinearGauge

du.widgets.lineargauge.LinearGauge(name[, parent])

The linear gauge 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`

min

du.widgets.lineargauge.LinearGauge.min(value)

Sets the lower boundary of the gauge.

arg	type	description
value	`number`	Lower boundary.

return	description
`du.widgets.lineargauge.LinearGauge`	Reference to the current LinearGauge.

max

du.widgets.lineargauge.LinearGauge.max(value)

Sets the upper boundary of the gauge.

arg	type	description
value	`number`	Upper boundary.

return	description
`du.widgets.lineargauge.LinearGauge`	Reference to the current LinearGauge.

thickness

du.widgets.lineargauge.LinearGauge.thickness(size)

Sets the thickness of the segments in pixels. Default is 20.

arg	type	description
size	`number`	Size of the thickness relative to the gauge radius.

return	description
`du.widgets.lineargauge.LinearGauge`	Reference to the current LinearGauge.

tick

du.widgets.lineargauge.LinearGauge.tick(on)

Adds a tick on the left side of the gauge bar. Default is false.

arg	type	description
on	`boolean`	Whether to add a tick to the side of the bar.

return	description
`du.widgets.lineargauge.LinearGauge`	Reference to the current LinearGauge.

trackColor

du.widgets.lineargauge.LinearGauge.trackColor(color)

Sets the track color for the gauge bar. Default is rgba(0, 0, 0, 0.1).

arg	type	description
color	`string`	Color of the track.

return	description
`du.widgets.lineargauge.LinearGauge`	Reference to the current LinearGauge.

colors

du.widgets.lineargauge.LinearGauge.colors(colors)

Sets the min and max colors of the gauge. Must be an array with two colors. The color of intermediate segments is interpolated with HSL interpolation. Default values are the first red and green colors from Color Brewer (['#e41a1c', '#4daf4a']).
Overrides: du.widgets.Widget.colors

arg	type	description
colors	`string[]`	Start and end colors of the gauge.

return	description
`du.widgets.lineargauge.LinearGauge`	Reference to the current LinearGauge.

position

du.widgets.lineargauge.LinearGauge.position(value)

Sets the position of the gauge bar to the specified value.

arg	type	description
value	`number`	The value to set the gauge's position to.

return	description
`du.widgets.lineargauge.LinearGauge`	Reference to the current LinearGauge.