Range - Documentation

new Range(optionsopt)

TK.Range is used for calculating linear scales from different values. They are useful to build coordinate systems, calculate pixel positions for different scale types and the like. TK.Range is used e.g. in TK.Scale, TK.MeterBase and TK.Graph to draw elements on a certain position according to a value on an arbitrary scale.

Parameters:

Name	Type	Attributes	Default	Description
`options`	Object	<optional>	{ }	An object containing initial options.

Properties:

Name	Type	Attributes	Default	Description
`options.scale`	String \| function	<optional>	"linear"	Type of the value. `linear`, `decibel`, `log2`, `frequency` or a `function (value, options, coef) {}`. If a function instead of a constant is handed over, it receives the actual options object as the second argument and is supposed to return a coefficient between 0 and 1. If the third argument "coef" is true, it is supposed to return a value depending on a coefficient handed over as the first argument.
`options.reverse`	Boolean	<optional>	false	`true` if the range is reversed.
`options.basis`	Number	<optional>	0	Dimensions of the range, set to width/height in pixels, if you need it for drawing purposes, to 100 if you need percentual values or to 1 if you just need a linear coefficient for a e.g. logarithmic scale.
`options.min`	Number	<optional>	0	The minimum value possible.
`options.max`	Number	<optional>	0	The maximum value possible.
`options.step`	Number	<optional>	1	Step size, needed for e.g. user interaction
`options.shift_up`	Number	<optional>	4	Multiplier for e.g. SHIFT pressed while stepping
`options.shift_down`	Number	<optional>	0.25	Multiplier for e.g. SHIFT + CONTROL pressed while stepping
`options.snap`	Number \| Array	<optional>	0	Snap the value to a virtual grid with this distance. Numbers define the step size between snaps, an array contains a list of values to snap to. Using snap option with float values causes the range to reduce its minimum and maximum values depending on the amount of decimal digits because of the implementation of math in JavaScript. Using a step size of e.g. 1.125 reduces the maximum usable value from 9,007,199,254,740,992 to 9,007,199,254,740.992 (note the decimal point).
`options.round`	Boolean	<optional>	false	if snap is set, decide how to jump between snaps. Setting this to true slips to the next snap if the value is more than on its half way to it. Otherwise the value has to reach the next snap until it is hold there again.

Mixes In:	TK.Ranged
Source:	modules/range.js \| line 22

Extends

TK.Base

Methods inherited from TK.Base

add_event(event, func, prevent, stop)

add_events(events, func)

Add multiple event handlers at once, either as dedicated event handlers or a list of event descriptors with a single handler function.

delegate_events(element) → {HTMLElement}

Delegates all occuring DOM events of a specific DOM node to the widget. This way the widget fires e.g. a click event if someone clicks on the given DOM node.

destroy()

Destroys all event handlers and the options object.

fire_event(event, …args)

Fires an event.

fire_events(events)

Fires several events.

get(key)

Get the value of an option.

has_event_listeners(event) → {boolean}

Test if the event descriptor has some handler functions in the queue.

remove_event(event, fun)

Removes the given function from the event queue. If it is a native DOM event, it removes the DOM event listener as well.

remove_events(events, func)

Remove multiple event handlers at once, either as dedicated event handlers or a list of event descriptors with a single handler function.

set(key, value)

Sets an option. Fires both the events set with arguments key and value; and the event 'set_'+key with arguments value and key.

set_options(optionsopt)

Merges a new options object into the existing one, including deep copies of objects. If an option key begins with the string "on" it is considered as event handler. In this case the value should be the handler function for the event with the corresponding name without the first "on" characters.

userset(key, value)

Sets an option by user interaction. Emits the userset event. The userset event can be cancelled (if an event handler returns false), in which case the option is not set. Returns true if the option was set, false otherwise. If the option was set, it will emit a useraction event.

TK.Range