-
Wijmo
- Arraybase
- Binding
- Canceleventargs
- Clipboard
- Collectionview
- Collectionviewgroup
- Color
- Control
- Datetime
- Event
- Eventargs
- Globalize
- Groupdescription
- Notifycollectionchangedeventargs
- Observablearray
- Pagechangingeventargs
- Interop
- Point
- Printdocument
- Propertychangedeventargs
- Propertygroupdescription
- Rect
- Requesterroreventargs
- Size
- Sortdescription
- Tooltip
- Tooltipeventargs
- Aggregate
- Datatype
- Key
- Notifycollectionchangedaction
- Popupposition
- Sortnulls
- Tooltiptrigger
- Ibindinginfo
- Icollectionview
- Ieditablecollectionview
- Ihttprequestoptions
- Inotifycollectionchanged
- Iqueryinterface
- Ipagedcollectionview
- Barcode
- Chart
- Cloud
- Gauge
-
Grid
- Celleditendingeventargs
- Cellfactory
- Cellrange
- Column
- Cellrangeeventargs
- Columncollection
- Columngroup
- Columngroupcollection
- Datamap
- Flexgrid
- Formatitemeventargs
- Gridpanel
- Grouprow
- Hittestinfo
- Mergemanager
- Row
- Rowcolcollection
- Rowcol
- Rowcollection
- Allowdragging
- Allowmerging
- Allowpinning
- Allowresizing
- Allowsorting
- Autosizemode
- Celltype
- Clipstringoptions
- Datamapeditor
- Frozenrowcol
- Groupsummaryposition
- Headersvisibility
- Headersfocusability
- Keyaction
- Rowcolflags
- Selectedstate
- Selectionmode
- Selmove
- Icelltemplatecontext
- Igridfreezeoptions
- Cellmaker
- Detail
- Filter
- Grouppanel
- Immutable
- Multirow
- Search
- Selector
- Sheet
- Transposed
- Transposedmultirow
- Xlsx
- Input
- Nav
- Odata
- Olap
- Touch
- Undo
- Rest
- Viewer
- Xlsx
- Interops
FlexGridSearch Class
FlexGridSearch Class
Type parameters
-
T
Heirarchy
-
Control
- FlexGridSearch
Constructors
Properties
Methods
- add
Event Listener - apply
Template - begin
Update - contains
Focus - defer
Update - dispose
- end
Update - focus
- get
Template - has
Own Property - initialize
- invalidate
- is
Prototype Of - on
Got Focus - on
Invalid Input - on
Lost Focus - on
Refreshed - on
Refreshing - property
IsEnumerable - refresh
- remove
Event Listener - to
Locale String - to
String - value
Of - dispose
All - get
Control - invalidate
All - refresh
All
Events
Constructors
constructor
-
Initializes a new instance of the FlexGridSearch class.
Parameters
-
element: any
The DOM element that hosts the control, or a selector for the host element (e.g. '#theCtrl').
-
Optional options: any
The JavaScript object containing initialization data for the control.
Returns FlexGridSearch
-
Properties
cssMatch
Gets or sets the name of the CSS class used to highlight any parts of the content that match the search terms.
The default value for this property is "wj-state-match".
Highlighing is not supported in template cells.
delay
Gets or sets the delay, in milliseconds, between when a keystroke occurs and when the search is performed.
The default value for this property is 500 milliseconds.
grid
Gets or sets the FlexGrid that is connected to this GroupPanel.
Once a grid is connected to the panel, the panel displays the groups defined in the grid's data source. Users can drag grid columns into the panel to create new groups, drag groups within the panel to re-arrange the groups, or delete items in the panel to remove the groups.
hostElement
Gets the DOM element that is hosting the control.
inputElement
Gets the HTML input element hosted by the control.
Use this property in situations where you want to customize the attributes of the input element.
isDisabled
Gets or sets a value that determines whether the control is disabled.
Disabled controls cannot get mouse or keyboard events.
isTouching
Gets a value that indicates whether the control is currently handling a touch event.
isUpdating
Gets a value that indicates whether the control is currently being updated.
placeholder
Gets or sets the string shown as a hint when the control is empty.
The default value for this property is an empty string "".
rightToLeft
Gets a value indicating whether the control is hosted in an element with right-to-left layout.
searchAllColumns
Gets or sets a value that determines whether invisible columns should be included in the search.
The default value for this property is false.
tabOrder
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.
text
Gets or sets the text to search for.
The text may include multiple terms, separated by spaces.
Static controlTemplate
Gets or sets the template used to instantiate FlexGridSearch controls.
Methods
addEventListener
-
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.
Parameters
-
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
-
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.
Parameters
-
classNames: string
-
template: string
-
parts: Object
-
Optional namePart: string
Returns HTMLElement
-
beginUpdate
-
Suspends notifications until the next call to endUpdate.
Returns void
containsFocus
-
Checks whether this control contains the focused element.
Returns boolean
deferUpdate
-
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.
Parameters
-
fn: Function
Function to be executed.
Returns void
-
dispose
-
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
-
Resumes notifications suspended by calls to beginUpdate.
Parameters
-
Optional shouldInvalidate: boolean
should invalidate the control. Default value for this parameter is true.
Returns void
-
focus
-
Sets the focus to this control.
Returns void
getTemplate
-
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
-
Determines whether an object has a property with the specified name.
Parameters
-
v: PropertyKey
A property name.
Returns boolean
-
initialize
-
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:
grid.initialize({ 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.
Parameters
-
options: any
Object that contains the initialization data.
Returns void
-
invalidate
-
Invalidates the control causing an asynchronous refresh.
Parameters
-
Optional fullUpdate: boolean
Whether to update the control layout as well as the content.
Returns void
-
isPrototypeOf
-
Determines whether an object exists in another object's prototype chain.
Parameters
-
v: Object
Another object whose prototype chain is to be checked.
Returns boolean
-
onGotFocus
onInvalidInput
-
Raises the invalidInput event.
If the event handler cancels the event, the control will keep the invalid input and the focus.
Parameters
Returns boolean
onLostFocus
onRefreshed
onRefreshing
-
Raises the refreshing event.
Parameters
-
Optional e: EventArgs
Returns void
-
propertyIsEnumerable
-
Determines whether a specified property is enumerable.
Parameters
-
v: PropertyKey
A property name.
Returns boolean
-
refresh
-
Refreshes the control.
Parameters
-
Optional fullUpdate: boolean
Whether to update the control layout as well as the content.
Returns void
-
removeEventListener
-
Removes one or more event listeners attached to elements owned by this Control.
Parameters
-
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
-
Returns a date converted to a string using the current locale.
Returns string
toString
-
Returns a string representation of an object.
Returns string
valueOf
-
Returns the primitive value of the specified object.
Returns Object
Static disposeAll
-
Disposes of all Wijmo controls contained in an HTML element.
Parameters
-
Optional e: HTMLElement
Container element.
Returns void
-
Static getControl
-
Gets the control that is hosted in a given DOM element.
Parameters
-
element: any
The DOM element that hosts the control, or a CSS selector for the host element (e.g. '#theCtrl').
Returns Control
-
Static invalidateAll
-
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.
Parameters
-
Optional e: HTMLElement
Container element. If set to null, all Wijmo controls on the page will be invalidated.
Returns void
-
Static refreshAll
-
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.
Parameters
-
Optional e: HTMLElement
Container element. If set to null, all Wijmo controls on the page will be invalidated.
Returns void
-
Events
gotFocus
Occurs when the control gets the focus.
invalidInput
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
Occurs when the control loses the focus.
refreshed
Occurs after the control has refreshed its contents.
refreshing
Occurs when the control is about to refresh its contents.
The FlexGridSearch control allows users to quickly search the items displayed in a FlexGrid.
The control filters the items and shows only the ones that contain the text provided by the user. It also highlights the matches in the target FlexGrid (except for templated cells, which do not support highlighting).
The FlexGridSearch control may be used in conjunction with the FlexGridFilter control, which provides column-specific filtering.
The example below shows how you can create a FlexGridSearch control and connect it to a FlexGrid:
import { FlexGrid } from '@mescius/wijmo.grid'; import { FlexGridSearch } from '@mescius/wijmo.grid.search'; // create FlexGrid let grid = new FlexGrid('#gridElement', { itemsSource: getData(); }); // create FlexGridSearch and connect it to the grid let search = new FlexGridSearch('#searchElement', { grid: grid });