cp.apple.finalcutpro.inspector.color.ColorBoard.md

docs » cp.apple.finalcutpro.inspector.color.ColorBoard

---

Color Board Module.

API Overview

• Constants - Useful values which cannot be changed
• aspect
• Variables - Configurable values
• currentAspect
• Functions - API calls offered directly by the extension
• matches
• Constructors - API calls which return an object, typically one that offers API methods
• ColorBoard
• Fields - Variables which can only be accessed from an object returned by a constructor
• aspectGroup
• color
• contentUI
• exposure
• isActive
• isShowing
• saturation
• Methods - API calls which can only be made on an object returned by a constructor
• childUI
• current
• doHide
• doNextAspect
• doResetCurrent
• doSelectAspect
• doShow
• hide
• nextAspect
• reset
• show

API Documentation

Constants

aspect

Signature	cp.apple.finalcutpro.inspector.color.ColorBoard.aspect -> table
Type	Constant
Description	A table containing tables of all the aspect panel settings

Variables

currentAspect

Signature	cp.apple.finalcutpro.inspector.color.ColorBoard.currentAspect -> string
Type	Variable
Description	The current aspect as a string.

Functions

matches

Signature	cp.apple.finalcutpro.inspector.color.ColorBoard.matches(element) -> boolean
Type	Function
Description	Checks to see if a GUI element is the Color Board.
Parameters	element - The element you want to check
Returns	true if the element is a Color Board otherwise false

Constructors

ColorBoard

Signature	cp.apple.finalcutpro.inspector.color.ColorBoard(parent) -> ColorBoard object
Type	Constructor
Description	Creates a new ColorBoard object
Parameters	parent - The parent
Returns	A ColorBoard object

Fields

aspectGroup

Signature	cp.apple.finalcutpro.inspector.color.ColorBoard.aspectGroup <cp.ui.RadioGroup>
Type	Field
Description	The RadioGroup for the 'aspect' currently being controlled

color

Signature	cp.apple.finalcutpro.inspector.color.ColorBoard.color <ColorBoardAspect>
Type	Field
Description	The color aspect of the color board.

contentUI

Signature	cp.apple.finalcutpro.inspector.color.ColorBoard.contentUI <cp.prop: hs._asm.axuielement; read-only; live>
Type	Field
Description	Returns the hs._asm.axuielement object for the Color Board's content.

exposure

Signature	cp.apple.finalcutpro.inspector.color.ColorBoard.exposure <ColorBoardAspect>
Type	Field
Description	The exposure aspect of the color board.

isActive

Signature	cp.apple.finalcutpro.inspector.color.ColorBoard:isActive <cp.prop: boolean; read-only>
Type	Field
Description	Returns whether or not the Color Board is active

isShowing

Signature	cp.apple.finalcutpro.inspector.color.ColorBoard.isShowing <cp.prop: boolean; read-only; live>
Type	Field
Description	Returns whether or not the Color Board is visible.

saturation

Signature	cp.apple.finalcutpro.inspector.color.ColorBoard.saturation <ColorBoardAspect>
Type	Field
Description	The saturation aspect of the color board.

Methods

childUI

Signature	cp.apple.finalcutpro.inspector.color.ColorBoard:childUI(id) -> hs._asm.axuielement object
Type	Method
Description	Gets the hs._asm.axuielement object for a child with the specified ID.
Parameters	axID - AXIdentifier of the child
Returns	An hs._asm.axuielement object

current

Signature	cp.apple.finalcutpro.inspector.color.ColorBoard:current() -> ColorBoardAspect
Type	Method
Description	Returns the currently-selected 'aspect' of the Color Board - either the color, saturation or exposure.
Parameters	None
Returns	The currently active ColorBoardAspect, or the color aspect if none is showing.

doHide

Signature	cp.apple.finalcutpro.inspector.color.ColorBoard:doHide() -> cp.rx.go.Statement
Type	Method
Description	A Statement that hides the Color Board.
Parameters	None
Returns	The Statement, which will send a single true if successful, otherwise false, or an error being sent.

doNextAspect

Signature	cp.apple.finalcutpro.inspector.color.ColorBoard:doNextAspect() -> cp.rx.go.Statement<boolean>
Type	Method
Description	A Statement that toggles the Color Board Panels between "Color", "Saturation" and "Exposure".
Parameters	None
Returns	ColorBoard object

doResetCurrent

Signature	cp.apple.finalcutpro.inspector.color.ColorBoard:doResetCurrent([range]) -> cp.rx.go.Statement
Type	Method
Description	A Statement that will reset the current 'active' aspect (e.g. color) in the Color Board.
Parameters	range - Optional range to reset in the current aspect.
Returns	The Statement, resolving with true if completed or an error if not.

doSelectAspect

Signature	cp.apple.finalcutpro.inspector.color.ColorBoard:doSelectAspect(index) -> cp.rx.go.Statement
Type	Method
Description	A Statement that will attempt to select the specified aspect index.
Parameters	index - The index to select.
Returns	The Statement, which will resolve to true if successful, or throw an error if not.

doShow

Signature	cp.apple.finalcutpro.inspector.color.ColorBoard:doShow() -> cp.rx.go.Statement
Type	Method
Description	A Statement that shows the Color Board.
Parameters	None
Returns	The Statement, which will send a single true if successful, otherwise false, or an error being sent.

hide

Signature	cp.apple.finalcutpro.inspector.color.ColorBoard:hide() -> self
Type	Method
Description	Hides the Color Board
Parameters	None
Returns	ColorBoard object

nextAspect

Signature	cp.apple.finalcutpro.inspector.color.ColorBoard:nextAspect() -> ColorBoard object
Type	Method
Description	Toggles the Color Board Panels between "Color", "Saturation" and "Exposure"
Parameters	None
Returns	ColorBoard object

reset

Signature	cp.apple.finalcutpro.inspector.color.ColorBoard:reset() -> self
Type	Method
Description	Resets the current aspect.
Parameters	None
Returns	ColorBoard object

show

Signature	cp.apple.finalcutpro.inspector.color.ColorBoard:show() -> ColorBoard object
Type	Method
Description	Shows the Color Board
Parameters	None
Returns	ColorBoard object