• Share
    • Twitter
    • LinkedIn
    • Facebook
    • Email
  • Feedback
  • Edit
Show / Hide Table of Contents

Planner

Some tooltip text!
• 2 minutes to read
 • 2 minutes to read

This element will display a planner (day schedule style).

It can contain one or more columns, which may represent multiple days, multiple people, and so on.

Configuration

Setting Description
startHour The initial start of the day
For example, "8" for 08:00
exactPosition Granularity:
true = use exact start and end of follow-up (minutes)
false = round follow-up down to nearest half hour
roundUpAppointment Whether to round up to nearest half hour instead of down
ignored if exactPosition = true
overlappingAppointments How to display overlapping follow-ups
true = draw overlapping
false = draw side-by-side
hourSize Vertical space for 1 hour (in pixels)
Default = 40
editEntryUrl The base URL to redirect to for editing an entry
newEntryUrl The base URL to redirect to for creating a new entry (when dragging in the planner)

Functions

setFieldValue(String action, Map values)

Action Map keys Description
addDay id
header
highlightStart
highlightStop
Adds a day to the calender
addAppointment start
stop
id
body
Adds a follow-up to the calender
roundUpAppointment value Whether to round up duration to nearest half hour
overlappingAppointments value Whether to let follow-ups overlap if one ends after another starts
exactPosition value Whether start and stop times are set exactly (true) or to nearest half hour (false)
hourSize Height in pixels per hour
Minimum height is 30

These fields are used for specifying the light area in the planner, normally indicating business hours (for example, 09:00 to 17:00).

In This Article
© SuperOffice. All rights reserved.
SuperOffice |  Community |  Release Notes |  Privacy |  Site feedback |  Search Docs |  About Docs |  Contribute |  Back to top