Class wibox.container.arcchart
A circular chart (arc chart).
It can contain a central widget (or not) and display multiple values.
Info:
- Copyright: 2013 Emmanuel Lepage Vallee
- Author: Emmanuel Lepage Vallee <elv1313@gmail.com>
Functions
arcchart:get_children () | Get the children elements. |
arcchart:set_children (children) | Replace the layout children This layout only accept one children, all others will be ignored |
arcchart:reset () | Reset this layout. |
wibox.container.arcchart ([widget]) | Returns a new arcchart layout. |
Object properties
wibox.container.arcchart.widget | The widget to wrap in a radial proggressbar. |
wibox.container.arcchart.paddings | The padding between the outline and the progressbar. |
wibox.container.arcchart.border_color | The border background color. |
wibox.container.arcchart.color | The border foreground color. |
wibox.container.arcchart.border_width | The border width. |
wibox.container.arcchart.min_value | The minimum value. |
wibox.container.arcchart.max_value | The maximum value. |
wibox.container.arcchart.bg | The radial background. |
wibox.container.arcchart.value | The value. |
wibox.container.arcchart.values | The values. |
wibox.container.arcchart.rounded_edge | If the chart has rounded edges. |
wibox.container.arcchart.thickness | The arc thickness. |
wibox.container.arcchart.start_angle | The (radiant) angle where the first value start. |
Theme variables
beautiful.arcchart_border_color | The progressbar border background color. |
beautiful.arcchart_color | The progressbar foreground color. |
beautiful.arcchart_border_width | The progressbar border width. |
beautiful.arcchart_paddings | The padding between the outline and the progressbar. |
beautiful.thickness | The arc thickness. |
Functions
- arcchart:get_children ()
-
Get the children elements.
Returns:
-
table
The children
- arcchart:set_children (children)
-
Replace the layout children
This layout only accept one children, all others will be ignored
- children table A table composed of valid widgets
- arcchart:reset ()
- Reset this layout. The widget will be removed and the rotation reset.
- wibox.container.arcchart ([widget])
-
Returns a new arcchart layout.
- widget The widget to display.
Object properties
- wibox.container.arcchart.widget
-
The widget to wrap in a radial proggressbar.
Type:
- widget widget The widget
- wibox.container.arcchart.paddings
-
The padding between the outline and the progressbar.
Type:
- paddings A number or a table
- top number (default 0)
- bottom number (default 0)
- left number (default 0)
- right number (default 0)
- paddings A number or a table
- wibox.container.arcchart.border_color
- The border background color.
- wibox.container.arcchart.color
- The border foreground color.
- wibox.container.arcchart.border_width
-
The border width.
Type:
- border_width number (default 3)
- wibox.container.arcchart.min_value
- The minimum value.
- wibox.container.arcchart.max_value
- The maximum value.
- wibox.container.arcchart.bg
-
The radial background.
Type:
- color
See also:
- wibox.container.arcchart.value
-
The value.
Type:
- value number Between min_value and max_value
See also:
- wibox.container.arcchart.values
-
The values.
The arcchart is designed to display multiple values at once. Each will be
shown in table order.
Type:
- values table An ordered set if values.
See also:
- wibox.container.arcchart.rounded_edge
-
If the chart has rounded edges.
Type:
- boolean (default false)
- wibox.container.arcchart.thickness
-
The arc thickness.
Type:
- number
- wibox.container.arcchart.start_angle
-
The (radiant) angle where the first value start.
Type:
- number A number between 0 and 2*math.pi (default math.pi)
Theme variables
- beautiful.arcchart_border_color
- The progressbar border background color.
- beautiful.arcchart_color
- The progressbar foreground color.
- beautiful.arcchart_border_width
- The progressbar border width.
- beautiful.arcchart_paddings
-
The padding between the outline and the progressbar.
Type:
- paddings A number or a table
- top number (default 0)
- bottom number (default 0)
- left number (default 0)
- right number (default 0)
- paddings A number or a table
- beautiful.thickness
-
The arc thickness.
Type:
- number