WoW:API Region GetHeight: Difference between revisions

From AddOn Studio
Jump to navigation Jump to search
m (Move page script moved page API Region GetHeight to API Region GetHeight without leaving a redirect)
 
(One intermediate revision by one other user not shown)
Line 1: Line 1:
{{widgetmethod}} __NOTOC__
{{widgetmethod}}
 
Gets the height and width, respectively, of an object.
Gets the height and width, respectively, of an object.


Line 6: Line 5:
  dimension = MyObject:GetHeight();
  dimension = MyObject:GetHeight();


== Returns ==
== Parameters ==
:;dimension : Number - height/width of the object in pixels, in its own coordinate space (scaling dependent). This is the desired height/width, if set with [[API Region SetHeight|:SetHeight]]() / [[API Region SetHeight|:SetWidth]](), or the actual height/width used if computed from two or more [[API Region SetPoint|:SetPoint]]() calls.
 
=== Arguments ===
 
=== Returns ===
* dimension (number) - height/width of the object in pixels, in its own coordinate space (scaling dependent). This is the desired height/width, if set with [[API Region SetHeight|:SetHeight]]() / [[API Region SetHeight|:SetWidth]](), or the actual height/width used if computed from two or more [[API Region SetPoint|:SetPoint]]() calls.


== Example ==
== Example ==

Latest revision as of 04:47, 15 August 2023

Widget API ← Region < GetHeight

Gets the height and width, respectively, of an object.

dimension = MyObject:GetWidth();
dimension = MyObject:GetHeight();

Parameters[edit]

Arguments[edit]

Returns[edit]

  • dimension (number) - height/width of the object in pixels, in its own coordinate space (scaling dependent). This is the desired height/width, if set with :SetHeight() / :SetWidth(), or the actual height/width used if computed from two or more :SetPoint() calls.

Example[edit]

myAddonOptionsParent = myAddonOptions:GetParent();
myAddonOptions:SetHeight(myAddonOptionsParent:GetHeight() / 2);

Result[edit]

The frame named "myAddonOptions" would be set to half the height of its parent frame.

Notes[edit]

Note that even though FontString has GetWidth()/GetHeight() methods, they behave very differently and have potentially very little to do with the displayed dimension.