cp.apple.finalcutpro.timeline.IndexMode.md

docs » cp.apple.finalcutpro.timeline.IndexMode

---

Timeline Index Mode Radio Group Module.

API Overview

• Functions - API calls offered directly by the extension
• matches
• Constructors - API calls which return an object, typically one that offers API methods
• IndexMode
• Fields - Variables which can only be accessed from an object returned by a constructor
• captions
• clips
• roles
• tags

API Documentation

Functions

matches

Signature	cp.apple.finalcutpro.timeline.IndexMode.matches(element) -> boolean
Type	Function
Description	Checks if the element is the IndexMode.
Parameters	element - The axuielement to check.
Returns	true if it matches, otherwise false.

Constructors

IndexMode

Signature	cp.apple.finalcutpro.timeline.IndexMode(index) -> cp.apple.finalcutpro.timeline.IndexMode
Type	Constructor
Description	Creates a new IndexMode instance.
Parameters	index - The Index that contains the mode.
Returns	The new IndexMode instance.

Fields

captions

Signature	cp.apple.finalcutpro.timeline.IndexMode.captions <cp.ui.RadioButton>
Type	Field
Description	The RadioButton for the "Captions" mode.

clips

Signature	cp.apple.finalcutpro.timeline.IndexMode.clips <cp.ui.RadioButton>
Type	Field
Description	The RadioButton for the "Clips" mode.

roles

Signature	cp.apple.finalcutpro.timeline.IndexMode.roles <cp.ui.RadioButton>
Type	Field
Description	The RadioButton for the "Roles" mode.

tags

Signature	cp.apple.finalcutpro.timeline.IndexMode.tags <cp.ui.RadioButton>
Type	Field
Description	The RadioButton for the "Tags" mode.