ColumnFilterField

A field that filters the columns of a linked TaskBoard when typing into it.

Column filter field
//<code-header>
fiddle.title = 'Column filter field';
//</code-header>
const taskBoard = new TaskBoard({
    appendTo : targetElement,

    features : {
        columnToolbars : false
    },

    tbar : [
        { type : 'columnfilterfield', value : 'Done' }
    ],

    // Columns to display
    columns : [
        'todo',
        'doing',
        'done',
        'ignore'
    ],

    // Field used to pair a task to a column
    columnField : 'status',

    // Project using inline data
    project : {
        tasks : [
            { id : 1, name : 'Task 1', status : 'doing' },
            { id : 2, name : 'Task 2', status : 'done' },
            { id : 3, name : 'Task 3', status : 'ignore' },
            { id : 4, name : 'Task 4', status : 'todo' },
            { id : 5, name : 'Task 5', status : 'todo' }
        ]
    }
});

When used within a TaskBoard, it connects to it automatically:

const taskBoard = new TaskBoard({
    tbar : [
        { type : 'columnfilterfield' }
    ]
});

When used outside of a TaskBoard, it will query globally to find one but if there are multiple on page it might have to be linked to one manually (see taskBoard:

const taskBoard = new TaskBoard({});

const picker = new ColumnFilterField({
   taskBoard // Link it to the taskBoard instance created above
});

Configs

116

Common

field: String= text

The ColumnModel field name to filter by, defaults to 'text'.

listenersEvents
taskBoardTaskBoardLinked

Label

label: String

Label, defaults to a localized version of 'Filter columns'.

Content is determined by the TaskBoard.filterColumns key in the applied locale.

hintField
labelClsLabelable
labelPositionLabelable
labelsField
labelWidthLabelable

Accessibility

ariaLabelWidget
keyMapKeyMap

Container

inlineField

CSS

clsWidget
colorWidget
htmlClsWidget
styleWidget
uiWidget

DOM

adoptWidget
appendToWidget
contentWidget
datasetWidget
htmlWidget
idWidget
tagWidget
titleWidget

Field

maxLengthTextField
minLengthTextField

Filtering

filterFunctionFilterField
filterIdFilterField
internalFilterFilterField
storeFilterField

Float & align

alignWidget
anchorWidget
centeredWidget
draggableWidget
floatingWidget
xWidget
yWidget

Input element

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

88

Class hierarchy

isColumnFilterField: Boolean= truereadonly
Identifies an object as an instance of ColumnFilterField class, or subclass thereof.
isColumnFilterField: Boolean= truereadonlystatic
Identifies an object as an instance of ColumnFilterField class, or subclass thereof.
isBadgeBadge
isDelayableDelayable
isEventsEvents
isFieldField
isFilterFieldFilterField
isFormulaFieldFormulaField
isKeyMapKeyMap
isLabelableLabelable
isLocalizableLocalizable
isTaskBoardLinkedTaskBoardLinked
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