FilterCombination
A logical grouping filter used to apply multiple filters together using AND or OR logic.
Combination filters enable complex conditional logic by nesting different filters into a tree structure.
filters
propertyThe list of filters to combine using the specified operator.
This list may contain any combination of core filter types, including nested combination filters.
No properties
kind
propertyType discriminator for a combination filter. Identifies this object as a logical combination of sub-filters.
Value
"\"combination\""
operator
propertyThe logical operator to apply when evaluating the list of filters (e.g., AND, OR).
FilterCombinationOperator
Logical operators used to join multiple filters inside a combination filter.
Type
"AND" | "OR"
Variants
"AND""OR"
FilterDate
A filter type for evaluating date fields in a grid dataset.
Date filters enable both exact and relative comparisons of date values and are essential
for time-series or event-driven data. LyteNyte Grid expects date values to follow a standard
ISO string format like "2025-02-01 12:00:11-02:00" .
If filtering on timestamps or partial dates, be mindful of timezone offsets and whether time components are relevant to your comparison.
kind
propertyType discriminator used to identify this filter as a date-based filter.
Helps distinguish between multiple filter types when working with compound filters.
Value
"\"date\""
operator
propertyThe comparison operator to apply. Determines how the field value is matched
against the provided filter value .
Refer to FilterDateOperator for the complete set of options.
options
propertyOptional configuration to control how the date is parsed and compared.
For example, setting includeTime enables precise comparisons down to milliseconds.
value
propertyThe comparison value used by the filter.
This may be:
- A date string (e.g., "2025-01-01") for direct comparisons
- A number (e.g., 7) for relative filters like "n_days_ago"
- Null, for special null-matching semantics
The exact type depends on the operator in use.
Type
null | string | number
Variants
nullstringnumber
FilterDateOperator
Set of valid comparison operators for evaluating date-based filters.
These operators support both fixed comparisons (e.g., "equals", "before") and dynamic relative date expressions (e.g., "n_days_ago", "last_week", "is_weekend").
The required type of the value field depends on the selected operator.
Type
"equals" | "not_equals" | "before" | "before_or_equals" | "after" | "after_or_equals" | "year_to_date" | "this_week" | "this_month" | "this_year" | "last_week" | "last_month" | "last_year" | "next_week" | "next_month" | "next_year" | "today" | "tomorrow" | "yesterday" | "week_of_year" | "quarter_of_year" | "is_weekend" | "is_weekday" | "n_days_ago" | "n_days_ahead" | "n_weeks_ago" | "n_weeks_ahead" | "n_months_ago" | "n_months_ahead" | "n_years_ago" | "n_years_ahead"
Variants
"equals""not_equals""before""before_or_equals""after""after_or_equals""year_to_date""this_week""this_month""this_year""last_week""last_month""last_year""next_week""next_month""next_year""today""tomorrow""yesterday""week_of_year""quarter_of_year""is_weekend""is_weekday""n_days_ago""n_days_ahead""n_weeks_ago""n_weeks_ahead""n_months_ago""n_months_ahead""n_years_ago""n_years_ahead"
FilterDateOptions
Optional modifiers to customize date filter evaluation behavior.
Includes options like null handling and whether time values should be considered during comparisons.
includeTime
propertyIf true, includes time components (hours, minutes, seconds) when comparing date values.
By default, only the calendar date is compared. Enabling this flag allows for high-precision filtering, which is useful for timestamp-based data (e.g., log entries or event schedules).
Type
boolean
nullHandling
propertyControls how null values are treated when applying the filter.
"ignore": Excludes rows where the value isnull"include": Retains rows withnullvalues
Note: Actual behavior depends on the row data source. Properly implemented sources will
respect this setting, but others may not. Additionally, this setting may be ignored by some
filter operators. For instance, equality checks may treat null as a valid match if it's
explicitly passed as the filter value.
Type
"ignore" | "include"
Variants
"ignore""include"
FilterFn
A function-based filter used for advanced filtering logic that cannot be represented using built-in filter types.
The function should return true to keep a row or false to filter it out.
Parameters
params | FilterFnParams (docs) |
Returns
boolean
FilterFnParams
The parameters passed to a custom function filter.
Includes both the current row's data and the overall grid configuration.
data
propertyThe data object associated with the row. It may be null if the row is loading or not yet available.
Type
null | T
Variants
nullT
grid
propertyA reference to the LyteNyte Grid instance.
| Type | Grid |
FilterFunc
A functional filter definition. It provides ultimate flexibility for filtering scenarios that don't conform to basic models.
Should be used selectively and optimized for performance.
func
propertyThe filter function to evaluate for each row.
| Type | FilterFn |
kind
propertyType discriminator used to identify this as a function filter.
Value
"\"func\""
FilterIn
Represents a set-based filter that checks whether a value is included in (or excluded from) a set of values.
Often referred to as a "Set Filter", this is a PRO-only feature in LyteNyte Grid and cannot be nested in combination filters.
kind
propertyType discriminator used to identify this filter as an in filter.
Ensures correct handling within the filter model.
Value
"\"in\""
operator
propertySpecifies whether to include or exclude the values in the set. See FilterInOperator .
| Type | FilterInOperator |
value
propertyThe set of allowed or disallowed values to filter against.
Values may include strings, numbers, or nulls. The operator determines how this set is interpreted.
| Type | Set |
FilterInFilterItem
Represents a displayable filter option for use with the in filter UI component.
Supports grouping and human-friendly labeling for raw filter values.
groupPath
propertyGrouping path to organize filter values into nested structures.
This is useful for tree-based UIs where items belong to categories (e.g., year > month > day).
No properties
id
propertyA unique id for the in filter item.
Type
string
label
propertyThe display label for the item in the UI. Should be human-readable even when the value itself is raw or technical.
Type
string
value
propertyThe value to be matched in the in-filter set. Typically a string or number.
Type
unknown
FilterInOperator
The valid operators for an in filter.
"in": Tests for inclusion in the set."not_in": Tests for exclusion from the set.
Type
"in" | "not_in"
Variants
"in""not_in"
FilterNumber
Defines a filter for numeric columns.
Applies common comparison logic to include or exclude rows based on numerical values in a specified column.
kind
propertyDiscriminant property used for type narrowing and filter dispatching. Identifies this object as a number-based filter.
Value
"\"number\""
operator
propertyOperator to apply in the filter condition (e.g., greater_than , equals ).
Determines how the row value is compared to the provided value .
options
propertyOptional behavior modifiers for the filter such as absolute value comparison and null handling.
These settings enhance precision and flexibility when filtering numerical data.
value
propertyTarget value for the filter.
This will be used as the right-hand operand when applying the operator to each row's value. May be null if specifically filtering for nulls.
Type
null | number
Variants
nullnumber
FilterNumberOperator
Logical operators available for number-based filtering.
These correspond to the traditional comparison operators, >, <= , etc.
Type
"greater_than" | "greater_than_or_equals" | "less_than" | "less_than_or_equals" | "equals" | "not_equals"
Variants
"greater_than""greater_than_or_equals""less_than""less_than_or_equals""equals""not_equals"
FilterNumberOptions
Optional configuration values for number filters. These options allow fine-tuning of filter behavior, especially in cases involving precision or null handling.
absolute
propertyIf set to true , the filter will compare absolute values instead of signed numbers.
Useful for scenarios where magnitude is more relevant than direction (e.g., distance, deviation).
Type
boolean
epsilon
propertyFloating-point precision buffer when evaluating comparisons.
For example, a comparison using epsilon = 0.0001 allows for minor rounding differences
when dealing with decimal values.
Type
number
nullHandling
propertyControls how null values are treated when applying the filter.
"ignore": Excludes rows where the value isnull"include": Retains rows withnullvalues
Note: Actual behavior depends on the row data source. Properly implemented sources will
respect this setting, but others may not. Additionally, this setting may be ignored by some
filter operators. For instance, equality checks may treat null as a valid match if it's
explicitly passed as the filter value.
Type
"ignore" | "include"
Variants
"ignore""include"
FilterQuickSearchSensitivity
Sensitivity mode for the quick search functionality.
"case-sensitive": Exact matches required."case-insensitive": Case differences are ignored.
Type
"case-sensitive" | "case-insensitive"
Variants
"case-sensitive""case-insensitive"
FilterString
Filter configuration for string-based column data.
Supports a wide range of operators such as exact match, substring containment, regex matching, and string length comparisons.
kind
propertyType discriminant used internally to identify this as a string filter. Useful when filters are stored in a mixed array.
Value
"\"string\""
operator
propertyThe filtering operator (e.g., "contains", "equals", "length_greater_than").
options
propertyOptional modifiers to control filter behavior including case sensitivity, whitespace, punctuation, and locale-sensitive matching.
value
propertyThe value to compare against.
May be:
string: for most text comparisonsnumber: for length-based operatorsnull: when matching absence of value
Type
null | string | number
Variants
nullstringnumber
FilterStringCollation
Collation configuration for locale-sensitive string comparisons.
Used to construct an Intl.Collator instance, which enables proper handling of language and region-specific rules.
locale
propertyThe locale string to apply during comparisons (e.g., "en", "de", "zh-CN"). This determines how values are interpreted for culturally appropriate sorting.
| Type | Locale |
sensitivity
propertySpecifies the sensitivity of character comparisons (e.g., case vs. accent differences).
See the Intl.Collator documentation for details on supported sensitivity levels.
Type
"base" | "accent" | "case" | "variant"
Variants
"base""accent""case""variant"
FilterStringOperator
List of operators available for string filtering.
These include comparison operators (e.g., "equals"), substring checks (e.g., "contains"), and
length-based checks (e.g., "length_less_than"). Some operators require a numeric value
(e.g., those dealing with string length).
Type
"equals" | "not_equals" | "less_than" | "less_than_or_equals" | "greater_than" | "greater_than_or_equals" | "begins_with" | "not_begins_with" | "ends_with" | "not_ends_with" | "contains" | "not_contains" | "length" | "not_length" | "matches" | "length_less_than" | "length_less_than_or_equals" | "length_greater_than" | "length_greater_than_or_equals"
Variants
"equals""not_equals""less_than""less_than_or_equals""greater_than""greater_than_or_equals""begins_with""not_begins_with""ends_with""not_ends_with""contains""not_contains""length""not_length""matches""length_less_than""length_less_than_or_equals""length_greater_than""length_greater_than_or_equals"
FilterStringOptions
Optional settings to modify the behavior of string filter evaluation.
These provide control over how string values are matched, such as case sensitivity, whitespace trimming, regular expression flags, and locale-based collation.
caseInsensitive
propertyIf true, string comparisons are case-insensitive.
Note: Some locales may implicitly perform case-insensitive comparisons depending on sensitivity .
Type
boolean
collation
propertyCollation options to apply locale-sensitive sorting and comparison behavior using Intl.Collator .
ignorePunctuation
propertyIf true, removes punctuation from strings before evaluating the comparison.
Type
boolean
nullHandling
propertyControls how null values are treated when applying the filter.
"ignore": Excludes rows where the value isnull"include": Retains rows withnullvalues
Note: Actual behavior depends on the row data source. Properly implemented sources will
respect this setting, but others may not. Additionally, this setting may be ignored by some
filter operators. For instance, equality checks may treat null as a valid match if it's
explicitly passed as the filter value.
Type
"ignore" | "include"
Variants
"ignore""include"
regexOpts
propertyFlags to apply when using the matches operator (e.g., "i" for case-insensitive, "g" for global).
See the MDN RegExp flags guide for details.
Type
string
trimWhitespace
propertyIf true, trims leading and trailing whitespace from both the value and target before comparing.
Type
boolean
Locale
The supported locale identifiers for string filtering and collation.
Used to configure internationalized string comparison behavior.
Type
"en-US" | "en-GB" | "en-CA" | "en-AU" | "en-IN" | "fr-FR" | "fr-CA" | "fr-BE" | "fr-CH" | "es-ES" | "es-MX" | "es-AR" | "es-CO" | "zh-CN" | "zh-TW" | "zh-HK" | "zh-Hant" | "zh-Hans" | "ar-SA" | "ar-EG" | "ar-AE" | "de-DE" | "de-AT" | "de-CH" | "ja-JP" | "ko-KR" | "hi-IN" | "pt-BR" | "pt-PT" | "ru-RU" | "uk-UA" | "pl-PL" | "it-IT" | "nl-NL" | "sv-SE" | "tr-TR" | "th-TH" | "vi-VN" | "he-IL" | "fa-IR" | "el-GR"
Variants
"en-US""en-GB""en-CA""en-AU""en-IN""fr-FR""fr-CA""fr-BE""fr-CH""es-ES""es-MX""es-AR""es-CO""zh-CN""zh-TW""zh-HK""zh-Hant""zh-Hans""ar-SA""ar-EG""ar-AE""de-DE""de-AT""de-CH""ja-JP""ko-KR""hi-IN""pt-BR""pt-PT""ru-RU""uk-UA""pl-PL""it-IT""nl-NL""sv-SE""tr-TR""th-TH""vi-VN""he-IL""fa-IR""el-GR"