Jump to: navigation, search
(Created target blank page For Version: PSAAS:Public)
 
(Update with the copy of version: draft)
Line 1: Line 1:
−
<!-- Creation of the target page -->
+
= Configuration =
 +
== Description ==
 +
Calendar share the configuration namespace '_genesys.widgets.calendar'. Calendar has UI options.
 +
== Example ==
 +
<pre>
 +
window._genesys.widgets.calendar = {
 +
 
 +
showAvailability: true,
 +
numberOfDays: 5,
 +
        timeFormat:12
 +
calenderHours: {
 +
 
 +
interval: 10,
 +
 
 +
morning: {
 +
 
 +
enable: true,
 +
openTime: '09:00',
 +
closeTime: '11:59'
 +
},
 +
 
 +
afternoon: {
 +
 
 +
enable: true,
 +
openTime: '12:00',
 +
closeTime: '16:59'
 +
},
 +
 
 +
evening: {
 +
 
 +
enable: true,
 +
openTime: '17:00',
 +
closeTime: '23:59'
 +
}
 +
}
 +
};
 +
</pre>
 +
 
 +
== Options ==
 +
{|
 +
|-
 +
! Name
 +
! Type
 +
! Description
 +
! Default
 +
! Required
 +
|-
 +
| timeFormat
 +
| number/string
 +
| This sets the time format for the timestamps in this widget. It can be 12 or 24
 +
| 12
 +
|
 +
|-
 +
| showAvailability
 +
| boolean
 +
| Enable/disable calendar to update the timeslots based on the callback availability. The unavailable timeslots are greyed out.
 +
| true
 +
| n/a
 +
|-
 +
| numberOfDays
 +
| number
 +
| The number of days to display on calendar starting today.
 +
| 5
 +
| n/a
 +
|-
 +
| calenderHours.interval
 +
| number
 +
| The time interval between each consecutive timeslot displayed on calendar.
 +
| 15
 +
| n/a
 +
|-
 +
| calenderHours.morning.enable
 +
| boolean
 +
| Enable/Disable morning section in calendar.
 +
| true
 +
| n/a
 +
|-
 +
| calenderHours.morning.openTime
 +
| number
 +
| Morning section opening time in 'HH:MM' 24 Hr format.
 +
| 08:00
 +
| n/a
 +
|-
 +
| calenderHours.morning.closeTime
 +
| number
 +
| Morning section closing time in 'HH:MM' 24 Hr format.
 +
| 11:59
 +
| n/a
 +
|-
 +
| calenderHours.afternoon.enable
 +
| boolean
 +
| Enable/Disable afternoon section in calendar.
 +
| true
 +
| n/a
 +
|-
 +
| calenderHours.afternoon.openTime
 +
| number
 +
| Afternoon section opening time in 'HH:MM' 24 Hr format.
 +
| 12:00
 +
| n/a
 +
|-
 +
| calenderHours.afternoon.closeTime
 +
| number
 +
| Afternoon section closing time in 'HH:MM' 24 Hr format.
 +
| 16:59
 +
| n/a
 +
|-
 +
| calenderHours.evening.enable
 +
| boolean
 +
| Enable/Disable evening section in calendar.
 +
| true
 +
| n/a
 +
|-
 +
| calenderHours.evening.openTime
 +
| number
 +
| Evening section opening time in 'HH:MM' 24 Hr format.
 +
| 17:00
 +
| n/a
 +
|-
 +
| calenderHours.evening.closeTime
 +
| number
 +
| Evening section closing time in 'HH:MM' 24 Hr format.
 +
| 23:59
 +
| n/a
 +
|-
 +
|}
 +
 
 +
[[Category:V:PSAAS:Public]]

Revision as of 14:48, August 25, 2017

Configuration

Description

Calendar share the configuration namespace '_genesys.widgets.calendar'. Calendar has UI options.

Example

window._genesys.widgets.calendar = {

	showAvailability: true,
	numberOfDays: 5,
        timeFormat:12
	calenderHours: {

		interval: 10,

		morning: {

			enable: true,
			openTime: '09:00',
			closeTime: '11:59'
		},

		afternoon: {

			enable: true,
			openTime: '12:00',
			closeTime: '16:59'
		},

		evening: {

			enable: true,
			openTime: '17:00',
			closeTime: '23:59'
		}
	}
};

Options

Name Type Description Default Required
timeFormat number/string This sets the time format for the timestamps in this widget. It can be 12 or 24 12
showAvailability boolean Enable/disable calendar to update the timeslots based on the callback availability. The unavailable timeslots are greyed out. true n/a
numberOfDays number The number of days to display on calendar starting today. 5 n/a
calenderHours.interval number The time interval between each consecutive timeslot displayed on calendar. 15 n/a
calenderHours.morning.enable boolean Enable/Disable morning section in calendar. true n/a
calenderHours.morning.openTime number Morning section opening time in 'HH:MM' 24 Hr format. 08:00 n/a
calenderHours.morning.closeTime number Morning section closing time in 'HH:MM' 24 Hr format. 11:59 n/a
calenderHours.afternoon.enable boolean Enable/Disable afternoon section in calendar. true n/a
calenderHours.afternoon.openTime number Afternoon section opening time in 'HH:MM' 24 Hr format. 12:00 n/a
calenderHours.afternoon.closeTime number Afternoon section closing time in 'HH:MM' 24 Hr format. 16:59 n/a
calenderHours.evening.enable boolean Enable/Disable evening section in calendar. true n/a
calenderHours.evening.openTime number Evening section opening time in 'HH:MM' 24 Hr format. 17:00 n/a
calenderHours.evening.closeTime number Evening section closing time in 'HH:MM' 24 Hr format. 23:59 n/a
Comments or questions about this documentation? Contact us for support!