Module: `wibox.widget.graph`

A graph widget.

The graph goes from left to right. To change this to right to left, use a wibox.container.mirror widget. This can also be used to have data shown from top to bottom.

To add text on top of the graph, use a wibox.layout.stack and a wibox.container.align widgets.

To display the graph vertically, use a wibox.container.rotate widget.

Usage example

Usage:

wibox.widget {
    max_value = 29,
    widget = wibox.widget.graph
}

Info:

Copyright: 2009 Julien Danjou
Author: Julien Danjou <[email protected]>

Constructors

wibox.widget.graph {[args]}

Create a graph widget.

Object properties

border_color	gears.color	Set the graph border color.
color	color	Set the graph foreground color.
background_color	gears.color	Set the graph background color.
max_value	number	Set the maximum value the graph should handle.
min_value	number	The minimum value.
scale	boolean	Set the graph to automatically scale its values.
step_width	number	Set the width or the individual steps.
step_spacing	number	Set the spacing between the steps.
step_shape	gears.shape or function	The step shape.
stack	boolean	Set the graph to draw stacks.
stack_colors	table	Set the graph stacking colors.
height	number	Set the graph height.
width	number	Set the graph width.
children	table	Get or set the children elements.	Inherited from wibox.widget
all_children	table	Get all direct and indirect children widgets.	Inherited from wibox.widget
forced_height	number or nil	Force a widget height.	Inherited from wibox.widget
forced_width	number or nil	Force a widget width.	Inherited from wibox.widget
opacity	number	The widget opacity (transparency).	Inherited from wibox.widget
visible	boolean	The widget visibility.	Inherited from wibox.widget
buttons	table	The widget buttons.	Inherited from wibox.widget

Object methods

:add_value (value[, group])	Add a value to the graph
:clear ()	Clear the graph.
:setup {[args]}	Set a declarative widget hierarchy description.	Inherited from wibox.widget
:add_button (button)	Add a new awful.button to this widget.	Inherited from wibox.widget
:emit_signal_recursive (signal_name, ...)	Emit a signal and ensure all parent widgets in the hierarchies also forward the signal.	Inherited from wibox.widget
:emit_signal (name, ...)	Emit a signal.	Inherited from gears.object
:connect_signal (name, func)	Connect to a signal.	Inherited from gears.object
:weak_connect_signal (name, func)	Connect to a signal weakly.	Inherited from gears.object

Signals

widget::layout_changed	When the layout (size) change.	Inherited from wibox.widget
widget::redraw_needed	When the widget content changed.	Inherited from wibox.widget
button::press	When a mouse button is pressed over the widget.	Inherited from wibox.widget
button::release	When a mouse button is released over the widget.	Inherited from wibox.widget
mouse::enter	When the mouse enter a widget.	Inherited from wibox.widget
mouse::leave	When the mouse leave a widget.	Inherited from wibox.widget

Theme variables

beautiful.graph_bg	color	The graph background color.
beautiful.graph_fg	color	The graph foreground color.
beautiful.graph_border_color	color	The graph border color.

Constructors

wibox.widget.graph {[args]}

Create a graph widget.

Parameters:

args table Standard widget() arguments. You should add width and height key to set graph geometry.

Returns:

wibox.widget.graph

Object properties

border_color gears.color · 1 signal · 1 theme variable

Set the graph border color.

If the value is nil, no border will be drawn.

Type constraints:

border_color gears.color The border color to set.

Emit signals:

property::border_color When the border_color value changes.

self wibox.widget.graph The object which changed (useful when connecting many object to the same callback).
new_value border_color The new value affected to the property.

Consumed theme variables:

Theme variable	Usage
beautiful.graph_border_color	Fallback when border_color isn't set.

color color · 1 signal · 1 theme variable

Set the graph foreground color.

Type constraints:

color color The graph color.

Emit signals:

property::color When the color value changes.

self wibox.widget.graph The object which changed (useful when connecting many object to the same callback).
new_value color The new value affected to the property.

Consumed theme variables:

Theme variable	Usage
beautiful.graph_fg

background_color gears.color · 1 signal · 1 theme variable

Set the graph background color.

Type constraints:

background_color gears.color The graph background color.

Emit signals:

property::background_color When the background_color value changes.

self wibox.widget.graph The object which changed (useful when connecting many object to the same callback).
new_value background_color The new value affected to the property.

Consumed theme variables:

Theme variable	Usage
beautiful.graph_bg

max_value number · 1 signal

Set the maximum value the graph should handle.

If “scale” is also set, the graph never scales up below this value, but it automatically scales down to make all data fit.

Click to display more

Emit signals:

property::max_value When the max_value value changes.

self wibox.widget.graph The object which changed (useful when connecting many object to the same callback).
new_value max_value The new value affected to the property.

min_value number · 1 signal

The minimum value.

