Dynamics

Dynamics

new Dynamics()

Source:
Properties:
Name Type Attributes Default Description
options.min Number <optional>
 -96

Minimum decibels to display.
options.max Number <optional>
 24

Maximum decibels to display.
options.scale String <optional>
 "linear"

Scale of the display, see Range for details.
options.type String <optional>
 false

Type of the dynamics: compressor, expander, gate, limiter or false to draw your own graph.
options.threshold Number <optional>
 0

Threshold of the dynamics.
options.ratio Number <optional>
 1

Ratio of the dynamics.
options.makeup Number <optional>
 0

Makeup of the dynamics. This raises the whole graph after all other property are applied.
options.range Number <optional>
 0

Range of the dynamics. Only used in type expander. The maximum gain reduction.
options.gain Number <optional>
 0

Input gain of the dynamics.
options.reference Number <optional>
 0

Input reference of the dynamics.
options.knee Number <optional>
 0

Soft knee width of the compressor in dB. Replaces the hard knee of the compressor at the salient point by a quadratic curve.
options.grid_labels function <optional>
 function (val) { return val + (!val ? "dB":""); }

Callback to format the labels of the Grid.
options.db_grid Number <optional>
 12

Draw a grid line every [n] decibels.
options.show_handle Boolean <optional>
 true

Draw a handle to manipulate threshold and ratio.
options.format_label Boolean | function <optional>
 false

Function to format the handle label.

Dynamics are based on Chart and display the characteristics of dynamic processors. They are square widgets drawing a Grid automatically based on the range.

Extends

Members

_graphs :SVGGroup

Source:
Inherited From:

The SVG group containing all graphs. Has class .aux-graphs.

Type:
  • SVGGroup

_handles :SVGGroup

Source:
Overrides:

The SVG group containing all handles. Has class .aux-handles.

Type:
  • SVGGroup

_label :SVGText

Source:
Inherited From:

The label of the chart. Has class .aux-label.

Type:
  • SVGText

element :HTMLDivElement

Source:
Overrides:

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

Type:
  • HTMLDivElement

grid :Grid

Source:
Inherited From:

The grid element of the chart. Has class .aux-grid.

Type:

handle :ChartHandle

Source:

The handle to set threshold. Has class .aux-handle

Type:

handles :Array

Source:
Inherited From:

An array containing all ChartHandle instances.

Type:
  • Array

range_x :Range

Source:
Inherited From:

The Range for the x axis.

Type:

range_y :Range

Source:
Inherited From:

The Range for the y axis.

Type:

response :Graph

Source:

The graph drawing the dynamics response. Has class .aux-response

Type:

steady :Graph

Source:

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

Type:

Methods

addChild(child)

Source:
Inherited From:
See:

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

Parameters:
Name Type Description
child Widget

The child to add.
Fires:
  • Widget#event:child_added

addChildren(a)

Source:
Inherited From:

Registers an array of widgets as children.

Parameters:
Name Type Description
a Array.<Widget>

An array of Widgets.

addGraph(graph) → {Object}

Source:
Inherited From:

Add a graph to the chart.

Parameters:
Name Type Description
graph Object

The graph to add. This can be either an instance of Graph or an object of options to Graph.
Fires:
Returns:

The instance of Graph.

Type
Object

addGraphs(options)

Source:
Inherited From:

Add multiple new Graph to the widget. Options is an array of objects containing options for the new instances of Graph.

Parameters:
Name Type Description
options Array.<Object>

An array of options objects for the Graph.

addHandle(optionsopt, typeopt)

Source:
Inherited From:

Add a new handle to the widget. Options is an object containing options for the ChartHandle.

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

An object containing initial options. - The options for the ChartHandle.
type Object <optional>
 ChartHandle

A widget class to be used as the new handle.
Fires:

addHandles(options, typeopt)

Source:
Inherited From:

Add multiple new ChartHandle to the widget. Options is an array of objects containing options for the new instances of ChartHandle.

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

An array of options objects for the ChartHandle.
type Object <optional>
 ChartHandle

A widget class to be used for the new handles.

allChildren()

Source:
Inherited From:

Returns an array of all children.

appendChild(child)

Source:
Inherited From:

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

Parameters:
Name Type Description
child Widget

The child widget to append.

appendChildren(children)

Source:
Inherited From:

Calls Widget#appendChild for an array of widgets.

