Equalizer

Equalizer

new Equalizer()

Source:
Properties:
Name Type Attributes Default Description
options.show_bands Boolean <optional>
true

Show or hide all bands.

Equalizer is a FrequencyResponse, utilizing EqBands instead of simple ChartHandles. An Equalizer - by default - has one EqualizerGraph which contains all bands. Additional EqualizerGraphs can be added. The Equalizer inherits all options of EqualizerGraph.

Extends

Members

_bands :SVGGroup

Source:

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

Type:
  • SVGGroup

bands :Array

Source:

Array of EqBand instances.

Type:
  • Array

baseline :Graph

Source:

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

Type:

element :HTMLDivElement

Source:
Overrides:

The main DIV container. Has class .aux-crossover.

Type:
  • HTMLDivElement

element :HTMLDivElement

Source:
Overrides:

The main DIV container. Has class .aux-equalizer.

Type:
  • HTMLDivElement

Methods

addBand(optionsopt, typeopt)

Source:

Add a new band to the equalizer. Options is an object containing options for the EqBand

Parameters:
Name Type Attributes Default Description
options Object <optional>
{ }

An object containing initial options for the EqBand.

type Object <optional>
EqBand

A widget class to be used for the new band.

Fires:

addBands(options, typeopt)

Source:

Add multiple new EqBands to the equalizer. Options is an array of objects containing options for the new instances of EqBand

Parameters:
Name Type Attributes Default Description
options Array.<Object>

An array of options objects for the EqBand.

type Object <optional>
EqBand

A widget class to be used for the new band.

removeBand(band)

Source:

Remove a band from the widget.

Parameters:
Name Type Description
band EqBand

The EqBand to remove.

Fires:

removeBands(bands)

Source:

Remove multiple EqBand from the equalizer. Options is an array of EqBand instances.

Parameters:
Name Type Description
bands Array.<EqBand>

An array of EqBand instances.

Events

bandadded

Source:

Is fired when a new band was added.

Parameters:
Name Type Description
band EqBand

The EqBand which was added.

bandremoved

Source:

Is fired when a band was removed.

Parameters:
Name Type Description
band EqBand

The EqBand which was removed.

emptied

Source:

Is fired when all bands are removed.