...
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. |
objectApiName* | The sObject API name for the recordId | This sets the sObjectType of the page that the calendar thinks it is displayed on |
dimensionIds | A list of dimension record ids. | Instead of using the recordId property, utilize this property to display reservations for multiple records in the calendar. It requires a Javascript Array containing the record-ids to be assigned. |
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 or percent of window height. The single calendar does not automatically resize based on the height of the content of the calendar like the multi calendar does. |
maxHeightUnit | A string with value “px” or “vh”. | The unit used for the maximum height of the calendar. Either pixels (px) or percentage of window height (vh). |
hiddenReservationFilterName | The name of a globally available reservation filter. | Sets a filter on the reservation records shown in the calendar. This filter will be hidden from the user. Not compatible with hiddenReservationFilters. The filter needs to be visible to the user that is looking at the calendar. Otherwise an error 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. |
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 |
...