-
Notifications
You must be signed in to change notification settings - Fork 10
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Component is a funny word.
- Loading branch information
bbb
committed
Feb 27, 2018
1 parent
73ec449
commit c1b3a75
Showing
2 changed files
with
75 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,69 @@ | ||
.. highlight:: javascript | ||
|
||
.. _component: | ||
|
||
Component object | ||
=================== | ||
|
||
``Component`` | ||
|
||
**Description** | ||
|
||
The **component** object represents something which has been added or applied to a trackItem. | ||
|
||
---- | ||
|
||
========== | ||
Attributes | ||
========== | ||
|
||
.. _component.displayName: | ||
|
||
name | ||
********************************************* | ||
|
||
``component.displayName`` | ||
|
||
**Description** | ||
|
||
The name of the component, as it is displayed to the user. Localized. | ||
|
||
**Type** | ||
|
||
String; read-only. | ||
|
||
|
||
---- | ||
|
||
.. _component.matchName: | ||
|
||
name | ||
********************************************* | ||
|
||
``component.matchName`` | ||
|
||
**Description** | ||
|
||
The name of the component, as it is loaded from disk; used to uniquely identify effect plug-ins. | ||
|
||
**Type** | ||
|
||
String; read-only. | ||
|
||
---- | ||
|
||
.. _component.properties: | ||
|
||
properties | ||
********************************************* | ||
|
||
``component.properties`` | ||
|
||
**Description** | ||
|
||
The properties of the component in question; typically, these are effect parameters. | ||
|
||
**Type** | ||
|
||
Array of components, read-only. | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters