Skip to content

Commit

Permalink
Added Component object
Browse files Browse the repository at this point in the history
Component is a funny word.
  • Loading branch information
bbb committed Feb 27, 2018
1 parent 73ec449 commit c1b3a75
Show file tree
Hide file tree
Showing 2 changed files with 75 additions and 0 deletions.
69 changes: 69 additions & 0 deletions 8 - Component object/component.rst
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.

6 changes: 6 additions & 0 deletions index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -45,3 +45,9 @@ Welcome to the Premiere Scripting Guide!
:caption: Chapter 7 - Track Item object

7 - Track Item object/trackitem

.. toctree::
:maxdepth: 2
:caption: Chapter 8 - Component object

8 - Component object/component

0 comments on commit c1b3a75

Please sign in to comment.