ResourceFilter
A List which allows selection of resources to filter a specified eventStore to only show events for the selected resources.
Because this widget maintains a state that can be changed through the UI, it offers some of the API of an input field. It has a read only value property, and it fires a change event.
Configs
97
Configs
97Common
Other
The EventStore to filter. Events for resources which are deselected in this List will be filtered out.
By default, deselecting list items filters only the eventStore so that
events for the deselected resources are hidden from view. The resourceStore is not
filtered.
Configure this as true to also filter the resourceStore so that deselected resources
are also hidden from view (They will remain in this List)
An optional filter function to apply when loading resources from the project's resource store. Defaults to loading all resources.
This is called using this ResourceFilter as the this object.
| Parameter | Type | Description |
|---|---|---|
resource | ResourceModel | Resorce for filtering |
Returns true to include the passed resource
Configure as false to only allow selecting one resource at a time
Configure as false to not use the Resource`s color field to style the checkbox
DOM
Float & align
Layout
Misc
Scrolling
Properties
79
Properties
79Class hierarchy
Other
Configure as false to only allow selecting one resource at a time
An array encapsulating the currently selected resources.
CSS
DOM
Layout
Misc
Functions
65
Functions
65Configuration
Events
Misc
Other
Widget hierarchy
Events
20
Events
20Fired when this widget's selection changes
// Adding a listener using the "on" method
resourceFilter.on('change', ({ value, oldValue, source }) => {
});| Parameter | Type | Description |
|---|---|---|
value | String | This field's value |
oldValue | String | This field's previous value |
source | Field | This ResourceFilter |
Event handlers
20
Event handlers
20Called when this widget's selection changes
new ResourceFilter({
onChange({ value, oldValue, source }) {
}
});| Parameter | Type | Description |
|---|---|---|
value | String | This field's value |
oldValue | String | This field's previous value |
source | Field | This ResourceFilter |
Typedefs
6
Typedefs
6CSS variables
39
CSS variables
39| Name | Description |
|---|---|
--b-resource-filter-item-selected-background | Background to use for selected items in the resource filter list |