Module: wibox.container.arcchart

A circular chart (arc chart) container.

It can contain a central widget (or not) and display multiple values.

Class Hierarchy

Info:

Constructors

wibox.container.arcchart (widget) Returns a new arcchart layout.

Object properties

widget widget or nil The widget to wrap in a radial proggressbar.
paddings table or number The padding between the outline and the progressbar.
border_color color or nil The border background color.
colors table The arcchart values foreground colors.
border_width number or nil The border width.
min_value number The minimum value.
max_value number The maximum value.
bg color or nil The radial background.
value number The value.
values table The values.
rounded_edge boolean or nil If the chart has rounded edges.
thickness number or nil The arc thickness.
start_angle number The (radiant) angle where the first value start.
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

:reset () Reset this layout.
: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.arcchart_border_color color The progressbar border background color.
beautiful.arcchart_color color The progressbar foreground color.
beautiful.arcchart_border_width number The progressbar border width.
beautiful.arcchart_paddings table or number The padding between the outline and the progressbar.
beautiful.arcchart_thickness number The arc thickness.
beautiful.arcchart_rounded_edge boolean If the chart has rounded edges.
beautiful.arcchart_bg gears.color The radial background.
beautiful.arcchart_start_angle number The (radiant) angle where the first value start.

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.container.arcchart (widget)
Returns a new arcchart layout.

Parameters:

Name Type(s) Description
widget Optional wibox.widget The widget to display.

Object properties

🔗 widget widget or nil
The widget to wrap in a radial proggressbar.

Constraints:

Default value : nil
🔗 paddings table or number · 1 signal · 1 theme variable
The padding between the outline and the progressbar.

Constraints:

Default value : 0
Type description:
number : A single padding value for each side.
table: : A different padding value for each side.
top (number)
bottom (number)
left (number)
right (number)
Unit : pixel
Negative allowed : false
Valid values : A number or a table

Click to display more

Emit signals:

Consumed theme variables:

Theme variable Usage
beautiful.arcchart_paddingsFallback value when the object paddings isn't specified.
🔗 border_color color or nil · 1 signal · 1 theme variable
The border background color.

Constraints:

Default value : beautiful.wibox_container_arcchart_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.arcchart_border_color.

Click to display more

Emit signals:

Consumed theme variables:

Theme variable Usage
beautiful.arcchart_border_colorFallback when border_color isn't set.
🔗 colors table · 1 signal · 1 theme variable
The arcchart values foreground colors.

Constraints:

Default value : beautiful.arcchart_color
Table content : An ordered list of colors for each value in arcchart.

Click to display more

Emit signals:

  • property::colors When the colors value changes.
    • self wibox.container.arcchart 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.arcchart_color
🔗 border_width number or nil · 1 signal · 1 theme variable
The border width.

Constraints:

Default value : 0
Type description:
nil : Fallback to the current value of beautiful.arcchart_border_width.
Unit : pixel
Negative allowed : false

Click to display more

Emit signals:

Consumed theme variables:

Theme variable Usage
beautiful.arcchart_border_widthFallback when border_width isn't set.
🔗 min_value number · 1 signal
The minimum value.

Constraints:

Default value : 0
Negative allowed : true

Click to display more

Emit signals:

  • property::min_value When the min_value value changes.
    • self wibox.container.arcchart The object which changed (useful when connecting many object to the same callback).
    • new_value min_value The new value affected to the property.
🔗 max_value number · 1 signal
The maximum value.

Constraints:

Default value : The sum of all values.
Negative allowed : true

Click to display more

Emit signals:

  • property::max_value When the max_value value changes.
    • self wibox.container.arcchart The object which changed (useful when connecting many object to the same callback).
    • new_value max_value The new value affected to the property.
🔗 bg color or nil · 1 signal · 1 theme variable
The radial background.

Constraints:

Default value : beautiful.wibox_container_arcchart_bg
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.arcchart_bg.

See also:

gears.color This module simplifies the creation of cairo pattern objects. module

Click to display more

Emit signals:

  • property::bg When the bg value changes.
    • self wibox.container.arcchart The object which changed (useful when connecting many object to the same callback).
    • new_value bg The new value affected to the property.

Consumed theme variables:

Theme variable Usage
beautiful.arcchart_bgFallback when bg isn't set.
🔗 value number · 1 signal
The value.

Constraints:

Default value : 0
Minimum value : min_value
Maximum value : max_value
Negative allowed : true

See also:

values The values. object properties

Click to display more

Emit signals:

  • property::value When the value value changes.
    • self wibox.container.arcchart The object which changed (useful when connecting many object to the same callback).
    • new_value value The new value affected to the property.
🔗 values table · 1 signal
The values. The arcchart is designed to display multiple values at once. Each will be shown in table order.

Constraints:

Default value : {}
Table content : A list of numbers.
Valid values : An ordered set of values.

See also:

value The value. object properties

Click to display more

