Class TimeMap.params.OptionParam

Extends:: TimeMap.params.Param
Defined in:: param.js

A convenience class for those parameters which deal with a value in the options of a TimeMap or TimeMapItem object, setting some additional default functions.

Constructor

TimeMap.params.OptionParam(paramName, options)

Fields

	Field
	paramName :{String} String name of this param
	set Set the state value in the opts object of a TimeMap or TimeMapItem
	sourceName 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 the opts object of a TimeMap or TimeMapItem
	getString(o) Get the current value as a string
	setConfig(config, value) Set a new value on a config object for TimeMap.init() or a particular item
	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.OptionParam(paramName, options)

Parameters (optional)
paramName	{String}	String name of the option parameter
options	{Object}	Container for named arguments (see TimeMap.params.Param)

Field Details

set

Set the state value in the opts object of a TimeMap or TimeMapItem

Parameters (optional)
o	{TimeMap\|TimeMapItem}	Object to modify
value	{mixed}	Value to set

Method Details

get(o) :{mixed}

Get the current state value from the opts object of a TimeMap or TimeMapItem

Parameters (optional)
o	{TimeMap\|TimeMapItem}	Object to inspect

Returns:: {mixed} Current state value

setConfig(config, value)

Set a new value on a config object for TimeMap.init() or a particular item

Parameters (optional)
config	{Object}	Config object to modify
value	{mixed}	Value to set

Timemap.js v.2.0.1

Class TimeMap.params.OptionParam

Constructor

Fields

Methods