docs » cp.apple.finalcutpro.main.ColorBoard


Color Board Module.

API Overview

API Documentation

Constants

aspect

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

color

Signature cp.apple.finalcutpro.main.ColorBoard.aspect.color -> table
Type Constant
Description A table containing the Color Board Color panel settings

exposure

Signature cp.apple.finalcutpro.main.ColorBoard.aspect.exposure -> table
Type Constant
Description A table containing the Color Board Exposure panel settings

saturation

Signature cp.apple.finalcutpro.main.ColorBoard.aspect.saturation -> table
Type Constant
Description A table containing the Color Board Saturation panel settings

Variables

currentAspect

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

Functions

isColorBoard

Signature cp.apple.finalcutpro.main.ColorBoard.isColorBoard(element) -> boolean
Type Function
Description Checks to see if a GUI element is the Color Board or not
Parameters
  • `element` - The element you want to check
Returns
  • `true` if the `element` is a Color Board otherwise `false`

Methods

app

Signature cp.apple.finalcutpro.main.ColorBoard:app() -> table
Type Method
Description Returns the cp.apple.finalcutpro app table
Parameters
  • None
Returns
  • The application object as a table

applyAngle

Signature cp.apple.finalcutpro.main.ColorBoard:applyAngle(aspect, property, value) -> ColorBoard object
Type Method
Description Applies a Color Board Angle value to the specified aspect/property
Parameters
  • aspect - "color", "saturation" or "exposure"
  • property - "global", "shadows", "midtones" or "highlights"
  • value - value as string
Returns
  • ColorBoard object

applyPercentage

Signature cp.apple.finalcutpro.main.ColorBoard:applyPercentage(aspect, property, value) -> ColorBoard object
Type Method
Description Applies a Color Board Percentage value to the specified aspect/property
Parameters
  • aspect - "color", "saturation" or "exposure"
  • property - "global", "shadows", "midtones" or "highlights"
  • value - value as string
Returns
  • ColorBoard object

aspectPropertyPanelUI

Signature cp.apple.finalcutpro.main.ColorBoard:aspectPropertyPanelUI(aspect, property, type) -> hs._asm.axuielement object
Type Method
Description Ensures that the specified aspect/property panel is visible and returns the specified value type hs._asm.axuielement object
Parameters
  • aspect - "color", "saturation" or "exposure"
  • property - "global", "shadows", "midtones" or "highlights"
  • type - "pct" or "angle"
Returns
  • An `hs._asm.axuielement` object or `nil` if an error occurs

childUI

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

colorInspectorBarUI

Signature cp.apple.finalcutpro.main.ColorBoard:colorInspectorBarUI() -> hs._asm.axuielement object
Type Method
Description Returns the hs._asm.axuielement object for the Final Cut Pro 10.4 Color Board Inspector Bar (i.e. where you can add new Color Corrections from the dropdown)
Parameters
  • None
Returns
  • A `hs._asm.axuielement` object

colorSatExpUI

Signature cp.apple.finalcutpro.main.ColorBoard:colorSatExpUI() -> hs._asm.axuielement object
Type Method
Description Gets the hs._asm.axuielement object for the AXRadioGroup which houses the "Color", "Saturation" and "Exposure" button
Parameters
  • None
Returns
  • An `hs._asm.axuielement` object

getAngle

Signature `cp.apple.finalcutpro.main.ColorBoard:getAngle(aspect, property) -> number nil` </span>
Type Method
Description Gets an angle value of the specified aspect and property
Parameters
  • aspect - "color", "saturation" or "exposure"
  • property - "global", "shadows", "midtones" or "highlights"
Returns
  • Number or `nil` if an error occurred

getAspect

Signature cp.apple.finalcutpro.main.ColorBoard:getAspect(aspect, property) -> table
Type Method
Description Gets a table containing the ID information for a specific aspect and property
Parameters
  • aspect - "color", "saturation" or "exposure"
  • property - "global", "shadows", "midtones" or "highlights"
Returns
  • A table or `nil` if an error occurs

getPercentage

Signature `cp.apple.finalcutpro.main.ColorBoard:getPercentage(aspect, property) -> number nil` </span>
Type Method
Description Gets a percentage value of the specified aspect and property
Parameters
  • aspect - "color", "saturation" or "exposure"
  • property - "global", "shadows", "midtones" or "highlights"
Returns
  • Number or `nil` if an error occurred

hide

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

isActive

Signature cp.apple.finalcutpro.main.ColorBoard:isActive() -> boolean
Type Method
Description Returns whether or not the Color Board is active
Parameters
  • None
