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
}

Class Hierarchy

Info:

Constructors

wibox.widget.graph {[args]} Create a graph widget.

Object properties

border_width number Set the graph border_width.
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.base
all_children table Get all direct and indirect children widgets. Inherited from wibox.widget.base
forced_height number or nil Force a widget height. Inherited from wibox.widget.base
forced_width number or nil Force a widget width. Inherited from wibox.widget.base
opacity number The widget opacity (transparency). Inherited from wibox.widget.base
visible boolean The widget visibility. Inherited from wibox.widget.base
buttons table The widget buttons. Inherited from wibox.widget.base

Object methods

:add_value (value[, group]) Add a value to the graph
:clear () Clear the graph.
:add_button (button) Add a new awful.button to this widget. Inherited from wibox.widget.base
:emit_signal_recursive (signal_name, ...) Emit a signal and ensure all parent widgets in the hierarchies also forward the signal. Inherited from wibox.widget.base
:index (widget[, recursive[, ...]]) -> (number, widget, table) Get the index of a widget. Inherited from wibox.widget.base
: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
:disconnect_signal (name, func) Disonnect from a signal. Inherited from gears.object
:emit_signal (name, ...) Emit a signal. Inherited from gears.object

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.

Signals

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


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 A new graph widget.

Object properties

border_width number · 1 signal
Set the graph border_width.

Usage example

See also:

Usage:

    for _, width in ipairs { 1, 2, 4, 10 } do
    wibox.widget {
        max_value     = 30,
        border_color  = beautiful.border_color,
        widget        = wibox.widget.graph,
    }
 end

Click to display more

Emit signals:

  • property::border_width When the border_width value changes.
    • self wibox.widget.graph The object which changed (useful when connecting many object to the same callback).
    • new_value border_width The new value affected to the property.
border_color gears.color · 1 signal · 1 theme variable
Set the graph border color.

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

Usage example

Type constraints:

  • border_color gears.color The border color to set.

See also:

Usage:

    for _, color in ipairs {'#ff0000', '#00ff00', '#0000ff', '#ff00ff' } do
    wibox.widget {
        max_value     = 29,
        border_color  = color,
        widget        = wibox.widget.graph,
    }
 end

Click to display more

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_colorFallback when border_color isn't set.
color color · 1 signal · 1 theme variable
Set the graph foreground color.

Usage example

Type constraints:

  • color color The graph color.

See also:

Usage:

    for _, color in ipairs {'#ff0000', '#00ff00', '#0000ff', '#ff00ff' } do
    wibox.widget {
        max_value = 29,
        color     = color,
        widget    = wibox.widget.graph,
    }
 end

Click to display more

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.

Usage example

Type constraints:

  • background_color gears.color The graph background color.

See also:

Usage:

    for _, color in ipairs {'#ff0000', '#00ff00', '#0000ff', '#ff00ff' } do
    wibox.widget {
        max_value        = 29,
        background_color = color,
        widget        = wibox.widget.graph,
    }
 end

Click to display more

Emit signals:

Consumed theme variables:

Theme variable Usage
beautiful.graph_bg
max_value number · 1 signal
Set the maximum value the graph should handle.

Usage example

Usage:

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

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

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.

Usage example

Usage:

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

wibox.widget {
    min_value = 10,
    max_value = 30,
    widget    = wibox.widget.graph,
}

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.

Usage example

Usage:

    wibox.widget {
    scale  = false,
    widget = wibox.widget.graph,
}

wibox.widget {
    scale  = true,
    widget = wibox.widget.graph,
}

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:

    for _, width in ipairs {1, 2, 3, 10} do
    wibox.widget {
        step_width   = width,
        step_spacing = 1,
        step_shape   = function(cr, s_width, height)
            gears.shape.rounded_rect(cr, s_width, height, 2)
        end,
        widget       = wibox.widget.graph,
    }
 end

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.

Usage example

Usage:

    for _, spacing in ipairs {0, 2, 4, 10} do
    wibox.widget {
        max_value    = 29,
        step_spacing = spacing,
        widget       = wibox.widget.graph,
    }
 end

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.

Usage example

See also:

Usage:

    local shapes = {
    gears.shape.squircle,
    gears.shape.octogon,
    gears.shape.rounded_bar,
    gears.shape.arrow
}

