...
The following properties can be used:
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. |
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. |
\* This property is required.
B25:singleCalendarWrapper
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 |
\* This property is required.
...
This components saves you, in some cases, to create your own logic around the B25:multiCalendarWrapper to fetch the right data to show.
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 record of the page that the calendar thinks it is displayed on. |
objectApiName* | The sObject API name for the recordId | This sets the sObjectType of the page that the calendar thinks it is displayed on |
recordLookupToDimension** | String | The api name of the field on the record specified by recordId that contains the Id of the record that should be used as dimension record. |
dimensionRecordLookupInfo** | String | The api name of the related list sObject + the lookup on the related sObject to the primary sObject. For example if you want to display all the resources of a certain Resource type you could provide B25__Resource__c.B25__Resource_Type__c |
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 maximum pixel height that the calendar will stretch to. If the content is larger, a scroll bar will be shown. |
hiddenReservationFilters | A list of filter objects. | Sets filters on the reservation records shown in the calendar. These filters are not visible to users. |
hiddenDimensionFilters | A list of filter objects. | Sets filters on the dimension 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. |
mdaFilteringEnabled | Boolean | Will hide any sObjects that are not available because of availabilities. If you use multi dimensional availabilities it will use the record passed through recordId as the context for the multi dimensional availabilities. |
isReadOnly | Boolean | When this property is set to |
\* This property is required.
\** One of these two properties must be set.
...
B25:mobileCalendarWrapper
Property | Expected Value | Description |
|---|---|---|
calendarName* | The Name of a Calendar record. | This sets the configuration based on the linked Calendar record. (Views are overridden with the mobile calendar view) |
recordId | The id of a dimension record. | This sets the dimension record for this calendar. If not specified a record selector is displayed at the top allowing the user to select a record. |
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. |
hiddenReservationFilters | A list of filter objects. | Sets filters on the reservation records shown in the calendar. These filters are not visible to users. |
isReadOnly | Boolean | When this property is set to |
\* This property is required.
...
Each item in the list is expected to have the following properties:
Property | Description |
|---|---|
fieldName | The API name of the field being filtered. |
operator | The operator being applied. Valid values are: '=', '!=', '>', '<', '<=', '>='. |
value | The value being compared against. |
displayedValue | (Optional) The value being displayed to the user. This is useful for lookups, where the passed value is a record id, but you might want to display the record name to the user instead. |
| Code Block |
|---|
<aura:component implements="flexipage:availableForAllPageTypes" access="global">
<aura:attribute
name="myFilters"
type="Object[]"
default="[{'fieldName':'Name', 'operator':'=', 'value':'Nice'}]"
/>
<B25:multiCalendarWrapper
calendarId="Resources"
view="week"
startDate="2020-12-31"
hiddenDimensionFilters="{!v.myFilters}"
>
</B25:multiCalendarWrapper>
</aura:component> |
...
The following properties are required
Property | Description |
|---|---|
type | Indicates that it is a grouping, all belonging in the same logicalOperator |
logicalOperator | Either AND or OR. Indicating if the filters should both be true (AND) or one of them should be true (OR) |
subFilters | A list of hiddenFilters as described in the passing hidden filters section above. |
The example below is more complex, it shows resources that are marked Active AND that have a name Awesome OR Nice.
| 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'}
]
}
]);
}
})
|
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 |