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.

Functions

wibox.widget.graph.add_button (button)

Add a new awful.button to this 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	shape	The step shape.
stack	boolean	Set the graph to draw stacks.
stack_colors	stack_colors	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.
all_children	table	Get all direct and indirect children widgets.
forced_height	number or nil	Force a widget height.
forced_width	number or nil	Force a widget width.
opacity	number	The widget opacity (transparency).
visible	boolean	The widget visibility.
buttons	table	The widget buttons.

Object methods

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

Signals

widget::layout_changed	When the layout (size) change.
widget::redraw_needed	When the widget content changed.
button::press	When a mouse button is pressed over the widget.
button::release	When a mouse button is released over the widget.
mouse::enter	When the mouse enter a widget.
mouse::leave	When the mouse leave a 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 Standard widget() arguments. You should add width and height key to set graph geometry.

Returns:

A new graph widget.

Functions

wibox.widget.graph.add_button (button)

Add a new awful.button to this widget.

Parameters:

button awful.button The button to add.

Object properties

border_color (gears.color)

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.

Type constraints:

color color The graph color.

Type constraints:

background_color gears.color The graph background color.

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
}

step_spacing (number)

Set the spacing between the steps.

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

step_shape (shape)

The step shape.

Type constraints:

stack_colors A table with stacking colors.

height (number)

Set the graph height.

Type constraints:

number The height to set.

width (number)

Set the graph width.

Type constraints:

number The width to set.

children (table)

Get or set the children elements.

Type constraints:

The table children

all_children (table)

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:

The table children

forced_height (number or nil)

Force a widget height.

Type constraints:

height number or nil The height (nil for automatic)

forced_width (number or nil)

Force a widget width.

Type constraints:

width number or nil The width (nil for automatic)

opacity (number)

The widget opacity (transparency).

Type constraints:

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

visible (boolean)

The widget visibility.

buttons (table)

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 The value to be added to the graph
group The stack color group index.

:clear ()

Clear the graph.

:setup {[args]}

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

Parameters:

args An array containing the widgets disposition

:emit_signal_recursive (signal_name, ...)

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, ...)

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)

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)

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

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:

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:

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:

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:

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

Widget containers

Widget layouts

Popups and bars

Utility libraries

Theme related libraries

Libraries

Sample files

Classes

Documentation

Module: wibox.widget.graph

Usage:

Info:

Constructors

Functions

Object properties

Object methods

Signals

Theme variables

Constructors

Parameters:

Returns:

Functions

Parameters:

Object properties

Type constraints:

See also:

Type constraints:

See also:

Type constraints:

See also:

Usage:

See also:

Type constraints:

Type constraints:

Type constraints:

Type constraints:

Type constraints:

Type constraints:

Type constraints:

Type constraints:

See also:

Object methods

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`