Parameters:
Name Type Description
children Array.<Widget>

The child widgets to append.

destroy()

Source:
Inherited From:

Dispose of this Widget.

destroyAndRemove()

Source:
Inherited From:

Dispose of this Widget and remove it from the DOM.

disableTansitions()

Source:
Inherited From:

Disable CSS transitions.

empty()

Source:
Inherited From:

Remove all graphs from the chart.

Fires:

enableDraw()

Source:
Inherited From:

Schedules this widget for drawing.

Fires:

enableDrawChildren()

Source:
Inherited From:

Enables rendering for all children of this widget.

enableTransitions()

Source:
Inherited From:

Enable CSS transitions.

forceHide()

Source:
Inherited From:

Hide the widget immediately by applying the class aux-hide. Does not call disableDraw().

forceShow()

Source:
Inherited From:

Show the widget immediately by applying the class aux-show. Does not call enableDraw().

getStyle()

Source:
Inherited From:

Returns the computed style of this widget's DOM element.

hidden()

Source:
Inherited From:

Returns the current hidden status.

hide()

Source:
Inherited From:

Hide the widget. This will result in the class aux-hide being applied to this widget in the next rendering step.

invalidate(key)

Source:
Inherited From:

Invalidates an option and triggers a redraw() call.

Parameters:
Name Type Description
key string

invalidateAll()

Source:
Inherited From:

Invalidates all dependencies which will trigger all renderers to rerun.

observeResize(cb)

Source:
Inherited From:

Calls a callback whenever the widget resizes. This method will trigger one resize.

Parameters:
Name Type Description
cb function

removeChild(child)

Source:
Inherited From:

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

Parameters:
Name Type Description
child Widget

The child to remove.
Fires:
  • Widget#event:child_removed

removeChildren(a)

Source:
Inherited From:

Removes an array of children.

Parameters:
Name Type Description
a Array.<Widget>

An array of Widgets.

removeGraph(graph)

Source:
Inherited From:

Remove a graph from the chart.

Parameters:
Name Type Description
graph Graph

The Graph to remove.
Fires:

removeHandle(handle)

Source:
Inherited From:

Remove a handle from the widget.

Parameters:
Name Type Description
handle ChartHandle

The ChartHandle to remove.
Fires:

removeHandles(handles)

Source:
Inherited From:

Remove multiple or all ChartHandle from the widget.

Parameters:
Name Type Description
handles Array.<ChartHandle>

An array of ChartHandle instances. If the argument reveals to false, all handles are removed from the widget.

set(key, value)

Source:
Overrides:

Sets an option.

Parameters:
Name Type Description
key string

The option name.
value

The option value.

setStyle()

Source:
Inherited From:

Sets a CSS style property in this widget's DOM element.

show()

Source:
Inherited From:

Make the widget visible. This will apply the class aux-show during the next rendering step.

toggleHidden()

Source:
Inherited From:

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

transitionsDisabled()

Source:
Inherited From:

Returns true if transitions are currently disabled on this widget.

visibleChildren()

Source:
Inherited From:

Returns an array of all visible children.

Events

destroy

Source:
Inherited From:

Is fired when a widget is destroyed.

doubleclick

Source:
Inherited From:

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

Parameters:
Name Type Description
event string

The browsers MouseEvent.

emptied

Source:
Overrides:

Is fired when all graphs are removed from the chart.

GenericDOMEvents

Source:
Inherited From:

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

graphadded

Source:
Inherited From:

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

Parameters:
Name Type Description
graph Graph

The Graph which was added.

graphremoved

Source:
Inherited From:

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

Parameters:
Name Type Description
graph Graph

The Graph which was removed.

handleadded

Source:
Inherited From:

Is fired when a new handle was added.

Parameters:
Name Type Description
handle ChartHandle

The ChartHandle which was added.

handleremoved

Source:
Inherited From:

Is fired when a handle was removed.

hide

Source:
Inherited From:

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

initialized

Source:
Inherited From:

Is fired when a widget is initialized.

resize

Source:
Inherited From:

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 Widget#resized event can be used instead.

resized

Source:
Inherited From:

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

set

Source:
Inherited From:

The set event is emitted when an option was set using the 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

Source:
Inherited From:

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

visibility

Source:
Inherited From:

Is fired when the visibility state changes. The first argument is the visibility state, which is either true or false.