summaryrefslogtreecommitdiff
path: root/API.md
diff options
context:
space:
mode:
authorWuzzy <almikes@aol.com>2016-11-07 21:30:03 +0100
committerWuzzy <almikes@aol.com>2016-11-07 21:30:03 +0100
commitb0bec3da6a03d65e34635795c314830c3c6b10a2 (patch)
tree67e01f509395a391c22a260c9a8f06fec59c1ef5 /API.md
parentd5736bda723e2995e6f70a7511337e6afc4a3f93 (diff)
Add optional text widget boundaries
Diffstat (limited to 'API.md')
-rw-r--r--API.md11
1 files changed, 7 insertions, 4 deletions
diff --git a/API.md b/API.md
index cb92f65..f275f78 100644
--- a/API.md
+++ b/API.md
@@ -404,10 +404,13 @@ this function may be deprecated if it isn't needed anymore.
#### Parameters
* `data`: Text to be written inside the widget
-* `x`: Formspec X coordinate
-* `y`: Formspec Y coordinate
-* `width`: Width of the widget in formspec units
-* `height`: Height of the widget in formspec units
+* `x`: Formspec X coordinate (optional)
+* `y`: Formspec Y coordinate (optional)
+* `width`: Width of the widget in formspec units (optional)
+* `height`: Height of the widget in formspec units (optional)
+
+The default values for the optional parameters result in a widget which fills
+nearly the entire entry page.
#### Return value
A string which contains a complete formspec definition building the widget.