Crossover

Crossover

new Crossover(optionsopt)

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

Define if bands are allowed to leap over each other.
options.distance Number <optional>
 0

Set a minimal distance between bands. This has no effect is leap=true. The value is interpreted as a factor of the frequency of the next band, e.g. if distance is 0.2 and a band is at 1kHz, then a second lower band cannot be moved beyond 800Hz.

Crossover is a Equalizer displaying the response of a multi-band crossover filter. Crossover uses CrossoverBand as response handles.

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

An object containing initial options.

Extends

Members

_bands :SVGGroup

Source:
Inherited From:

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

Type:
  • SVGGroup

bands :Array

Source:
Inherited From:

Array of EqBand instances.

Type:
  • Array

baseline :Graph

Source:
Inherited From:

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

Methods

addBand(optionsopt, typeopt)

Source:
Overrides:

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:
Inherited From:

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:
Inherited From:

Remove a band from the widget.

Parameters:
Name Type Description
band EqBand

The EqBand to remove.
Fires:

removeBands(bands)

Source:
Inherited From:

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:
Inherited From:

Is fired when a new band was added.

Parameters:
Name Type Description
band EqBand

The EqBand which was added.

bandremoved

Source:
Inherited From:

Is fired when a band was removed.

Parameters:
Name Type Description
band EqBand

The EqBand which was removed.

emptied

Source:
Inherited From:

Is fired when all bands are removed.