LyteNyte Grid logo for light mode. Links back to the documentation home page.
Functionality

Filters

The API reference for the filters functionality in LyteNyte Grid.

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.

FilterCombinationOperator

Prop

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.

Prop

FilterDateOperator

Prop

FilterDateOptions

Optional modifiers to customize date filter evaluation behavior.

Includes options like null handling and whether time values should be considered during comparisons.

Prop

FilterFn

Prop

FilterFnParams

The parameters passed to a custom function filter.

Includes both the current row's data and the overall grid configuration.

Prop

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.

Prop

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.

Prop

FilterInFilterItem

Represents a displayable filter option for use with the in filter UI component.

Supports grouping and human-friendly labeling for raw filter values.

Prop

FilterInOperator

Prop

FilterModelItem

FilterNumber

Defines a filter for numeric columns.

Applies common comparison logic to include or exclude rows based on numerical values in a specified column.

Prop

FilterNumberOperator

Prop

FilterNumberOptions

Optional configuration values for number filters. These options allow fine-tuning of filter behavior, especially in cases involving precision or null handling.

Prop

FilterQuickSearchSensitivity

Prop

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.

Prop

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.

Prop

FilterStringOperator

Prop

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.

Prop

Locale

Prop