library-mirrors/dat.gui
1
0
Fork 0
mirror of https://github.com/dataarts/dat.gui.git synced 2024-12-12 04:08:27 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Add dropdown documentation

Browse Source
This commit is contained in:
Tomas 2020-04-22 10:58:03 +02:00 committed by GitHub
parent 071edeb334
commit 5a7f51d29f
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 22 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
API.md
View File

@ -41,6 +41,7 @@ manipulate variables and fire functions on the fly.
* [.load](#GUI+load) : <code>Object</code> * [.load](#GUI+load) : <code>Object</code>
* [.useLocalStorage](#GUI+useLocalStorage) : <code>Boolean</code> * [.useLocalStorage](#GUI+useLocalStorage) : <code>Boolean</code>
* [.add(object, property, [min], [max], [step])](#GUI+add) ⇒ [<code>Controller</code>](#Controller) * [.add(object, property, [min], [max], [step])](#GUI+add) ⇒ [<code>Controller</code>](#Controller)
* [.add(object, property, values)](#GUI+add2) ⇒ [<code>Controller</code>](#Controller)
* [.addColor(object, property)](#GUI+addColor) ⇒ [<code>Controller</code>](#Controller) * [.addColor(object, property)](#GUI+addColor) ⇒ [<code>Controller</code>](#Controller)
* [.remove(controller)](#GUI+remove) * [.remove(controller)](#GUI+remove)
* [.destroy()](#GUI+destroy) * [.destroy()](#GUI+destroy)
@ -171,6 +172,27 @@ gui.add(person, 'name');
var person = {age: 45}; var person = {age: 45};
gui.add(person, 'age', 0, 100); gui.add(person, 'age', 0, 100);
``` ```
<a name="GUI+addColor2"></a>
### gui.add(object, property, values) ⇒ [<code>Controller</code>](#Controller)
Adds a new [Controller](#Controller) to the GUI. The type of controller created
is a `<select>` dropdown.
**Kind**: instance method of [<code>GUI</code>](#GUI)
**Returns**: [<code>Controller</code>](#Controller) - The controller that was added to the GUI.
| Param | Type | Description |
| --- | --- | --- |
| object | <code>Object</code> | The object to be manipulated |
| property | <code>String</code> | The name of the property to be manipulated |
| values | <code>Array</code> | Array of possible options' values |
**Example**
```js
// Add a dropdown controller.
var person = {name: 'Sam'};
gui.add(person, 'name', ['Sam', 'Alex', 'Riley']);
```
<a name="GUI+addColor"></a> <a name="GUI+addColor"></a>
### gui.addColor(object, property) ⇒ [<code>Controller</code>](#Controller) ### gui.addColor(object, property) ⇒ [<code>Controller</code>](#Controller)