Components
    • Animation
    • Buttons
    • Charts
    • Common Utilities
    • Conversational UI
    • Data Query
    • Data Tools
    • Date Inputs
    • Date Math
    • Dialogs
    • Drawing
    • Dropdowns
    • Editor
    • Excel Export
    • File Saver
    • Form
    • Gantt
    • Gauges
    • Grid
    • Indicators
    • Inputs
    • Labels
    • Layout
    • ListBox
    • ListView
    • Notification
    • PDF Processing
    • Popup
    • Progress Bars
    • Ripple
    • Scheduler
    • Sortable
    • Tooltip
    • TreeList
    • TreeView
    • Upload
    Sample Applications
    Styling & Themes
    Common Features
    Project Setup
    Changelog

FilterDescriptor

A basic filter expression. Usually a part of CompositeFilterDescriptor.

For more information, refer to the filterBy method.

field?

string | Function

The field of the data item to which the filter operator is applied.

ignoreCase?

boolean

Determines if the string comparison is case-insensitive.

operator

string | Function

The filter operator (comparison).

The supported operators are:

  • "eq" (equal to)
  • "neq" (not equal to)
  • "isnull" (is equal to null)
  • "isnotnull" (is not equal to null)
  • "lt" (less than)
  • "lte" (less than or equal to)
  • "gt" (greater than)
  • "gte" (greater than or equal to)

The following operators are supported for string fields only:

  • "startswith"
  • "endswith"
  • "contains"
  • "doesnotcontain"
  • "isempty"
  • "isnotempty"

value?

any

The value to which the field is compared. Has to be of the same type as the field.

In this article

Not finding the help you need?