Skip to main content
Version: 2.2 (dev)

wibox.container.arcchart

Draws value, or each entry of values, as an arc around the edge of its box, with the child in the middle. It needs a definite size: give it forced_width and forced_height, or put it in a container that sizes it, or it is left out with a warning.

Eight arc charts around the number 42: default, thick, three values, rounded ends, starting at the right, with a background ring, with a border, and with padding

Each row sets one property. The outline is the box the container was given.

Show Lua

Save this as /tmp/container-arcchart.lua, then run:

somewm-client eval 'dofile("/tmp/container-arcchart.lua")'

It opens the figure on your focused screen and closes after two minutes. Every row is a 56 by 56 arcchart around a textbox with one property set.

-- Shared canvas for the SomeWM widget reference figures, in the style of the
-- 2.1.0 announcement diagrams: the session's theme colors and font family
-- with gruvbox fallbacks, a bold title and a muted subtitle, rounded cards
-- with one-pixel borders, 28 px margins, an ontop popup that closes itself.
--
-- generate.sh concatenates this file ahead of each scene and publishes the
-- result next to the PNG, so a reader can run the same file:
-- somewm-client eval 'dofile("/tmp/figure.lua")'
-- The scene calls F.scene(title, subtitle, rows). This file defines the
-- global F instead of returning a module because the concatenation is one
-- chunk with no package path.

local awful = require("awful")
local beautiful = require("beautiful")
local gears = require("gears")
local wibox = require("wibox")

if _G.somewm_reference_figure then _G.somewm_reference_figure.stop() end

F = {}

F.bg = beautiful.bg_normal or "#282828"
F.fg = beautiful.fg_normal or "#ebdbb2"
F.panel = "#32302f"
F.slot = "#504945"
F.muted = "#bdae93"
F.amber = "#d79921"
F.blue = "#83a598"
F.green = "#b8bb26"
F.family = (beautiful.font or "sans 10"):gsub("%s+%d+%.?%d*$", "")
F.font = F.family .. " 14"
F.font_bold = F.family .. " Bold 14"
F.mono = "monospace 13"

F.width = 940
F.label_width = 300
F.slot_height = 44

function F.rounded(cr, w, h)
gears.shape.rounded_rect(cr, w, h, 8)
end

-- A line of text in the figure's own font. size is in points.
function F.text(text, size, color, bold)
return wibox.widget {
markup = '<span foreground="' .. (color or F.fg) .. '">'
.. gears.string.xml_escape(text) .. '</span>',
font = F.family .. (bold and " Bold " or " ") .. size,
widget = wibox.widget.textbox,
}
end

-- A textbox in the figure font, for rows that show text. extra overrides
-- properties, which is how a row demonstrates one of them.
function F.label(text, extra)
local t = { text = text, font = F.font, widget = wibox.widget.textbox }
for k, v in pairs(extra or {}) do t[k] = v end
return t
end

-- A solid block of a given size and color, for layout figures.
function F.block(w, h, color, text)
return {
text and {
text = text, font = F.mono, halign = "center", valign = "center",
widget = wibox.widget.textbox,
} or nil,
forced_width = w,
forced_height = h,
bg = color,
fg = F.bg,
shape = F.rounded,
widget = wibox.container.background,
}
end

-- One row: the property value in monospace, then the widget in a rounded
-- slot outlined in F.slot. The outline is the box the widget is given plus
-- opts.pad on each side (6 unless the scene needs the edge). opts.w and
-- opts.h size the slot; opts.fit lets it take the widget's own size.
function F.row(label, widget, opts)
opts = opts or {}
local slot = {
{ widget, margins = opts.pad or 6, widget = wibox.container.margin },
border_width = 1,
border_color = F.slot,
shape = F.rounded,
widget = wibox.container.background,
}
if not opts.fit then
slot.forced_width = opts.w or (F.width - 56 - F.label_width - 20)
slot.forced_height = opts.h or F.slot_height
elseif opts.h then
slot.forced_height = opts.h
end
return {
{
markup = '<span foreground="' .. F.muted .. '">' .. gears.string.xml_escape(label) .. '</span>',
font = F.mono,
ellipsize = "none",
forced_width = F.label_width,
widget = wibox.widget.textbox,
},
{
slot,
halign = "left",
valign = "center",
widget = wibox.container.place,
},
spacing = 20,
layout = wibox.layout.fixed.horizontal,
}
end

