Class TimeMap.params.Param
- Defined in:
- param.js
A parameter, with methods to get, set, and serialize the current value.
Constructor
TimeMap.params.Param(paramName, options, sourceName)
Fields
| Field | |
|---|---|
|
paramName
:{String}
String name of this param
|
|
|
String name of the source element, if different
|
Methods
| Method | |
|---|---|
|
fromString(s)
Parse a state value from a string
|
|
|
get(o)
Get the current state value from a TimeMap or TimeMapItem object
|
|
|
getString(o)
Get the current value as a string
|
|
|
set(o, value)
Set the current state value on a TimeMap or TimeMapItem object
|
|
|
setConfig(config, value)
Set a new value on a config object for TimeMap.init()
|
|
|
setConfigXML(config, node)
Set a config object based on an XML tag
|
|
|
setString(o, s)
Set the current state value from a string
|
|
|
toString(value)
Serialize a state value as a string
|
Class Detail
TimeMap.params.Param(paramName, options, sourceName)
| Parameters (optional) | ||
|---|---|---|
| paramName | {String} | String name of the parameter |
| options | {Object} | Container for named arguments |
| sourceName | {String} | String name of the source element, if different |
| options.get | {Function} | Function to get the current param value |
| options.set | {Function} | Function to set the param to a new value |
| options.setConfig | {Function} | Function to set a new value in a config object |
| options.fromStr | {Function} | Function to parse the value from a string |
| options.toStr | {Function} | Function to serialize the current value to a string |
| options.setConfigXML | {Function} | Function to parse the value from an XML node and set to config |
Field Details
paramName
:{String}
String name of this param
sourceName
String name of the source element, if different
Method Details
fromString(s)
:{mixed}
Parse a state value from a string
| Parameters (optional) | ||
|---|---|---|
| s | {String} | String to parse |
- Returns:
- {mixed} Current state value
get(o)
:{mixed}
Get the current state value from a TimeMap or TimeMapItem object
| Parameters (optional) | ||
|---|---|---|
| o | {TimeMap|TimeMapItem} | Object to inspect |
- Returns:
- {mixed} Current state value
getString(o)
Get the current value as a string
| Parameters (optional) | ||
|---|---|---|
| o | {TimeMap|TimeMapItem} | Object to inspect |
set(o, value)
Set the current state value on a TimeMap or TimeMapItem object
| Parameters (optional) | ||
|---|---|---|
| o | {TimeMap|TimeMapItem} | Object to modify |
| value | {mixed} | Value to set |
setConfig(config, value)
Set a new value on a config object for TimeMap.init()
| Parameters (optional) | ||
|---|---|---|
| config | {Object} | Config object to modify |
| value | {mixed} | Value to set |
- See:
- TimeMap.init
setConfigXML(config, node)
Set a config object based on an XML tag
| Parameters (optional) | ||
|---|---|---|
| config | {Object} | Config object to modify |
| node | {XML NodeList} | Parent node of the desired tag |
setString(o, s)
Set the current state value from a string
| Parameters (optional) | ||
|---|---|---|
| o | {TimeMap|TimeMapItem} | Object to modify |
| s | {String} | String version of value to set |
toString(value)
:{String}
Serialize a state value as a string
| Parameters (optional) | ||
|---|---|---|
| value | {mixed} | Value to serialize |
- Returns:
- {String} Serialized string
©2010 Nick Rabinowitz
Documentation generated by JsDoc Toolkit 2.3.2 on Sat Aug 06 2011 13:40:08 GMT-0700 (PDT)
Documentation generated by JsDoc Toolkit 2.3.2 on Sat Aug 06 2011 13:40:08 GMT-0700 (PDT)