Content deleted Content added
parse meta JSON; support for footer in meta; caption also from meta |
Report unknown $var • Wikiploy |
||
(23 intermediate revisions by 4 users not shown) | |||
Line 1:
local p = {}
local priv = {} -- private functions scope
-- expose private for easy testing/debugging
p.__priv = priv
-- require exact colors for printing
local forPrinting = "-webkit-print-color-adjust: exact; print-color-adjust: exact;"
--[===[
Smooth piechart module.
Draws charts in HTML with an accessible legend (optional).
A list of all features is in the "TODO" section of the main `p.pie` function.
Module info:
- Changelog and TODO: [[:en:User:Nux/pie_chart_-_todo]] (Piechart 1.0, 2.0 and beyond).
- Author: [[:en:User:Nux|Maciej Nux]].
Use with a helper template that adds required CSS.
Line 17 ⟶ 25:
{ "label": "raw pizza $v", "color": "#f30" }
]
{{{meta}}}:
{"size":200, "autoscale":false, "legend":true}
All meta options are optional (see `function p.setupOptions`).
]===]
--[[
Line 51 ⟶ 59:
-- 4-cuts
local entries = {
}
local json_data = '['..table.concat(entries, ',')..']'
Line 71 ⟶ 79:
]]
function p.color(frame)
local index = tonumber(priv.trim(frame.args[1]))
return ' ' .. priv.defaultColor(index)
end
--[===[
Main pie chart function.
TODO (maybe):
[[:en:User:Nux/pie_chart_-_todo#Hopes_and_dreams]]
]===]
function p.pie(frame)
local json_data = priv.trim(frame.args[1])
local options = {}
if (frame.args.meta) then
options.meta = priv.trim(frame.args.meta)
end
local html = p.renderPie(json_data, options)
return priv.trim(html)
end
Line 145 ⟶ 120:
-- footer below the labels
footer = "",
-- formatting template for labels
labelformat = "",
}
-- internals
options.style = ""
if user_options and user_options.meta then
local decodeSuccess, rawOptions = pcall(function()
return mw.text.jsonDecode(user_options.meta, mw.text.JSON_TRY_FIXING) end)
if not decodeSuccess then
rawOptions = false
mw.log('invalid meta parameters')
end
if rawOptions then
if type(rawOptions.size) == "number" then
Line 178 ⟶ 161:
if (type(rawOptions.footer) == "string") then
options.footer = rawOptions.footer
end
if (type(rawOptions.labelformat) == "string") then
options.labelformat = rawOptions.labelformat
end
end
Line 193 ⟶ 179:
return options
end
-- internal for testing legend rendering
p.__priv.legendDebug = false
--[[
Line 200 ⟶ 189:
]]
function p.renderPie(json_data, user_options)
if type(json_data) ~= "string" then
error('invalid piechart data type: '..type(json_data))
end
if #json_data < 2 then
error('piechart data is empty')
end
local decodeSuccess, data = pcall(function()
return mw.text.jsonDecode(json_data, mw.text.JSON_TRY_FIXING)
end)
-- Handle decode error
if not decodeSuccess then
error('invalid piechart data: '..json_data)
end
local options = p.setupOptions(user_options)
Line 211 ⟶ 212:
-- error info
if not ok then
html = html .. priv.renderErrors(data)
end
Line 217 ⟶ 218:
if options.legend then
html = html .. p.renderLegend(data, options)
end
if p.__priv.legendDebug then
return html
end
Line 227 ⟶ 232:
return html
end
function priv.boundaryFormatting(diff)
local value = 0.0
if diff <= 1.0 then
value = math.ceil(diff / 0.2) * 0.2 -- 0.2 step
else
value = math.ceil(diff / 0.5) * 0.5 -- 0.5 step
end
return string.format("%.1f", value)
end
-- Check if sum will trigger autoscaling
function priv.willAutoscale(sum)
-- Compare with a number larger then 100% to avoid floating-point precision problems
--- ...and data precision problems https://en.wikipedia.org/wiki/Template_talk:Pie_chart#c-PrimeHunter-20250420202500-Allow_percentage_sum_slightly_above_100
local diff = sum - 100
local grace = 1
return diff > grace
end
-- Tracking errors in data (note: somewhat expensive, similar to a red link)
-- In short: ±0.3 is a reasonable deviation; ±1 when the errors accumulate
-- https://en.wikipedia.org/wiki/Template_talk:Pie_chart#c-Nux-20250429152000-Nux-20250422224600
function priv.sumErrorTracking(sum, items)
local diff = sum - 100
if diff >= 0.4 and diff <= 10 then
local firstItem = items[1]
local lastItem = items[#items]
mw.addWarning("pie chart: Σ (value) = "..sum.."% ("..firstItem.value.." + .. .+ "..lastItem.value..")")
if mw.title.getCurrentTitle().namespace == 0 then
local suffix = priv.boundaryFormatting(diff)
_ = mw.title.new("Module:Piechart/tracing/diff below "..suffix).id
end
end
end
-- Prepare data (slices etc)
function p.prepareEntries(data, options)
local sum = priv.sumValues(data);
-- force autoscale when over 100
if priv.willAutoscale(sum
options.autoscale = true
end
Line 242 ⟶ 281:
for index, entry in ipairs(data) do
no = no + 1
if not priv.prepareSlice(entry, no, sum, total, options) then
no = no - 1
ok = false
Line 252 ⟶ 291:
end
function priv.sumValues(data)
local sum = 0;
for _, entry in ipairs(data) do
local value = entry.value
if not (type(value) ~= "number" or value < 0) then
end
end
Line 264 ⟶ 303:
-- render error info
function priv.renderErrors(data)
local html = "\n<ol class='chart-errors' style='display:none'>"
for _, entry in ipairs(data) do
if entry.error then
local entryJson = mw.text.jsonEncode(entry)
html = html .. "\n<li>".. entryJson .."</li>"
end
Line 277 ⟶ 316:
-- Prepare single slice data (modifies entry).
-- @param no = 1..total
function priv.prepareSlice(entry, no, sum, total, options)
local autoscale = options.autoscale
local value = entry.value
Line 295 ⟶ 334:
-- prepare final label
entry.label = priv.prepareLabel(
-- background, but also color for MW syntax linter
entry.bcolor = priv.backColor(entry, no, total) .. ";color:#000"
return true
Line 314 ⟶ 353:
for _, entry in ipairs(data) do
if not entry.error then
html = html .. priv.renderLegendItem(entry, options)
end
end
Line 327 ⟶ 366:
end
-- render legend item
function priv.renderLegendItem(entry, options)
-- invisible value (for a11y reasons this should not be used for important values!)
if entry.visible ~= nil and entry.visible == false then
Line 336 ⟶ 375:
local bcolor = entry.bcolor
local html = "\n<li>"
if p.__priv.legendDebug then
forPrinting = ""
end
html = html .. '<span class="l-color" style="'..forPrinting..bcolor..'"></span>'
html = html .. '<span class="l-label">'..label..'</span>'
Line 348 ⟶ 390:
local first = true
local previous = 0
local items = ""
for index, entry in ipairs(data) do
if not entry.error then
items = items .. priv.renderItem(previous, entry, options)
previous = previous + entry.value
end
end
local header = priv.renderHeader(options)
local footer = '\n<div class="smooth-pie-border"></div></div>'
return header, items, footer
end
-- header of pie-items (class="smooth-pie")
function
local
local size = options.size
Line 383 ⟶ 419:
<div class="smooth-pie"
style="]]..style..[["
]]..aria..[[
>]]
return html
end
-- Render pie-item
function priv.renderItem(previous, entry, options)
local value = entry.value
local label = entry.label
Line 397 ⟶ 433:
if (value < 0.03) then
mw.log('value too small', value, label)
mw.addWarning("pie chart: Value too small ↆ "..value.."% ("..label..")")
return ""
end
-- minimize transformation defects
if value < 10 then
if previous > 1 then
previous = previous - 0.01
end
value = value + 0.02
else
if previous > 1 then
previous = previous - 0.1
end
value = value + 0.2
end
-- force sum to be below 100% (needed due to value errors)
if previous + value > 100 then
if previous >= 100 then
mw.log('previous is already at 100', value, label)
return ""
end
value = 100 - previous
end
local html = ""
Line 405 ⟶ 463:
-- mw.logObject({'v,p,l', value, previous, label})
if (value >= 50) then
html = priv.sliceWithClass('pie50', 50, value, previous, bcolor, label)
elseif (value >= 25) then
html = priv.sliceWithClass('pie25', 25, value, previous, bcolor, label)
elseif (value >= 12.5) then
html = priv.sliceWithClass('pie12-5', 12.5, value, previous, bcolor, label)
elseif (value >= 7) then
html = priv.sliceWithClass('pie7', 7, value, previous, bcolor, label)
elseif (value >= 5) then
html = priv.sliceWithClass('pie5', 5, value, previous, bcolor, label)
else
-- 0-5%
local cutIndex = priv.round(value*10)
if cutIndex < 1 then
end
local cut = p.cuts[cutIndex]
local transform = priv.rotation(previous)
html = priv.sliceX(cut, transform, bcolor, label)
end
-- mw.log(html)
Line 430 ⟶ 488:
-- round to int
function priv.round(number)
end
-- render full slice with specific class
function priv.sliceWithClass(sizeClass, sizeStep, value, previous, bcolor, label)
local transform = priv.rotation(previous)
local html = ""
html = html .. priv.sliceBase(sizeClass, transform, bcolor, label)
-- mw.logObject({'sliceWithClass:', sizeClass, sizeStep, value, previous, bcolor, label})
if (value > sizeStep) then
local extra = value - sizeStep
transform = priv.rotation(previous + extra)
-- mw.logObject({'sliceWithClass; extra, transform', extra, transform})
html = html .. priv.sliceBase(sizeClass, transform, bcolor, label)
end
return html
Line 450 ⟶ 508:
-- render single slice
function priv.sliceBase(sizeClass, transform, bcolor, label)
local style = bcolor
if transform ~= "" then
return '\n\t<div class="'..sizeClass..'" style="'..style..'" title="'..p.extract_text(label)..'"></div>'
end
Line 461 ⟶ 519:
-- range in theory: 0 to 24.(9)% reaching 24.(9)% for cut = +inf
-- range in practice: 0 to 5%
function priv.sliceX(cut, transform, bcolor, label)
local path = 'clip-path: polygon(0% 0%, '..cut..'% 0%, 0 100%)'
return '\n\t<div style="'..transform..'; '..bcolor..'; '..path..'" title="'..p.extract_text(label)..'"></div>'
end
-- translate value to turn rotation (v=100 => 1.0turn)
function priv.rotation(value)
if (value > 0.001) then
f = f:gsub("(%d)0+$", "%1") -- remove trailing zeros
return "transform: rotate("..f.."turn)"
end
return ''
end
-- Language sensitive float, small numbers.
function priv.formatNum(value)
local lang = mw.language.getContentLanguage()
Line 492 ⟶ 552:
return v
end
-- Format large values.
function priv.formatLargeNum(value)
local lang = mw.language.getContentLanguage()
-- add thusands separators
local v = lang:formatNum(value)
return v
end
-- Testing formatLargeNum.
-- p.__priv.test_formatLargeNum()
function priv.test_formatLargeNum()
mw.log("must not add fractional part")
mw.log( p.__priv.formatLargeNum(12) )
mw.log( p.__priv.formatLargeNum(123) )
mw.log("should preserve fractional part for small numbers")
mw.log( p.__priv.formatLargeNum(1.1) )
mw.log( p.__priv.formatLargeNum(1.12) )
mw.log( p.__priv.formatLargeNum(12.1) )
mw.log("can preserve long fractional part")
mw.log( p.__priv.formatLargeNum(1.1234) )
mw.log( p.__priv.formatLargeNum(1.12345) )
mw.log("should add separators above 1k")
mw.log( p.__priv.formatLargeNum(999) )
mw.log( p.__priv.formatLargeNum(1234) )
mw.log( p.__priv.formatLargeNum(12345) )
mw.log( p.__priv.formatLargeNum(123456) )
mw.log( p.__priv.formatLargeNum(1234567) )
mw.log("must handle large float, but might round values")
mw.log( p.__priv.formatLargeNum(1234.123) )
mw.log( p.__priv.formatLargeNum(12345.123) )
mw.log( p.__priv.formatLargeNum(123456.123) )
mw.log( p.__priv.formatLargeNum(1234567.123) )
end
--[[
Line 498 ⟶ 593:
Typical tpl:
"
will result in:
"Abc: 23%" -- when values are percentages
Line 504 ⟶ 599:
Advanced tpl:
"
"$L: $v" is the same as above when values are autoscaled
Long vs short variable names:
$label ($L)
$auto ($v)
$value ($d)
$percent ($p)
]]
function priv.prepareLabel(tpl, entry)
--
if not tpl
-- simple if no label
if not entry.label or entry.label == "" then
tpl = "$v"
else
if entry.label:find("%$[a-z]") then
tpl = entry.label
else
tpl = "$L: $v"
end
end
end
local labelLabel = entry.label and entry.label or priv.getLangOther()
-- format % value without %
local
local pp = pRaw .. "%%"
local label = tpl
-- aliases
label = label
:gsub("%$label", "$L")
:gsub("%$auto", "$v")
:gsub("%$value", "$d")
:gsub("%$percent", "$p")
-- replace variables
label = label:gsub("%$L", labelLabel)
local d = priv.formatLargeNum(entry.raw and entry.raw or entry.value)
local v = entry.raw and (d .. " (" .. pp .. ")") or pp
label = label
:gsub("%$p", pp)
:gsub("%$d", d)
:gsub("%$v", v)
-- Report unknown variables
for var in label:gmatch("%$[a-zA-Z]+") do
mw.addWarning("pie chart: Unknown variable (wrong format of your label): " .. var)
-- tracing links
_ = mw.title.new("Module:Piechart/tracing/unknown-variable").id
end
return label
end
Line 553 ⟶ 680:
local lastColor = '#fff'
-- background color from entry or the default colors
function priv.backColor(entry, no, total)
:gsub('#', '#') -- workaround Module:Political_party issue reported on talk
:gsub("[^a-zA-Z0-9#%-]", "")
return 'background:' .. sanitizedColor
else
local color = priv.defaultColor(no, total)
return 'background:' .. color
end
end
-- color from the default colors
function priv.defaultColor(no, total)
local color = lastColor
if no <= 0 then
Line 573 ⟶ 702:
total = size + 1
end
local colorNo = priv.defaultColorNo(no, total, size)
if colorNo > 0 then
color = colorPalette[colorNo]
Line 582 ⟶ 711:
-- trys to return a light color as the last one
-- 0 means white-ish color should be used
function priv.defaultColorNo(no, total, size)
local color = 0 -- special, lastColor
if total == 1 then
Line 606 ⟶ 735:
--[[
Testing defaultColorNo:
p.__priv.test_defaultColorNo(1, 12)
p.__priv.test_defaultColorNo(2, 12)
p.__priv.test_defaultColorNo(3, 12)
p.__priv.test_defaultColorNo(4, 12)
p.__priv.test_defaultColorNo(5, 12)
p.__priv.test_defaultColorNo(6, 12)
]]
function
for no=1,total do
local color = priv.defaultColorNo(no, total, size)
mw.logObject({no=no, color=color})
end
Line 627 ⟶ 756:
`s:gsub(...)` returns a string and a number
]]
function priv.trim(s)
return (s:gsub("^%s+", ""):gsub("%s+$", ""))
end
Line 642 ⟶ 771:
-- mw.log(p.extract_text("sandwiches: $v"))
function p.extract_text(label)
label = label
-- replace links with pipe (e.g., [[candy|sweets]])
:gsub("%[%[[^|%]]+|(.-)%]%]", "%1")
-- replace simple links without pipe (e.g., [[sandwich]])
:gsub("%[%[(.-)%]%]", "%1")
-- remove templates?
-- :gsub("{.-}", "")
-- remove tags
:gsub("<[^>]+>", "")
-- escape special chars just in case
:gsub("<", "<"):gsub(">", ">")
:gsub("'", "'"):gsub("\"", """)
return label
end
Line 667 ⟶ 799:
]]
function p.parseEnumParams(frame)
return priv.parseEnumParams(args)
end
function priv.parseEnumParams(args)
local result = {}
local i = 1
local sum = 0.0
local hasCustomColor = false -- has last custom color
local label = args["label" .. i]
if label and label ~= "" then
end
local color = args["color" .. i]
if color and color ~= "" then
local willAutoscale = priv.willAutoscale(sum)
for _, entry in ipairs(result) do
end
-- tracking data errors
priv.sumErrorTracking(sum, result)
local
local colorOther = "#FEFDFD" -- white-ish for custom colors for best chance and contrast
local otherValue = 100 - sum
if args["other"] and args["other"] ~= "" then
if
end
local otherEntry = { label = (args["other-label"] or langOther) .. " ($p)" }
if args["other-color"] and args["other-color"] ~= "" then
otherEntry.color = args["other-color"]
else
otherEntry.color = colorOther
end
table.insert(result, otherEntry)
elseif otherValue > 0.01 then
if hasCustomColor then
table.insert(result, {visible = false, label = langOther .. " ($v)", color = colorOther})
else
table.insert(result, {visible = false, label = langOther .. " ($v)"})
end
end
end
function priv.getLangOther()
-- support other value mapping
local lang = mw.language.getContentLanguage()
if (lang:getCode() == 'pl') then
return "Inne"
end
return "Other"
end
-- Function to check if a value is true-ish
local trueValues = { ["true"] = true, ["1"] = true, ["on"] = true, ["yes"] = true }
function priv.isTrueishValue(value)
-- should return nil for empty args (i.e. undefined i.e. default)
if not value or value == "" then return nil end
value = priv.trim(value)
if value == "" then return nil end
-- other non-empty are false
return trueValues[value:lower()] or false
end
Line 740 ⟶ 894:
]]
function p.parseMetaParams(frame)
-- default meta for value1..n parameters
-- ...and for thumb right/left
local thumb = args["thumb"]
if args["value1"] or (thumb and (thumb == "right" or thumb == "left")) then
end
-- explicit meta param
if args["meta"] then
local decodeSuccess, tempMeta = pcall(function()
return mw.text.jsonDecode(args["meta"], mw.text.JSON_TRY_FIXING)
end)
if not decodeSuccess then
mw.log('invalid meta parameter')
else
meta = tempMeta
end
end
if args["size"] then meta.size = tonumber(args["size"]) end
if args["radius"] and tonumber(args["radius"]) then
end
if args["autoscale"] then meta.autoscale = priv.isTrueishValue(args["autoscale"]) end
if args["legend"] then meta.legend = priv.isTrueishValue(args["legend"]) end
if args["ariahidechart"] then meta.ariahidechart = priv.isTrueishValue(args["ariahidechart"]) end
if args["direction"] and args["direction"] ~= "" then
meta.direction = args["direction"]:gsub("[^a-z0-9%-]", "")
end
if args["width"] and args["width"] ~= "" then
meta.width = args["width"]:gsub("[^a-z0-9%-]", "")
end
if args["caption"] and args["caption"] ~= "" then
meta.caption = args["caption"]
end
if args["footer"] and args["footer"] ~= "" then
meta.footer = args["footer"]
end
if args["labelformat"] and args["labelformat"] ~= "" then
meta.labelformat = args["labelformat"]
end
end
|