Module: `wibox.widget.piechart`

Display percentage in a circle.

Note that this widget makes no attempts to prevent overlapping labels or labels drawn outside of the widget boundaries.

Usage:

wibox.widget {
    data_list = {
        { 'L1', 100 },
        { 'L2', 200 },
        { 'L3', 300 },
    },
    border_width = 1,
    colors = {
        beautiful.bg_normal,
        beautiful.bg_highlight,
        beautiful.border_color,
    },
    widget = wibox.widget.piechart
}

Class Hierarchy

gears.object
- wibox.widget.base
- - wibox.widget.piechart

Info:

Copyright: 2012 Emmanuel Lepage Vallee
Originally authored by: Emmanuel Lepage Valle
(Full contributors list available on our github project)

Constructors

wibox.widget.piechart (data_list)

Create a new piechart.

Object properties

data_list	table	The pie chart data list.
data	table	The pie chart data.
border_color	color or nil	The border color.
border_width	number or nil	The pie elements border width.
colors	table or nil	The pie chart colors.
display_labels	boolean	If the pie chart has labels.
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

Theme variables

beautiful.piechart_border_color	color	The border color.
beautiful.piechart_border_width	number	The pie elements border width.
beautiful.piechart_colors	table	The pie chart colors.

Object methods

: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

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.piechart (data_list)

Create a new piechart.

Parameters:

Name		Type(s)	Description
data_list		table	The data.

Object properties

🔗 data_list table · 1 signal

The pie chart data list.

Constraints:

Default value	: `{}`
Table content:	: Sorted list where each entry has a label as its first value and a number as its second value.
`1` (string)	: The label.
`2` (number)	: The value.

Click to display more

Emit signals:

property::data_list When the data_list value changes.

self wibox.widget.piechart The object which changed (useful when connecting many object to the same callback).

🔗 data table · 1 signal

The pie chart data.

Constraints:

Default value	: `{}`
Table content:	: Key/value pair.
`key` (string)	: The label.
`value` (number)	: The value.

Emit signals:

property::data When the data value changes.

self wibox.widget.piechart The object which changed (useful when connecting many object to the same callback).

🔗 border_color color or nil · 1 signal · 1 theme variable

The border color.

If none is set, it will use current foreground (text) color.

Constraints:

Default value	: `beautiful.wibox_widget_piechart_border_color`
Type description:
string	: An hexadecimal color code, such as `"#ff0000"` for red.
string	: A color name, such as `"red"`.
table	: A gradient table.
cairo.pattern	: Any valid Cairo pattern.
cairo.pattern	: A texture build from an image by gears.color.create_png_pattern
nil	: Fallback to the current value of `beautiful.piechart_border_color`.

Emit signals:

property::border_color When the border_color value changes.

self wibox.widget.piechart 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.piechart_border_color	Fallback when border_color isn't set.

🔗 border_width number or nil · 1 signal · 1 theme variable

The pie elements border width.

Constraints:

Default value	: `1`
Type description:
nil	: Fallback to the current value of `beautiful.piechart_border_width`.
Unit	: pixel
Negative allowed	: false

Click to display more

Emit signals:

property::border_width When the border_width value changes.

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

Consumed theme variables:

Theme variable	Usage
beautiful.piechart_border_width	Fallback when border_width isn't set.

🔗 colors table or nil · 1 signal · 1 theme variable

The pie chart colors.

If no color is set, only the border will be drawn. If less colors than required are set, colors will be re-used in order.

Constraints:

Default value	: `beautiful.wibox_widget_piechart_colors`
Type description:
table	: List of colors (numerical keys).
nil	: Fallback to the current value of `beautiful.piechart_colors`.
Valid values	: A table of colors, one for each elements.

Emit signals:

property::colors When the colors value changes.

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

Consumed theme variables:

Theme variable	Usage
beautiful.piechart_colors	Fallback when colors isn't set.

🔗 display_labels boolean · 1 signal

If the pie chart has labels.

Constraints:

