# Index | tablefilter v0.5.3 API Document

# References

## Class Summary

Static Public Class Summary
public | AdapterEzEditTable Adapter module for ezEditTable, an external library providing advanced grid features (selection and edition): http://codecanyon.net/item/ezedittable-enhance-html-tables/2425123?ref=koalyptus |
public | AdapterSortableTable SortableTable Adapter module |
public | AlternateRows Rows with alternating background color for improved readability |
public | CheckList Checklist filter UI component |
public | ClearButton Clear button UI component |
public | ColOps Column calculations extension |
public | ColsVisibility Columns Visibility extension |
public | DateType Wrapper for Sugar Date module providing datetime helpers and locales |
public | Dropdown Dropdown filter UI component |
public | Emitter Event emitter class |
public | Feature Base class defining the interface of a TableFilter feature |
public | FiltersVisibility Filters Visibility extension |
public | GridLayout Grid layout, table with fixed headers |
public | Hash Manages state via URL hash changes |
public | Help Help UI component |
public | HighlightKeyword Highlight matched keywords upon filtering |
public | Loader Activity indicator |
public | NoResults UI when filtering yields no matches |
public | Paging Paging UI component |
public | PopupFilter Pop-up filter component |
public | RowsCounter Rows counter UI component |
public | State Features state object persistable with localStorage, cookie or URL hash |
public | StatusBar Status bar UI component |
public | Storage Stores the features state in browser's local storage or cookie |
public | TableFilter Makes HTML tables filterable and a bit more :) |

## Function Summary

Static Public Function Summary
public | EMPTY_FN (): Function Return an empty function |

## Variable Summary

Static Public Variable Summary
public | AUTO_FILTER_DELAY : Number Auto filter delay in milliseconds |
public | CELL_TAG : String Cell tag |
public | CHECKLIST : String Checklist filter type |
public | DATE : String Date |
public | DOWN_ARROW_KEY : Number Down arrow key code |
public | ENTER_KEY : Number Enter key code |
public | ESC_KEY : Number Escape key code |
public | FORMATTED_NUMBER : String Formatted number |
public | HEADER_TAG : String Header cell tag |
public | INPUT : String Input filter type |
public | IP_ADDRESS : String IP address |
public | MULTIPLE : String Multiple select filter type |
public | NONE : String None filter type |
public | NUMBER : String Number |
public | SELECT : String Select filter type |
public | STRING : String String |
public | TAB_KEY : Number Tab key code |
public | UP_ARROW_KEY : Number Up arrow key code |
public | addClass (ele: DOMElement, cls: String): * Adds the specified class to the passed element |
public | addEvt (obj: DOMElement, type: String, Handler: Function, capture: Boolean): * Add event handler for specified event on passed element |
public | cancelEvt (evt: Event): * Cancels the event if it is cancelable, without stopping further propagation of the event. |
public | contains (term: String, data: String, exactMatch: Boolean, caseSensitive: Boolean, ignoreDiacritics: Boolean): Boolean: * Checks if passed data contains the searched term |
public | createCheckItem (id: String, chkValue: String, labelText: String): Object: * Creates and returns a checklist item |
public | createElm (tag: String, an: Array): Object: * Creates an html element with given collection of attributes |
public | createOpt (text: String, value: String, isSel: Boolean): Object: * Creates and returns an option element |
public | createText (txt: String): Object: * Returns a text node with given text |
public | elm (id: String): DOMElement: * Returns the element matching the supplied Id |
public | getFirstTextNode (node: NodeElement): String: * Returns the first text node contained in the supplied node |
public | getText (node: NodeElement): String: * Returns text + text of children of given node |
public | has (arr: Array, val: Any, caseSensitive: Boolean): Boolean: * Checks if given item can be found in the passed collection |
public | hasClass (ele: DOMElement, cls: String): Boolean: * Determine whether the passed elements is assigned the given class |
public | hasHashChange : * Checks if browser has onhashchange event |
public | hasStorage : * Checks if browser has Storage feature |
public | ignoreCase (First: String, Second: String): Number: * Case insensitive compare function for passed strings |
public | isArray (obj: Array): Boolean: * Check passed argument is an array |
public | isEmpty (text: String): Boolean: * Checks if passed string is empty |
public | isEmpty (obj: Any): Boolean: * Check passed argument is empty (undefined, null or empty string) |
public | isFn (obj: Function): Boolean: * Check passed argument is a function |
public | isNull (obj: Any): Boolean: * Check passed argument is null |
public | isNumber (obj: Number): Boolean: * Check passed argument is a number |
public | isObj (obj: Object): Boolean: * Check passed argument is an object |
public | isString (obj: String): Boolean: * Check passed argument is a string |
public | isUndef (obj: Any): Boolean: * Check passed argument is undefined |
public | keyCode (evt: Event): Number: * Returns the Unicode value of pressed key |
public | matchCase (text: String): String: * Returns passed string as lowercase if caseSensitive flag set false. |
public | numSortAsc (First: Number, Second: Number, Negative,: Number): * Sorts passed numbers in a ascending manner |
public | numSortDesc (First: Number, Second: Number, Negative,: Number): * Sorts passed numbers in a descending manner |
public | parse (Formatted: String, Decimal: String): Number: * Takes a string, removes all formatting/cruft and returns the raw float value |
public | removeClass (ele: DOMElement, cls: String): * Removes the specified class to the passed element |
public | removeElm (node: DOMElement): DOMElement: * Removes passed node from DOM |
public | removeEvt (obj: DOMElement, type: String, Handler: Function, capture: Boolean): * Remove event handler for specified event on passed element |
public | rgxEsc (text: String): String: * Makes regex safe string by escaping special characters from passed string |
public | root : * Export window or global object depending on the environment |
public | stopEvt (evt: Event): * Prevents further propagation of the current event in the bubbling phase |
public | tag (tagname: String): NodeList: * Returns list of element matching the supplied tag name |
public | targetEvt (evt: Event): DOMElement: * Reference to the object that dispatched the event |
public | trim (text: String): String: * Removes whitespace from both sides of passed string |