#cp.apple.finalcutpro.inspector.color.ColorBoardAspect

Represents a particular aspect of the color board (Color/Saturation/Exposure).

#API Overview

Constants - Useful values which cannot be changed

Constructors - API calls which return an object, typically one that offers API methods

Fields - Variables which can only be accessed from an object returned by a constructor

Methods - API calls which can only be made on an object returned by a constructor


Signature	`cp.apple.finalcutpro.inspector.color.ColorBoardAspect.ids -> table`
Type	Constant
Description	A table containing the list of aspect IDs ("color", "saturation", "exposure").
Notes	None
Source	src/extensions/cp/apple/finalcutpro/inspector/color/ColorBoardAspect.lua line 20


Signature	`cp.apple.finalcutpro.inspector.color.ColorBoardAspect(parent, index[, hasAngle]) -> ColorBoardAspect`
Type	Constructor
Description	Creates a new `ColorBoardAspect` object.
Parameters	parent - The parent object. index - The Color Board Aspect Index. hasAngle - If `true`, the aspect has an `angle` parameter. Defaults to `false`
Returns	A new `ColorBoardAspect object.
Notes	None
Examples	None
Source	src/extensions/cp/apple/finalcutpro/inspector/color/ColorBoardAspect.lua line 38


Signature	`cp.apple.finalcutpro.inspector.color.ColorBoardAspect.highlights <ColorPuck>`
Type	Field
Description	The Highlights ColorPuck object.
Notes	None
Source	src/extensions/cp/apple/finalcutpro/inspector/color/ColorBoardAspect.lua line 222


Signature	`cp.apple.finalcutpro.inspector.color.ColorBoardAspect.master <ColorPuck>`
Type	Field
Description	The Master ColorPuck object.
Notes	None
Source	src/extensions/cp/apple/finalcutpro/inspector/color/ColorBoardAspect.lua line 189


Signature	`cp.apple.finalcutpro.inspector.color.ColorBoardAspect.midtones <ColorPuck>`
Type	Field
Description	The Midtones ColorPuck object.
Notes	None
Source	src/extensions/cp/apple/finalcutpro/inspector/color/ColorBoardAspect.lua line 211


Signature	`cp.apple.finalcutpro.inspector.color.ColorBoardAspect:selected() -> boolean`
Type	Field
Description	Is the Color Board Aspect selected?
Notes	None
Source	src/extensions/cp/apple/finalcutpro/inspector/color/ColorBoardAspect.lua line 68


Signature	`cp.apple.finalcutpro.inspector.color.ColorBoardAspect.shadows <ColorPuck>`
Type	Field
Description	The Shadows ColorPuck object.
Notes	None
Source	src/extensions/cp/apple/finalcutpro/inspector/color/ColorBoardAspect.lua line 200


Signature	`cp.apple.finalcutpro.inspector.color.ColorBoardAspect:doShow() -> cp.rx.go.Statement`
Type	Method
Description	A Statement that shows this Color Board Aspect.
Parameters	None
Returns	The `Statement`, resolving to `true` if successful or throwing an error if not.
Notes	None
Examples	None
Source	src/extensions/cp/apple/finalcutpro/inspector/color/ColorBoardAspect.lua line 94


Signature	`cp.apple.finalcutpro.inspector.color.ColorBoardAspect:hasAngle() -> boolean`
Type	Method
Description	Checks if the aspect has an `angle` property.
Parameters	None
Returns	`true` if it has an `angle` propery.
Notes	None
Examples	None
Source	src/extensions/cp/apple/finalcutpro/inspector/color/ColorBoardAspect.lua line 128


Signature	`cp.apple.finalcutpro.inspector.color.ColorBoardAspect:id() -> string`
Type	Method
Description	Gets the Color Board Aspect ID.
Parameters	None
Returns	The ID as string.
Notes	None
Examples	None
Source	src/extensions/cp/apple/finalcutpro/inspector/color/ColorBoardAspect.lua line 141


Signature	`cp.apple.finalcutpro.inspector.color.ColorBoardAspect:index() -> number`
Type	Method
Description	Gets the Color Board Aspect index.
Parameters	None
Returns	A number.
Notes	None
Examples	None
Source	src/extensions/cp/apple/finalcutpro/inspector/color/ColorBoardAspect.lua line 115


Signature	`cp.apple.finalcutpro.inspector.color.ColorBoardAspect:reset() -> cp.rx.go.Statement`
Type	Method
Description	A Statement that resets all pucks in the the Color Board Aspect.
Parameters	None
Returns	The `Statement`, which will resolve to `true` if sucessful, or throws an error if not.
Notes	None
Examples	None
Source	src/extensions/cp/apple/finalcutpro/inspector/color/ColorBoardAspect.lua line 172


Signature	`cp.apple.finalcutpro.inspector.color.ColorBoardAspect:show() -> cp.apple.finalcutpro.inspector.color.ColorBoardAspect`
Type	Method
Description	Shows the Color Board Aspect
Parameters	None
Returns	The `cp.apple.finalcutpro.inspector.color.ColorBoardAspect` object for method chaining.
Notes	None
Examples	None
Source	src/extensions/cp/apple/finalcutpro/inspector/color/ColorBoardAspect.lua line 75