Interface FilterOptions

Hierarchy

  • FilterOptions

Properties

blankValuesLabel?: string

Value for the blank item in multi select combobox filter control Please note, there is a space in the front of this string so it shows up right below the "All" option.

Property

Default

" [None] "

delayedChangeDuration?: number

Applicable only if the filter control is TextInput. Amount of time to wait before applying the filter. This is useful if you want to wait for the user to finish typing.

Property

Default

300

See

https://www.reactdatagrid.com/examples?example=Filter_Options

excludeFromQuickFind?: boolean

If set to true, this column wont be included in the quick find mechanism by default.

Property

filterComboBoxBuildFromGrid?: boolean

Flag, if set to true, will automatically build this collection on basis of distinct values in the grid.

Property

Default

false

See

https://www.reactdatagrid.com/examples?example=Filter_Options

filterComboBoxBuildFromGridHierarchy?: boolean

A flag to build the multi select filter accounting for the hierarchy of the grid.

Property

Default

false

See

https://www.reactdatagrid.com/examples?example=Grouping

filterComboBoxDataField?: string

Used in conjunction with the

Filter Combo Box Data Provider

field, used to set the value of the data field for the associated ISelectFilterControl

Property

See

https://www.reactdatagrid.com/examples?example=Filter_Options

filterComboBoxDataProvider?: unknown[]

Dataprovider to use to build the list of values to dipsplay in the filter control, only applicable if the filterControl is a SelectFilter or MultiSelectFilter.

Note: It is not required to set this field. You may set the

See

Property

Default

null

filterComboBoxLabelField?: string

Used in conjunction with the

Filter Combo Box Data Provider

field, used to set the value of the label field for the associated ISelectFilterControl

Property

See

https://www.reactdatagrid.com/examples?example=Filter_Options

filterCompareFunction?: ((item: unknown, col: ColumnOptions, value: unknown) => boolean)

Type declaration

    • (item: unknown, col: ColumnOptions, value: unknown): boolean
    • A function that takes an item, and a filterExpression, and returns true or false on basis of whether the provided item matches the filterExpression. Please note, the filterExpression has a pointer to the iFilterControl that it was created from.

      Property

      Default

      null

      Parameters

      Returns boolean

filterComparisionType?: FilterComparisionType

This is usually automatically set, you dont have to manually set it, unless you're sending strings as Date objects. When set, will attempt to first convert the current value to the type you specified and then do the conversion. Values : auto,string,number,boolean,date

Property

Default

"auto"

filterConverterFunction?: ((item: unknown, col: ColumnOptions, value: unknown) => unknown)

Type declaration

    • (item: unknown, col: ColumnOptions, value: unknown): unknown
    • A function that takes an item, and returns a processed value for comparison. For example, if your backend sends down strings that represents a date, wire this function up and return a date object for comparison purposes.

      Property

      Default

      null

      Example

      convertDate(item,col) {
      var dt = flexiciousNmsp.UIUtils.resolveExpression(item,col.getDataField()).toString();
      var date =flexiciousNmsp.UIUtils.getDateValue(dt,flexiciousNmsp.Constants.YMD_MASK); //will need to change this for
      return date;
      }

      Parameters

      Returns unknown

filterDateRangeOptions?: (DateRangeType | {
    end: Date;
    start: Date;
    type: string;
})[]

Applicable only when the filtercontrol is a date filter control. This is a list of Date Range Strings from the below: This has to be a list of Date Range Strings from the below:

  • "Last60Minutes" = "Last 60 Minutes"
  • "Last12Hours" = "Last 12 Hours"
  • "Last24Hours" = "Last 24 Hours"
  • "Last7Days" = "Last 7 Days"
  • "ThisHour" = "This Hour"
  • "LastHour" = "Last Hour"
  • "NextHour" = "Next Hour"
  • "Today" = "Today"
  • "Yesterday" = "Yesterday"
  • "Tomorrow" = "Tomorrow"
  • "ThisWeek" = "This Week"
  • "LastWeek" = "Last Week"
  • "NextWeek" = "Next Week"
  • "Next2Weeks" = "Next 2 Weeks"
  • "ThisMonth" = "This Month"
  • "LastMonth" = "Last Month"
  • "NextMonth" = "Next Month"
  • "ThisYear" = "This Year"
  • "LastYear" = "Last Year"
  • "NextYear" = "Next Year"
  • "Custom" = "Custom"
  • "ThisQuarter" = "This Quarter"
  • "NextQuarter" = "Next Quarter"
  • "LastQuarter" = "Last Quarter"

Property

Default

[]

See

https://www.reactdatagrid.com/examples?example=Filter_Options

filterDeserializerFunction?: ((col: ColumnOptions, value: unknown) => unknown)

Type declaration

    • (col: ColumnOptions, value: unknown): unknown
    • filterDeserializerFunction is a function that takes a column, and a value, and returns a deserialized value. Primarily used by settings persistence, to deserialize the filter value.

      Parameters

      Returns unknown

filterOperation?: FilterOperation

The operator to apply when doing the conversion. See FILTER_OPERATION_TYPE constant values from com.flexicious.grids.filters.FilterExpression. Here are a list of options:

  • Equals
  • NotEquals
  • BeginsWith
  • EndsWith
  • Contains
  • DoesNotContain
  • GreaterThan
  • LessThan
  • GreaterThanEquals
  • LessThanEquals
  • InList
  • NotInList
  • Between

Property

Default

FilterExpression.FILTER_OPERATION_TYPE_EQUALS

See

https://www.reactdatagrid.com/examples?example=Filter_Options

filterRenderer?: ((props: RendererProps) => unknown)

Type declaration

filterWaterMark?: string

Applicable only if the filter control is TextInput. If set, sets the watermark of the TextInput filter to the value specified.

useLabelFunctionForFilterCompare?: boolean

Flag, that defaults to true, indicates that in client filter mode, use the label function to perform the search (opposed) comparison to using the raw value of the "searchField" property of the column.

Property

Default

false

Generated using TypeDoc