TK.Equalizer

new Equalizer()

TK.Equalizer is a TK.ResponseHandler adding some EqBands instead of simple ResponseHandles.

Parameters:
Name Type Attributes Default Description
options.options.accuracy Number <optional>
1

The distance between points on the x axis.

options.bands Array <optional>
[]

A list of bands to add on init.

options.show_bands Boolean <optional>
true

Show or hide all bands.

Properties:
Name Type Description
options Object
Source:

Extends

Members

_bands :SVGGroup

The SVG group containing all the bands SVG elements. Has class toolkit-eqbands.

Source:

bands :Array

Array of TK.EqBand instances.

Source:

baseline :TK.Graph

The graph drawing the zero line. Has class toolkit-baseline

Source:

element :HTMLDivElement

The main DIV container. Has class toolkit-equalizer.

Overrides:
Source:

Members inherited from TK.ResponseHandler

_handles :SVGImage

An SVG group element containing all TK.ResponseHandle graphics. Has class toolkit-response-handles.

handles :Array

An array containing all TK.ResponseHandle instances.

Members inherited from TK.Chart

_graphs :SVGGroup

The group containing all graphs. Has class toolkit-graphs.

_key :SVGGroup

The group containing all descriptions. Has class toolkit-key.

_key_background :SVGRect

The rectangle of the key. Has class toolkit-background.

_key_txt :SVGText

The text label for the key. Has class toolkit-key-text.

_title :SVGText

The title of the chart. Has class toolkit-title.

grid :TK.Grid

The grid for the chart.

range_x :TK.Range

The range for the x axis.

range_y :TK.Range

The range for the y axis.

Methods inherited from TK.Chart

add_graph(graph) → {Object}

Add a graph to the chart.

empty()

Remove all graphs from the chart.

remove_graph(graph)

Remove a graph from the chart.

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.

force_hide()

This is an alias for hide, which may be overloaded. See TK.Container for an example.

force_show()

This is an alias for hide, which may be overloaded. See TK.Container for an example.

get_style()

Returns the computed style of this widgets DOM element.

hidden()

Returns the current hidden status.

hide()

Make the widget hidden. This does not modify the DOM, instead it will stop rendering this widget. Options changed after calling hide will only be rendered (i.e. applied to the DOM) when the widget is made visible again using TK.Widget#show.

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.

show()

Make the widget visible. This does not modify the DOM, instead it will only schedule the widget for rendering.

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)

Register an event handler.

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, func)

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.

Events

bandadded

Is fired when a new band was added.

Parameters:
Name Type Description
band TK.Band

The TK.EqBand which was added.

Source:

bandremoved

Is fired when a band was removed.

Parameters:
Name Type Description
band TK.EqBand

The TK.EqBand which was removed.

Source:

emptied

Is fired when all bands are removed.

Overrides:
Source:

Events inherited from TK.ResponseHandler

handleadded

Is fired when a new handle was added.

handleremoved

Is fired when a handle was removed.

Events inherited from TK.Chart

graphadded

Is fired when a graph was added. Arguments are the graph and its position in the array.

graphremoved

Is fired when a graph was removed. Arguments are the graph and its position in the array.

Events inherited from TK.Widget

classified

Is fired when a widget is classified.

destroy

Is fired when a widget is destroyed.

hide

The hide event is emitted when a widget is hidden and is not rendered anymore. This happens both with browser visibility changes and also internally when using layout widgets such as TK.Pager.

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.

resized

The resized event is emitted after each rendering frame, which was triggered by a resize event.

set

The set event is emitted when an option was set using the TK.Widget#set method. The arguments are the option name and its new value.

Note that this happens both for user interaction and programmatical option changes.

show

The show event is emitted when a widget is shown and is being rendered. This is the counterpart to TK.Widget#hide.

stylized

Is fired when a widget is stylized.

widgetize

Is fired when a widget is widgetized.

Events inherited from TK.Base

delegated

Is fired when an element is delegated.

set_[option]

Is fired when an option is set.