canvasLabel(3tk)

💖 canvasLabel(3tk) — the manual page but make it a group chat 💖

okay so bestie, you opened the canvasLabel(3tk) page and honestly? it's giving "tiny widget, big personality." let's get into it, no cap. 🎀

---

✨ NAME ✨

canvasLabel — the tkpiechart canvas label class. that's it, that's the whole name section, she's concise and she's iconic. 💅

---

🌸 SYNOPSIS 🌸

package require stooop 4.1

package require switched 2.2

package require tkpiechart 6.6

stooop::new canvasLabel canvas ?options?

switched::configure canvasLabelObject ?options?

switched::cget canvasLabelObject option

stooop::delete canvasLabelObject

like yes, you need stooop 4.1, switched 2.2 and tkpiechart 6.6 first. prerequisites, babe. 🫶

---

🦋 DESCRIPTION 🦋

so the canvasLabel class literally brings some Tk label widget functionality over to the canvas text item — we're talking a background and a border, the glow-up essentials. ✨

the canvasLabel is built with a bullet rectangle on the left side of the text. the relief changes according to the select state, and when it's selected it gets a traditionally sunken relief. it's giving "pressed and proud." 💅

and the label has a specific tag, which you can use to retrieve the coordinates of the object or move it — thanks to the canvas facilities. main character energy, honestly. 👑

---

🌈 the four calls you'll be doing

stooop::new canvasLabel canvas ?options?

Creates a canvasLabel object in the specified Tk canvas. The canvasLabel object identifier is returned — and that's what this whole document calls canvasLabelObject. remember that name, she comes up a lot. 📛

switched::configure canvasLabelObject ?options?

Configures a canvasLabel object, or returns all the options with their current values if you don't pass any options as parameters. no options? she just tells you everything. oversharing queen. 🙈

switched::cget canvasLabelObject option

Returns an option value for the specified canvasLabel object. one option, one answer. 🍓

stooop::delete canvasLabelObject

Deletes the specified canvasLabel object. bye bestie 👋😭

---

👑 OPTIONS 👑

okay here's the full roster, all 17 of them, no skipping, we do not leave anyone on read:

• -anchor value — Specifies the anchor position of the rectangle and the text, relative to the positioning point. The behavior is similar to the -anchor option of the canvas text item, except that the rectangle is taken into account. The default is center. 🎯
• -background color — Specifies the background color of the bullet rectangle, as in the -fill option of the canvas rectangle item. The default is transparent (that's an empty string, fr). 🫥
• -bordercolor color — Specifies the border color of the rectangle, as in the -outline option of the canvas rectangle item. The default is black. 🖤
• -borderwidth value — Specifies the border width of the rectangle, as in the -width option of the canvas rectangle item. By default, the width is 1 pixel, which is the minimum width. no thinner than that, bestie. 📏
• -bulletwidth value — Specifies the width of the rectangle placed to the left of the text. Defaults to 10. 🔫✨
• -font value — Specifies the font of the text, as in the -font option of the canvas text item. The default is system dependent. so like, whatever your machine woke up feeling today. 💅
• -foreground color — Specifies the color of the text, as in the -fill option of the canvas text item. The default is black. 🖤
• -justify value — Specifies how to justify the text, as in the -justify option of the canvas text item. The default is left. ⬅️
• -minimumwidth value — The total label width will not go below the specified value, but may be larger if the label text requires it. so it's a floor, not a ceiling. 🧱
• -padding value — Specifies how much space to leave between the text and the closest rectangle edge. Units are identical to those specified in the canvas COORDINATES manual section. 📐
• -scale list — List of 2 floating point numbers used to set the scaling factor in the x and y axis. Scaling is applied immediately and defaults to 1. ⚖️
• -select boolean — Sets the label state. 🎚️
• -selectrelief value — Either flat, raised or sunken. Specifies the 3D effect desired for the text area when the label is selected. 🧊
• -stipple bitmap — Specifies the stipple pattern filling the rectangle, as in the -stipple option of the canvas rectangle item. There is no bitmap by default. 🕳️
• -text text — Specifies the string to be displayed in the text area, as in the -text option of the canvas text item. The default is an empty string. 🤐
• -textbackground color — Specifies the color of the text area background. 🎨
• -width value — Specifies a maximum line length for the text, as in the -width option of the canvas text item. The default is 0. ➡️

---

🏷️ TAGS 🏷️

the labeler has the following specific tag — see the canvas manual page ITEM IDS AND TAGS section for more info, iykyk:

• canvasLabel(canvasLabelObject)

---

💀 BUGS, IDEAS, FEEDBACK 💀

ngl, this document, and the package it describes, will undoubtedly contain bugs and other problems. it's not a vibe, it's just true. 😭

Please report such in the category tkpiechart of the Tklib Trackers at http://core.tcl.tk/tklib/reportlist.

Please also report any ideas for enhancements you may have for either package and/or documentation. we love a suggestion box moment. 💌

---

🔍 SEE ALSO 🔍

• pie
• pieBoxLabeler
• piePeripheralLabeler

---

🔑 KEYWORDS 🔑

canvas, labeler, pie, slice

---

📜 COPYRIGHT 📜

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

---

and that's the whole page bestie, you ate it. 🫶 this was tklib version 6.6 — go forth and label your canvases, periodt. 💖✨🎀