Skip to content

Commit

Permalink
Bump docs.
Browse files Browse the repository at this point in the history
  • Loading branch information
donmccurdy committed Mar 30, 2019
1 parent d979883 commit 39facfd
Showing 1 changed file with 15 additions and 1 deletion.
16 changes: 15 additions & 1 deletion API.md
Expand Up @@ -48,6 +48,8 @@ manipulate variables and fire functions on the fly.
* [.removeFolder(folder)](#GUI+removeFolder)
* [.open()](#GUI+open)
* [.close()](#GUI+close)
* [.hide()](#GUI+hide)
* [.show()](#GUI+show)
* [.getRoot()](#GUI+getRoot) ⇒ <code>dat.gui.GUI</code>
* [.getSaveObject()](#GUI+getSaveObject) ⇒ <code>Object</code>

Expand All @@ -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.parent] | <code>dat.gui.GUI</code> | | The GUI I'm nested in. |
| [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.closeOnTop] | <code>Boolean</code> | <code>false</code> | If true, close/open button shows on top of the GUI |

Expand Down Expand Up @@ -252,6 +254,18 @@ Opens the GUI.
### gui.close()
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)
<a name="GUI+getRoot"></a>

Expand Down

0 comments on commit 39facfd

Please sign in to comment.