Default value	: `true`
Valid values	: `true` or `false`.

Click to display more

Emit signals:

property::display_labels When the display_labels value changes.

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

🔗 children table · Inherited from wibox.widget.base

Get or set the children elements.

Constraints:

Default value	: `{}`
Table content	: A list of wibox.widget.

Constraints:

Default value	: `{}`
Table content	: A list of wibox.widget.

Constraints:

Default value	: `nil`
Type description:
nil	: Let the layout decide the height. Usually using the widget native height.
number	: Enforce a number of pixels.
Unit	: pixel
Negative allowed	: false

Constraints:

Default value	: `nil`
Type description:
nil	: Let the layout decide the width. Usually using the widget native width.
number	: Enforce a number of pixels.
Unit	: pixel
Negative allowed	: false

Constraints:

Default value	: `1.0`
Unit	: A gradient between transparent (`0.0`) and opaque (`1.0`).
Minimum value	: 0.0
Maximum value	: 1.0

Constraints:

Default value	: `true`
Valid values	: `true` or `false`.

Constraints:

Default value	: `{}`
Table content	: A list of awful.button.

Theme variables

🔗 beautiful.piechart_border_color color

The border color.

If none is set, it will use current foreground (text) color.

Used by:

border_color The border color.

🔗 beautiful.piechart_border_width number

The pie elements border width.
Click to display more

Used by:

border_width The pie elements border width.

🔗 beautiful.piechart_colors table

The pie chart colors.

If no color is set, only the border will be drawn. If less colors than required are set, colors will be re-used in order.

Type constraints:

Name		Type(s)	Description
colors		table	A table of colors, one for each elements

Used by:

colors The pie chart colors.

Object methods

🔗 :add_button (button) · Inherited from wibox.widget.base

Add a new awful.button to this widget.

Parameters:

Name		Type(s)	Description
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:

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.
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).
If the widget is removed from the widget tree, the signal is still forwarded for some time, similar to the first case.

Parameters:

Name		Type(s)	Description
signal_name		string
...			Other arguments

🔗 :index (widget, recursive, ...) -> (number, widget, table) · Inherited from wibox.widget.base

Get the index of a widget.

Parameters:

Name		Type(s)	Description
widget		widget	The widget to look for.
recursive	Optional	boolean	Recursively check accross the sub-widgets hierarchy.
...	Optional	widget	Additional widgets to add at the end of the sub-widgets hierarchy "path".

Returns:

number The widget index.
widget The parent widget.
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		Type(s)	Description
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		Type(s)	Description
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		Type(s)	Description
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		Type(s)	Description
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()

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.

Arguments:

Name	Type(s)	Description
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	table	The entry from the result of wibox: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:

Name	Type(s)	Description
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	table	The entry from the result of wibox: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:

Name	Type(s)	Description
self	table	The current object instance itself.
find_widgets_result	table	The entry from the result of wibox: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:

Name	Type(s)	Description
self	table	The current object instance itself.
find_widgets_result	table	The entry from the result of wibox: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.

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.piechart

Usage:

Class Hierarchy

Info:

Constructors

Object properties

Theme variables

Object methods

Signals

Constructors

Parameters:

Object properties

Constraints:

Emit signals:

Constraints:

See also:

Emit signals:

Constraints:

See also:

Emit signals:

Consumed theme variables:

Constraints:

Emit signals:

Consumed theme variables:

Constraints:

See also:

Emit signals:

Consumed theme variables:

Constraints:

Emit signals:

Constraints:

See also:

Constraints:

See also:

Constraints:

See also:

Constraints:

See also:

Constraints:

See also:

Constraints:

See also:

Constraints:

See also:

Theme variables

See also:

Used by:

Used by:

Type constraints:

See also:

Used by:

Object methods

Parameters:

Parameters:

Parameters:

Returns:

Parameters:

Usage:

Parameters:

Parameters:

Parameters:

Signals

See also:

See also:

Arguments:

Module: `wibox.widget.piechart`