Document toolboxDocument toolbox

3.2.2.2. Week view

 

Every option is optional in your view configuration! It’s enough to just select the viewtype to configure a view.

 

View

image-20240722-121058.png

Here you can configure the basic view settings.

Enabled

This expression dynamically enables or disables the view. Disabling it will hide the view from the menu.

Hide weekends

This feature gives you the possibility to hide weekends (Saturday and Sunday) from your view. You can set a default value or give the option to the user to toggle the view with $CurrentObject/HideWeekends for example.

View range settings

The day start and end time will determine the upper and lower bounds of the view. For example, to show only a workday, you can set these to 09:00 and 17:00.

The visible start time determines the scroll position of the view when it is overflowing. In other words, if the view overflows, the visible start time will be the time visible at the topmost position.

A hour value between 0 and 23, a 24 hour HH:MM string or in MS.
For example: 8 AM would be presentended as 8 * 60 * 60 * 1000

Content

image-20240722-112940.png

The content tab is where you can override the content specifically for this view. In other words if you want this view to show different content then the another views (e.g. because there is less space in or another need) this is where you can override it. It’s also possible to change the content fot the all day part of the view for similar reasons.

Show time

If "show time" is enabled, the time will be displayed in the event (see the event above at 10:45 AM).

 

Advanced

In the advanced tab further view settings can be specified.

Core hours

You can define core hours for your agenda, which will gray out any times outside of these core hours. Core hours are defined in JSON as an array of objects with a start and end time.

[{"start" : 9.5, "end" : 12.5}, {"start" : 13, "end" : 17}]

The core hours overlay day setting determines whether only the sidebar or the full width of the day view is grayed out. See the examples above where the right example has the core hours overlay day setting set to true, and the left example has it set to false. Logically, this only works for core hours that are the same for everyday. If not this will be forced on.

If configured as an array with fewer than seven elements, it defines multiple core hours blocks within a single day. A seven-element array can specify different core hours for each day of the week (where 0 represents Sunday and 6 represents Saturday), causing only the hours in the day columns to be masked. Additionally, you can use an array to set on of the 7 days, instead of an object to define multiple core hour objects per day. See the example below for an advanced configuration:

[{"start" : 0, "end" : 0}, [{"start" : 9, "end": 12}, {"start" : 13, "end": 17}], [{"start" : 9, "end": 12}, {"start" : 13, "end": 17}], [{"start" : 9, "end": 12}], [{"start" : 9, "end": 12}, {"start" : 13, "end": 17}], [{"start" : 9, "end": 12}, {"start" : 13, "end": 17}], {"start" : 0, "end": 0}]

For an example see: Core hours demo

Show all day header

By default, the all-day header is enabled. However, when it is disabled, all-day events will be shown over the entire duration of the day (see the right screenshot).

All day events overflow cap

This setting determines how many icons can be in the all-day header before it overflows. When there are more items than this limit, an overflow indicator will be shown, which opens a popup when clicked

Fit hours to height

"Fit hours to height" will scale the defined view to the available height of the calendar. This works in conjunction with the “(Min) height hours” property. No scrollbar will be shown unless the total height of the hours in the view, multiplied by the minimum height hours, is more than the available space.

If fit hours to height is disabled the “(Min) Height hours” property will always determine the height for an hour.