RevGrid - v0.9.3
    Preparing search index...

    Provides access to a field

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    Properties

    compare: (this: void, left: never, right: never) => number

    Compares two records based on this field for sorting in ascending order

    Type declaration

      • (this: void, left: never, right: never): number
      • Parameters

        • this: void
        • left: never

          The record on the left of the comparison

        • right: never

          The record on the right of the comparison

        Returns number

    compareDesc: (this: void, left: never, right: never) => number

    Compares two records based on this field for sorting in descending order

    Type declaration

      • (this: void, left: never, right: never): number
      • Parameters

        • this: void
        • left: never

          The record on the left of the comparison

        • right: never

          The record on the right of the comparison Can be undefined to disable sorting based on this field

        Returns number

    getViewValue: (this: void, record: never) => unknown

    Retrieves the value of a field for display purposes

    index: number

    Used by servers to index data. Will be used by client to access data in circumstances when a complete row of data is retrieved with RevDataServer.getViewRow from the server.

    name: string

    Identifies a field in the schema. Will be unique within a schema (ie grid).

    Methods