The Slicer control provides a quick way to edit filters applied to PivotField objects.
It provides buttons the user can click to filter data based on values and indicates the current filtering state, which makes it easy to understand what is shown in filtered PivotGrid and PivotChart controls.
For example, when the user selects 'Smith' in a 'Salespersons' field, only data that includes 'Smith' in that field will be included in the output summary.
Slicer controls are based on value filters. To use them with server-based pivot engines, you must set the uniqueValues property of the fields you want to filter on. For example:
// set Country field's unique values so we can use a slicer
// this is necessary only when using server-based pivot engines
var fld = ngCube.fields.getField('Country');
fld.filter.valueFilter.uniqueValues = 'Japan,Portugal,Russia,UK,US'.split(',');
// show slicer
var slicer = new wijmo.olap.Slicer('#slicer', {
field: fld,
multiSelect: true
});
constructor(element: any, options?: any): Slicer
Initializes a new instance of the Slicer 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 or sets the template used to instantiate Slicer controls.
Gets or sets the PivotField being filtered by this Slicer.
If the PivotField is not included in the current view definition, the Slicer will automatically add the field to the engine's filterFields collection.
If you want to remove the field from any PivotPanel controls so users cannot remove the field from the view definition, set the fields visible property to false. The field will remain active, but will not be shown in any PivotPanel controls.
Gets or sets the header string shown at the top of the Slicer.
The default value for this property is **null**, which causes the Slicer to display the field header at the top of the Slicer.
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 a value that determines whether users should be allowed to select multiple values from the list.
The default value for this property is **false**.
Gets a value indicating whether the control is hosted in an element with right-to-left layout.
Gets or sets a value indicating whether the control displays checkboxes next to each item.
The default value for this property is **false**.
Gets or sets a value indicating whether the control displays the header area with the header string and multi-select/clear buttons.
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).
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(fullUpdate?: boolean): void
Refreshes the control.
Whether to update the control layout as well as the content.
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.