cp.apple.finalcutpro.browser.AppearanceAndFiltering.md

docs » cp.apple.finalcutpro.browser.AppearanceAndFiltering

---

Clip Appearance & Filtering Menu Popover

API Overview

• Constants - Useful values which cannot be changed
• DURATION
• Functions - API calls offered directly by the extension
• matches
• Constructors - API calls which return an object, typically one that offers API methods
• AppearanceAndFiltering
• Fields - Variables which can only be accessed from an object returned by a constructor
• button
• clipHeight
• continuousPlayback
• duration
• groupBy
• sortBy
• waveforms
• Methods - API calls which can only be made on an object returned by a constructor
• show

API Documentation

Constants

DURATION

Signature	cp.apple.finalcutpro.browser.AppearanceAndFiltering.DURATION -> table
Type	Constant
Description	A lookup table of the duration values.

Functions

matches

Signature	cp.apple.finalcutpro.browser.AppearanceAndFiltering.matches(element) -> boolean
Type	Function
Description	Checks to see if a GUI element is the "Clip Appearance & Filtering Menu" popover or not.
Parameters	element - The element you want to check
Returns	true if the element is the "Clip Appearance & Filtering Menu" popover otherwise false

Constructors

AppearanceAndFiltering

Signature	cp.apple.finalcutpro.browser.AppearanceAndFiltering(parent) -> AppearanceAndFiltering
Type	Constructor
Description	Constructs a new "Clip Appearance & Filtering Menu" popover.
Parameters	parent - The parent object
Returns	The new AppearanceAndFiltering instance.

Fields

button

Signature	cp.apple.finalcutpro.browser.AppearanceAndFiltering.button <cp.ui.Button>
Type	Field
Description	The "Clip Appearance & Filtering Menu" button.

clipHeight

Signature	cp.apple.finalcutpro.browser.AppearanceAndFiltering.clipHeight <cp.ui.Slider>
Type	Field
Description	The Clip Height Slider.

continuousPlayback

Signature	cp.apple.finalcutpro.browser.AppearanceAndFiltering.continuousPlayback <cp.ui.CheckBox>
Type	Field
Description	The Continuous Playback checkbox.

duration

Signature	cp.apple.finalcutpro.browser.AppearanceAndFiltering.duration <cp.ui.Slider>
Type	Field
Description	The Duration Slider.

groupBy

Signature	cp.apple.finalcutpro.browser.AppearanceAndFiltering.groupBy <cp.ui.PopUpButton>
Type	Field
Description	The "Group By" popup button.

sortBy

Signature	cp.apple.finalcutpro.browser.AppearanceAndFiltering.sortBy <cp.ui.PopUpButton>
Type	Field
Description	The "Sort By" popup button.

waveforms

Signature	cp.apple.finalcutpro.browser.AppearanceAndFiltering.waveforms <cp.ui.CheckBox>
Type	Field
Description	The Waveforms checkbox.

Methods

show

Signature	cp.apple.finalcutpro.browser.AppearanceAndFiltering:show() -> self
Type	Method
Description	Shows the "Clip Appearance & Filtering Menu" Popover
Parameters	None
Returns	Self