Note that the min_value is not supported when used along with the stack property.

Click to display more

Emit signals:

property::min_value When the min_value value changes.

self wibox.widget.graph The object which changed (useful when connecting many object to the same callback).
new_value min_value The new value affected to the property.

scale boolean · 1 signal

Set the graph to automatically scale its values. Default is false.
Click to display more

Emit signals:

property::scale When the scale value changes.

self wibox.widget.graph The object which changed (useful when connecting many object to the same callback).
new_value scale The new value affected to the property.

step_width number · 1 signal

Set the width or the individual steps.

Note that it isn’t supported when used along with stacked graphs.

Usage example

Usage:

wibox.widget {
    max_value = 29,
    step_width = 3,
    step_spacing = 1,
    step_shape = function(cr, width, height)
        gears.shape.rounded_rect(cr, width, height, 2)
    end,
    widget = wibox.widget.graph
}

Click to display more

Emit signals:

property::step_width When the step_width value changes.

self wibox.widget.graph The object which changed (useful when connecting many object to the same callback).
new_value step_width The new value affected to the property.

step_spacing number · 1 signal

Set the spacing between the steps.

Note that it isn’t supported when used along with stacked graphs.

Click to display more

Emit signals:

property::step_spacing When the step_spacing value changes.

self wibox.widget.graph The object which changed (useful when connecting many object to the same callback).
new_value step_spacing The new value affected to the property.

step_shape gears.shape or function · 1 signal

The step shape.

Emit signals:

property::step_shape When the step_shape value changes.

self wibox.widget.graph The object which changed (useful when connecting many object to the same callback).
new_value step_shape The new value affected to the property.

stack boolean · 1 signal

Set the graph to draw stacks. Default is false.
Click to display more

Emit signals:

property::stack When the stack value changes.

self wibox.widget.graph The object which changed (useful when connecting many object to the same callback).
new_value stack The new value affected to the property.

stack_colors table

Set the graph stacking colors. Order matters.

Type constraints:

stack_colors table A table with stacking colors.

height number · 1 signal

Set the graph height.

Type constraints:

height number The height to set.

Click to display more

Emit signals:

property::height When the height value changes.

self wibox.widget.graph The object which changed (useful when connecting many object to the same callback).
new_value height The new value affected to the property.

width number · 1 signal

Set the graph width.

Type constraints:

number width The width to set.

Click to display more

Emit signals:

property::width When the width value changes.

self wibox.widget.graph The object which changed (useful when connecting many object to the same callback).
new_value number The new value affected to the property.

children table · Inherited from wibox.widget

Get or set the children elements.

Type constraints:

children table The children.

all_children table · Inherited from wibox.widget

Get all direct and indirect children widgets. This will scan all containers recursively to find widgets Warning: This method it prone to stack overflow id the widget, or any of its children, contain (directly or indirectly) itself.

Type constraints:

children table The children.

forced_height number or nil · Inherited from wibox.widget

Force a widget height.

Type constraints:

height number or nil The height (nil for automatic)

forced_width number or nil · Inherited from wibox.widget

Force a widget width.

Type constraints:

width number or nil The width (nil for automatic)

opacity number · Inherited from wibox.widget

The widget opacity (transparency).

Type constraints:

opacity number The opacity (between 0 and 1) (default 1)

visible boolean · Inherited from wibox.widget

The widget visibility.

buttons table · Inherited from wibox.widget

The widget buttons.

The table contains a list of awful.button objects.

Object methods

:add_value (value[, group])

Add a value to the graph

Parameters:

value number The value to be added to the graph
group number The stack color group index. (optional)

:clear ()

Clear the graph.

:setup {[args]} · Inherited from wibox.widget

Set a declarative widget hierarchy description. See The declarative layout system

Parameters:

args An array containing the widgets disposition

:add_button (button) · Inherited from wibox.widget

Add a new awful.button to this widget.

Parameters:

button awful.button The button to add.

:emit_signal_recursive (signal_name, ...) · Inherited from wibox.widget

Emit a signal and ensure all parent widgets in the hierarchies also forward the signal. This is useful to track signals when there is a dynamic set of containers and layouts wrapping the widget.

Parameters:

signal_name string
... Other arguments

:emit_signal (name, ...) · Inherited from gears.object

Emit a signal.

Parameters:

name string The name of the signal.
... Extra arguments for the callback functions. Each connected function receives the object as first argument and then any extra arguments that are given to emit_signal().

:connect_signal (name, func) · Inherited from gears.object

Connect to a signal.

Parameters:

name string The name of the signal.
func function The callback to call when the signal is emitted.

:weak_connect_signal (name, func) · Inherited from gears.object

Connect to a signal weakly.

This allows the callback function to be garbage collected and automatically disconnects the signal when that happens.

Warning: Only use this function if you really, really, really know what you are doing.

Parameters:

