@deephaven/jsapi-types
    Preparing search index...

    Class ColumnRestrictionAbstract

    Abstract base class representing a restriction on an input table column. Each restriction has a type string identifying what kind of restriction it is, and a ColumnRestriction.validate() method for client-side validation.

    Built-in restriction types are exposed as typed subclasses with strongly-typed fields:

    Custom restriction types can be registered via ColumnRestrictionRegistry.register. The converter must return a concrete subclass of ColumnRestriction that overrides ColumnRestriction.validate() as needed.

    Hierarchy (View Summary)

    Index
    • get type(): string

      The fully-qualified protobuf type name of this restriction (e.g., "io.deephaven.proto.backplane.grpc.IntegerRangeRestriction").

      Returns string

      The restriction type name

    • Validates a proposed value against this restriction.

      Parameters

      • value: any

        The proposed column value to validate

      Returns string

      An error message if the value violates the restriction, or null if the value is valid