# cp.apple.finalcutpro.inspector.color.ValueIndicator

ValueIndicator Module.

# API Overview

Functions - API calls offered directly by the extension

  • matches

Constructors - API calls which return an object, typically one that offers API methods

  • ValueIndicator

Methods - API calls which can only be made on an object returned by a constructor

  • decrement
  • increment
  • isShowing
  • loadLayout
  • saveLayout
  • shiftValue

# API Documentation

# Functions

# matches

Signature cp.apple.finalcutpro.inspector.color.ValueIndicator.matches(element) -> boolean
Type Function
Description Checks to see if an element matches what we think it should be.
Parameters
  • element - An axuielementObject to check.
Returns
  • true if matches otherwise false
Notes None
Examples None
Source src/extensions/cp/apple/finalcutpro/inspector/color/ValueIndicator.lua line 14

# Constructors

# ValueIndicator

Signature cp.apple.finalcutpro.inspector.color.ValueIndicator(parent, uiFinder, minValue, maxValue, toAXValueFn, fromAXValueFn) -> ValueIndicator
Type Constructor
Description Creates a new ValueIndicator.
Parameters
  • parent - The parent table.
  • uiFinder - The function which returns the axuielement.
  • minValue - The minimum value allowed for the value.
  • maxValue - The maximum value allowed for the value.
  • toAXValueFn - The function which will convert the user value to the actual AXValue.
  • fromAXValueFn - The function which will convert the current AXValue to a user value.
Returns
  • New ValueIndicator instance.
Notes None
Examples None
Source src/extensions/cp/apple/finalcutpro/inspector/color/ValueIndicator.lua line 27

# Methods

# decrement

Signature cp.apple.finalcutpro.inspector.color.ValueIndicator:decrement() -> cp.apple.finalcutpro.inspector.color.ValueIndicator
Type Method
Description Decrements the value indicator.
Parameters
  • None
Returns
  • The cp.apple.finalcutpro.inspector.color.ValueIndicator object.
Notes None
Examples None
Source src/extensions/cp/apple/finalcutpro/inspector/color/ValueIndicator.lua line 145

# increment

Signature cp.apple.finalcutpro.inspector.color.ValueIndicator:increment() -> cp.apple.finalcutpro.inspector.color.ValueIndicator
Type Method
Description Increments the value indicator.
Parameters
  • None
Returns
  • The cp.apple.finalcutpro.inspector.color.ValueIndicator object.
Notes None
Examples None
Source src/extensions/cp/apple/finalcutpro/inspector/color/ValueIndicator.lua line 128

# isShowing

Signature cp.apple.finalcutpro.inspector.color.ValueIndicator:isShowing() -> boolean
Type Method
Description Is the Value Indicator currently showing?
Parameters
  • None
Returns
  • true if showing, otherwise false
Notes None
Examples None
Source src/extensions/cp/apple/finalcutpro/inspector/color/ValueIndicator.lua line 50

# loadLayout

Signature cp.apple.finalcutpro.inspector.color.ValueIndicator:loadLayout(layout) -> none
Type Method
Description Loads a layout.
Parameters
  • layout - The layout table you want to load.
Returns
  • None
Notes None
Examples None
Source src/extensions/cp/apple/finalcutpro/inspector/color/ValueIndicator.lua line 177

# saveLayout

Signature cp.apple.finalcutpro.inspector.color.ValueIndicator:saveLayout() -> table
Type Method
Description Saves the layout.
Parameters
  • None
Returns
  • A table containing the layout.
Notes None
Examples None
Source src/extensions/cp/apple/finalcutpro/inspector/color/ValueIndicator.lua line 162

# shiftValue

Signature cp.apple.finalcutpro.inspector.color.ValueIndicator:shiftValue(value) -> cp.apple.finalcutpro.inspector.color.ValueIndicator
Type Method
Description Shifts the Value Indicator value.
Parameters
  • value - The amount to shift the value indicator by as a number.
Returns
  • The cp.apple.finalcutpro.inspector.color.ValueIndicator object.
Notes None
Examples None
Source src/extensions/cp/apple/finalcutpro/inspector/color/ValueIndicator.lua line 91

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