https://wiki.returnofreckoning.com/index.php?action=history&feed=atom&title=API%3ALabelGetTextDimensionsAPI:LabelGetTextDimensions - Revision history2026-10-17T11:51:29ZRevision history for this page on the wikiMediaWiki 1.43.11https://wiki.returnofreckoning.com/index.php?title=API:LabelGetTextDimensions&diff=30551&oldid=prevMaintenance script: UI Lua API import (WAR 1.4.8)2026-10-16T19:46:23Z<p>UI Lua API import (WAR 1.4.8)</p>
<p><b>New page</b></p><div>{{LuaApi|group=Label|wrapper=interfacecore/source/windowstate.lua}}<br />
Returns the width and height of the text in a Label.<br />
<br />
<pre><br />
width, height = LabelGetTextDimensions(labelName)<br />
</pre><br />
<br />
== Arguments ==<br />
;labelName : <code>string</code> – Name of a Label window.<br />
<br />
== Returns ==<br />
;width : <code>number</code> – Width of the widest line of text.<br />
;height : <code>number</code> – Height of all lines: the number of lines times the line height.<br />
<br />
== Details ==<br />
* Both values are divided by the label's scale (see [[API:WindowGetScale|WindowGetScale]]).<br />
* A label that has no text layout yet returns <code>0, 0</code>.<br />
* The client registers the C function as <code>_LabelGetTextDimensions</code>. The <code>LabelGetTextDimensions</code> that addons call is a Lua function defined in <code>interfacecore/source/windowstate.lua</code>:<br />
** If the global table named after the window (<code>_G[labelName]</code>) has a <code>STATE</code> table, it returns <code>STATE.LABEL_TEXTDIMS_X</code> and <code>STATE.LABEL_TEXTDIMS_Y</code> without calling into the client.<br />
** Otherwise it calls <code>_LabelGetTextDimensions(labelName)</code>.<br />
* For windows with state tracking enabled, the client writes the same two values to <code>''labelName''.STATE.LABEL_TEXTDIMS_X</code> and <code>LABEL_TEXTDIMS_Y</code> when it lays out the label's text.<br />
* Avoid using <code>STATE</code> as a field name on a global table that has the same name as a label.<br />
<br />
== Errors ==<br />
Raised by <code>_LabelGetTextDimensions</code>:<br />
* <code>Error in function call 'LabelGetTextDimensions': Window %s does not exist</code><br />
* <code>Error in function call 'LabelGetTextDimensions': Window %s is not a Label</code><br />
<br />
== Example ==<br />
Sizing a tooltip to its text, from <code>easystem_tooltips/source/abilitytooltips.lua</code>:<br />
<pre><br />
local nameWidth, nameHeight = LabelGetTextDimensions(windowName.."Name")<br />
local typeWidth, typeHeight = LabelGetTextDimensions(windowName.."Type")<br />
...<br />
local width1 = nameWidth + typeWidth + c_TOOLTIP_BUFFER<br />
</pre><br />
<br />
== See also ==<br />
* [[API:LabelGetText|LabelGetText]]<br />
* [[API:ButtonGetTextDimensions|ButtonGetTextDimensions]]<br />
* [[API:WindowGetDimensions|WindowGetDimensions]]</div>Maintenance script