for _, shape in ipairs(shapes) do
    wibox.widget {
        step_width   = 5,
        step_spacing = 1,
        step_shape   = shape,
        widget       = wibox.widget.graph,
    }
 end

Click to display more

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.

Usage example

Usage:

    local colors = {
    '#ff0000',
    '#00ff00',
    '#0000ff'
}

wibox.widget {
    max_value     = 29,
    stack         = true,
    stack_colors  = colors,
    widget        = wibox.widget.graph,
}

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.base
Get or set the children elements.

Type constraints:

  • children table The children.
all_children table · Inherited from wibox.widget.base
Get all direct and indirect children widgets. This will scan all containers recursively to find widgets Warning: This method it prone to stack overflow if there is a loop in the widgets hierarchy. A hierarchy loop is when a 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.base
Force a widget height.

Type constraints:

  • height number or nil The height (nil for automatic)
forced_width number or nil · Inherited from wibox.widget.base
Force a widget width.

Type constraints:

  • width number or nil The width (nil for automatic)
opacity number · Inherited from wibox.widget.base
The widget opacity (transparency).

Type constraints:

  • opacity number The opacity (between 0 and 1) (default 1)
visible boolean · Inherited from wibox.widget.base
The widget visibility.
buttons table · Inherited from wibox.widget.base
The widget buttons.

The table contains a list of awful.button objects.

See also:

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.
:add_button (button) · Inherited from wibox.widget.base
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.base

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.

Note that this function has some flaws:

  1. The signal is only forwarded once the widget tree has been built. This happens after all currently scheduled functions have been executed. Therefore, it will not start to work right away.
  2. In case the widget is present multiple times in a single widget tree, this function will also forward the signal multiple times (once per upward tree path).
  3. If the widget is removed from the widget tree, the signal is still forwarded for some time, similar to the first case.

Parameters:

  • signal_name string
  • ... Other arguments
:index (widget[, recursive[, ...]]) -> (number, widget, table) · Inherited from wibox.widget.base
Get the index of a widget.

Parameters:

  • widget widget The widget to look for.
  • recursive boolean Recursively check accross the sub-widgets hierarchy. (optional)
  • ... widget Additional widgets to add at the end of the sub-widgets hierarchy “path”. (optional)

Returns:

  1. number The widget index.
  2. widget The parent widget.
  3. table The hierarchy path between “self” and “widget”.
:connect_signal (name, func) · Inherited from gears.object

Connect to a signal.

Usage example output:

In slot [obj]   nil nil nil
In slot [obj]   foo bar 42

Parameters:

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

Usage:

    local o = gears.object{}
-- Function can be attached to signals
local function slot(obj, a, b, c)
    print('In slot', obj, a, b, c)
end
o:connect_signal('my_signal', slot)
-- Emitting can be done without arguments. In that case, the object will be
-- implicitly added as an argument.
o:emit_signal 'my_signal'
-- It is also possible to add as many random arguments are required.
o:emit_signal('my_signal', 'foo', 'bar', 42)
-- Finally, to allow the object to be garbage collected (the memory freed), it
-- is necessary to disconnect the signal or use weak_connect_signal
o:disconnect_signal('my_signal', slot)
-- This time, the slot wont be called as it is no longer connected.
o:emit_signal 'my_signal'
: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.
:disconnect_signal (name, func) · Inherited from gears.object
Disonnect from a signal.

Parameters:

  • name string The name of the signal.
  • func function The callback that should be disconnected.
: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()

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.

Signals

widget::layout_changed · Inherited from wibox.widget.base
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.

See also:

widget::redraw_needed · Inherited from wibox.widget.base
When the widget content changed. This signal is emitted when the content of the widget changes. The widget will be redrawn, it is not re-layouted. Put differently, it is assumed that :layout() and :fit() would still return the same results as before.

See also:

button::press · Inherited from wibox.widget.base
When a mouse button is pressed over the widget.

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.

See also:

button::release · Inherited from wibox.widget.base
When a mouse button is released over the widget.

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.

See also:

mouse::enter · Inherited from wibox.widget.base
When the mouse enter a widget.

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.

See also:

mouse::leave · Inherited from wibox.widget.base
When the mouse leave a widget.

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.

See also:

generated by LDoc 1.4.6 Last updated 2030-01-01 00:00:00