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
Notes None
Source src/extensions/cp/apple/finalcutpro/inspector/color/ColorBoard.lua line 26

Variables

currentAspect

   
Signature cp.apple.finalcutpro.inspector.color.ColorBoard.currentAspect -> string
Type Variable
Description The current aspect as a string.
Notes None
Source src/extensions/cp/apple/finalcutpro/inspector/color/ColorBoard.lua line 31

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
Notes None
Examples None
Source src/extensions/cp/apple/finalcutpro/inspector/color/ColorBoard.lua line 36

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
Notes None
Examples None
Source src/extensions/cp/apple/finalcutpro/inspector/color/ColorBoard.lua line 56

Fields

aspectGroup

   
Signature cp.apple.finalcutpro.inspector.color.ColorBoard.aspectGroup <cp.ui.RadioGroup>
Type Field
Description The RadioGroup for the 'aspect' currently being controlled
Notes None
Source src/extensions/cp/apple/finalcutpro/inspector/color/ColorBoard.lua line 281

color

   
Signature cp.apple.finalcutpro.inspector.color.ColorBoard.color <ColorBoardAspect>
Type Field
Description The color aspect of the color board.
Notes None
Source src/extensions/cp/apple/finalcutpro/inspector/color/ColorBoard.lua line 204

contentUI

   
Signature cp.apple.finalcutpro.inspector.color.ColorBoard.contentUI <cp.prop: hs.axuielement; read-only; live>
Type Field
Description Returns the hs.axuielement object for the Color Board's content.
Notes None
Source src/extensions/cp/apple/finalcutpro/inspector/color/ColorBoard.lua line 82

exposure

   
Signature cp.apple.finalcutpro.inspector.color.ColorBoard.exposure <ColorBoardAspect>
Type Field
Description The exposure aspect of the color board.
Notes None
Source src/extensions/cp/apple/finalcutpro/inspector/color/ColorBoard.lua line 218

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
Notes None
Source src/extensions/cp/apple/finalcutpro/inspector/color/ColorBoard.lua line 107

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.
Notes None
Source src/extensions/cp/apple/finalcutpro/inspector/color/ColorBoard.lua line 97

saturation

   
Signature cp.apple.finalcutpro.inspector.color.ColorBoard.saturation <ColorBoardAspect>
Type Field
Description The saturation aspect of the color board.
Notes None
Source src/extensions/cp/apple/finalcutpro/inspector/color/ColorBoard.lua line 211

Methods

childUI

   
Signature cp.apple.finalcutpro.inspector.color.ColorBoard:childUI(id) -> hs.axuielement object
Type Method
Description Gets the hs.axuielement object for a child with the specified ID.
Parameters
  • axID - AXIdentifier of the child
Returns
  • An hs.axuielement object
Notes None
Examples None
Source src/extensions/cp/apple/finalcutpro/inspector/color/ColorBoard.lua line 182

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. If the color board is not currently visible, it returns the color aspect by default.
Parameters
  • None
Returns
  • The currently active ColorBoardAspect, or the color aspect if none is showing.
Notes None
Examples None
Source src/extensions/cp/apple/finalcutpro/inspector/color/ColorBoard.lua line 225

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.
Notes None
Examples None
Source src/extensions/cp/apple/finalcutpro/inspector/color/ColorBoard.lua line 169

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
Notes None
Examples None
Source src/extensions/cp/apple/finalcutpro/inspector/color/ColorBoard.lua line 324

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. If the range is provided, only that subset (master, shadows, midtones, highlights) will be reset.
Parameters
  • range - Optional range to reset in the current aspect.
Returns
  • The Statement, resolving with true if completed or an error if not.
Notes None
Examples None
Source src/extensions/cp/apple/finalcutpro/inspector/color/ColorBoard.lua line 243

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. If the index is not between 1 and 3, and error will be thrown.
Parameters
  • index - The index to select.
Returns
  • The Statement, which will resolve to true if successful, or throw an error if not.
Notes None
Examples None
Source src/extensions/cp/apple/finalcutpro/inspector/color/ColorBoard.lua line 291

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.
Notes None
Examples None
Source src/extensions/cp/apple/finalcutpro/inspector/color/ColorBoard.lua line 136

hide

   
Signature cp.apple.finalcutpro.inspector.color.ColorBoard:hide() -> self
Type Method
Description Hides the Color Board
Parameters
  • None
Returns
  • ColorBoard object
Notes None
Examples None
Source src/extensions/cp/apple/finalcutpro/inspector/color/ColorBoard.lua line 153

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
Notes None
Examples None
Source src/extensions/cp/apple/finalcutpro/inspector/color/ColorBoard.lua line 306

reset

   
Signature cp.apple.finalcutpro.inspector.color.ColorBoard:reset() -> self
Type Method
Description Resets the current aspect.
Parameters
  • None
Returns
  • ColorBoard object
Notes None
Examples None
Source src/extensions/cp/apple/finalcutpro/inspector/color/ColorBoard.lua line 341

show

   
Signature cp.apple.finalcutpro.inspector.color.ColorBoard:show() -> ColorBoard object
Type Method
Description Shows the Color Board
Parameters
  • None
Returns
  • ColorBoard object
Notes None
Examples None
Source src/extensions/cp/apple/finalcutpro/inspector/color/ColorBoard.lua line 120

© Copyright 2026 LateNite Films Pty Ltd. All rights reserved.