cp.apple.finalcutpro.inspector.color.ColorWheels.md

docs » cp.apple.finalcutpro.inspector.color.ColorWheels

---

Color Wheels Module.

Extends Element

API Overview

• Functions - API calls offered directly by the extension
• matches
• Constructors - API calls which return an object, typically one that offers API methods
• ColorWheels
• Fields - Variables which can only be accessed from an object returned by a constructor
• contentUI
• highlights
• hue
• hueRow
• hueSlider
• hueTextField
• master
• maxValue
• midtones
• minValue
• mix
• mixRow
• mixSlider
• mixTextField
• shadows
• temperature
• temperatureRow
• temperatureSlider
• temperatureTextField
• tint
• tintRow
• tintSlider
• tintTextField
• value
• viewingAllWheels
• viewMode
• wheelType
• Methods - API calls which can only be made on an object returned by a constructor
• doShow
• show

API Documentation

Functions

matches

Signature	cp.apple.finalcutpro.inspector.color.ColorWheels.matches(element)
Type	Function
Description	Checks if the specified element is the Color Wheels element.
Parameters	element - The element to check
Returns	true if the element is the Color Wheels.

Constructors

ColorWheels

Signature	cp.apple.finalcutpro.inspector.color.ColorWheels(parent) -> ColorInspector
Type	Constructor
Description	Creates a new ColorWheels object
Parameters	parent - The parent
Returns	A new ColorInspector object

Fields

contentUI

Signature	cp.apple.finalcutpro.inspector.color.ColorWheels.contentUI <cp.prop: hs._asm.axuielement; read-only>
Type	Field
Description	The axuielement representing the content element of the ColorWheels corrector.

highlights

Signature	cp.apple.finalcutpro.inspector.color.ColorWheels.highlights <ColorWheel>
Type	Field
Description	A ColorWheel that allows control of the 'highlights' color settings.

hue

Signature	cp.apple.finalcutpro.inspector.color.ColorWheels.hue <cp.prop: number>
Type	Field
Description	The hue for the corrector. A number from 0 to 360.

hueRow

Signature	cp.apple.finalcutpro.inspector.color.ColorWheels.hueRow <cp.ui.PropertyRow>
Type	Field
Description	A PropertyRow that provides access to the 'Hue' parameter, and axuielement

hueSlider

Signature	cp.apple.finalcutpro.inspector.color.ColorWheels.hueSlider <cp.ui.Slider>
Type	Field
Description	Returns a Slider that provides access to the 'Hue' slider.

hueTextField

Signature	cp.apple.finalcutpro.inspector.color.ColorWheels.hueTextField <cp.ui.TextField>
Type	Field
Description	A TextField that provides access to the 'Hue' slider.

master

Signature	cp.apple.finalcutpro.inspector.color.ColorWheels.master <ColorWheel>
Type	Field
Description	A ColorWheel that allows control of the 'master' color settings.

maxValue

Signature	cp.apple.finalcutpro.inspector.color.ColorWheels.maxValue <cp.prop: number>
Type	Field
Description	The maximum value of the indicator as a number.

midtones

Signature	cp.apple.finalcutpro.inspector.color.ColorWheels.midtones <ColorWheel>
Type	Field
Description	A ColorWheel that allows control of the 'midtones' color settings.

minValue

Signature	cp.apple.finalcutpro.inspector.color.ColorWheels.minValue <cp.prop: number>
Type	Field
Description	The minimum value of the indicator as a number.

mix

Signature	cp.apple.finalcutpro.inspector.color.ColorWheels.mix <cp.prop: number>
Type	Field
Description	The mix amount for this corrector. A number ranging from 0 to 1.

mixRow

Signature	cp.apple.finalcutpro.inspector.color.ColorWheels.mixRow <cp.ui.PropertyRow>
Type	Field
Description	A PropertyRow that provides access to the 'Mix' parameter, and axuielement

mixSlider

Signature	cp.apple.finalcutpro.inspector.color.ColorWheels.mixSlider <cp.ui.Slider>
Type	Field
Description	A Slider that provides access to the 'Mix' slider.

mixTextField

Signature	cp.apple.finalcutpro.inspector.color.ColorWheels.mixTextField <cp.ui.TextField>
Type	Field
Description	A TextField that provides access to the 'Mix' slider.

shadows

Signature	cp.apple.finalcutpro.inspector.color.ColorWheels.shadows <ColorWheel>
Type	Field
Description	A ColorWheel that allows control of the 'shadows' color settings.

temperature

Signature	cp.apple.finalcutpro.inspector.color.ColorWheels.temperature <cp.prop: number>
Type	Field
Description	The color temperature for this corrector. A number from 2500 to 10000.

temperatureRow

Signature	cp.apple.finalcutpro.inspector.color.ColorWheels.temperatureRow <cp.ui.PropertyRow>
Type	Field
Description	A PropertyRow that provides access to the 'Temperatures' parameter, and axuielement

temperatureSlider

Signature	cp.apple.finalcutpro.inspector.color.ColorWheels.temperatureSlider <cp.ui.Slider>
Type	Field
Description	A Slider that provides access to the 'Temperatures' slider.

temperatureTextField

Signature	cp.apple.finalcutpro.inspector.color.ColorWheels.temperatureTextField <cp.ui.TextField>
Type	Field
Description	A TextField that provides access to the 'Temperature' slider.

tint

Signature	cp.apple.finalcutpro.inspector.color.ColorWheels.tint <cp.prop: number>
Type	Field
Description	The tint for the corrector. A number from -50 to 50.

tintRow

Signature	cp.apple.finalcutpro.inspector.color.ColorWheels.tintRow <cp.ui.PropertyRow>
Type	Field
Description	A PropertyRow that provides access to the 'Tint' parameter, and axuielement

tintSlider

Signature	cp.apple.finalcutpro.inspector.color.ColorWheels.tintSlider <cp.ui.Slider>
Type	Field
Description	Returns a Slider that provides access to the 'Tint' slider.

tintTextField

Signature	cp.apple.finalcutpro.inspector.color.ColorWheels.tintTextField <cp.ui.TextField>
Type	Field
Description	A TextField that provides access to the 'Tint' slider.

value

Signature	cp.apple.finalcutpro.inspector.color.ColorWheels.value <cp.prop: number>
Type	Field
Description	The value of the value indicator as a number.

viewingAllWheels

Signature	cp.apple.finalcutpro.inspector.color.ColorWheels.viewingAllWheels <cp.prop: boolean>
Type	Field
Description	Reports and modifies whether the ColorWheels corrector is showing "All Wheels" (true) or "Single Wheels" (false).

viewMode

Signature	cp.apple.finalcutpro.inspector.color.ColorWheels.viewMode <cp.ui.MenuButton>
Type	Field
Description	The MenuButton for the View Mode.

wheelType

Signature	cp.apple.finalcutpro.inspector.color.ColorWheels.wheelType <cp.ui.RadioGroup>
Type	Field
Description	The RadioGroup that allows selection of the wheel type. Only available when

Methods

doShow

Signature	cp.apple.finalcutpro.inspector.color.ColorWheels:doShow() -> cs.rx.go.Statement
Type	Method
Description	A Statement that shows the Color Board within the Color Inspector.
Parameters	None
Returns	The Statement, resolving to true if successfully shown.

show

Signature	cp.apple.finalcutpro.inspector.color.ColorWheels:show() -> boolean
Type	Method
Description	Show's the Color Board within the Color Inspector.
Parameters	None
Returns	ColorWheels object