pieBoxLabeler(3tk)

📦 version 0.9, in debian bookworm, debian trixie, ubuntu jammy, ubuntu noble, ubuntu questing, ubuntu resolute, ubuntu stonking

💖 pieBoxLabeler — the class that labels ur pie slices, bestie 💖

okay so this is pieBoxLabeler, a manual page from the tkpiechart fam, and it's the pie box style labeler class. she's the one who decides where ur slice labels go. no cap. ✨

✨ SYNOPSIS ✨

stooop::new pieBoxLabeler canvas ?options?

switched::configure pieBoxLabelerObject ?options?

switched::cget pieBoxLabelerObject option

like… that's the whole vibe. three commands. iconic. 💅

🎀 DESCRIPTION 🎀

so the pie box style labeler object is literally a slice label placer for a pie object, and you hand it over to the pie constructor through its -labeler option (go peek at the pie class manual, iykyk).

the labels get arranged in 2 columns below the pie graphics. fr fr, two. each label text sits to the right of a rectangle, and the background color of that rectangle matches its corresponding slice — matching fit, we love to see it 🫶. the slice share value goes to the right of the label text, separated by a semicolon. and plot twist: each label is actually a canvasLabel object (check the canvasLabel class manual for more, bestie).

no need to delete a pieBoxLabeler object — the pie class handles that automatically. she's taken care of. periodt. 💀

🦋 the three commands, explained

  • stooop::new pieBoxLabeler canvas ?options? — creates a pieBoxLabeler object in the Tk canvas you specified. it returns the pieBoxLabeler object identifier (which this whole doc calls pieBoxLabelerObject). ✨
  • switched::configure pieBoxLabelerObject ?options? — configures a pieBoxLabeler object. or, if you pass no options at all, it returns every option with its current value. mood. 🌸
  • switched::cget pieBoxLabelerObject option — returns one option value for the pieBoxLabeler object you specified. just the one. 💜

🌈 OPTIONS 🌈

  • -font value — sets a font for the slice labels. if you don't specify one, the default font is system dependent. 🙈
  • -justify value — how to justify labels within their own column. must be one of left, center or right. defaults to left. for example, if justification is right, all column labels' right edges are aligned. slay. 💅
  • -offset value — the distance between the pie graphics and the closest slice label. this value can be given in any of the forms described in the canvas COORDINATES manual section. 👑

🏷️ TAGS 🏷️

the labeler has one specific tag of its own (see the canvas manual page ITEM IDS AND TAGS section for the deets):

  • pieBoxLabeler(pieBoxLabelerObject)

😭 BUGS, IDEAS, FEEDBACK 😭

ngl, this document — and the package it describes — will undoubtedly contain bugs and other problems. like, obviously. so please report them in the category tkpiechart of the Tklib Trackers: http://core.tcl.tk/tklib/reportlist. also pls report any ideas for enhancements you may have for either the package and/or the documentation. we want them. 🫶

👀 SEE ALSO 👀

canvasLabel, pie, piePeripheralLabeler

🔥 KEYWORDS 🔥

canvas, labeler, pie, slice

Copyright (c) 1995-2004 Jean-Luc Fontaine <jfontain@free.fr>

and that's the whole page, bestie — brought to you by tklib 6.6 ✨ go forth and label ur slices, u absolute icon 👑💅🌸

📦 where this page comes from