...
| Excerpt | ||
|---|---|---|
| ||
Users themselves can set filters to ignore events not important to them. Admins can set predefined filters to enforce a component to only display certain events. |
You The Schedule calendar allows users and admins to define event filters. Events not matching the filters will not be shown.
User-defined filters
Users can filter out the events not important to you them by adding any number of custom filters. To do so, they can click on the filter icon on the top left of the calendar.
Admin-defined filters
If you are wrapping the Schedule calendar in your own component, you can set additional filters that are always applied whenever the component is loaded. These filters are visible and can be modified by the user, unless a special property 'hidden' is set. This can be useful to force the component to always display a certain set of events.
| Property name | Required | Type | Description | Example |
|---|---|---|---|---|
| fieldName | yes | String | The API name of the Reservation Template field that the filter applies to. | fieldName: 'B25__Start_Date__c' |
| operator | yes | String | The comparison operator to apply to the value and the field. Valid values are:
| operator: '>' |
| value | yes | String | The literal value that the field is being compared to. For lookups this should be a record id, for dates this should be a date in the format 'yyyy-MM-dd'. | value: '2019-12-31' |
| displayValue | no | String | Use this property if you want to display a different value to the user. If not provided, the actual value will be displayed to the user. | displayValue: 'December 31st 2019' |
| hidden | no | Boolean | If set to true, this filter will not be displayed, and the user can't modify it. | hidden: false |
On Single Schedule calendars, the filter property is named predefinedFilters. On Multi Schedule calendars, this property is named predefinedTemplateFilters. This is because Multi Schedule calendars have two types of filters, one for the templates (events), and one for the dimensions. In all cases, the property expects a JSON string containing an array of filter objects.