# cp.apple.finalcutpro.inspector.color.ColorWheel
Represents a single Color Well in the Color Wheels Inspector.
---
## API Overview
**Constants** - _Useful values which cannot be changed_
* [TYPE](#type)
**Functions** - _API calls offered directly by the extension_
* [matches](#matches)
**Constructors** - _API calls which return an object, typically one that offers API methods_
* [ColorWheel](#colorwheel)
**Fields** - _Variables which can only be accessed from an object returned by a constructor_
* [brightnessValue](#brightnessvalue)
* [colorOrientation](#colororientation)
* [colorPosition](#colorposition)
* [colorValue](#colorvalue)
* [puckPosition](#puckposition)
* [reset](#reset)
* [saturationValue](#saturationvalue)
**Methods** - _API calls which can only be made on an object returned by a constructor_
* [brightness](#brightness)
* [colorWell](#colorwell)
* [doNudgeColor](#donudgecolor)
* [doSelect](#doselect)
* [doShow](#doshow)
* [nudgeColor](#nudgecolor)
* [saturation](#saturation)
* [select](#select)
* [show](#show)
---
## API Documentation
#### Constants
### [TYPE](#type)
| | |
| --------------------------------------------|-------------------------------------------------------------------------------------|
| **Signature** | `cp.apple.finalcutpro.inspector.color.ColorWheel.TYPE` |
| **Type** | Constant |
| **Description** | The possible types of ColorWheels: MASTER, SHADOWS, MIDTONES, HIGHLIGHTS. |
| **Notes** | None |
| **Source** | [src/extensions/cp/apple/finalcutpro/inspector/color/ColorWheel.lua line 23](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/apple/finalcutpro/inspector/color/ColorWheel.lua#L23) |
---
#### Functions
### [matches](#matches)
| | |
| --------------------------------------------|-------------------------------------------------------------------------------------|
| **Signature** | `cp.apple.finalcutpro.inspector.color.ColorWheel.matches(element)` |
| **Type** | Function |
| **Description** | Checks if the specified element is a Color Well. |
| **Parameters** | - element - The element to check
|
| **Returns** | - `true` if the element is a Color Well.
|
| **Notes** | None |
| **Examples** | None |
| **Source** | [src/extensions/cp/apple/finalcutpro/inspector/color/ColorWheel.lua line 38](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/apple/finalcutpro/inspector/color/ColorWheel.lua#L38) |
---
#### Constructors
### [ColorWheel](#colorwheel)
| | |
| --------------------------------------------|-------------------------------------------------------------------------------------|
| **Signature** | `cp.apple.finalcutpro.inspector.color.ColorWheel(parent, type) -> ColorWheel` |
| **Type** | Constructor |
| **Description** | Creates a new `ColorWheel` instance, with the specified parent and type. |
| **Parameters** | - parent - The parent object.
- type - The type of color wheel. Must be one of the `ColorWheel.TYPE` values.
|
| **Returns** | - A new `ColorWheel` instance.
|
| **Notes** | None |
| **Examples** | None |
| **Source** | [src/extensions/cp/apple/finalcutpro/inspector/color/ColorWheel.lua line 55](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/apple/finalcutpro/inspector/color/ColorWheel.lua#L55) |
---
#### Fields
### [brightnessValue](#brightnessvalue)
| | |
| --------------------------------------------|-------------------------------------------------------------------------------------|
| **Signature** | `cp.apple.finalcutpro.inspector.color.ColorWheel.brightnessValue ` |
| **Type** | Field |
| **Description** | The current brightness value, as a number between -12 and 10. |
| **Notes** | None |
| **Source** | [src/extensions/cp/apple/finalcutpro/inspector/color/ColorWheel.lua line 135](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/apple/finalcutpro/inspector/color/ColorWheel.lua#L135) |
---
### [colorOrientation](#colororientation)
| | |
| --------------------------------------------|-------------------------------------------------------------------------------------|
| **Signature** | `cp.apple.finalcutpro.inspector.color.ColorWheel.colorOrientation ` |
| **Type** | Field |
| **Description** | Provides the orientation of the color as a table containing an `up` and `right` value. |
| **Notes** | None |
| **Source** | [src/extensions/cp/apple/finalcutpro/inspector/color/ColorWheel.lua line 120](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/apple/finalcutpro/inspector/color/ColorWheel.lua#L120) |
---
### [colorPosition](#colorposition)
| | |
| --------------------------------------------|-------------------------------------------------------------------------------------|
| **Signature** | `cp.apple.finalcutpro.inspector.color.ColorWheel.colorPosition ` |
| **Type** | Field |
| **Description** | X/Y screen position for the current color value of the Color Well. This ignores the bounds of the |
| **Notes** | None |
| **Source** | [src/extensions/cp/apple/finalcutpro/inspector/color/ColorWheel.lua line 112](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/apple/finalcutpro/inspector/color/ColorWheel.lua#L112) |
---
### [colorValue](#colorvalue)
| | |
| --------------------------------------------|-------------------------------------------------------------------------------------|
| **Signature** | `cp.apple.finalcutpro.inspector.color.ColorWheel.colorValue ` |
| **Type** | Field |
| **Description** | The current color value, as a `hs.drawing.color` table. |
| **Notes** | None |
| **Source** | [src/extensions/cp/apple/finalcutpro/inspector/color/ColorWheel.lua line 98](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/apple/finalcutpro/inspector/color/ColorWheel.lua#L98) |
---
### [puckPosition](#puckposition)
| | |
| --------------------------------------------|-------------------------------------------------------------------------------------|
| **Signature** | `cp.apple.finalcutpro.inspector.color.ColorWheel.puckPosition ` |
| **Type** | Field |
| **Description** | Absolute X/Y screen position for the puck in the Color Well. Colours outside the bounds are clamped inside the color well. |
| **Notes** | None |
| **Source** | [src/extensions/cp/apple/finalcutpro/inspector/color/ColorWheel.lua line 105](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/apple/finalcutpro/inspector/color/ColorWheel.lua#L105) |
---
### [reset](#reset)
| | |
| --------------------------------------------|-------------------------------------------------------------------------------------|
| **Signature** | `cp.apple.finalcutpro.inspector.color.ColorWheel.reset ` |
| **Type** | Field |
| **Description** | A [Button](cp.ui.Button.md) that resets the color wheel values, if the `ColorWheel` is showing. |
| **Notes** | None |
| **Source** | [src/extensions/cp/apple/finalcutpro/inspector/color/ColorWheel.lua line 275](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/apple/finalcutpro/inspector/color/ColorWheel.lua#L275) |
---
### [saturationValue](#saturationvalue)
| | |
| --------------------------------------------|-------------------------------------------------------------------------------------|
| **Signature** | `cp.apple.finalcutpro.inspector.color.ColorWheel.saturationValue ` |
| **Type** | Field |
| **Description** | The current saturation value, as a number between 0 and 10. |
| **Notes** | None |
| **Source** | [src/extensions/cp/apple/finalcutpro/inspector/color/ColorWheel.lua line 128](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/apple/finalcutpro/inspector/color/ColorWheel.lua#L128) |
---
#### Methods
### [brightness](#brightness)
| | |
| --------------------------------------------|-------------------------------------------------------------------------------------|
| **Signature** | `cp.apple.finalcutpro.inspector.color.ColorWheel.brightness ` |
| **Type** | Method |
| **Description** | Returns the brightness `ValueIndicator` for this ColorWheel. |
| **Parameters** | |
| **Returns** | - The brightness `ValueIndicator` instance.
|
| **Notes** | None |
| **Examples** | None |
| **Source** | [src/extensions/cp/apple/finalcutpro/inspector/color/ColorWheel.lua line 251](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/apple/finalcutpro/inspector/color/ColorWheel.lua#L251) |
---
### [colorWell](#colorwell)
| | |
| --------------------------------------------|-------------------------------------------------------------------------------------|
| **Signature** | `cp.apple.finalcutpro.inspector.color.ColorWheel.colorWell ` |
| **Type** | Method |
| **Description** | Returns the `ColorWell` for this ColorWheel. |
| **Parameters** | |
| **Returns** | - The `ColorWell` instance.
|
| **Notes** | None |
| **Examples** | None |
| **Source** | [src/extensions/cp/apple/finalcutpro/inspector/color/ColorWheel.lua line 212](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/apple/finalcutpro/inspector/color/ColorWheel.lua#L212) |
---
### [doNudgeColor](#donudgecolor)
| | |
| --------------------------------------------|-------------------------------------------------------------------------------------|
| **Signature** | `cp.apple.finalcutpro.inspector.color.ColorWheel:doNudgeColor(right, up) -> cp.rx.go.Statement` |
| **Type** | Method |
| **Description** | A [Statement](cp.rx.go.Statement.md) that nudges the `colorPosition` by `right`/`up` values. Negative `right` values shift left, negative `up` values shift down. You may have decimal shift values. |
| **Parameters** | - `right` - The number of steps to shift right. May be negative to shift left.
- `up` - The number of pixels to shift down. May be negative to shift down.
|
| **Returns** | - The `Statement`, resolving to `true` if successful.
|
| **Notes** | None |
| **Examples** | None |
| **Source** | [src/extensions/cp/apple/finalcutpro/inspector/color/ColorWheel.lua line 300](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/apple/finalcutpro/inspector/color/ColorWheel.lua#L300) |
---
### [doSelect](#doselect)
| | |
| --------------------------------------------|-------------------------------------------------------------------------------------|
| **Signature** | `cp.apple.finalcutpro.inspector.color.ColorWheel:doSelect() -> cp.rx.go.Statement` |
| **Type** | Method |
| **Description** | A [Statement](cp.rx.go.Statement.md) that attempts to select this `ColorWheel`. |
| **Parameters** | |
| **Returns** | - The `Statement`, resolving to `true` if selected, otherwise `false`.
|
| **Notes** | None |
| **Examples** | None |
| **Source** | [src/extensions/cp/apple/finalcutpro/inspector/color/ColorWheel.lua line 195](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/apple/finalcutpro/inspector/color/ColorWheel.lua#L195) |
---
### [doShow](#doshow)
| | |
| --------------------------------------------|-------------------------------------------------------------------------------------|
| **Signature** | `cp.apple.finalcutpro.inspector.color.ColorWheel:doShow() -> cp.rx.go.Statement` |
| **Type** | Method |
| **Description** | A [Statement](cp.rx.go.Statement.md) that attempts to show the `ColorWheel`. |
| **Parameters** | |
| **Returns** | - The `Statement`, resolving to `true` if shown, `false` if not.
|
| **Notes** | None |
| **Examples** | None |
| **Source** | [src/extensions/cp/apple/finalcutpro/inspector/color/ColorWheel.lua line 161](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/apple/finalcutpro/inspector/color/ColorWheel.lua#L161) |
---
### [nudgeColor](#nudgecolor)
| | |
| --------------------------------------------|-------------------------------------------------------------------------------------|
| **Signature** | `cp.apple.finalcutpro.inspector.color.ColorWheel:nudgeColor(right, up) -> self` |
| **Type** | Method |
| **Description** | Nudges the `colorPosition` by `right`/`up` values. Negative `right` values shift left, negative `up` values shift down. You may have decimal shift values. |
| **Parameters** | - `right` - The number of steps to shift right. May be negative to shift left.
- `up` - The number of pixels to shift down. May be negative to shift down.
|
| **Returns** | - The `ColorWheel` instance.
|
| **Notes** | None |
| **Examples** | None |
| **Source** | [src/extensions/cp/apple/finalcutpro/inspector/color/ColorWheel.lua line 285](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/apple/finalcutpro/inspector/color/ColorWheel.lua#L285) |
---
### [saturation](#saturation)
| | |
| --------------------------------------------|-------------------------------------------------------------------------------------|
| **Signature** | `cp.apple.finalcutpro.inspector.color.ColorWheel.saturation ` |
| **Type** | Method |
| **Description** | Returns the saturation `ValueIndicator` for this ColorWheel. |
| **Parameters** | |
| **Returns** | - The saturation `ValueIndicator` instance.
|
| **Notes** | None |
| **Examples** | None |
| **Source** | [src/extensions/cp/apple/finalcutpro/inspector/color/ColorWheel.lua line 227](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/apple/finalcutpro/inspector/color/ColorWheel.lua#L227) |
---
### [select](#select)
| | |
| --------------------------------------------|-------------------------------------------------------------------------------------|
| **Signature** | `cp.apple.finalcutpro.inspector.color.ColorWheel:select() -> cp.apple.finalcutpro.inspector.color.ColorWheel` |
| **Type** | Method |
| **Description** | Shows and selects this color wheel. |
| **Parameters** | |
| **Returns** | - The `ColorWheel` instance.
|
| **Notes** | None |
| **Examples** | None |
| **Source** | [src/extensions/cp/apple/finalcutpro/inspector/color/ColorWheel.lua line 181](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/apple/finalcutpro/inspector/color/ColorWheel.lua#L181) |
---
### [show](#show)
| | |
| --------------------------------------------|-------------------------------------------------------------------------------------|
| **Signature** | `cp.apple.finalcutpro.inspector.color.ColorWheel:show() -> self` |
| **Type** | Method |
| **Description** | Shows the `ColorWheel`, if possible. |
| **Parameters** | |
| **Returns** | - The same `ColorWheel` instance, for chaining.
|
| **Notes** | None |
| **Examples** | None |
| **Source** | [src/extensions/cp/apple/finalcutpro/inspector/color/ColorWheel.lua line 142](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/apple/finalcutpro/inspector/color/ColorWheel.lua#L142) |
---
---