Emit signals:

  • property::values When the values value changes.
    • self wibox.container.arcchart The object which changed (useful when connecting many object to the same callback).
    • new_value values The new value affected to the property.
🔗 rounded_edge boolean or nil · 1 signal · 1 theme variable
If the chart has rounded edges.

Constraints:

Default value : false
Type description:
nil : Fallback to the current value of beautiful.arcchart_rounded_edge.

Click to display more

Emit signals:

Consumed theme variables:

Theme variable Usage
beautiful.arcchart_rounded_edgeFallback when rounded_edge isn't set.
🔗 thickness number or nil · 1 signal · 1 theme variable
The arc thickness.

Constraints:

Default value : beautiful.wibox_container_arcchart_thickness
Type description:
nil : Fallback to the current value of beautiful.arcchart_thickness.
Unit : pixel
Negative allowed : false

Click to display more

Emit signals:

  • property::thickness When the thickness value changes.
    • self wibox.container.arcchart The object which changed (useful when connecting many object to the same callback).
    • new_value thickness The new value affected to the property.

Consumed theme variables:

Theme variable Usage
beautiful.arcchart_thicknessFallback when thickness isn't set.
🔗 start_angle number · 1 signal · 1 theme variable
The (radiant) angle where the first value start.

Constraints:

Default value : math.pi
Minimum value : 0
Maximum value : 2*math.pi

Click to display more

Emit signals:

  • property::start_angle When the start_angle value changes.
    • self wibox.container.arcchart The object which changed (useful when connecting many object to the same callback).
    • new_value start_angle The new value affected to the property.

Consumed theme variables:

Theme variable Usage
beautiful.arcchart_start_angle
🔗 children table · Inherited from wibox.widget.base
Get or set the children elements.

Constraints:

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

See also:

wibox.widget.base.all_children Get all direct and indirect children widgets. object properties
🔗 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.

Constraints:

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

See also:

wibox.widget.base.children Get or set the children elements. object properties
🔗 forced_height number or nil · Inherited from wibox.widget.base
Force a widget height.

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

See also:

wibox.widget.base.forced_width Force a widget width. object properties
🔗 forced_width number or nil · Inherited from wibox.widget.base
Force a widget width.

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

See also:

wibox.widget.base.forced_height Force a widget height. object properties
🔗 opacity number · Inherited from wibox.widget.base
The widget opacity (transparency).

Constraints:

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

See also:

wibox.widget.base.visible The widget visibility. object properties
🔗 visible boolean · Inherited from wibox.widget.base
The widget visibility.

Constraints:

Default value : true
Valid values : true or false.

See also:

wibox.widget.base.opacity The widget opacity (transparency). object properties
🔗 buttons table · Inherited from wibox.widget.base
The widget buttons.

The table contains a list of awful.button objects.

Constraints:

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

See also:

awful.button Create easily new buttons objects ignoring certain modifiers. module

Object methods

🔗 :reset ()
Reset this layout. The widget will be removed and the rotation reset.
🔗 :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:

  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:

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:

  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 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()

Theme variables

🔗 beautiful.arcchart_border_color color
The progressbar border background color.
Click to display more

Used by:
🔗 beautiful.arcchart_color color
The progressbar foreground color.
Click to display more

Used by:

  • colors The arcchart values foreground colors.
🔗 beautiful.arcchart_border_width number
The progressbar border width.
Click to display more

Used by:
🔗 beautiful.arcchart_paddings table or number
The padding between the outline and the progressbar.

Type constraints:

Name Type(s) Description Default value
paddings Optional table A number or a table 0
top Optional number 0
bottom Optional number 0
left Optional number 0
right Optional number 0

Click to display more

Used by:

  • paddings The padding between the outline and the progressbar.
🔗 beautiful.arcchart_thickness number
The arc thickness.
Click to display more

Used by:
🔗 beautiful.arcchart_rounded_edge boolean
If the chart has rounded edges.
Click to display more

Used by:
🔗 beautiful.arcchart_bg gears.color
The radial background.
Click to display more

Used by:

  • bg The radial background.
🔗 beautiful.arcchart_start_angle number
The (radiant) angle where the first value start.
Click to display more

Used by:

  • start_angle The (radiant) angle where the first value start.

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 When the widget content changed. signals
🔗 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:

widget::layout_changed When the layout (size) change. signals
🔗 button::press · Inherited from wibox.widget.base
When a mouse button is pressed over the widget.

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.

See also:

mouse Manipulate and inspect the mouse cursor. module
🔗 button::release · Inherited from wibox.widget.base
When a mouse button is released over the widget.

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.

See also:

mouse Manipulate and inspect the mouse cursor. module
🔗 mouse::enter · Inherited from wibox.widget.base
When the mouse enter a widget.

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.

See also:

mouse Manipulate and inspect the mouse cursor. module
🔗 mouse::leave · Inherited from wibox.widget.base
When the mouse leave a widget.

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.

See also:

mouse Manipulate and inspect the mouse cursor. module
generated by LDoc 1.5.0