Event Source Object

An “event source” is anything that provides FullCalendar with data about events. It can be a simple array, an event-generating function that you define, a URL to a json feed, or a Google Calendar feed.

Event Objects can have “options” associated with them. However, before you can start specifying options, you must write an Event Object in its extended form. It must be a traditional JavaScript object with properties. Here are the extended forms for each type of Event Source:

Array of events:

{
  events: [
    {
      title: 'Event1',
      start: '2011-04-04'
    },
    {
      title: 'Event2',
      start: '2011-05-05'
    }
    // etc...
  ],
  color: 'yellow',   // an option!
  textColor: 'black' // an option!
}

Event-generating function:

{
  events: function(info, successCallback, failureCallback) {
    // ...
  },
  color: 'yellow',   // an option!
  textColor: 'black' // an option!
}

JSON feed:

{
  url: '/myfeed.php',
  color: 'yellow',   // an option!
  textColor: 'black' // an option!
}

Google Calendar feed:

{
  googleCalendarId: 'abcd1234@group.calendar.google.com',
  color: 'yellow',   // an option!
  textColor: 'black' // an option!
}

Event Source Options

id	Optional. Useful for getEventSourceById.
url	If a JSON feed or iCalendar feed, the specified URL
format	Specify `'json'` for a JSON feed (the default) or `'ics'` for an iCalendar feed
color	Sets every Event Object's `color` for this source.
backgroundColor	Sets every Event Object's `backgroundColor` for this source.
borderColor	Sets every Event Object's `borderColor` for this source.
textColor	Sets every Event Object's `textColor` for this source.
className	Sets every Event Object's `className` for this source.
editable	Sets every Event Object's `editable` for this source.
startEditable	Sets every Event Object's `startEditable` for this source.
durationEditable	Sets every Event Object's `durationEditable` for this source.
resourceEditable	Sets every Event Object's `resourceEditable` for this source.
display	Sets the eventDisplay setting for every event in this source.
overlap	Sets the eventOverlap setting for every event in this source. Does not accept a function.
constraint	Sets the eventConstraint setting for every event in this source.
allow	Sets the eventAllow setting for every event in this source.
defaultAllDay	Sets the defaultAllDay option, but only for this source.
success	Sets the eventSourceSuccess callback, but only for this source.
failure	Sets the eventSourceFailure callback, but only for this source.
eventDataTransform	Sets the eventDataTransform callback, but only for this source.

For JSON feeds, there are additional options you can set.

After Parsing

The above object is what you specify to initially define an event source, but if you want to access it and manipulate it dynamically afterwards, you’ll be dealing with a different type of object. This type of object is emitted from methods like getEventSources and getEventSourceById. It has the following properties and methods:

id	The specified ID
url	If a JSON feed or iCalendar feed, the specified URL
format	`'json'` for a JSON feed, `'ics'` for an iCalendar feed, or `null` for anything else.
refetch()	Refetches event data for this event source. More information.
remove()	Removes this source from the calendar More information.

Event Requesting

Methods

Event Source Object

Event Source Options

After Parsing