...
Property | Expected Value | Description |
|---|---|---|
calendarId* | The Name of a Calendar record. | This sets the configuration based on the linked Calendar record. |
view | The Unique Identifier of a View record. | This sets the currently displayed view. Make sure to choose a View record that is linked to the Calendar record, otherwise this property will be ignored. |
startDate | A date string in almost any kind of format. | This sets the start date of the currently displayed view. |
prototypeReservation | An object that represents a Reservation record. | Allows you to prepopulate fields on new reservations being created on the calendar, even if that field is not displayed on the reservation form. Note: you can include junctions (such as ReservationContacts) or service reservations in the prototype. |
dynamicFilters | An object containing dynamic filter options. | Sets initial values for the dynamic filters available in the multi resource calendar. |
maxHeight | An integer. | The maximum pixel height that the calendar will stretch to. If the content is larger, a scroll bar will be shown. |
hiddenDimensionFilters | A list of filter objects. | Sets filters on the dimension records shown in the calendar. These filters are not visible to users. |
hiddenReservationFilters | A list of filter objects. | Sets filters on the reservation records shown in the calendar. These filters are not visible to users. |
filterIdentifierPrefix | A string. | Any calendars with the same filterIdentifierPrefix will share saved filters. By default the name of the calendar record is used. This allows you to share filters between calendars or have separate filters for the same calendar. |
unfilteredDimensionIds | A list of record ids. | Allows you to limit the dimension records that are displayed on the calendar. Any additional filters will never allow records outside of this list to be displayed. |
isReadOnly | Boolean | When this property is set to |
availabilityFilteringEnabled | Boolean | When enabled all dimension records that are fully unavailable in the current view will be hidden. |
mdaContext | MDAContext | Context for filtering MDavailabilities. |
...
B25:singleCalendarWrapper
...
Property
...
Expected Value
...
Description
...
| Info |
|---|
By using the dimensionIds property, the single calendar can actually display reservations for multiple records, like the multi calendar. Unlike the multi calendar however, it will not add a row for each dimension record. |
Property | Expected Value | Description |
|---|---|---|
calendarId* | The Name of a Calendar record. | This sets the configuration based on the linked Calendar record. |
recordId* | The id of a dimension record. | This sets the dimension record for this calendar. |
dimensionIds | A list of dimension record ids. | Use this property instead of recordId to make the calendar display reservations for multiple records. |
view | The Unique Identifier of a View record. | This sets the currently displayed view. Make sure to choose a View record that is linked to the Calendar record, otherwise this property will be ignored. |
startDate | A date string in almost any kind of format. | This sets the start date of the currently displayed view. |
prototypeReservation | An object that represents a Reservation record. | This can be used to prepopulate fields on new reservations being created on the calendar, even if that field is not displayed on the reservation form. Note: you can include junctions (such as ReservationContacts) or service reservations in the prototype. |
maxHeight | An integer. | The height of the calendar in pixels. The single calendar does not automatically resize based on the height of the content of the calendar like the multi calendar does. |
hiddenReservationFilters | A list of filter objects. | Sets filters on the reservation records shown in the calendar. These filters are not visible to users. |
filterIdentifierPrefix | A string. | Any calendars with the same filterIdentifierPrefix will share saved filters. By default the name of the calendar record is used. This allows you to share filters between calendars or have separate filters for the same calendar. |
isReadOnly | Boolean | When this property is set to |
...
| Code Block |
|---|
/* calendar.cmp */
<aura:component implements="flexipage:availableForAllPageTypes" access="global">
<aura:handler name="init" value="{!this}" action="{!c.doInit}" />
<aura:attribute
name="myFilters"
type="Object[]"
/>
<B25:multiCalendarWrapper
calendarId="Resources"
view="week"
startDate="2020-12-31"
hiddenDimensionFilters="{!v.myFilters}"
>
</B25:multiCalendarWrapper>
</aura:component>
/* calendarController.js */
({
doInit: function (cmp, event, helper) {
var recordId = cmp.get('v.recordId');
cmp.set('v.myFilters', [
{ 'fieldName': 'B25__Is_Active__c', 'operator': '=', 'value': 'true'},
{
type: 1,
logicalOperator: 'OR',
subFilters: [
{ 'fieldName': 'Name', 'operator': '=', 'value': 'Awesome'},
{ 'fieldName': 'Name', 'operator': '=', 'value': 'Nice'}
]
}
]);
}
})
|
| Anchor | ||||
|---|---|---|---|---|
|
Passing Dynamic Filters
You can pass a special object to the property dynamicFilters (available only on multi calendars). This property allows you to specify initial values for two different types of dynamic filters: “Available Resource Filter” (allowing you to show only available resources during the specified times), and “Hide rows without reservations” (allowing you to choose whether to show rows that have no visible reservations in the calendar view).
dynamicFilters should contain the following properties:
Property | Description |
|---|---|
hideRowsWithoutReservations | A boolean specifying whether to show empty rows in the calendar view. |
availableResourceFilter | A nested object containing initial values for the available resource filter. |
availableResourceFilter should contain the following properties:
Property | Description |
|---|---|
enabled | A boolean specifying whether to show empty rows in the calendar view. |
fromDateTime | A datetime string specifying the beginning datetime for the filter. |
untilDateTime | A datetime string specifying the ending datetime for the filter. |
| Code Block |
|---|
/* calendar.cmp */
<aura:component implements="flexipage:availableForAllPageTypes" access="global">
<aura:attribute
name="dynamicFilters"
type="Object"
/>
<B25:multiCalendarWrapper
calendarId="Resources"
view="week"
startDate="2024-04-12"
dynamicFilters="{!v.dynamicFilters}"
>
</B25:multiCalendarWrapper>
</aura:component>
/* calendarController.js */
({
doInit: function (cmp, event, helper) {
component.set("v.dynamicFilters", {
hideRowsWithoutReservations: true,
availableResourceFilter: {
enabled: true,
fromDateTime: '2024-04-12T12:30:00.000Z',
untilDateTime: '2024-04-19T12:30:00.000Z'
}
});
}
}) |
MDAContext
Property | Expected Value | Description |
|---|---|---|
enabled | Boolean | If the MDA filtering is enabled |
context | Map<String, List<Id>> | A Map of The availability lookups on the Availability record to a list of ids. Availabilities will only be included if the lookup specified matches any of the provided ids. |
subtreeContext | Map<String, List<Id>> | Works in the same way as the normal context however will not be take into account if the availability is an unavailability |
...