Class: Choice

Extends

• module:nyc/Container~Container

Methods

---

append(elements)

A method to append elements to the container

Parameters:

Name	Type	Description
elements	jQuery | Element | Array.<Element> | string	The element to append

Inherited From:

• module:nyc/Container~Container#append

Source:

• Container.js, line 63

Returns:

The container

Type

jQuery

---

find(selector)

A method to return elements in the container

Parameters:

Name	Type	Description
selector	string	jQuery selector

Inherited From:

• module:nyc/Container~Container#find

Source:

• Container.js, line 43

Returns:

The element

Type

jQuery

---

getContainer()

A method to return a control container HTML element wrapped in a JQuery

Inherited From:

• module:nyc/Container~Container#getContainer

Source:

• Container.js, line 33

Returns:

The the control container HTML element wrapped in a JQuery

Type

jQuery

---

prepend(elements)

A method to prepend elements to the container

Parameters:

Name	Type	Description
elements	jQuery | Element | Array.<Element> | string	The element to append

Inherited From:

• module:nyc/Container~Container#prepend

Source:

• Container.js, line 53

Returns:

The container

Type

jQuery

---

setChoices(choices)

Set the available choices

Parameters:

Name	Type	Description
choices	Array.<module:nyc/Choice~Choice.Choice>	The choices

Source:

• Choice.js, line 50

---

val(choices)

Get or set the seleced choices

Parameters:

Name	Type	Description
choices	Array.<module:nyc/Choice~Choice.Choice>	The choices

Source:

• Choice.js, line 81

Type Definitions

---

Choice

A choice for module:nyc/Choice~Choice

Type:

• Object

Properties:

Name	Type	Argument	Default	Description
name	string			The name for the choice
label	string			The label for the choice
value	Array.<Object>			The value of the choice
checked	boolean	<optional>	false	The value of the checked state of the choice

Source:

• Choice.js, line 137

---

Options

Constructor options for module:nyc/Choice~Choice

Type:

• Object

Properties:

Name	Type	Argument	Default	Description
target	jQuery | Element | string			The target DOM node for creating the choice control
choices	Array.<module:nyc/Choice~Choice.Choice>			The choices
radio	boolean	<optional>	false	Checkbox or radio button

Source:

• Choice.js, line 147

Events

---

change

The change event

Type: module:nyc/Choice~Choice

Source:

• Choice.js, line 149