name string The name of the signal.
func function The callback to call when the signal is emitted.

Signals

widget::layout_changed · Inherited from wibox.widget

When the layout (size) change. This signal is emitted when the previous results of :layout() and :fit() are no longer valid. Unless this signal is emitted, :layout() and :fit() must return the same result when called with the same arguments.

Arguments:

self table The current object instance itself.
lx number The horizontal position relative to the (0,0) position in the widget.
ly number The vertical position relative to the (0,0) position in the widget.
button number The button number.
mods table The modifiers (mod4, mod1 (alt), Control, Shift)
find_widgets_result The entry from the result of wibox.drawable:find_widgets for the position that the mouse hit.
- drawable wibox.drawable The drawable containing the widget.
- widget widget The widget being displayed.
- hierarchy wibox.hierarchy The hierarchy managing the widget’s geometry.
- x number An approximation of the X position that the widget is visible at on the surface.
- y number An approximation of the Y position that the widget is visible at on the surface.
- width number An approximation of the width that the widget is visible at on the surface.
- height number An approximation of the height that the widget is visible at on the surface.
- widget_width number The exact width of the widget in its local coordinate system.
- widget_height number The exact height of the widget in its local coordinate system.

Arguments:

self table The current object instance itself.
lx number The horizontal position relative to the (0,0) position in the widget.
ly number The vertical position relative to the (0,0) position in the widget.
button number The button number.
mods table The modifiers (mod4, mod1 (alt), Control, Shift)
find_widgets_result The entry from the result of wibox.drawable:find_widgets for the position that the mouse hit.
- drawable wibox.drawable The drawable containing the widget.
- widget widget The widget being displayed.
- hierarchy wibox.hierarchy The hierarchy managing the widget’s geometry.
- x number An approximation of the X position that the widget is visible at on the surface.
- y number An approximation of the Y position that the widget is visible at on the surface.
- width number An approximation of the width that the widget is visible at on the surface.
- height number An approximation of the height that the widget is visible at on the surface.
- widget_width number The exact width of the widget in its local coordinate system.
- widget_height number The exact height of the widget in its local coordinate system.

Arguments:

self table The current object instance itself.
find_widgets_result The entry from the result of wibox.drawable:find_widgets for the position that the mouse hit.
- drawable wibox.drawable The drawable containing the widget.
- widget widget The widget being displayed.
- hierarchy wibox.hierarchy The hierarchy managing the widget’s geometry.
- x number An approximation of the X position that the widget is visible at on the surface.
- y number An approximation of the Y position that the widget is visible at on the surface.
- width number An approximation of the width that the widget is visible at on the surface.
- height number An approximation of the height that the widget is visible at on the surface.
- widget_width number The exact width of the widget in its local coordinate system.
- widget_height number The exact height of the widget in its local coordinate system.

Arguments:

self table The current object instance itself.
find_widgets_result The entry from the result of wibox.drawable:find_widgets for the position that the mouse hit.
- drawable wibox.drawable The drawable containing the widget.
- widget widget The widget being displayed.
- hierarchy wibox.hierarchy The hierarchy managing the widget’s geometry.
- x number An approximation of the X position that the widget is visible at on the surface.
- y number An approximation of the Y position that the widget is visible at on the surface.
- width number An approximation of the width that the widget is visible at on the surface.
- height number An approximation of the height that the widget is visible at on the surface.
- widget_width number The exact width of the widget in its local coordinate system.
- widget_height number The exact height of the widget in its local coordinate system.

Theme variables

beautiful.graph_bg color: The graph background color.
beautiful.graph_fg color: The graph foreground color.
beautiful.graph_border_color color: The graph border color.

awesome

Contents

Widgets

Core components

Input handling

Declarative rules

Widget containers

Widget layouts

Popups and bars

Utility libraries

Theme related libraries

Libraries

Sample files

Classes

Documentation

Module: wibox.widget.graph

Usage:

Info:

Constructors

Object properties

Object methods

Signals

Theme variables

Constructors

Parameters:

Returns:

Object properties

Type constraints:

See also:

Emit signals:

Consumed theme variables:

Type constraints:

See also:

Emit signals:

Consumed theme variables:

Type constraints:

See also:

Emit signals:

Consumed theme variables:

Emit signals:

Emit signals:

Emit signals:

Usage:

Emit signals:

Emit signals:

See also:

Emit signals:

Emit signals:

Type constraints:

Type constraints:

Emit signals:

Type constraints:

Emit signals:

Type constraints:

Type constraints:

Type constraints:

Type constraints:

Type constraints:

See also:

Object methods

Parameters:

Parameters:

Parameters:

Parameters:

Parameters:

Parameters:

Parameters:

Signals

See also:

See also:

Arguments:

See also:

Arguments:

See also:

Arguments:

See also:

Arguments:

See also:

Theme variables

Module: `wibox.widget.graph`