wijmo.grid.filter Class ColumnFilterEditor Wijmo API Class

ColumnFilterEditor Class

The editor used to inspect and modify column filters.

This class is used by the FlexGridFilter class; you rarely use it directly.






filter: ColumnFilter

Gets a reference to the ColumnFilter being edited.


hostElement: HTMLElement

Gets the DOM element that is hosting the control.


isDisabled: boolean

Gets or sets a value that determines whether the control is disabled.

Disabled controls cannot get mouse or keyboard events.


isTouching: boolean

Gets a value that indicates whether the control is currently handling a touch event.


isUpdating: boolean

Gets a value that indicates whether the control is currently being updated.


rightToLeft: boolean

Gets a value indicating whether the control is hosted in an element with right-to-left layout.


tabOrder: number

Gets or sets a value of the tabindex attribute associated with the control.

tabindex attribute value can be defined statically for a Wijmo control by specifying it on the control's host HTML element. But this value can't be changed later during application lifecycle, because Wijmo controls have complex structure, and the control may need to propagate this attribute value to its internal element to work properly.

Because of this, to read or change control's tabindex dynamically, you should do it using this property.

Static controlTemplate

controlTemplate: string

Gets or sets the template used to instantiate ColumnFilterEditor controls.



  • addEventListener(target: EventTarget, type: string, fn: any, capture?: boolean, passive?: boolean): void
  • Adds an event listener to an element owned by this Control.

    The control keeps a list of attached listeners and their handlers, making it easier to remove them when the control is disposed (see the dispose and removeEventListener methods).

    Failing to remove event listeners may cause memory leaks.

    The passive parameter is set to false by default, which means the event handler may call event.preventDefault(). If you are adding passive handlers to touch or wheel events, setting this parameter to true will improve application performance.

    For details on passive event listeners, please see Improving scrolling performance with passive listeners.


    • target: EventTarget

      Target element for the event.

    • type: string

      String that specifies the event.

    • fn: any

      Function to execute when the event occurs.

    • Optional capture: boolean

      Whether the listener should be handled by the control before it is handled by the target element.

    • Optional passive: boolean

      Indicates that the handler will never call preventDefault().

    Returns void


  • applyTemplate(classNames: string, template: string, parts: Object, namePart?: string): HTMLElement
  • Applies the template to a new instance of a control, and returns the root element.

    This method should be called by constructors of templated controls. Therefore, this method is not available. It is responsible for binding the template parts to the corresponding control members.

    For example, the code below applies a template to an instance of an InputNumber control. The template must contain elements with the 'wj-part' attribute set to 'input', 'btn-inc', and 'btn-dec'. The control members '_tbx', '_btnUp', and '_btnDn' will be assigned references to these elements.

    this.applyTemplate('wj-control wj-inputnumber', templateString, {
      _tbx: 'input',
      _btnUp: 'btn-inc',
      _btnDn: 'btn-dec'
    }, 'input');

    @param classNames Names of classes to add to the control's host element. @param template An HTML string that defines the control template. @param parts A dictionary of part variables and their names. @param namePart Name of the part to be named after the host element. This determines how the control submits data when used in forms.


    • classNames: string
    • template: string
    • parts: Object
    • Optional namePart: string

    Returns HTMLElement


  • beginUpdate(): void


  • containsFocus(): boolean
  • Checks whether this control contains the focused element.

    Returns boolean


  • deferUpdate(fn: Function): void
  • Executes a function within a beginUpdate/endUpdate block.

    The control will not be updated until the function has been executed. This method ensures endUpdate is called even if the function throws an exception.


    • fn: Function

      Function to be executed.

    Returns void


  • dispose(): void
  • Disposes of the control by removing its association with the host element.

    The dispose method automatically removes any event listeners added with the addEventListener method.

    Calling the dispose method is important in applications that create and remove controls dynamically. Failing to dispose of the controls may cause memory leaks.

    Returns void


  • endUpdate(): void


  • focus(): void
  • Sets the focus to this control.

    Returns void


  • getTemplate(): string
  • Gets the HTML template used to create instances of the control.

    This method traverses up the class hierarchy to find the nearest ancestor that specifies a control template. For example, if you specify a prototype for the ComboBox control, which does not specify a template, it will override the template defined by the DropDown base class (the nearest ancestor that does specify a template).

    Returns string


  • hasOwnProperty(v: PropertyKey): boolean
  • Determines whether an object has a property with the specified name.


    • v: PropertyKey

      A property name.

    Returns boolean


  • initialize(options: any): void
  • Initializes the control by copying the properties from a given object.

    This method allows you to initialize controls using plain data objects instead of setting the value of each property in code.

    For example:

      itemsSource: myList,
      autoGenerateColumns: false,
      columns: [
        { binding: 'id', header: 'Code', width: 130 },
        { binding: 'name', header: 'Name', width: 60 }
    // is equivalent to
    grid.itemsSource = myList;
    grid.autoGenerateColumns = false;
    // etc.

    The initialization data is type-checked as it is applied. If the initialization object contains unknown property names or invalid data types, this method will throw.


    • options: any

      Object that contains the initialization data.

    Returns void


  • invalidate(fullUpdate?: boolean): void
  • Invalidates the control causing an asynchronous refresh.


    • Optional fullUpdate: boolean

      Whether to update the control layout as well as the content.

    Returns void


  • isPrototypeOf(v: Object): boolean
  • Determines whether an object exists in another object's prototype chain.


    • v: Object

      Another object whose prototype chain is to be checked.

    Returns boolean









  • propertyIsEnumerable(v: PropertyKey): boolean
  • Determines whether a specified property is enumerable.


    • v: PropertyKey

      A property name.

    Returns boolean


  • refresh(fullUpdate?: boolean): void
  • Refreshes the control.


    • Optional fullUpdate: boolean

      Whether to update the control layout as well as the content.

    Returns void


  • removeEventListener(target?: EventTarget, type?: string, fn?: any, capture?: boolean): number
  • Removes one or more event listeners attached to elements owned by this Control.


    • Optional target: EventTarget

      Target element for the event. If null, removes listeners attached to all targets.

    • Optional type: string

      String that specifies the event. If null, removes listeners attached to all events.

    • Optional fn: any

      Handler to remove. If null, removes all handlers.

    • Optional capture: boolean

      Whether the listener is capturing. If null, removes capturing and non-capturing listeners.

    Returns number

    The number of listeners removed.


  • toLocaleString(): string
  • Returns a date converted to a string using the current locale.

    Returns string


  • toString(): string
  • Returns a string representation of an object.

    Returns string


  • updateEditor(): void
  • Updates editor with current filter settings.

    Returns void


  • updateFilter(): void
  • Updates filter with current editor settings.

    Returns void


  • valueOf(): Object
  • Returns the primitive value of the specified object.

    Returns Object

Static disposeAll

  • disposeAll(e?: HTMLElement): void
  • Disposes of all Wijmo controls contained in an HTML element.


    • Optional e: HTMLElement

      Container element.

    Returns void

Static getControl

  • getControl(element: any): Control
  • Gets the control that is hosted in a given DOM element.


    • element: any

      The DOM element that hosts the control, or a CSS selector for the host element (e.g. '#theCtrl').

    Returns Control

Static invalidateAll

  • invalidateAll(e?: HTMLElement): void
  • Invalidates all Wijmo controls contained in an HTML element.

    Use this method when your application has dynamic panels that change the control's visibility or dimensions. For example, splitters, accordions, and tab controls usually change the visibility of its content elements. In this case, failing to notify the controls contained in the element may cause them to stop working properly.

    If this happens, you must handle the appropriate event in the dynamic container and call the Control.invalidateAll method so the contained Wijmo controls will update their layout information properly.


    • Optional e: HTMLElement

      Container element. If set to null, all Wijmo controls on the page will be invalidated.

    Returns void

Static refreshAll

  • refreshAll(e?: HTMLElement): void
  • Refreshes all Wijmo controls contained in an HTML element.

    This method is similar to invalidateAll, except the controls are updated immediately rather than after an interval.


    • Optional e: HTMLElement

      Container element. If set to null, all Wijmo controls on the page will be invalidated.

    Returns void



Occurs when one of the editor buttons is clicked.


Occurs after the filter is modified.


gotFocus: Event<Control, EventArgs>

Occurs when the control gets the focus.


invalidInput: Event<Control, CancelEventArgs>

Occurs when invalid input is detected.

Invalid input may occur when the user types or pastes a value that cannot be converted to the proper type, or a value that is outside the valid range.

If the event handler cancels the event, the control will retain the invalid content and the focus, so users can correct the error.

If the event is not canceled, the control will ignore the invalid input and will retain the original content.


lostFocus: Event<Control, EventArgs>

Occurs when the control loses the focus.


refreshed: Event<Control, EventArgs>

Occurs after the control has refreshed its contents.


refreshing: Event<Control, EventArgs>

Occurs when the control is about to refresh its contents.