Configure rows order¶

UI • interface

Configures the order of the rows in the Data section.

By default the order is identical to that in the input dataset, and row indices will be used to decide any ties found.

If you're selecting a list-like column, only the highest (ascending) or lowest (descending) value of the column will be used for sorting.

Usage¶

The following are the step's expected inputs and outputs and their specific types.

Step signature

configure_rows_order(column_to_order: column, {
    "param": value
})

where the object {"param": value} is optional in most cases and if present may contain any of the parameters described in the corresponding section below.

Example¶

Order table rows from highest to lowest salary

Example call (in recipe editor)

configure_rows_order(ds.salary, { "order": "ascending" })

More examples

Order table rows from lowest to highest age

Example call (in recipe editor)

configure_rows_order(ds.age, { "order": "descending" })

Inputs¶

column_to_order: column

Column to be used to order the rows.

Parameters¶

order: string

Sort direction to be applied to data table rows order.

Must be one of: "ascending", "descending"