Members
(constant) S
- Source:
Global DOM Scheduler.
Methods
calculateEntryPosition()
- Source:
Calculates the pixel position of the entry at the given index.
defineChildElement(widget, name, config)
- Source:
Creates a HTMLElement as a child for a widget. Is used to simplify
widget definitions. E.g. the tiny marker used to display the back-end
value is a simple DIV added using child element. The generic element
is a DIV added to Widget.element with the class
.aux-[name]
. Default creating and adding can be
overwritten with custom callback functions.
Parameters:
Name | Type | Description | |||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
widget |
Widget | The Widget to add the child element to. |
|||||||||||||||||||||||||||||||||||||||||||||
name |
string | The identifier of the element. It will be prefixed
by an underscore |
|||||||||||||||||||||||||||||||||||||||||||||
config |
object | The configuration of the child element. Properties
|
defineChildWidget(widget, name, config)
- Source:
Defines a Widget as a child for another widget. This function
is used internally to simplify widget definitions. E.g. the Icon of a
Button is defined as a child widget. Child widgets
are created/added after the initialization of the parent widget.
If not configured explicitly, all options of the child widget can
be accessed via Widget.options[config.name + "." + option]
on the parent widget.
Parameters:
Name | Type | Description | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
widget |
Widget | The Widget to add the ChildWidget to. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
name |
string | The identifier of the element inside the parent element, |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
config |
object | The configuration of the child element. Properties
|
defineRecalculation(widget, dependencies, cb)
- Source:
Register a reclaculation function. If one of the dependencies changes it will be called before the next call to redraw().
Parameters:
Name | Type | Description |
---|---|---|
widget |
class | The Widget to define a recalculation function for. |
dependencies |
Array.<string> | The list of options this function uses. |
cb |
function | The function to run. The first parameter will be the options of the widget. |
drawPath()
- Source:
Draws an SVG path for the current frequency response curve.
getEntry()
- Source:
Return the entry for the given index. Returns null if there is currently no entry assigned to that index.
getFilterFunctions()
- Source:
Returns the functions representing the frequency response of all active filters.
invalidate(key)
- Source:
Invalidates an option and triggers a redraw() call.
Parameters:
Name | Type | Description |
---|---|---|
key |
string |
isChildHidden(child) → {boolean}
- Source:
Returns true if the given child is currently marked as hidden in this container.
Parameters:
Name | Type | Description |
---|---|---|
child |
number | Widget |
Returns:
- Type
- boolean
observeResize(cb)
- Source:
Calls a callback whenever the widget resizes. This method will trigger one resize.
Parameters:
Name | Type | Description |
---|---|---|
cb |
function |
subscribeOptions(parent, name, callback) → {function}
- Source:
Subscribe to the set of options defined in the nearest AUX-OPTIONS component of a given name and parent.
Parameters:
Name | Type | Description |
---|---|---|
parent |
Node | Parent node. This is usually the parent node of the component which references a given set of options. |
name |
String | Options name. |
callback |
function | Callback to call when a set of options become available. Will be called with null as long as no options set can be found. |
Returns:
- Returns a function which must be called in order to unsubscribe from the options.
- Type
- function
subscribeOptionsAttributes(parent, name, callback) → {function}
- Source:
Subscribe to the set of attributes defined by the inheritance chain of AUX-OPTIONS of a given name and parent.
Parameters:
Name | Type | Description |
---|---|---|
parent |
Node | Parent node. This is usually the parent node of the component which references a given set of options. |
name |
String | Options name. |
callback |
function | Callback to call when a set of options become available. Will be called with a Map of attributes. |
Returns:
- Returns a function which must be called in order to unsubscribe from the options.
- Type
- function
transitionsDisabled()
- Source:
Returns true if transitions are currently disabled on this widget.
updateData(index1, index2, connection, source, sink)
- Source:
Updates the Indicator with the relevant data.
Parameters:
Name | Type | Description |
---|---|---|
index1 |
Integer | The index of the entry in the first list. |
index2 |
Integer | The index of the entry in the second list. |
connection |
ConnectionData | The connection data. |
source |
PortData | The source data. |
sink |
PortData | The sink data. |
updateEntry(entry, virtualtreeview, index, element, treePosition)
- Source:
Update the given entry with the new data.
Parameters:
Name | Type | Description |
---|---|---|
entry |
VirtualTreeEntry | The entry widget. |
virtualtreeview |
VirtualTreeView | The tree data. |
index |
number | The index of the element in the list. |
element |
Datum | The data model of the entry. |
treePosition |
Array | The tree position of the entry. |