Returns
  • `true` if the Color Board is active, otherwise `false`

isShowing

Signature cp.apple.finalcutpro.main.ColorBoard:isShowing() -> boolean
Type Method
Description Returns whether or not the Color Board is visible
Parameters
  • None
Returns
  • `true` if the Color Board is showing, otherwise `false`

new

Signature cp.apple.finalcutpro.main.ColorBoard:new(parent) -> ColorBoard object
Type Method
Description Creates a new ColorBoard object
Parameters
  • `parent` - The parent
Returns
  • A ColorBoard object

parent

Signature cp.apple.finalcutpro.main.ColorBoard:parent() -> table
Type Method
Description Returns the ColorBoard's parent table
Parameters
  • None
Returns
  • The parent object as a table

puckUI

Signature cp.apple.finalcutpro.main.ColorBoard:puckUI(aspect, property) -> hs._asm.axuielement object
Type Method
Description Gets the hs._asm.axuielement object of a specific Color Board puck
Parameters
  • aspect - "color", "saturation" or "exposure"
  • property - "global", "shadows", "midtones" or "highlights"
Returns
  • An `hs._asm.axuielement` object

reset

Signature cp.apple.finalcutpro.main.ColorBoard:reset(aspect) -> ColorBoard object
Type Method
Description Resets a specified aspect
Parameters
  • aspect - "color", "saturation" or "exposure"
Returns
  • ColorBoard object

selectedPanel

Signature `cp.apple.finalcutpro.main.ColorBoard:selectedPanel() -> string nil` </span>
Type Method
Description Returns the currently selected Color Board panel
Parameters
  • None
Returns
  • "Color", "Saturation", "Exposure" or `nil` if an error occurs

selectPuck

Signature cp.apple.finalcutpro.main.ColorBoard:selectPuck(aspect, property) -> ColorBoard object
Type Method
Description Selects a specific Color Board puck
Parameters
  • aspect - "color", "saturation" or "exposure"
  • property - "global", "shadows", "midtones" or "highlights"
Returns
  • ColorBoard object

shiftAngle

Signature cp.apple.finalcutpro.main.ColorBoard:shiftAngle(aspect, property, shift) -> ColorBoard object
Type Method
Description Shifts a Color Board Angle value of the specified aspect/property
Parameters
  • aspect - "color", "saturation" or "exposure"
  • property - "global", "shadows", "midtones" or "highlights"
  • shift - number you want to increase/decrease the angle by
Returns
  • ColorBoard object

shiftPercentage

Signature cp.apple.finalcutpro.main.ColorBoard:shiftPercentage(aspect, property, shift) -> ColorBoard object
Type Method
Description Shifts a Color Board Percentage value of the specified aspect/property
Parameters
  • aspect - "color", "saturation" or "exposure"
  • property - "global", "shadows", "midtones" or "highlights"
  • shift - number you want to increase/decrease the percentage by
Returns
  • ColorBoard object

show

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

showInspectorUI

Signature cp.apple.finalcutpro.main.ColorBoard:showInspectorUI() -> hs._asm.axuielement object
Type Method
Description Gets the hs._asm.axuielement object for the inspector
Parameters
  • None
Returns
  • An `hs._asm.axuielement` object

showPanel

Signature cp.apple.finalcutpro.main.ColorBoard:showPanel(aspect) -> ColorBoard object
Type Method
Description Shows a specific panel based on the specified aspect
Parameters
  • aspect - "color", "saturation" or "exposure"
Returns
  • ColorBoard object

startPucker

Signature cp.apple.finalcutpro.main.ColorBoard:startPucker(aspect, property) -> Pucker object
Type Method
Description Creates a Pucker object for the specified aspect and property
Parameters
  • aspect - "color", "saturation" or "exposure"
  • property - "global", "shadows", "midtones" or "highlights"
Returns
  • Pucker object

togglePanel

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

topToolbarUI

Signature cp.apple.finalcutpro.main.ColorBoard:topToolbarUI() -> hs._asm.axuielement object
Type Method
Description Gets the hs._asm.axuielement object for the top toolbar (i.e. where the Back Button is located in Final Cut Pro 10.3)
Parameters
  • None
Returns
  • An `hs._asm.axuielement` object
Notes
  • This object doesn't exist in Final Cut Pro 10.4 as the Color Board is now contained within the Color Inspector

UI

Signature cp.apple.finalcutpro.main.ColorBoard:UI() -> hs._asm.axuielement object
Type Method
Description Returns the hs._asm.axuielement object for the Color Board
Parameters
  • None
Returns
  • A `hs._asm.axuielement` object

results matching ""

    No results matching ""