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 example

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
}

Info:

Copyright: 2012 Emmanuel Lepage Vallee
Author: Emmanuel Lepage Valle

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	The border color.
border_width	number	The pie elements border width.
colors	table	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
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

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

Constructors

wibox.widget.piechart (data_list)

Create a new piechart.

Parameters:

data_list table The data.

Object properties

data_list (table) · 1 signal

The pie chart data list.

Type constraints:

data_list table Sorted table where each entry has a label as its first value and a number as its second 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.

Type constraints:

data table Labels as keys and number as value.

Click to display more

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) · 1 signal · 1 theme variable

The border color.

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

Usage example

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) · 1 signal · 1 theme variable

The pie elements border width.

Usage example

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

Type constraints:

colors table 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)

If the pie chart has labels.

Usage example

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

: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.piechart_border_color (color)

The border color.

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

Type constraints:

colors table A table of colors, one for each elements

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:

Info:

Constructors

Object properties

Object methods

Signals

Theme variables

Constructors

Parameters:

Object properties

Type constraints:

Emit signals:

Type constraints:

Emit signals:

See also:

Emit signals:

Consumed theme variables:

Emit signals:

Consumed theme variables:

Type constraints:

See also:

Emit signals:

Consumed theme variables:

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

See also:

Type constraints:

See also:

Module: `wibox.widget.piechart`