- Information
- License (MIT)
- Recent Changes
- Supported Languages
- Supported Export Types
- Supported Import Types
- Setup
- Getting Started
- CDN Links
- JSON Objects
- Calendar Event
- Holiday
- Navigation
- Shortcut Keys
- API
- Binding Functions
- Class Instance Functions
- Advanced
- Custom Triggers
- Basic Options
- View Options
- Search Options
- Side Menu Options
- Text Options
- Date Formatting
Basic Options
Explore this complete list of basic Calendar.js configuration options to easily set up, customize, and update your calendar settings on the fly.
Example
calendarInstance.setOptions( {
visibleDays: [ 0, 1, 2, 3, 4 ]
} );| Type: | Name: | Description: |
|---|---|---|
| boolean | showDayNumberOrdinals | States if the day ordinal values should be shown (defaults to true). |
| boolean | dragAndDropForEventsEnabled | States if dragging and dropping events around the days of the month is enabled (defaults to true). |
| boolean | exportEventsEnabled | States if exporting events is enabled (defaults to true). |
| boolean | manualEditingEnabled | States if adding, editing, dragging and removing events is enabled (defaults to true). |
| number | autoRefreshTimerDelay | The amount of time to wait before each full refresh (defaults to 30000 milliseconds, 0 disables it). |
| boolean | fullScreenModeEnabled | States if double-click on the main title bar activates full-screen mode (defaults to true). |
| number | tooltipDelay | The amount of time to wait until a tooltip is shown (defaults to 1000 milliseconds). |
| Holiday[] | holidays | The holidays that should be shown for specific days/months (refer to "Holiday" documentation for properties). |
| string | organizerName | The default name of the organizer (defaults to an empty string). |
| string | organizerEmailAddress | The default email address of the organizer (defaults to an empty string). |
| number | spacing | States the default spacing that should be used for additional margins (defaults to 10). |
| number | maximumEventTitleLength | States the maximum length allowed for an event title (defaults to 0 to allow any size). |
| number | maximumEventDescriptionLength | States the maximum length allowed for an event description (defaults to 0 to allow any size). |
| number | maximumEventLocationLength | States the maximum length allowed for an event location (defaults to 0 to allow any size). |
| number | maximumEventGroupLength | States the maximum length allowed for an event group (defaults to 0 to allow any size). |
| boolean | eventNotificationsEnabled | States if notifications should be shown for events (defaults to false). |
| boolean | tooltipsEnabled | States if the tooltips are enabled throughout all the displays (defaults to true). |
| number[] | visibleDays | States the day numbers that should be visible (Outside listing all events. Defaults to [ 0, 1, 2, 3, 4, 5, 6 ], Mon=0, Sun=6). |
| string | urlWindowTarget | States the target that an event URL should be opened in (defaults to _blank for a new window). |
| string | defaultEventBackgroundColor | States the default background color that should be used for events (defaults to "#484848"). |
| string | defaultEventTextColor | States the default text color that should be used for events (defaults to "#F5F5F5"). |
| string | defaultEventBorderColor | States the default border color that should be used for events (defaults to "#282828"). |
| boolean | openInFullScreenMode | States if full-screen mode should be turned on when the calendar is rendered (defaults to false). |
| boolean | hideEventsWithoutGroupAssigned | States if events without a group should be hidden (defaults to false). |
| boolean | showHolidays | States if the holidays should be shown (defaults to true). |
| boolean | useTemplateWhenAddingNewEvent | States if a blank template event should be added when adding a new event (causing the dialog to be in edit mode, defaults to true). |
| boolean | useEscapeKeyToExitFullScreenMode | States if the escape key should exit full-screen mode (if enabled, defaults to true). |
| boolean | allowHtmlInDisplay | States if HTML can be used in the display (defaults to false). |
| number[] | weekendDays | States the day numbers that are considered weekend days (defaults to [ 0, 1, 2, 3, 4, 5, 6 ], Mon=0, Sun=6). |
| Object | initialDateTime | States the date that the calendar should start from when first loaded (defaults to today). |
| Search | searchOptions | States all the configurable search options that should be used (refer to "Search Options" documentation for properties). This is an alternate way of getting the options into the instance. |
| Event[] | data | States the events that will be shown when the calendar first renders (defaults to null). |
| number[] | workingDays | States the day numbers that are considered working days (defaults to [ 0, 1, 2, 3, 4, 5, 6 ], Mon=0, Sun=6). |
| number | minimumYear | The minimum year that can be shown in the Calendar (defaults to 1900). |
| number | maximumYear | The maximum year that can be shown in the Calendar (defaults to 2099). |
| number | defaultEventDuration | States the default duration used when a new event is added (defaults to 30 minutes). |
| boolean | configurationDialogEnabled | States if the configuration dialog is enabled (defaults to true). |
| boolean | popUpNotificationsEnabled | States if the popup notifications (when actions are performed) are enabled (defaults to true). |
| number | startOfWeekDay | States what day the week starts on (defaults to 0, with options: Mon = 0, Sat = 5, Sun = 6). |
| boolean | useLocalStorageForEvents | States if the events added should be stored in local storage (remembered between browser usages, defaults to false). |
| boolean | shortcutKeysEnabled | States if the shortcut keys are enabled (defaults to true). |
| Object | workingHoursStart | States what time the working hours start (for example, "09:00", or { 2: "09:00" } for specific days, and defaults to null). |
| Object | workingHoursEnd | States what time the working hours end (for example, "17:00", or { 2: "17:00" } for specific days, and defaults to null). |
| boolean | reverseOrderDaysOfWeek | States if the days of the week should be reversed (for Hebrew calendars, for example. Defaults to false). |
| boolean | importEventsEnabled | States if importing events is enabled (defaults to true). |
| boolean | useAmPmForTimeDisplays | States if the AM/PM time format should be used for all time displays (defaults to false). |
| boolean | isWidget | States if the new calendar instance is only a widget (defaults to false). |
| string | viewToOpenOnFirstLoad | States which view should be opened when the Calendar is first initialized (defaults to null, accepts "full-day", "full-week", "full-year", "timeline", and "all-events"). |
| boolean | eventColorsEditingEnabled | States if changing the colors for events in the "Edit Event" dialog is enabled (defaults to true). |
| number | eventTooltipDelay | The amount of time to wait until an event tooltip is shown (defaults to 1000 milliseconds). |
| boolean | jumpToDateEnabled | States if the "Jump To Date" dialog is enabled (defaults to true). |
| boolean | shareEventsEnabled | States if sharing events is enabled (defaults to true). |
| boolean | showReoccurringEventIcons | States if the icons should be shown in a reoccurring events (defaults to true). |
| boolean | dialogMovingEnabled | States if the dialogs can be moved (defaults to true). |