new Patchbay(optionsopt)
- Source:
Properties:
| Name | Type | Description |
|---|---|---|
options.sources |
Object | A VirtualTreeDataView containing sources data. |
options.sinks |
Object | A VirtualTreeDataView containing sinks data. |
Patchbay is a generic widget for managing connections between sources and sinks. It relies on various data models like two VirtualTreeDataView and a ConnectionDataView.
Parameters:
| Name | Type | Attributes | Default | Description |
|---|---|---|---|---|
options |
Object |
<optional> |
{ }
|
An object containing initial options. |
Extends
Members
element :HTMLDivElement
- Source:
- Inherited From:
The main DIV element. Has class .aux-container
Type:
- HTMLDivElement
Methods
hide()
- Source:
- Inherited From:
Starts the transition of the visible to false.
hideChild(child)
- Source:
- Inherited From:
Switches the hidden state of a child to hidden.
The argument is either the child index or the child itself.
Parameters:
| Name | Type | Description |
|---|---|---|
child |
Object | integer | Child or its index. |
isChildHidden(child) → {boolean}
- Source:
- Inherited From:
Returns true if the given child is currently marked as hidden in this container.
Parameters:
| Name | Type | Description |
|---|---|---|
child |
number | Widget |
Returns:
- Type
- boolean
show()
- Source:
- Inherited From:
Starts the transition of the visible to true.
showChild(child)
- Source:
- Inherited From:
Switches the hidden state of a child to shown.
The argument is either the child index or the child itself.
Parameters:
| Name | Type | Description |
|---|---|---|
child |
Object | integer | Child or its index. |
toggleChild(child)
- Source:
- Inherited From:
Toggles the hidden state of a child. The argument is either the child index or the child itself.
Parameters:
| Name | Type | Description |
|---|---|---|
child |
Object | integer | Child or its index. |