The GroupPanel control provides a drag and drop UI for editing groups in a bound FlexGrid control.
It allows users to drag columns from the FlexGrid into the panel and to move groups within the panel. Users may click the group markers in the panel to sort based on the group column or to remove groups.
In order to use a GroupPanel, add it to a page that contains a FlexGrid control and set the panel's grid property to the FlexGrid control. For example:
import { FlexGrid } from '@mescius/wijmo.grid';
import { GroupPanel } from '@mescius/wijmo.grid.grouppanel';
// create a FlexGrid
let theGrid = new FlexGrid('#theGrid', {
itemsSource: getData();
});
// add a GroupPanel to edit data groups
let thePanel = new GroupPanel('#thePanel', {
grid: theGrid,
placeholder: 'Drag columns here to create Groups.'
});
The example below shows how you can use a GroupPanel control to add Outlook-style grouping to a FlexGrid control:
{@sample Grid/Grouping/GroupPanel/purejs Example}
constructor(element: any, options?: any): GroupPanel
Initializes a new instance of the GroupPanel class.
The DOM element that hosts the control, or a CSS selector for the host element (e.g. '#theCtrl').
The JavaScript object containing initialization data for the control.
Gets the ICollectionView whose groups are being managed by this GroupPanel.
Gets or sets the template used to instantiate GroupPanel controls.
Gets or sets the FlexGridFilter to use for filtering the grid data.
If you set this property to a valid filter, the group descriptors will display filter icons that can be used to see and edit the filer conditions associated with the groups.
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.
Gets or sets a GroupDescription creator function used to create group descriptions when users drag columns into the group.
For example, the code below defines a groupDescriptionCreator function that groups dates by year and values in ranges:
thePanel.groupDescriptionCreator = (prop: string) => {
switch (prop) {
case 'date':
return new PropertyGroupDescription(prop, (item, prop) => {
return Globalize.formatDate(item[prop], 'yyyy');
});
case 'sales':
return new PropertyGroupDescription(prop, (item, prop) => {
let value = item[prop];
if (value > 50000) return 'High';
if (value > 25000) return 'Medium';
return 'Low';
});
}
return null; // default
}
Gets or sets a value indicating whether the panel hides grouped columns in the owner grid.
The FlexGrid displays grouping information in row headers, so it is usually a good idea to hide grouped columns since they display redundant information.
The default value for this property is **true**.
Gets the DOM element that is hosting the control.
Gets or sets a value that determines whether the control is disabled.
Disabled controls cannot get mouse or keyboard events.
Gets a value that indicates whether the control is currently handling a touch event.
Gets a value that indicates whether the control is currently being updated.
Gets or sets the maximum number of groups allowed.
Setting this property to -1 allows any number of groups to be created. Setting it to zero prevents any grouping.
The default value for this property is **6**.
Gets or sets a string to display in the control when it contains no groups.
The default value for this property is **null**, which causes the control to use a localized version of the string "Drag and Drop columns here to create Groups." as a placeholder.
Set this property to a custom string if you want, or set it to an empty string to remove the placeholder message, or set it to null to restore the default message.
Gets a value indicating whether the control is hosted in an element with right-to-left layout.
Gets or sets a value that determines whether the control should add drag glyphs to the group marker elements.
The default value for this property is **true**.
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.
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 element for the event.
String that specifies the event.
Function to execute when the event occurs.
Whether the listener should be handled by the control before it is handled by the target element.
Indicates that the handler will never call preventDefault().
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');
```
Names of classes to add to the control's host element.
An HTML string that defines the control template.
A dictionary of part variables and their names.
Name of the part to be named after the host element. This determines how the control submits data when used in forms.
beginUpdate(): void
Suspends notifications until the next call to endUpdate.
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.
Function to be executed.
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.
disposeAll(e?: HTMLElement): void
Disposes of all Wijmo controls contained in an HTML element.
Container element.
endUpdate(): void
Resumes notifications suspended by calls to beginUpdate.
getControl(element: any): Control
Gets the control that is hosted in a given DOM element.
The DOM element that hosts the control, or a CSS selector for the host element (e.g. '#theCtrl').
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).
hitTest(e: MouseEvent | Element): GroupDescription
Gets the GroupDescription at a given mouse position or represented by a given HTML element.
Element to test.
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:
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.
Object that contains the initialization data.
invalidate(fullUpdate?: boolean): void
Invalidates the control causing an asynchronous refresh.
Whether to update the control layout as well as the content.
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 invalidateAll method so the contained Wijmo controls will update their layout information properly.
Container element. If set to null, all Wijmo controls on the page will be invalidated.
onGotFocus(e?: EventArgs): void
Raises the gotFocus event.
onInvalidInput(e: CancelEventArgs): void
Raises the invalidInput event.
If the event handler cancels the event, the control will keep the invalid input and the focus.
onLostFocus(e?: EventArgs): void
Raises the lostFocus event.
onRefreshed(e?: EventArgs): void
Raises the refreshed event.
onRefreshing(e?: EventArgs): void
Raises the refreshing event.
refresh(): void
Updates the panel to show the current groups.
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.
Container element. If set to null, all Wijmo controls on the page will be invalidated.
removeEventListener(target?: EventTarget, type?: string, fn?: any, capture?: boolean): number
Removes one or more event listeners attached to elements owned by this Control.
Target element for the event. If null, removes listeners attached to all targets.
String that specifies the event. If null, removes listeners attached to all events.
Handler to remove. If null, removes all handlers.
Whether the listener is capturing. If null, removes capturing and non-capturing listeners.
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.
Occurs after the control has refreshed its contents.