Package io.deephaven.web.client.api

Class Sort

java.lang.Object
io.deephaven.web.client.api.Sort
@TsName(namespace="dh") public class Sort extends Object
Describes a Sort present on the table. No visible constructor, created through the use of Column.sort(), will be tied to that particular column data. Sort instances are immutable, and use a builder pattern to make modifications. All methods return a new Sort instance.

  • Field Details

  • Constructor Details

    • Sort

      public Sort(Column column)

  • Method Details

    • reverse

      public static Sort reverse()

    • getColumn

      @JsProperty public Column getColumn()
      The column which is sorted.
      Returns:
      Column

    • getDirection

      @JsProperty public String getDirection()
      The direction of this sort, either ASC, DESC, or REVERSE.
      Returns:
      String

    • isAbs

      @JsProperty(name="isAbs") public boolean isAbs()
      Set to true if the absolute value of the column should be used when sorting; defaults to false.
      Returns:
      boolean

    • asc

      @JsMethod public Sort asc()
      Builds a Sort instance to sort values in ascending order.
      Returns:
      Sort

    • desc

      @JsMethod public Sort desc()
      Builds a Sort instance to sort values in descending order.
      Returns:
      Sort

    • abs

      @JsMethod public Sort abs()
      Builds a Sort instance which takes the absolute value before applying order.
      Returns:
      Sort

    • makeDescriptor

      public SortDescriptor makeDescriptor()

    • toString

      @JsMethod public String toString()
      Overrides:
      toString in class Object

    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class Object

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object