-- Build the figure as a centered popup on the primary screen, so every
-- capture comes from the same output and scale. It stays until
-- stop() runs or two minutes pass. Returns a message; generate.sh reads the
-- geometry from _G.somewm_reference_figure.popup once it has a size.
function F.scene(title, subtitle, rows)
local target = screen.primary
local contents = wibox.layout.fixed.vertical()
contents.spacing = 12
contents:add(F.text(title, 27, F.fg, true))
contents:add(F.text(subtitle, 16, F.muted))
contents:add(wibox.widget { forced_height = 6, widget = wibox.container.background })
for _, r in ipairs(rows) do contents:add(wibox.widget(r)) end

local popup = awful.popup {
screen = target,
visible = true,
ontop = true,
input_passthrough = true,
bg = F.bg,
fg = F.fg,
minimum_width = F.width,
maximum_width = F.width,
placement = awful.placement.centered,
widget = { contents, margins = 28, widget = wibox.container.margin },
}
local state = { popup = popup, screen = target }
_G.somewm_reference_figure = state
function state.stop()
popup.visible = false
if state.timer then state.timer:stop() end
if _G.somewm_reference_figure == state then _G.somewm_reference_figure = nil end
end
state.timer = gears.timer.start_new(120, function() state.stop(); return false end)
return title .. " figure opened on screen " .. target.index
end
-- wibox.container.arcchart: values as arcs around a child.
local function arc(extra)
local t = { { text = "42", font = F.mono, halign = "center", valign = "center", widget = wibox.widget.textbox },
value = 42, max_value = 100, forced_width = 56, forced_height = 56, colors = { F.blue }, widget = wibox.container.arcchart }
for k, v in pairs(extra or {}) do t[k] = v end
return t
end
return F.scene("wibox.container.arcchart", "One or more values drawn as arcs around the child", {
F.row('value = 42, max_value = 100', arc(), { fit = true }),
F.row('thickness = 10', arc { thickness = 10 }, { fit = true }),
F.row('values = {30, 20, 10}, colors = {...}', arc { value = nil, values = { 30, 20, 10 }, colors = { F.blue, F.amber, F.green } }, { fit = true }),
F.row('rounded_edge = true', arc { rounded_edge = true, thickness = 8 }, { fit = true }),
F.row('start_angle = 0', arc { start_angle = 0 }, { fit = true }),
F.row('bg = "#504945"', arc { bg = F.slot }, { fit = true }),
F.row('border_width = 2, border_color = "#d79921"', arc { border_width = 2, border_color = F.amber }, { fit = true }),
F.row('paddings = 6', arc { paddings = 6 }, { fit = true }),
})

Download the Lua file. To close it early:

somewm-client eval 'if somewm_reference_figure then somewm_reference_figure.stop() end'

Constructor: wibox.container.arcchart(widget). Upstream page.

local battery = wibox.widget {
{
text = "80",
halign = "center",
widget = wibox.widget.textbox,
},
value = 80,
max_value = 100,
colors = { "#b8bb26" },
thickness = 4,
forced_width = 32,
forced_height = 32,
widget = wibox.container.arcchart,
}

Properties​

PropertyTypeDefaultWhat it doesIn SomeWM
widgetwidget or nilnilThe child, drawn in the middle.
valuenumber0One value, drawn as one arc.
valuestable{}Several values, drawn one after another clockwise from start_angle. Overrides value.
min_valuenumber0The value where an arc starts.
max_valuenumber1The value that closes the circle.
colorstablebeautiful.arcchart_colorOne color per arc, reused in turn.A color that is not solid or a gradient warns once and is transparent. A gradient is drawn in the box.
thicknessnumber or nilbeautiful.arcchart_thickness, else 5Arc width in pixels.
start_anglenumberbeautiful.arcchart_start_angle, else math.piWhere the first arc starts, in radians clockwise from the right. math.pi is the left.
rounded_edgebooleanfalseRound the ends of each arc.
bgcolor or nilbeautiful.arcchart_bgA full ring drawn behind the arcs.Same color rule.
border_widthnumber0Outline around the ring.
border_colorcolorbeautiful.arcchart_border_colorOutline color.Must be solid or it warns once and is transparent.
paddingsnumber or tablebeautiful.arcchart_paddings, else 0Space between the box edge and the ring.A negative value warns once and is 0.

Setting a property emits property::<name>.

Methods​

MethodWhat it does
:reset()Removes the child.

The common properties, methods and signals apply.