Calendar Link Parameters

Calendar settings is where you configure your calendar. These settings apply to all users globally. What if the global settings are not quite right for all users? Calendar link parameters allow you to overwrite global settings. Currently, the following parameters are supported:

  • date: Opens the calendar for a specific date.
  • view: Opens the calendar with a specific view.
  • lang: Overwrites the default language of the calendar.
  • title: Overwrites the default calendar title.
  • tz: Force the timezone of the calendar to a specific value.
  • refresh: Configure the calendar to automatically refresh.
  • showHeader: Show or hide the calendar header (logo, title, search, etc.)
  • showLogo: Show or hide the logo.
  • showSidepanel: Show or hide the sidepanel. User can still access it.
  • disableSidepanel: Disable the sidepanel. User cannot access it anymore.
  • showTitle: Show or hide the calendar title.
  • showViewSelector: Show or hide selector for calendar view.
  • showStripes: Select how to visualize events assigned to multiple events
  • weekStartDay: Select the first day of the week
  • Examples with multiple Parameters

Example:

Calendar link parameters are key=value pairs that are appended at the end of a calendar URL. In the following example, link parameters are used to set the calendar start date to Sep. 9, 2017, the initial view to weekly view and the side-panel to be hidden.
http://teamup.com/ks48cf2135e7e080bc?date=2017-09-09&view=w&showSidepanel=0

Please note that the preferred way to configure your calendar is to use the settings application. The link parameters described in this document are meant to be used for exceptional cases only.

date Parameter

Configures the date that is initially set when the calendar is loaded.

date=yyyy-mm-dd Sets start date to a specific date, e.g. date=2017-09-09. This is useful for calendars that are used to plan for a specific event, like a conference.
date=today Sets start date to the current date.
date=y1 Sets start date to January 1 of the current year.
date=q1 Sets start date to the first day of the current quarter.
date=m1 Sets start date to the first day of the current month.
date=+1day Sets start date to tomorrow.
date=+3days Sets start date to three days from now.
date=+2weeks Sets start date to two weeks from now.
date=+1month Sets start date to one month from now.
date=+3months Sets start date to three months from now.
date=-1month Sets start date to one month in the past.
date=-1week Sets start date to one week in the past.
date=+1year Sets start date to one year from now.

Examples:

view Parameter

Configures the view that is initially shown when the calendar is loaded.

view=d Start with daily view.
view=md Start with multi-day view. The number of days is read from the settings.
view=md<n> Start with multi-day view showing <n> days. <n> takes values between 2 and 6, for example view=md6.
view=w Start with weekly view.
view=mw Start with multi-week view. The number of weeks is read from the settings.
view=mw<n> Start with multi-week view showing <n> weeks. <n> takes values from 2 to 12, for example view=mw8.
view=m Start with monthly view.
view=y Start with year view. The number of months shown is taken from the calendar settings.
view=y<n>m Start with year view showing <n> months. <n> takes values between 1 and 12. Example: view=y6m
view=a Start with agenda view.
view=l Start with list view.
view=s Start with scheduler view.

Examples:

lang Parameter

Configures the user interface language of the calendar.

lang=en English US
lang=en_GB English GB
lang=cs Czech
lang=da Danish
lang=de German
lang=es Spanish
lang=fr French
lang=hu Hungarian
lang=it Italian
lang=pt_PT Portuguese (Portugal)
lang=sk Slovak
lang=zh_CN Chinese (simplified)
lang=zh_TW Chinese (traditional)

Example:

title Parameter

Configures the title used for the calendar. This settings is particularly useful if you are sharing only selected sub-calendars of your calendar and want to properly name the shared calendar.

Please note that the title string must be properly encoded to be used as part of the URL. The encoding ensures that special characters like space, & or ? don’t break the URL. You can use an online encoding tool or your favorite programming language to encode the string.

title=My+custom+title Overwrites the default calendar title with the string “My custom title”. Note that + characters are turned in space characters.

Example:

http://teamup.com/ks48cf2135e7e080bc?title=My+custom+title

tz Parameter

Forces the timezone of the calendar to a specific value.

Note that the preferred way to set the timezone is to use the timezone configuration dialog in the menu. This parameter is only needed for exceptional cases, for example when the calendar is run on a display screen.

tz=Asia/Tokyo Supported values for the tz parameter are the official timezone identifiers as defined in the timezone database maintained by IANA.
Note that the timezone database in many cases defines multiple identifiers for the same timezone. In those cases, only the main identifier is supported by Teamup. Furthermore, timezones that are not used anymore today are not supported.

Example:

refresh Parameter – Premium Feature

The refresh parameter can be used to activate a periodic refresh of the calendar. This parameter is only supported with the Premium plan.

Note that this parameter is only needed for exceptional use cases, for example when the calendar is run on an unattended display screen. In normal use, the calendar is refreshed when users switch views, navigate between dates and other interactions with the calendar.

refresh=n Where n is the number of minutes between refreshes of the calendar.

Example:

showHeader Parameter

Configures if the header is hidden or shown. The header includes the logo, the title and the search input. See also parameters showLogo and showTitle to hide individual elements of the title. Hidding the header is often the desired configuration if the calendar is embedded into a web page.

showHeader=1 Show header
showHeader=0 Hide header

Example:

showLogo Parameter

Configures if the logo is hidden or shown.

showLogo=1 Show logo
showLogo=0 Hide logo

Example:

showSidepanel Parameter

Configures the visibility of the side panel when the calendar is initially started.

showSidepanel=0 Start with side panel collapsed.
showSidepanel=1 Start with side panel visible.

Example:

disableSidepanel Parameter

Enable or disable the sidepanel. If disabled, the user cannot access it anymore.

disableSidepanel=0 Sidepanel is not disabled (default)
disableSidepanel=1 Sidepanel is disabled.

Example:

showTitle Parameter

Configures if the title is hidden or shown.

showTitle=1 Show title
showTitle=0 Hide title

Example:

showViewSelector Parameter

Show or hide selector for calendar view. If the view selector is hidden, the user is not able to switch to a different calendar view. This is a useful configuration if a very minimal user interface is needed, for example if the calendar is embedded into another web page.

showViewSelector=1 Show the view selector (default).
showViewSelector=0 Hide view selector.

Example:

showStripes Parameter

Use this parameter to configure how events assigned to multiple sub-calendars are visualized. Note that this can be configured also in the calendar settings (Settings -> General Settings). We recommend to use this URL parameter only to override the default behavior configured in the calendar settings.

showStripes=1 Use stripes to visualize events assigned to multiple sub-calendars.
showStripes=0 Use multiple boxes to visualize events assigned to multiple sub-calendars.

Example:

weekStartDay Parameter

Use this parameter to configure the week start day of the calendar. Note that this can be configured also in the calendar settings (Settings -> Date & Time). We recommend to use this URL parameter only to override the default behavior configured in the calendar settings.

weekStartDay=fr Set week start day to Friday.
weekStartDay=sa Set week start day to Satusday.
weekStartDay=su Set week start day to Sunday.
weekStartDay=mo Set week start day to Monday.

Example:

Examples with Multiple Parameters

 

Keywords: auto-refresh, auto refresh, disable header, reduce space, collapse, minimize, maximize

Tagged: