Module: wibox.container.arcchart

A circular chart (arc chart).

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

Usage example

Info:

  • Copyright: 2013 Emmanuel Lepage Vallee
  • Author: Emmanuel Lepage Vallee <[email protected]>

Constructors

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

Functions

wibox.container.arcchart.add_button (button) Add a new awful.button to this widget.

Object properties

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

:reset () Reset this layout.
: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.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.


Constructors

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

Parameters:

  • widget The widget to display. (optional)

Functions

wibox.container.arcchart.add_button (button)
Add a new awful.button to this widget.

Parameters:

  • button awful.button The button to add.

Object properties

widget (widget)
The widget to wrap in a radial proggressbar.

Type constraints:

paddings (table or number)
The padding between the outline and the progressbar.

Usage example

Type constraints:

  • paddings A number or a table
    • top number (default 0)
    • bottom number (default 0)
    • left number (default 0)
    • right number (default 0)
border_color (color)
The border background color.
colors (table)
The arcchart values foreground colors.

Type constraints:

  • values table An ordered set of colors for each value in arcchart.
border_width (number)
The border width.

Usage example

min_value (number)
The minimum value.
max_value (number)
The maximum value.
bg (color)
The radial background.

Usage example

See also:

value (number)
The value.

Usage example

Type constraints:

  • value number Between min_value and max_value

See also:

values (table)
The values. The arcchart is designed to display multiple values at once. Each will be shown in table order.

Type constraints:

  • values table An ordered set of values.

See also:

rounded_edge (boolean)
If the chart has rounded edges.

Usage example

thickness (number)
The arc thickness.

Usage example

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

Usage example

Type constraints:

  • number A number between 0 and 2*math.pi (default math.pi)
children (table)
Get or set the children elements.

Type constraints:

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:

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.

See also:

Object methods

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

See also:

widget::redraw_needed
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
When a mouse button is pressed over the widget.

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.

See also:

button::release
When a mouse button is released over the widget.

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.

See also:

mouse::enter
When the mouse enter a widget.

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.

See also:

mouse::leave
When the mouse leave a widget.

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.

See also:

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.

Type constraints:

  • paddings A number or a table
    • top number (default 0)
    • bottom number (default 0)
    • left number (default 0)
    • right number (default 0)
beautiful.arcchart_thickness (number)
The arc thickness.
generated by LDoc 1.4.6 Last updated 2030-01-01 00:00:00