FilterField

A simple text field for filtering a store.

Allows filtering by field:

const filterField = new FilterField({
   store : eventStore,
   field : 'name'
});

Or by using a filter function for greater control/custom logic:

const filterField = new FilterField({
   store          : eventStore,
   filterFunction : (record, value) => record.name.includes(value)
});

Configs

115

Common

listenersEvents

Filtering

field: String

The model field name to filter by. Can optionally be replaced by filterFunction

filterFunction: function

Optional filter function to be called with record and value as parameters for store filtering.

{
    type           : 'filterfield',
    store          : myStore,
    filterFunction : (record, value)  => {
       return record.text.includes(value);
    }
}
ParameterTypeDescription
recordModel

Record for comparison

valueString

Value to compare with

Returns: Boolean -

Returns true if record matches comparison requirements

filterId: String | Symbol

In case the filterId that is used in the store needs to be referenced elsewhere, it can be configured. This applies to a passed filterFunction as well as for an internally generated filter. If no value is configured, an internal ID will be generated.

{
    type     : 'filterfield',
    store    : myStore,
    filterId : 'ColumnFilter'
}
internalFilter: Boolean= false

Set this flag to mark the filter as internal when adding it to the associated Store. This prevents the filter from being removed when Store.clearFilters() is called.

The store to filter.

Accessibility

ariaLabelWidget
keyMapKeyMap

Container

inlineField

CSS

clsWidget
colorWidget
htmlClsWidget
styleWidget
uiWidget

DOM

adoptWidget
appendToWidget
contentWidget
datasetWidget
htmlWidget
idWidget
tagWidget
titleWidget

Field

maxLengthTextField
minLengthTextField

Float & align

alignWidget
anchorWidget
centeredWidget
draggableWidget
floatingWidget
xWidget
yWidget

Input element

Label

hintField
labelLabelable
labelClsLabelable
labelPositionLabelable
labelsField
labelWidthLabelable

Layout

alignSelfWidget
dockWidget
flexWidget
heightWidget
hiddenWidget
marginWidget
maxHeightWidget
maxWidthWidget
minHeightWidget
minWidthWidget
textAlignWidget
weightWidget
widthWidget

Misc

badgeBadge
dataFieldWidget
disabledWidget
localeClassLocalizable
localizableLocalizable
maskedWidget
ownerWidget
refWidget
rippleWidget
tabWidget
tooltipWidget

Other

columnWidget
nameField
renditionTextField
rtlRTL
spanWidget
valueField

Scrolling

Properties

86

Class hierarchy

isFilterField: Boolean= truereadonly
Identifies an object as an instance of FilterField class, or subclass thereof.
isFilterField: Boolean= truereadonlystatic
Identifies an object as an instance of FilterField class, or subclass thereof.
isBadgeBadge
isDelayableDelayable
isEventsEvents
isFieldField
isFormulaFieldFormulaField
isKeyMapKeyMap
isLabelableLabelable
isLocalizableLocalizable
isTextFieldTextField
isValidatableValidatable
isWidgetWidget

Accessibility

keyMapKeyMap

CSS

clsWidget

DOM

appendToWidget
contentWidget
datasetWidget
elementWidget
htmlWidget
idWidget
styleWidget

Float & align

xWidget
yWidget

Layout

alignSelfWidget
flexWidget
heightWidget
marginWidget
maxHeightWidget
maxWidthWidget
minHeightWidget
minWidthWidget
widthWidget

Lifecycle

configBase

Misc

badgeBadge
cellInfoWidget
disabledWidget
errorTipValidatable
labelLabelable
localeHelperLocalizable
localeManagerLocalizable
refWidget
tabWidget
tooltipWidget

Other

$namestaticWidget
columnWidget
formulaFormulaField
inputField
isEmptyField
isValidField
renditionTextField
rtlRTL
spanWidget
typestaticWidget
valueField

Visibility

hiddenWidget
isVisibleWidget

Widget hierarchy

ownerWidget
parentWidget

Functions

64

Configuration

applyDefaultsstaticBase

Events

Float & align

alignToWidget
setXYWidget
showByWidget
toFrontWidget

Lifecycle

createstaticWidget
destroystaticBase
initClassstaticWidget

Misc

attachTooltipstaticWidget
fromElementstaticWidget
fromSelectorstaticWidget
getByIdstaticWidget
isOfTypeNamestaticBase
mixinstaticBase
optionalLstaticLocalizable

Other

clearField
clearErrorValidatable
composeWidget
createOnFrameDelayable
disableWidget
enableWidget
focusWidget
getErrorsValidatable
LstaticLocalizable
maskWidget
onEvents
recomposeWidget
relayAllEvents
selectField
setErrorValidatable
triggerEvents
unEvents
unmaskWidget

Visibility

hideWidget
showWidget

Widget hierarchy

closestWidget
containsWidget
ownsWidget
queryWidget
queryAllWidget
upWidget

Events

19
actionField
catchAllEvents
changeField
clearField
destroyEvents
focusInWidget
focusOutWidget
hideWidget
inputField
paintWidget
readOnlyWidget
recomposeWidget
resizeWidget
showWidget
triggerField

Event handlers

19

Typedefs

7

CSS variables

124