# cp.apple.finalcutpro.timeline.IndexTags

Provides access to the 'Tags' section of the Timeline Index

# Submodules

# API Overview

Fields - Variables which can only be accessed from an object returned by a constructor

  • activate
  • all
  • analysisKeywords
  • chapters
  • completeTodos
  • incompleteTodos
  • keywords
  • list
  • standardMarkers
  • type

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

  • doLayout
  • doShowAll
  • doShowAnalysisKeywords
  • doShowChapters
  • doShowCompleteTodos
  • doShowIncompleteTodos
  • doShowKeywords
  • doShowStandardMarkers
  • saveLayout

# API Documentation

# Fields

# activate

Signature cp.apple.finalcutpro.timeline.IndexTags.activate <cp.ui.RadioButton>
Type Field
Description The RadioButton that activates the 'Tags' section.
Notes None
Source src/extensions/cp/apple/finalcutpro/timeline/IndexTags.lua line 23

# all

Signature cp.apple.finalcutpro.timeline.IndexTags.all <cp.ui.RadioButton>
Type Field
Description The RadioButton that will show "All" types of media.
Notes None
Source src/extensions/cp/apple/finalcutpro/timeline/IndexTags.lua line 44

# analysisKeywords

Signature cp.apple.finalcutpro.timeline.IndexTags.analysisKeywords <cp.ui.RadioButton>
Type Field
Description The RadioButton for the "Auto-analysis keywords" filter.
Notes None
Source src/extensions/cp/apple/finalcutpro/timeline/IndexTags.lua line 166

# chapters

Signature cp.apple.finalcutpro.timeline.IndexTags.chapters <cp.ui.RadioButton>
Type Field
Description The RadioButton for the "Chapter markers" filter.
Notes None
Source src/extensions/cp/apple/finalcutpro/timeline/IndexTags.lua line 187

# completeTodos

Signature cp.apple.finalcutpro.timeline.IndexTags.completeTodos <cp.ui.RadioButton>
Type Field
Description The RadioButton for the "Complete todo marker" filter.
Notes None
Source src/extensions/cp/apple/finalcutpro/timeline/IndexTags.lua line 180

# incompleteTodos

Signature cp.apple.finalcutpro.timeline.IndexTags.incompleteTodos <cp.ui.RadioButton>
Type Field
Description The RadioButton for the "Incomplete todo marker" filter.
Notes None
Source src/extensions/cp/apple/finalcutpro/timeline/IndexTags.lua line 173

# keywords

Signature cp.apple.finalcutpro.timeline.IndexTags.keywords <cp.ui.RadioButton>
Type Field
Description The RadioButton for the "Keywords" filter.
Notes None
Source src/extensions/cp/apple/finalcutpro/timeline/IndexTags.lua line 159

# list

Signature cp.apple.finalcutpro.timeline.IndexTags.list <cp.ui.OldTable>
Type Field
Description The list of tags as a Table.
Notes None
Source src/extensions/cp/apple/finalcutpro/timeline/IndexTags.lua line 30

# standardMarkers

Signature cp.apple.finalcutpro.timeline.IndexTags.standardMarkers <cp.ui.RadioButton>
Type Field
Description The RadioButton for the "Standard markers" filter.
Notes None
Source src/extensions/cp/apple/finalcutpro/timeline/IndexTags.lua line 152

# type

Signature cp.apple.finalcutpro.timeline.IndexTags.type <cp.apple.finalcutpro.timeline.IndexTags.Type>
Type Field
Description The IndexTags.Type.
Notes None
Source src/extensions/cp/apple/finalcutpro/timeline/IndexTags.lua line 145

# Methods

# doLayout

Signature cp.apple.finalcutpro.timeline.IndexTags:doLayout(layout) -> cp.rx.go.Statement
Type Method
Description Returns a Statement that will apply the layout provided, if possible.
Parameters
  • layout - the table containing the layout configuration. Usually created via the [#saveLayout] method.
Returns
Notes None
Examples None
Source src/extensions/cp/apple/finalcutpro/timeline/IndexTags.lua line 328

# doShowAll

Signature cp.apple.finalcutpro.timeline.IndexTags:doShowAll() -> cp.rx.go.Statement
Type Method
Description Returns a Statement that will set the tag index to "All" media types.
Parameters
  • None
Returns
  • Statement
Notes None
Examples None
Source src/extensions/cp/apple/finalcutpro/timeline/IndexTags.lua line 194

# doShowAnalysisKeywords

Signature cp.apple.finalcutpro.timeline.IndexTags:doShowAnalysisKeywords() -> cp.rx.go.Statement
Type Method
Description Returns a Statement that will set the tag index to "Analysis Keywords".
Parameters
  • None
Returns
  • Statement
Notes None
Examples None
Source src/extensions/cp/apple/finalcutpro/timeline/IndexTags.lua line 242

# doShowChapters

Signature cp.apple.finalcutpro.timeline.IndexTags:doShowChapters() -> cp.rx.go.Statement
Type Method
Description Returns a Statement that will set the tag index to "Chapter" markers.
Parameters
  • None
Returns
  • Statement
Notes None
Examples None
Source src/extensions/cp/apple/finalcutpro/timeline/IndexTags.lua line 290

# doShowCompleteTodos

Signature cp.apple.finalcutpro.timeline.IndexTags:doShowCompleteTodos() -> cp.rx.go.Statement
Type Method
Description Returns a Statement that will set the tag index to "Complete Todos".
Parameters
  • None
Returns
  • Statement
Notes None
Examples None
Source src/extensions/cp/apple/finalcutpro/timeline/IndexTags.lua line 274

# doShowIncompleteTodos

Signature cp.apple.finalcutpro.timeline.IndexTags:doShowIncompleteTodos() -> cp.rx.go.Statement
Type Method
Description Returns a Statement that will set the tag index to "Incomplete Todo Markers".
Parameters
  • None
Returns
  • Statement
Notes None
Examples None
Source src/extensions/cp/apple/finalcutpro/timeline/IndexTags.lua line 258

# doShowKeywords

Signature cp.apple.finalcutpro.timeline.IndexTags:doShowKeywords() -> cp.rx.go.Statement
Type Method
Description Returns a Statement that will set the tag index to "Keywords".
Parameters
  • None
Returns
  • Statement
Notes None
Examples None
Source src/extensions/cp/apple/finalcutpro/timeline/IndexTags.lua line 226

# doShowStandardMarkers

Signature cp.apple.finalcutpro.timeline.IndexTags:doShowStandardMarkers() -> cp.rx.go.Statement
Type Method
Description Returns a Statement that will set the tag index to "Standard" markers.
Parameters
  • None
Returns
  • Statement
Notes None
Examples None
Source src/extensions/cp/apple/finalcutpro/timeline/IndexTags.lua line 210

# saveLayout

Signature cp.apple.finalcutpro.timeline.IndexTags:saveLayout() -> table
Type Method
Description Returns a table containing the layout configuration for this class.
Parameters
  • None
Returns
  • The layout configuration table.
Notes None
Examples None
Source src/extensions/cp/apple/finalcutpro/timeline/IndexTags.lua line 306

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