# cp.apple.finalcutpro.inspector.color.ColorBoard Color Board Module. --- ## API Overview **Constants** - _Useful values which cannot be changed_ * [aspect](#aspect) **Variables** - _Configurable values_ * [currentAspect](#currentaspect) **Functions** - _API calls offered directly by the extension_ * [matches](#matches) **Constructors** - _API calls which return an object, typically one that offers API methods_ * [ColorBoard](#colorboard) **Fields** - _Variables which can only be accessed from an object returned by a constructor_ * [aspectGroup](#aspectgroup) * [color](#color) * [contentUI](#contentui) * [exposure](#exposure) * [isActive](#isactive) * [isShowing](#isshowing) * [saturation](#saturation) **Methods** - _API calls which can only be made on an object returned by a constructor_ * [childUI](#childui) * [current](#current) * [doHide](#dohide) * [doNextAspect](#donextaspect) * [doResetCurrent](#doresetcurrent) * [doSelectAspect](#doselectaspect) * [doShow](#doshow) * [hide](#hide) * [nextAspect](#nextaspect) * [reset](#reset) * [show](#show) --- ## API Documentation #### Constants ### [aspect](#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](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/apple/finalcutpro/inspector/color/ColorBoard.lua#L26) | --- #### Variables ### [currentAspect](#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](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/apple/finalcutpro/inspector/color/ColorBoard.lua#L31) | --- #### Functions ### [matches](#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** | | | **Returns** | | | **Notes** | None | | **Examples** | None | | **Source** | [src/extensions/cp/apple/finalcutpro/inspector/color/ColorBoard.lua line 36](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/apple/finalcutpro/inspector/color/ColorBoard.lua#L36) | --- #### Constructors ### [ColorBoard](#colorboard) | | | | --------------------------------------------|-------------------------------------------------------------------------------------| | **Signature** | `cp.apple.finalcutpro.inspector.color.ColorBoard(parent) -> ColorBoard object` | | **Type** | Constructor | | **Description** | Creates a new ColorBoard object | | **Parameters** | | | **Returns** | | | **Notes** | None | | **Examples** | None | | **Source** | [src/extensions/cp/apple/finalcutpro/inspector/color/ColorBoard.lua line 56](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/apple/finalcutpro/inspector/color/ColorBoard.lua#L56) | --- #### Fields ### [aspectGroup](#aspectgroup) | | | | --------------------------------------------|-------------------------------------------------------------------------------------| | **Signature** | `cp.apple.finalcutpro.inspector.color.ColorBoard.aspectGroup ` | | **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](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/apple/finalcutpro/inspector/color/ColorBoard.lua#L281) | --- ### [color](#color) | | | | --------------------------------------------|-------------------------------------------------------------------------------------| | **Signature** | `cp.apple.finalcutpro.inspector.color.ColorBoard.color ` | | **Type** | Field | | **Description** | The `color` aspect of the color board. | | **Notes** | None | | **Source** | [src/extensions/cp/apple/finalcutpro/inspector/color/ColorBoard.lua line 204](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/apple/finalcutpro/inspector/color/ColorBoard.lua#L204) | --- ### [contentUI](#contentui) | | | | --------------------------------------------|-------------------------------------------------------------------------------------| | **Signature** | `cp.apple.finalcutpro.inspector.color.ColorBoard.contentUI ` | | **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](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/apple/finalcutpro/inspector/color/ColorBoard.lua#L82) | --- ### [exposure](#exposure) | | | | --------------------------------------------|-------------------------------------------------------------------------------------| | **Signature** | `cp.apple.finalcutpro.inspector.color.ColorBoard.exposure ` | | **Type** | Field | | **Description** | The `exposure` aspect of the color board. | | **Notes** | None | | **Source** | [src/extensions/cp/apple/finalcutpro/inspector/color/ColorBoard.lua line 218](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/apple/finalcutpro/inspector/color/ColorBoard.lua#L218) | --- ### [isActive](#isactive) | | | | --------------------------------------------|-------------------------------------------------------------------------------------| | **Signature** | `cp.apple.finalcutpro.inspector.color.ColorBoard:isActive ` | | **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](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/apple/finalcutpro/inspector/color/ColorBoard.lua#L107) | --- ### [isShowing](#isshowing) | | | | --------------------------------------------|-------------------------------------------------------------------------------------| | **Signature** | `cp.apple.finalcutpro.inspector.color.ColorBoard.isShowing ` | | **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](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/apple/finalcutpro/inspector/color/ColorBoard.lua#L97) | --- ### [saturation](#saturation) | | | | --------------------------------------------|-------------------------------------------------------------------------------------| | **Signature** | `cp.apple.finalcutpro.inspector.color.ColorBoard.saturation ` | | **Type** | Field | | **Description** | The `saturation` aspect of the color board. | | **Notes** | None | | **Source** | [src/extensions/cp/apple/finalcutpro/inspector/color/ColorBoard.lua line 211](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/apple/finalcutpro/inspector/color/ColorBoard.lua#L211) | --- #### Methods ### [childUI](#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](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/apple/finalcutpro/inspector/color/ColorBoard.lua#L182) | --- ### [current](#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](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/apple/finalcutpro/inspector/color/ColorBoard.lua#L225) | --- ### [doHide](#dohide) | | | | --------------------------------------------|-------------------------------------------------------------------------------------| | **Signature** | `cp.apple.finalcutpro.inspector.color.ColorBoard:doHide() -> cp.rx.go.Statement` | | **Type** | Method | | **Description** | A [Statement](cp.rx.go.Statement.md) 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](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/apple/finalcutpro/inspector/color/ColorBoard.lua#L169) | --- ### [doNextAspect](#donextaspect) | | | | --------------------------------------------|-------------------------------------------------------------------------------------| | **Signature** | `cp.apple.finalcutpro.inspector.color.ColorBoard:doNextAspect() -> cp.rx.go.Statement` | | **Type** | Method | | **Description** | A [Statement](cp.rx.go.Statement.md) 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](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/apple/finalcutpro/inspector/color/ColorBoard.lua#L324) | --- ### [doResetCurrent](#doresetcurrent) | | | | --------------------------------------------|-------------------------------------------------------------------------------------| | **Signature** | `cp.apple.finalcutpro.inspector.color.ColorBoard:doResetCurrent([range]) -> cp.rx.go.Statement` | | **Type** | Method | | **Description** | A [Statement](cp.rx.go.Statement.md) 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](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/apple/finalcutpro/inspector/color/ColorBoard.lua#L243) | --- ### [doSelectAspect](#doselectaspect) | | | | --------------------------------------------|-------------------------------------------------------------------------------------| | **Signature** | `cp.apple.finalcutpro.inspector.color.ColorBoard:doSelectAspect(index) -> cp.rx.go.Statement` | | **Type** | Method | | **Description** | A [Statement](cp.rx.go.Statement.md) 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](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/apple/finalcutpro/inspector/color/ColorBoard.lua#L291) | --- ### [doShow](#doshow) | | | | --------------------------------------------|-------------------------------------------------------------------------------------| | **Signature** | `cp.apple.finalcutpro.inspector.color.ColorBoard:doShow() -> cp.rx.go.Statement` | | **Type** | Method | | **Description** | A [Statement](cp.rx.go.Statement.md) 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](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/apple/finalcutpro/inspector/color/ColorBoard.lua#L136) | --- ### [hide](#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](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/apple/finalcutpro/inspector/color/ColorBoard.lua#L153) | --- ### [nextAspect](#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](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/apple/finalcutpro/inspector/color/ColorBoard.lua#L306) | --- ### [reset](#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](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/apple/finalcutpro/inspector/color/ColorBoard.lua#L341) | --- ### [show](#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](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/apple/finalcutpro/inspector/color/ColorBoard.lua#L120) | --- ---