MultiMeter - Documentation

new MultiMeter(optionsopt)

TK.MultiMeter is a collection of TK.LevelMeters to show levels of channels containing multiple audio streams. It offers all options of TK.LevelMeter and TK.MeterBase which are passed to all instantiated level meters.

Parameters:

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

Properties:

Name	Type	Attributes	Default	Description
`options.count`	Number	<optional>	2	The amount of level meters.
`options.title`	String	<optional>	""	The title of the multi meter. Set to `false` to hide the title from the DOM.
`options.titles`	Array.<String>	<optional>	["L", "R"]	An Array containing titles for the level meters. Their order is the same as the meters.
`options.values`	Array.<Number>	<optional>	[]	An Array containing values for the level meters. Their order is the same as the meters.
`options.labels`	Array.<Number>	<optional>	[]	An Array containing label values for the level meters. Their order is the same as the meters.
`options.clips`	Array.<Boolean>	<optional>	[]	An Array containing clippings for the level meters. Their order is the same as the meters.
`options.peaks`	Array.<Number>	<optional>	[]	An Array containing peak values for the level meters. Their order is the same as the meters.
`options.tops`	Array.<Number>	<optional>	[]	An Array containing values for top for the level meters. Their order is the same as the meters.
`options.bottoms`	Array.<Number>	<optional>	[]	An Array containing values for bottom for the level meters. Their order is the same as the meters.

Source:

widgets/multimeter.js | line 61

Extends

TK.Container

Members

element :HTMLDivElement

The main DIV container. Has class toolkit-multi-meter.

Overrides:	TK.Container#element
Source:	widgets/multimeter.js \| line 103

title :HTMLDivElement

The TK.Label widget displaying the meters title.

Source:

widgets/multimeter.js | line 170

Methods inherited from TK.Container

append_child(child)

Appends child.element to the container element and registers child as a child widget.

append_children(children)

Calls TK.Container#append_child for an array of widgets.

force_hide()

Immediately switches the display state of this container to hide. Unlike TK.Container#hide this method does not perform the hiding transition and immediately modifies the DOM by setting the toolkit-hide class.

force_show()

Immediately switches the display state of this container to show. Unlike TK.Container#hide this method does not perform the hiding transition and immediately modifies the DOM by setting the toolkit-show class.

hide()

Starts the transition of the display_state to hide.

hide_child(child)

Switches the hidden state of a child to hidden. The argument is either the child index or the child itself.

show()

Starts the transition of the display_state to show.

show_child(child)

Switches the hidden state of a child to shown. The argument is either the child index or the child itself.

toggle_child(child)

Toggles the hidden state of a child. The argument is either the child index or the child itself.

Methods inherited from TK.Widget

add_child(child)

Registers a widget as a child widget. This method is used to build up the widget tree. It does not modify the DOM tree.

add_children(a)

Registers an array of widgets as children.

all_children()

Returns an array of all children.

enable_draw()

Schedules this widget for drawing.

get_style()

Returns the computed style of this widgets DOM element.

hidden()

Returns the current hidden status.

remove_child(child)

Removes a child widget. Note that this method only modifies the widget tree and does not change the DOM.

remove_children(a)

Removes an array of children.

set(key, value)

Sets an option.

set_style()

Sets a CSS style property in this widgets DOM element.

toggle_hidden()

TK.Toggle the hidden status. This is equivalent to calling hide() or show(), depending on the current hidden status of this widget.

visible_children()

Returns an array of all visible children.

widgetize()

Set the DOM elements of this widgets. This method is usually only used internally. Basically it means to add the id from options and set a basic CSS class. If delegate is true, basic events will be delegated from the element to the widget instance if classify is true, CSS functions will be bound to the widget instance.

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_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.

Events inherited from TK.Container

hide

Is fired when the container is hidden.

show

Is fired when the container is shown.

Events inherited from TK.Widget

GenericDOMEvents

Generic DOM events. Please refer to W3Schools for further details.

classified

Is fired when a widget is classified.

destroy

Is fired when a widget is destroyed.

doubleclick

Is fired after a double click appeared. Set dblclick to 0 to disable click event handling.

initialized

Is fired when a widget is initialized.

redraw

Is fired when a redraw is executed.

resize

The resize event is emitted whenever a widget is being resized. This event can be used to e.g. measure its new size. Note that some widgets do internal adjustments after the resize event. If that is relevant, the TK.Widget#resized event can be used, instead.