Class SortPair
An object representing a sort request on a column. Columns can be sorted in ascending or descending order, and by absolute value if requested.
Inheritance
Namespace: Deephaven.OpenAPI.Client
Assembly: DeephavenOpenAPI.dll
Syntax
public class SortPair : objectConstructors
SortPair(IColumn, SortDirection, Boolean)
Creates a SortPair bound to "column" with specified direction and absolute value handling.
Declaration
public SortPair(IColumn column, SortDirection sortDirection, bool abs)Parameters
| Type | Name | Description |
|---|---|---|
| IColumn | column | The IColumn to be sorted |
| SortDirection | sortDirection | The sort direction |
| System.Boolean | abs | Whether item should be sorted by absolute value |
SortPair(String, SortDirection, Boolean)
Creates a SortPair bound to "column" with specified direction and absolute value handling.
Declaration
public SortPair(string column, SortDirection sortDirection, bool abs)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | column | The name of the column to be sorted |
| SortDirection | sortDirection | The sort direction |
| System.Boolean | abs | Whether item should be sorted by absolute value |
Properties
Abs
Whether the sort should be done by absolute value.
Declaration
public bool Abs { get; }Property Value
| Type | Description |
|---|---|
| System.Boolean |
Column
Column name
Declaration
public string Column { get; }Property Value
| Type | Description |
|---|---|
| System.String |
Direction
Sort direction
Declaration
public SortDirection Direction { get; }Property Value
| Type | Description |
|---|---|
| SortDirection |
Methods
Ascending(IColumn, Boolean)
Creates a SortPair bound to "column" with Ascending direction and optional absolute value handling.
Declaration
public static SortPair Ascending(IColumn column, bool abs = false)Parameters
| Type | Name | Description |
|---|---|---|
| IColumn | column | The IColumn to be sorted |
| System.Boolean | abs | Whether item should be sorted by absolute value |
Returns
| Type | Description |
|---|---|
| SortPair | The SortPair |
Ascending(String, Boolean)
Creates a SortPair bound to "column" with Ascending direction and optional absolute value handling.
Declaration
public static SortPair Ascending(string column, bool abs = false)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | column | The name of the column to be sorted |
| System.Boolean | abs | Whether item should be sorted by absolute value |
Returns
| Type | Description |
|---|---|
| SortPair | The SortPair |
Descending(IColumn, Boolean)
Creates a SortPair bound to "column" with Descending direction and optional absolute value handling.
Declaration
public static SortPair Descending(IColumn column, bool abs = false)Parameters
| Type | Name | Description |
|---|---|---|
| IColumn | column | The IColumn to be sorted |
| System.Boolean | abs | Whether item should be sorted by absolute value |
Returns
| Type | Description |
|---|---|
| SortPair | The SortPair |
Descending(String, Boolean)
Creates a SortPair bound to "column" with Descending direction and optional absolute value handling.
Declaration
public static SortPair Descending(string column, bool abs = false)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | column | The name of the column to be sorted |
| System.Boolean | abs | Whether item should be sorted by absolute value |
Returns
| Type | Description |
|---|---|
| SortPair | The SortPair |