library-mirrors/dat.gui
1
0
Fork 0
mirror of https://github.com/dataarts/dat.gui.git synced 2024-10-10 06:54:18 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Bump docs.

Browse Source
This commit is contained in:
Don McCurdy 2019-03-29 21:43:20 -07:00
parent d979883423
commit 39facfd621
1 changed files with 15 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
API.md
View File

@ -48,6 +48,8 @@ manipulate variables and fire functions on the fly.
* [.removeFolder(folder)](#GUI+removeFolder) * [.removeFolder(folder)](#GUI+removeFolder)
* [.open()](#GUI+open) * [.open()](#GUI+open)
* [.close()](#GUI+close) * [.close()](#GUI+close)
* [.hide()](#GUI+hide)
* [.show()](#GUI+show)
* [.getRoot()](#GUI+getRoot) ⇒ <code>dat.gui.GUI</code> * [.getRoot()](#GUI+getRoot) ⇒ <code>dat.gui.GUI</code>
* [.getSaveObject()](#GUI+getSaveObject) ⇒ <code>Object</code> * [.getSaveObject()](#GUI+getSaveObject) ⇒ <code>Object</code>
@ -62,7 +64,7 @@ manipulate variables and fire functions on the fly.
| [params.load] | <code>Object</code> | | JSON object representing the saved state of this GUI. | | [params.load] | <code>Object</code> | | JSON object representing the saved state of this GUI. |
| [params.parent] | <code>dat.gui.GUI</code> | | The GUI I'm nested in. | | [params.parent] | <code>dat.gui.GUI</code> | | The GUI I'm nested in. |
| [params.autoPlace] | <code>Boolean</code> | <code>true</code> | | | [params.autoPlace] | <code>Boolean</code> | <code>true</code> | |
| [params.hideable] | <code>Boolean</code> | <code>true</code> | If true, GUI is closed by the <kbd>h</kbd> keypress. | | [params.hideable] | <code>Boolean</code> | <code>true</code> | If true, GUI is shown/hidden by <kbd>h</kbd> keypress. |
| [params.closed] | <code>Boolean</code> | <code>false</code> | If true, starts closed | | [params.closed] | <code>Boolean</code> | <code>false</code> | If true, starts closed |
| [params.closeOnTop] | <code>Boolean</code> | <code>false</code> | If true, close/open button shows on top of the GUI | | [params.closeOnTop] | <code>Boolean</code> | <code>false</code> | If true, close/open button shows on top of the GUI |
@ -252,6 +254,18 @@ Opens the GUI.
### gui.close() ### gui.close()
Closes the GUI. Closes the GUI.
**Kind**: instance method of [<code>GUI</code>](#GUI)
<a name="GUI+hide"></a>
### gui.hide()
Hides the GUI.
**Kind**: instance method of [<code>GUI</code>](#GUI)
<a name="GUI+show"></a>
### gui.show()
Shows the GUI.
**Kind**: instance method of [<code>GUI</code>](#GUI) **Kind**: instance method of [<code>GUI</code>](#GUI)
<a name="GUI+getRoot"></a> <a name="GUI+getRoot"></a>