maps.nyc.gov

Class: Choice

nyc.Choice

(abstract) new Choice(options)

Collapsible choice control
Parameters:
Name Type Description
options nyc.Choice.Options Constructor options
Source:
Fires:

Extends

Members

(static) uniqueId

Used to generate unique DOM name attributes
Source:

container :JQuery

A JQuery element representation of the container
Type:
  • JQuery
Inherited From:
Source:

currentVal :JQuery

A JQuery element used to display a readable representation of the current value
Type:
  • JQuery
Inherited From:
Source:

Methods

(abstract) changed(event)

Parameters:
Name Type Description
event JQuery.Event The change event object from an input element
Source:

disabled(choiceValue, enabled)

Enable/disable a radio button
Parameters:
Name Type Description
choiceValue string The value of the radio button to disable/enable
enabled boolean The value of enabled
Source:

off(eventName, evtHdlr, hdlrScopeopt)

Remove a previously connected event handler
Parameters:
Name Type Attributes Description
eventName string The name of the event to which the handler will be connected
evtHdlr function The event handler function
hdlrScope Object <optional>
 The scope in which to invoke the event handler
Inherited From:
Source:

on(eventName, evtHdlr, hdlrScopeopt)

Connect a function to an event
Parameters:
Name Type Attributes Description
eventName string The name of the event to which the handler will be connected
evtHdlr function The event handler function
hdlrScope Object <optional>
 The scope in which to invoke the event handler
Inherited From:
Source:

one(eventName, evtHdlr, hdlrScopeopt)

Connect a function to an event for a single invocation
Parameters:
Name Type Attributes Description
eventName string The name of the event to which the handler will be connected
evtHdlr function The event handler function
hdlrScope Object <optional>
 The scope in which to invoke the event handler
Inherited From:
Source:

setChoices()

Enable/disable a radio button
Properties:
Name Type Description
choices Array.<nyc.Choice.Choice> The choices for the user
Source:

trigger(eventName, dataopt)

Trigger a named event with event data
Parameters:
Name Type Attributes Description
eventName string The name of the event to trigger
data Object <optional>
 The event data
Inherited From:
Source:

val() → {Array.<nyc.Choice.Choice>}

Returns the value of the radio button collection
Source:
Returns:
The value of the choice control
Type
Array.<nyc.Choice.Choice>

Type Definitions

Choice

A choice for nyc.Choice.Options
Type:
  • Object
Properties:
Name Type Attributes Default Description
name string The name for the choice
label string The label for the choice
value string The value of the choice
checked boolean <optional>
 false The value of the checked state of the choice
Source:

Options

Constructor options for nyc.Choice
Type:
  • Object
Properties:
Name Type Description
target Element | JQuery | string The target DOM node for creating the collapsible choice control
title string The title to display
choices Array.<nyc.Choice.Choice> The choices for the user
Source:

Events

change

The change event
Type:
Source: