Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

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.

See https://gomeddo.atlassian.net/wiki/spaces/BPD/pages/1767931905/Wrapping+Calendar+Components#Passing-Hidden-Filters https://gomeddo.atlassian.net/wiki/spaces/BPD/pages/1767931905/Wrapping+Calendar+Components#%5BinlineExtension%5D below.

hiddenReservationFilters

A list of filter objects.

Sets filters on the reservation records shown in the calendar. These filters are not visible to users.

See https://gomeddo.atlassian.net/wiki/spaces/BPD/pages/1767931905/Wrapping+Calendar+Components#Passing-Hidden-Filters below.

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 true, the calendar does not allow the users to create or modify reservations. It will only display the reservations that are in the system.

availabilityFilteringEnabled

Boolean

When enabled all dimension records that are fully unavailable in the current view will be hidden.

mdaContext

MDAContext

Context for filtering MDavailabilities.

...

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.

See Passing Hidden https://gomeddo.atlassian.net/wiki/spaces/BPD/pages/1767931905/Wrapping+Calendar+Components#Passing-Hidden-Filters below.

isReadOnly

Boolean

When this property is set to true, the calendar does not allow the users to create, modify or delete reservations. It will only display the reservations and allow the user to navigate the calendars.

...