Internationalisation
Bundled Plugins API
Column
Represents an AXColumn axuielement.

API Overview

  • Functions - API calls offered directly by the extension
  • matches
  • Fields - Variables which can only be accessed from an object returned by a constructor
  • index
  • selected
  • Methods - API calls which can only be made on an object returned by a constructor
  • rows

API Documentation

Functions

matches

Signature
cp.ui.Column.matches(element) -> boolean
Type
Function
Description
Checks if the axuielement is a Column.
Parameters
  • element - The axuielement to check.
Returns
  • true if the element is a Column.

Fields

index

Signature
cp.ui.Column.index <cp.prop: number; read-only>
Type
Field
Description
The numeric index of this column in the overall container, with 0 being the first item.

selected

Signature
cp.ui.Column.selected <cp.prop: boolean>
Type
Field
Description
Indicates if the column is currently selected. May be set.

Methods

rows

Signature
cp.ui.Column:rows() -> table of cp.ui.Row or nil
Type
Method
Description
Returns a table of Rows contained in the Column.
Returns
  • The table, or nil if the column's UI is not available.
Signature
cp.ui.Column:visibleRows() -> table of cp.ui.Rows or nil
Type
Method
Description
Returns a table of Rows which are currently visible on screen.
Returns
  • The table, or nil if the column's UI is not available.
Last modified 1mo ago