module:baja/coll/TableCursor

module:baja/coll/TableCursor

new (require("baja/coll/TableCursor"))()

Description:

  • Cursor for a Table.

Source:
See:
Extends:

Extends

Methods

after(func)

Description:

  • When the cursor is iterated, the before function will be called
    just after iteration has finished.

    When the function is called, this refers to the Cursor. The Cursor is also
    passed in as a argument to this function.

Source:
Inherited From:
Parameters:
Name Type Description
func function

the after function.

before(func)

Description:

  • When the cursor is iterated, the before function will be called
    just before iteration starts.

    When the function is called, this refers to the Cursor. The Cursor is also
    passed in as a argument to this function.

Source:
Inherited From:
Parameters:
Name Type Description
func function

the before function.

each(func)

Description:

  • Iterate through the Cursor and call a function for every item.

    When the function is called, this refers to the Cursor.

Source:
Inherited From:
Parameters:
Name Type Description
func function

function called on every iteration with
the current row used as the first argument and row
index as the second argument.

get(columnopt)

Description:

  • Return the current row or row item.

    If column information is passed into this method then the value for a particular
    column and row will be returned.

Source:
Overrides:
Parameters:
Name Type Attributes Description
column String | module:baja/coll/Table.TableColumn <optional>

the column
name or column. If undefined, the entire row is returned.
Returns:

the cursor value (null if none available).

getDisplay(columnopt) → {String}

Description:

  • Return the current item display string.

    If column information is passed into this method then the display String for a particular
    column and row will be returned.

Source:
Parameters:
Name Type Attributes Description
column String | module:baja/coll/Table.TableColumn <optional>

the column
name or column. If undefined, the entire row is returned.
Returns:

the cursor display string (null if none available).

Type
String

getSource() → {baja.coll.QueryResult}

Description:

  • Return the underlying Cursor's data source.

Source:
Inherited From:
Returns:
Type
baja.coll.QueryResult