initially commit for new docs branch

This commit is contained in:
Adam Shaw 2010-01-16 14:29:18 -08:00
commit 3af5a65f69
120 changed files with 2529 additions and 0 deletions

11
agenda/allDaySlot.txt Normal file
View file

@ -0,0 +1,11 @@
allDaySlot *1.4*
================
Determines if the "all-day" slot is displayed at the top of the calendar.
<div class='spec' markdown='1'>
Boolean, *default*: `true`
</div>
When hidden with `false`, all-day events will not be displayed in agenda views.

9
agenda/allDayText.txt Normal file
View file

@ -0,0 +1,9 @@
allDayText *1.4*
================
The text titling the "all-day" slot at the top of the calendar.
<div class='spec' markdown='1'>
String, *default*: `'all-day'`
</div>

13
agenda/axisFormat.txt Normal file
View file

@ -0,0 +1,13 @@
axisFormat *1.4*
================
Determines the time-text that will be displayed on the left vertical axis of the agenda views.
<div class='spec' markdown='1'>
String, *default*: `'h(:mm)tt'`
</div>
The value is a format-string that will be processed by [formatDate](../utilities/formatDate).
The default value will produce times that look like "5pm" and "5:30pm".

View file

@ -0,0 +1,13 @@
defaultEventMinutes *1.4*
=========================
Determines the length (in minutes) an event appears to be when it has an unspecified end date.
<div class='spec' markdown='1'>
Integer, *default*: `120`
</div>
By default, if an [Event Object](../event_data/Event_Object) as no `end`, it will appear to be 2 hours.
This option only affects events that appear in the agenda slots, meaning they have `allDay` set to `true`.

14
agenda/firstHour.txt Normal file
View file

@ -0,0 +1,14 @@
firstHour *1.4*
===============
Determines the first hour that will be visible in the scroll pane.
<div class='spec' markdown='1'>
Integer, *default*: `6`
</div>
Values must be from 0-23, where 0=midnight, 1=1am, etc.
The user will be able to scroll upwards to see events before this time.
If you want to prevent users from doing this, use the [minTime]() option instead.

14
agenda/index.txt Normal file
View file

@ -0,0 +1,14 @@
Agenda Options
==============
The following options only apply to the `agendaWeek` and `agendaDay` views:
- allDaySlot
- allDayText
- axisFormat
- slotMinutes
- defaultEventMinutes
- firstHour
- minTime
- maxTime

11
agenda/maxTime.txt Normal file
View file

@ -0,0 +1,11 @@
maxTime *1.4.2*
===============
Determines the last hour/time (exclusively) that will be displayed, even when the scrollbars have been scrolled all the way down.
<div class='spec' markdown='1'>
Integer/String, *default*: `24`
</div>
This can be a number like `22` (which means 10pm), a string like `'22:30'` (which means 10:30pm) or a string like `'10:30pm'`.

11
agenda/minTime.txt Normal file
View file

@ -0,0 +1,11 @@
minTime *1.4.2*
===============
Determines the first hour/time that will be displayed, even when the scrollbars have been scrolled all the way up.
<div class='spec' markdown='1'>
Integer/String, *default*: `0`
</div>
This can be a number like `5` (which means 5am), a string like `'5:30'` (which means 5:30am) or a string like `'5:30am'`.

11
agenda/slotMinutes.txt Normal file
View file

@ -0,0 +1,11 @@
slotMinutes *1.4*
=================
The frequency for displaying time slots, in minutes.
<div class='spec' markdown='1'>
Integer, *default*: `30`
</div>
The default will make a slot every half hour.

16
current_date/date.txt Normal file
View file

@ -0,0 +1,16 @@
date *1.3*
==========
The initial date-of-the-month when the calendar loads.
<div class='spec' markdown='1'>
Integer
</div>
This option only matters for the week & day views. Month view does not need this option,
because month view always displays the entire month from start to finish.
If `date` is unspecified, and `year`/`month` are set to the current year/month, then the
calendar will start on the current date. If `date` is unspecified, and `year`/`month` are *not*
set to the current year/month, then the calendar will start on the first of the month.

19
current_date/getDate.txt Normal file
View file

@ -0,0 +1,19 @@
getDate *1.4.2*
===============
Returns a Date object for the current date of the calendar.
<div class='spec' markdown='1'>
.fullCalendar( 'getDate' ) -> Date object
</div>
For month view, it will always be sometime between the first and last day of the month.
For week views, it will always be sometime between the first and last day of the week.
Example of displaying a calendar's current date when a button is clicked:
$('#my-button').click(function() {
var d = $('#calendar').fullCalendar('getDate');
alert("The current date of the calendar is " + d);
});

14
current_date/gotoDate.txt Normal file
View file

@ -0,0 +1,14 @@
gotoDate
========
Moves the calendar to an arbitrary year/month/date.
<div class='spec' markdown='1'>
.fullCalendar( 'gotoDate', *year* [, *month*, [ *date* ]] )
</div>
**IMPORTANT**: `month` is 0-based, meaning January=`0`, February=`1`, etc.
This method can also be called with a single argument, a Date object
(only works in versions >= 1.3.2).

View file

@ -0,0 +1,9 @@
incrementDate *1.3*
===================
Moves the calendar forward/backward an arbitrary amount of time.
<div class='spec' markdown='1'>
.fullCalendar( 'incrementDate', *years* [, *months*, [ *days* ]] )
</div>

17
current_date/index.txt Normal file
View file

@ -0,0 +1,17 @@
Current Date
============
<ul>
<li>year</li>
<li>month</li>
<li>date</li>
<li class='method'><a href='prev'>prev</a> <em>(method)</em></li>
<li class='method'><a href='next'>next</a> <em>(method)</em></li>
<li class='method'><a href='prevYear'>prevYear</a> <em>(method)</em></li>
<li class='method'><a href='nextYear'>nextYear</a> <em>(method)</em></li>
<li class='method'><a href='today'>today</a> <em>(method)</em></li>
<li class='method'><a href='gotoDate'>gotoDate</a> <em>(method)</em></li>
<li class='method'><a href='incrementDate'>incrementDate</a> <em>(method)</em></li>
<li class='method'><a href='getDate'>getDate</a> <em>(method)</em></li>
</ul>

14
current_date/month.txt Normal file
View file

@ -0,0 +1,14 @@
month
=====
The initial month when the calendar loads.
<div class='spec' markdown='1'>
Integer
</div>
**IMPORTANT**: The value is 0-based, meaning January=`0`, February=`1`, etc.
If `month` is unspecified and `year` is set to the current year, the calendar will start on the current month.
If `month` is unspecified and `year` is *not* set to the current year, the calendar will start on January.

26
current_date/next.txt Normal file
View file

@ -0,0 +1,26 @@
next *1.3*
==========
Moves the calendar one step forward (either by a month, week, or day).
<div class='spec' markdown='1'>
.fullCalendar( 'next' )
</div>
If the calendar is in `month` view, will move the calendar forward one month.
If the calendar is in `basicWeek` or `agendaWeek`, will move the calendar forward one week.
If the calendar is in `basicDay` or `agendaDay`, will move the calendar forward one day.
Example using `next` with an external button:
$('#my-next-button').click(function() {
$('#calendar').fullCalendar('next');
});
<div class='version-info' markdown='1'>
In versions 1.0 through 1.2.1, this option was known as *prevMonth*.
</div>

11
current_date/nextYear.txt Normal file
View file

@ -0,0 +1,11 @@
nextYear *1.2.x and 1.4 onward*
===============================
Moves the calendar forward one year.
<div class='spec' markdown='1'>
.fullCalendar( 'nextYear' )
</div>
Version 1.3.x did not include this method, but you can use `.fullCalendar('incrementDate', 1)` instead.

25
current_date/prev.txt Normal file
View file

@ -0,0 +1,25 @@
prev *1.3*
==========
Moves the calendar one step back (either by a month, week, or day).
<div class='spec' markdown='1'>
.fullCalendar( 'prev' )
</div>
If the calendar is in `month` view, will move the calendar back one month.
If the calendar is in `basicWeek` or `agendaWeek`, will move the calendar back one week.
If the calendar is in `basicDay` or `agendaDay`, will move the calendar back one day.
Example using `prev` with an external button:
$('#my-prev-button').click(function() {
$('#calendar').fullCalendar('prev');
});
<div class='version-info' markdown='1'>
In versions 1.0 through 1.2.1, this option was known as *prevMonth*.
</div>

11
current_date/prevYear.txt Normal file
View file

@ -0,0 +1,11 @@
prevYear *1.2.x and 1.4 onward*
===============================
Moves the calendar back one year.
<div class='spec' markdown='1'>
.fullCalendar( 'prevYear' )
</div>
Version 1.3.x did not include this method, but you can use `.fullCalendar('incrementDate', -1)` instead.

15
current_date/today.txt Normal file
View file

@ -0,0 +1,15 @@
today
=====
Moves the calendar to the current date.
<div class='spec' markdown='1'>
.fullCalendar( 'today' )
</div>
Example using `today` with an external button:
$('#my-today-button').click(function() {
$('#calendar').fullCalendar('today');
});

13
current_date/year.txt Normal file
View file

@ -0,0 +1,13 @@
year
====
The initial year when the calendar loads.
<div class='spec' markdown='1'>
Integer
</div>
Must be a 4-digit year like `2009`.
If `year` is unspecified, the calendar will begin at the current year.

32
display/aspectRatio.txt Normal file
View file

@ -0,0 +1,32 @@
aspectRatio *1.3*
=================
Determines the width-to-height aspect ratio of the calendar.
<div class='spec' markdown='1'>
Float, *default*: `1.35`
</div>
A calendar is a block-level element that fills its entire avaiable width.
The calendars height, however, is determined by this ratio of width-to-height.
(Hint: larger numbers make smaller heights).
The following example will initialize a calendar who's width is twice its height:
$('#calendar').fullCalendar({
aspectRatio: 2
});
setter
------
You may dynamically set a calendar's aspectRatio after initialization:
$('#calendar').fullCalendar('option', 'aspectRatio', 1.8);
<div class='version-info' markdown='1'>
The *setter* only works in version 1.4.2 and later.
</div>

22
display/buttonIcons.txt Normal file
View file

@ -0,0 +1,22 @@
buttonIcons *1.3*
=================
Determines which theme icons appear within the header buttons.
<div class='spec' markdown='1'>
Object, *default:*
{
prev: 'circle-triangle-w',
next: 'circle-triangle-e'
}
</div>
This option only applies to calendars that have the [theme]() option enabled.
A hash must be supplied that maps button names (from the [header]()) to icon strings.
The icon strings determine the CSS class that will be used on the button. For example, the
string `'circle-triangle-w'` will result in the class `'ui-icon-triangle-w'`.
If a button does not have an entry, it falls back to using [buttonText](../text_customization/buttonText).

25
display/contentHeight.txt Normal file
View file

@ -0,0 +1,25 @@
contentHeight *1.4.2*
=====================
Will make the calendar's content area a pixel height.
<div class='spec' markdown='1'>
Integer
</div>
By default, this option is unset and the calendar's height is calculated by [aspectRatio]().
Example usage of `contentHeight`:
$('#calendar').fullCalendar({
contentHeight: 600
});
setter
------
You may dynamically set a calendar's contentHeight after initialization:
$('#calendar').fullCalendar('option', 'contentHeight', 650);

11
display/destroy.txt Normal file
View file

@ -0,0 +1,11 @@
destroy *1.4.3*
===============
Restores the element to the state before FullCalendar was initialized.
<div class='spec' markdown='1'>
.fullCalendar( 'destroy' )
</div>
Removes elements, events handlers, and data.

17
display/firstDay.txt Normal file
View file

@ -0,0 +1,17 @@
firstDay *1.3*
==============
The day that each week begins.
<div class='spec' markdown='1'>
Integer, *default*: `0` (Sunday)
</div>
The value must be a number that represents the day of the week.
Sunday=`0`, Monday=`1`, Tuesday=`2`, etc.
<div class='version-info' markdown='1'>
In versions 1.1 through 1.2.1, this option was known as *weekStart*.
</div>

46
display/header.txt Normal file
View file

@ -0,0 +1,46 @@
header *1.3*
============
Defines the buttons and title at the top of the calendar.
<div class='spec' markdown='1'>
Object/`false`, *default:*
{
left: 'title',
center: '',
right: 'today prev,next'
}
</div>
Setting the header options to `false` will display no header.
An object can be supplied with properties `left`, `center`, and `right`.
These properties contain strings with comma/space separated values.
Values separated by a comma will be displayed adjacently.
Values separated by a space will be displayed with a small gap in between.
Strings can contain any of the following values:
`title`
: text containing the current month/week/day
`prev`
: button for moving the calendar back one month/week/day
`next`
: button for moving the calendar forward one month/week/day
`prevYear`
: button for moving the calendar back on year
`nextYear`
: button for moving the calendar forward one year
`today`
: button for moving the calendar to the current month/week/day
*a view name*
: button that will switch the calendar to any of the [Available Views](../views/Available_Views)
Specifying an empty string for a property will cause it display no text/buttons.

25
display/height.txt Normal file
View file

@ -0,0 +1,25 @@
height *1.4.2*
==============
Will make the entire calendar (including header) a pixel height.
<div class='spec' markdown='1'>
Integer
</div>
By default, this option is unset and the calendar's height is calculated by [aspectRatio]().
Example usage of `height`:
$('#calendar').fullCalendar({
height: 650
});
setter
------
You may dynamically set a calendar's height after initialization:
$('#calendar').fullCalendar('option', 'height', 700);

20
display/index.txt Normal file
View file

@ -0,0 +1,20 @@
General Display
===============
<ul>
<li>header</li>
<li>theme</li>
<li>buttonIcons</li>
<li>firstDay</li>
<li>isRTL</li>
<li>weekends</li>
<li>weekMode</li>
<li>height</li>
<li>contentHeight</li>
<li>aspectRatio</li>
<li class='callback'><a href='viewDisplay'>viewDisplay</a> <em>(callback)</em></li>
<li class='callback'><a href='windowResize'>windowResize</a> <em>(callback)</em></li>
<li class='method'><a href='render'>render</a> <em>(method)</em></li>
<li class='method'><a href='destroy'>destroy</a> <em>(method)</em></li>
</ul>

15
display/isRTL.txt Normal file
View file

@ -0,0 +1,15 @@
isRTL *1.3*
===========
Displays the calendar in right-to-left mode.
<div class='spec' markdown='1'>
Boolean, *default*: `false`
</div>
This option is meant for right-to-left languages such as Arabic and Hebrew.
<div class='version-info' markdown='1'>
In versions 1.1 through 1.2.1, this option was known as *rightToLeft*.
</div>

26
display/render.txt Normal file
View file

@ -0,0 +1,26 @@
render *1.3.1*
==============
Immediately forces the calendar to render and/or readjusts its size.
<div class='spec' markdown='1'>
.fullCalendar( 'render' )
</div>
This method is useful in the scenario where a tab setup might hide/show a calendar. Call this method whenever the tabs are shown.
Here is an example with the [jQuery UI tab plugin](http://jqueryui.com/demos/tabs/):
$('#my-tabs').tabs({
show: function(event, ui) {
$('#calendar').fullCalendar('render');
}
});
Notice that this example calls `render` whenever *any* tab is shown, not just the tab that the calendar is within.
This is okay, because FullCalendar is smart enough to only render calendars that are visible to the user.
<div class='version-info' markdown='1'>
Prior to version 1.4.2, the *render* method did not readjust the size of the calendar. It only
render the calendar if it was not already rendered.
</div>

14
display/theme.txt Normal file
View file

@ -0,0 +1,14 @@
theme *1.3*
===========
Enables/disables use of jQuery UI themes.
<div class='spec' markdown='1'>
Boolean, *default*: `false`
</div>
Once you enable theming with `true`, you still need to include the CSS file for the
theme you want. For example, if you just downloaded a theme from the
[jQuery UI Themeroller](http://jqueryui.com/themeroller/), you need to put a `<link>`
tag in your page's `<head>`.

28
display/viewDisplay.txt Normal file
View file

@ -0,0 +1,28 @@
viewDisplay *1.3*
=================
Triggered when the calendar loads and every time a different date-range is displayed.
<div class='spec' markdown='1'>
function( *view* ) { }
</div>
The calendar's date-range changes whenever the user switches to a new view
(for example, if they switch from "month" to "agendaWeek") or when they click the prev/next buttons.
`view` is a [View Object](../views/View_Object).
Within the callback function, `this` will be set to the calendar's main element.
Example:
$('#calendar').fullCalendar({
viewDisplay: function(view) {
alert('The new title of the view is ' + view.title);
}
});
<div class='version-info' markdown='1'>
In versions 1.0 through 1.2.1, this option was known as *monthDisplay*.
</div>

29
display/weekMode.txt Normal file
View file

@ -0,0 +1,29 @@
weekMode *1.3*
==============
Determines the number of weeks displayed in a month view. Also determines each week's height.
<div class='spec' markdown='1'>
String, *default*: `'fixed'`
</div>
Available options:
`'fixed'`
: The calendar will always be 6 weeks tall. The height will always be the same, as determined by
[height](height), [contentHeight](), or [aspectRatio]().
`'liquid'`
: The calendar will have either 4, 5, or 6 weeks, depending on the month.
The height of the weeks will stretch to fill the available height, as determined by
[height](height), [contentHeight](), or [aspectRatio]().
`'variable'`
: The calendar will have either 4, 5, or 6 weeks, depending on the month.
Each week will have the same constant height, meaning the calendars height will change
month-to-month.
<div class='version-info' markdown='1'>
In versions 1.0 through 1.2.1, this option was known as *fixedWeeks*.
</div>

9
display/weekends.txt Normal file
View file

@ -0,0 +1,9 @@
weekends *1.4.1*
================
Whether to include Saturday/Sunday columns in any of the calendar views.
<div class='spec' markdown='1'>
Boolean, *default*: `true`
</div>

27
display/windowResize.txt Normal file
View file

@ -0,0 +1,27 @@
windowResize *1.3*
==================
Triggered after the calendar's dimensions have been changed due to the browser window being resized.
<div class='spec' markdown='1'>
function( *view* ) { }
</div>
The calendar has automatically adapted to the new size when windowResize is triggered.
`view` is a [View Object](../views/View_Object).
Within the callback function, `this` will be set to the calendar's main element.
Example:
$('#calendar').fullCalendar({
windowResize: function(view) {
alert('The calendar has adjusted to a window resize');
}
});
<div class='version-info' markdown='1'>
In version 1.1 through 1.2.1, this option was known as *resize*.
</div>

View file

@ -0,0 +1,76 @@
Event Object
============
A standard object that FullCalendar uses to store information about an event.
An Event Object has a number of properties, although only two of them are required
for `events`/`eventSources` (the `title` and `start` properties). Here they are:
**id**: String/Integer (optional)
: Uniquely identifies the given event. Different instances of repeating events should all have the same `id`.
**title**: String
: The text on an event's element
**allDay**: `true` or `false` (optional)
: Whether an event occurs at a specific time-of-day. This property affects whether an event's time is shown.
Also, in the agenda views, determines if it is displayed in the "all-day" section.
**Don't include quotes** around your `true`/`false`. This value is not a string!
When specifying Event Objects for `events` or `eventSources`,
omitting this property will make it inherit from
[allDayDefault](), which is normally `false`.
**start**: Date
: A JavaScript Date object indicating the date/time an event begins.
When specifying Event Objects for `events` or `eventSources`,
you may specify a string in IETF format (ex: "Wed, 18 Oct 2009 13:00:00 EST"),
a string in ISO8601 format (ex: "2009-11-05T13:15:30Z") or a UNIX timestamp.
**end**: Date (optional)
: A Javascript Date object indicating the date/time an event ends.
As with `start`, you may specify it in IETF, ISO8601, or UNIX timestamp format.
**If an event is all-day**...
the end date is inclusive. This means an event with `start` Nov 10 and
`end` Nov 12 will span 3 days on the calendar.
**If an event is NOT all-day**...
the end date is exclusive. This is only a gotcha when your `end` has time 00:00.
It means your event ends on midnight, and it will not span through the next day.
**url**: String (optional)
: A URL that will be visited when this event is clicked by the user.
For more information on controlling this behavior, see the [eventClick](../clicking_hovering/eventClick) callback.
**className**: String/Array (optional)
: A CSS class (or array of classes) that will be attached to this event's element.
**editable**: `true` or `false` (optional)
: Overrides the master [editable]() option for this single event.
**source**: Array/String/Function (automatically populated)
: A reference to the event source (as specified in `events` or `eventSources`)
that this event came from.
Do not worry about populating this value, FullCalendar will do this automatically.
In addition to the fields above, you may also include your own non-standard fields
in each Event Object. FullCalendar will not modify or delete these fields.
For example, developers often include a `description` field for use in callbacks such
as [eventRender](../event_rendering/eventRender).
<div class='version-info' markdown='1'>
Prior to version 1.3, the *allDay* property did not exist. *showTime* was used instead,
and was set to *true* to guarantee that an event's time was shown.
The *className* and *source* properties did not exist prior to version 1.2.
</div>

View file

@ -0,0 +1,12 @@
addEventSource *1.2*
====================
Dynamically adds an event source.
<div class='spec' markdown='1'>
.fullCalendar( 'addEventSource', *source* )
</div>
Source may be an Array/URL/Function just as in the `events` option.
Events will be immediately fetched from this source and placed on the calendar.

View file

@ -0,0 +1,9 @@
allDayDefault *1.3.1*
=====================
Determines the default value for each [Event Object]()'s `allDay` property, when it is unspecified.
<div class='spec' markdown='1'>
Boolean, *default*: `true`
</div>

11
event_data/cacheParam.txt Normal file
View file

@ -0,0 +1,11 @@
cacheParam *1.1*
================
A GET parameter of this name will be inserted into each JSON feed's URL to prevent caching.
<div class='spec' markdown='1'>
String, *default*: `'_'`
</div>
The value will be the current millisecond time.

View file

@ -0,0 +1,23 @@
clientEvents *1.3*
==================
Retrieves events that FullCalendar has in memory.
<div class='spec' markdown='1'>
.fullCalendar( 'clientEvents' [, *idOrFilter* ] )
</div>
This method will return an array of [Event Objects](Event_Object) that FullCalendar has stored
in client-side memory.
If `idOrFilter` is omitted, *all* events will be returned.
If `idOrFilter` is an ID, all events with the same ID will be returned.
`idOrFilter` may also be a filter function that accepts one [Event Object]()
argument and returns `true` if it should be included in the result set.
<div class='version-info' markdown='1'>
In versions 1.2 and 1.2.1, this option was known as *getEventsByID*
</div>

11
event_data/endParam.txt Normal file
View file

@ -0,0 +1,11 @@
endParam
========
A GET parameter of this name will be inserted into each JSON feed's URL.
<div class='spec' markdown='1'>
String, *default*: `'end'`
</div>
The value of this GET parameter will be a UNIX timestamp denoting the end of the last visible day (exclusive).

View file

@ -0,0 +1,21 @@
eventSources *1.2*
==================
A way to specify multiple event sources.
<div class='spec' markdown='1'>
Array
</div>
This option is used instead of the `events` option.
It can take an Array of Arrays/Functions/URLs (anything that the `events` option would take).
Here is an example calendar that displays two [JSON feeds](events_json_feed):
$('#calendar').fullCalendar({
eventSources: [
'/feed1.php',
'/feed2.php'
]
});

View file

@ -0,0 +1,26 @@
events (as an array)
====================
An array of [Event Objects](Event_Object) that will be displayed on the calendar.
Here is an example of how to specify an array of events:
$('#calendar').fullCalendar({
events: [
{
title : 'event1',
start : '2010-01-01'
},
{
title : 'event2',
start : '2010-01-05',
end : '2010-01-07'
},
{
title : 'event3',
start : '2010-01-09 12:30:00',
allDay : false // will make the time show
}
]
});

View file

@ -0,0 +1,54 @@
events (as a function)
======================
A custom function for programmatically generating [Event Objects](Event_Object).
<div class='spec' markdown='1'>
function( *start*, *end*, *callback* ) { }
</div>
FullCalendar will call this function whenever it needs new event data.
This is triggered when the user clicks prev/next or switches views.
This function will be given `start` and `end` parameters, which are
Date objects denoting the range the calendar needs events for.
It will also be given `callback`, a function that must be called when
the custom event function has generated its events. It is the event function's
responsibility to make sure `callback` is being called with an array of
[Event Objects](Event_Object).
Here is an example showing how to use an event function to fetch events from
an XML feed:
$('#calendar').fullCalendar({
events: function(start, end, callback) {
$.ajax({
url: 'myxmlfeed.php',
dataType: 'xml',
data: {
// our hypothetical feed requires UNIX timestamps
start: Math.round(start.getTime() / 1000),
end: Math.round(end.getTime() / 1000)
},
success: function(doc) {
var events = [];
$(doc).find('event').each(function() {
event.push({
title: $(this).attr('title'),
start: $(this).attr('start') // will be parsed
});
});
callback(events);
}
});
}
});
However, if you have the choice, JSON is a better idea because you can just specify a
[feed URL](events_json_feed).

View file

@ -0,0 +1,31 @@
events (as a json feed)
=======================
A URL of a JSON feed that the calendar will fetch [Event Objects](Event_Object) from.
FullCalendar will visit the URL whenever it needs new event data.
This happens when the user clicks prev/next or changes views.
FullCalendar will determine the date-range it needs events for and will
pass that information along in GET parameters.
The GET parameter names will be determined by the [startParam]() and [endParam]() options.
(`"start"` and `"end"` by default).
The value of the parameters will always be UNIX timestamps (seconds since 1970).
Consider the following script:
$('#calendar').fullCalendar({
events: "/myfeed.php"
});
Here is a URL that might be visited:
`/myfeed.php?start=1262332800&end=1265011200&_=1263178646`
The `_` parameter is automatically inserted to prevent the browser from
caching the result (see [cacheParam]()).
If you need to access a feed that is in a different domain, you can use JSONP
with a `?` in your URL (see the JSONP discussion in [$.ajax](http://api.jquery.com/jQuery.ajax/)).

24
event_data/index.txt Normal file
View file

@ -0,0 +1,24 @@
Event Data
==========
<ul>
<li class='article'>Event Object</li>
<li><a href='events_array'>events</a> <em>(as an array)</em></li>
<li><a href='events_json_feed'>events</a> <em>(as a json feed)</em></li>
<li><a href='events_function'>events</a> <em>(as a function)</em></li>
<li>eventSources</li>
<li>allDayDefault</li>
<li>startParam</li>
<li>endParam</li>
<li>cacheParam</li>
<li class='callback'><a href='loading'>loading</a> <em>(callback)</em></li>
<li class='method'><a href='updateEvent'>updateEvent</a> <em>(method)</em></li>
<li class='method'><a href='clientEvents'>clientEvents</a> <em>(method)</em></li>
<li class='method'><a href='removeEvents'>removeEvents</a> <em>(method)</em></li>
<li class='method'><a href='refetchEvents'>refetchEvents</a> <em>(method)</em></li>
<li class='method'><a href='addEventSource'>addEventSource</a> <em>(method)</em></li>
<li class='method'><a href='removeEventSource'>removeEventSource</a> <em>(method)</em></li>
</ul>
See also: [renderEvent]() (for adding an event)

15
event_data/loading.txt Normal file
View file

@ -0,0 +1,15 @@
loading
=======
Triggered when event fetching starts/stops.
<div class='spec' markdown='1'>
function( *isLoading*, *view* )
</div>
Triggered with a `true` argument when the calendar begins fetching events via AJAX. Triggered with `false` when done.
Last argument is the current [View Object](../views/View_Object).
This function is often used to show/hide a loading indicator.

View file

@ -0,0 +1,13 @@
refetchEvents *1.3*
===================
Refetches events from all sources and rerenders them on the screen.
<div class='spec' markdown='1'>
.fullCalendar( 'refetchEvents' )
</div>
<div class='version-info' markdown='1'>
Prior to version 1.3, the same effect was achieved by the *refresh* method.
</div>

View file

@ -0,0 +1,12 @@
removeEventSource *1.2*
=======================
Dynamically removes an event source.
<div class='spec' markdown='1'>
.fullCalendar( 'removeEventSource', *source* )
</div>
Source must be a reference to the original Array/URL/Function.
Events from the source will immediately be removed from the calendar.

View file

@ -0,0 +1,17 @@
removeEvents *1.2*
==================
Removes events from the calendar.
<div class='spec' markdown='1'>
.fullCalendar( 'removeEvents' [, *idOrFilter* ] )
</div>
If `idOrFilter` is omitted, *all* events are removed.
If `idOrFilter` is an ID, all events with the same ID will be removed.
`idOrFilter` may also be a filter function that accepts one [Event Object]()
argument and returns `true` if it should be removed.

11
event_data/startParam.txt Normal file
View file

@ -0,0 +1,11 @@
startParam
==========
A GET parameter of this name will be inserted into each JSON feed's URL.
<div class='spec' markdown='1'>
String, *default*: `'start'`
</div>
The value of this GET parameter will be a UNIX timestamp denoting the start of the first visible day (inclusive).

View file

@ -0,0 +1,26 @@
updateEvent *1.2*
=================
Reports changes to an event and renders them on the calendar.
<div class='spec' markdown='1'>
.fullCalendar( 'updateEvent', *event* )
</div>
`event` must be the original [Event Object]() for an event,
**NOT** merely a reconstructed object.
The original Event Object can obtained by callbacks such as [eventClick](../clicking_hovering/eventClick),
or by the [clientEvents]() method.
Here is how you might update an event after a click:
$('#calendar').fullCalendar({
eventClick: function(event, element) {
event.title = "CLICKED!";
$('#calendar').fullCalendar('updateEvent', event);
}
});

View file

@ -0,0 +1,36 @@
Event Colors
============
You can modify the default color that affects all events by adding some css in the following form:
.fc-event,
.fc-agenda .fc-event-time,
.fc-event a {
background-color: black; /* background color */
border-color: black; /* border color */
color: red; /* text color */
}
You can also change the color for certain events by using the `className` property of each [Event Object](../event_data/Event_Object).
Here is an example of the CSS you would write if your `className` was "holiday":
.holiday,
.fc-agenda .holiday .fc-event-time,
.holiday a {
background-color: green; /* background color */
border-color: green; /* border color */
color: yellow; /* text color */
}
If you are using the "default" and "className" techniques together,
make sure the CSS for the "default" technique comes first.
<p class='abstract' style='display:none'>
How to change colors of events through CSS.
</p>
<div class='version-info' markdown='1'>
Versions prior to 1.3 had different ways of setting colors through CSS.
Check your version's *fullcalendar.css* for an example.
</div>

View file

@ -0,0 +1,9 @@
eventAfterRender *1.4.2*
========================
Triggered after an event has been placed on the calendar in its final position.
<div class='spec' markdown='1'>
function( *event*, *element*, *view* ) { }
</div>

View file

@ -0,0 +1,40 @@
eventRender
===========
Triggered while an event is being rendered.
<div class='spec' markdown='1'>
function( *event*, *element*, *view* ) { }
</div>
`event` is the [Event Object](../event_data/Event_Object) that is attempting to be rendered.
`element` is a newly created jQuery `<div>` that will be used for rendering.
It has already been populated with the correct time/title.
The `eventRender` callback function can modify `element`, return a brand new
DOM element that will be used for rendering instead, or it can return `false`,
which will prevent the event from being rendered at all.
`eventRender` is a great way to attach other jQuery plugins to event elements,
such as a [qTip](http://craigsworks.com/projects/qtip/) tooltip effect:
$('#calendar').fullCalendar({
events: [
{
title: 'My Event',
start: '2010-01-01',
description: 'This is a cool event'
}
// more events here
],
eventRender: function(event, element) {
element.qtip({
content: event.description
});
}
});
Note that `description` is a non-standard Event Object field, which is allowed.

11
event_rendering/index.txt Normal file
View file

@ -0,0 +1,11 @@
Event Rendering
===============
<ul>
<li class='article'>Colors</li>
<li class='callback'><a href='eventRender'>eventRender</a> <em>(callback)</em></li>
<li class='callback'><a href='eventAfterRender'>eventAfterRender</a> <em>(callback)</em></li>
<li class='method'><a href='renderEvent'>renderEvent</a> <em>(method)</em></li>
<li class='method'><a href='rerenderEvents'>rerenderEvents</a> <em>(method)</em></li>
</ul>

View file

@ -0,0 +1,15 @@
renderEvent *1.3*
=================
Renders a new event on the calendar.
<div class='spec' markdown='1'>
.fullCalendar( 'renderEvent', *event* [, *stick* ] )
</div>
`event` must be an [Event Object](../event_data/Event_Object) with a `title` and `start` at the very least.
Normally, the event will disappear once the calendar refetches its event sources (example: when prev/next is clicked).
However, specifying `stick` as `true` will cause the event to be permanently fixed to the calendar.

View file

@ -0,0 +1,13 @@
rerenderEvents *1.3*
====================
Rerenders all events on the calendar.
<div class='spec' markdown='1'>
.fullCalendar( 'rerenderEvents' )
</div>
<div class='version-info' markdown='1'>
Prior to version 1.3, the same effect could be achieved by the *refresh* method.
</div>

21
event_ui/Requirements.txt Normal file
View file

@ -0,0 +1,21 @@
Requirements for Event Dragging & Resizing
==========================================
Event dragging and resizing requires the following jQuery UI modules:
- jQuery UI core
- [Draggable](http://jqueryui.com/demos/draggable/) (the Droppable module is **not** required)
- [Resizable](http://jqueryui.com/demos/resizable/)
These modules can be conveniently bundled/compressed/downloaded at the jQuery UI
[downloads page](http://jqueryui.com/download).
They are also included in the FullCalendar download in the "jquery" directory,
though as uncompressed files.
After you have gathered the dependencies, **you still need to enable dragging/resizing**
by settings the [editable]() option to `true`.
<p class='abstract' style='display:none'>
jQuery UI dependencies.
</p>

View file

@ -0,0 +1,9 @@
disableDragging *1.3*
=====================
Disables all event dragging, even when events are editable.
<div class='spec' markdown='1'>
Boolean, *default*: `false`
</div>

View file

@ -0,0 +1,9 @@
disableResizing *1.3*
=====================
Disables all event resizing, even when events are editable.
<div class='spec' markdown='1'>
Boolean, *default*: `false`
</div>

28
event_ui/dragOpacity.txt Normal file
View file

@ -0,0 +1,28 @@
dragOpacity *1.3*
=================
The opacity of an event when it is being dragged.
<div class='spec' markdown='1'>
Float/[View Option Hash](../views/View_Option_Hash), *default*:
{
// for agendaWeek and agendaDay
agenda: .5,
// for all other views
'': 1.0
}
</div>
Float values range from 0.0 to 1.0.
Specify a single number to affect all views, or a [View Option Hash](../views/View_Option_Hash) to target specific views
(which is what the default does).
<div class='version-info' markdown='1'>
A View Option Hash can only be provided in version 1.4 and later.
Prior to version 1.3, this option was known as *eventDragOpacity*
</div>

View file

@ -0,0 +1,15 @@
dragRevertDuration *1.3*
========================
Time it takes for an event to revert to its original position after an unsuccessful drag.
<div class='spec' markdown='1'>
Integer, *default*: `500`
</div>
Time is in milliseconds (1 second = 1000 milliseconds).
<div class='version-info' markdown='1'>
Prior to version 1.3, this option was known as *eventRevertDuration*
</div>

22
event_ui/editable.txt Normal file
View file

@ -0,0 +1,22 @@
editable *1.3*
==============
Determines whether the events on the calendar can be modified.
<div class='spec' markdown='1'>
Boolean, *default*: `false`
</div>
This determines if the events can be *dragged* and *resized*.
Enables/disables both at the same time. If you don't want both,
use `editable` in conjunction with [disableDragging]() and [disableResizing]().
This option can be overridden on a per-event basis with the
[Event Object](../event_data/Event_Object) `editable` property.
<div class='version-info' markdown='1'>
Prior to version 1.3, the *draggable* option was used instead.
</div>

View file

@ -0,0 +1,18 @@
eventDragStart
==============
Triggered when event dragging begins.
<div class='spec' markdown='1'>
function( *event*, *jsEvent*, *ui*, *view* ) { }
</div>
`event` is an [Event Object](../event_data/Event_Object) that hold the event's information (date, title, etc).
`jsEvent` holds the native javascript event with low-level information such as
click coordinates.
`ui` holds the [jQuery UI object](http://jqueryui.com/demos/draggable/).
`view` holds the current [View Object](../views/View_Object).

View file

@ -0,0 +1,23 @@
eventDragStop
=============
Triggered when event dragging stops.
<div class='spec' markdown='1'>
function( *event*, *jsEvent*, *ui*, *view* ) { }
</div>
This callback is *guaranteed* to be triggered after the user drags an event,
even if the event doesn't change date/time. It is triggered before the event's
information has been modified (if moved to a new date/time) and before the
[eventDrop]() callback is triggered.
`event` is an [Event Object](../event_data/Event_Object) that hold the event's information (date, title, etc).
`jsEvent` holds the native JavaScript event with low-level information such as
mouse coordinates.
`ui` holds the [jQuery UI object](http://jqueryui.com/demos/draggable/).
`view` holds the current [View Object](../views/View_Object).

73
event_ui/eventDrop.txt Normal file
View file

@ -0,0 +1,73 @@
eventDrop
=========
Triggered when dragging stops and the event has moved to a *different* day/time.
<div class='spec' markdown='1'>
function( *event*, *dayDelta*, *minuteDelta*, *allDay*, *revertFunc*, *jsEvent*, *ui*, *view* ) { }
</div>
`event` is an [Event Object](../event_data/Event_Object) that hold the event's information (date, title, etc).
`dayDelta` holds the number of days the event was moved forward (a positive number) or backwards (a negative number).
`minuteDelta` holds the number of minutes the event was moved forward (a positive number) or backwards (a negative number).
Only useful for the agenda views. In other views, `0` is passed in.
`dayDelta` and `minuteDelta` are elegant for dealing with multi-day and repeating events.
If updating a remote database, just add these values to the start and end times of all events with the given `event.id`.
`allDay` is `true` if the event has been dropped on a day in month view, or the "all-day" slot in the agenda views.
It will be `false` if dropped on a slot in the agenda views (meaning it has been assigned a time).
`revertFunc` is a function that, if called, reverts the event's start/end date to the values before the drag.
This is useful if an ajax call should fail.
`jsEvent` holds the native javascript event with low-level information such as
mouse coordinates.
`ui` holds the [jQuery UI object](http://jqueryui.com/demos/draggable/).
`view` holds the current [View Object](../views/View_Object).
Here is an example demonstrating most of these arguments:
$('#calendar').fullCalendar({
events: [
// events here
],
editable: true,
eventDrop: function(event,dayDelta,minuteDelta,allDay,revertFunc) {
alert(
event.title + " was moved " +
(dayDelta < 0 ? "back" : "forward") +
dayDelta + " days and " +
(minuteDelta < 0 ? "back" : "forward") +
minuteDelta + " minutes."
);
if (allDay) {
alert("Event is now all-day");
}else{
alert("Event has a time-of-day");
}
if (!confirm("Are you sure about this change?")) {
revertFunc();
}
}
});
<div class='version-info' markdown='1'>
Prior to version 1.4, the *allDay* paramameter was not included.
Prior to version 1.3, the *revertFunc* parameter was not included.
</div>

54
event_ui/eventResize.txt Normal file
View file

@ -0,0 +1,54 @@
eventResize *1.3*
=================
Triggered when resizing stops and the event has changed in duration.
<div class='spec' markdown='1'>
function( *event*, *dayDelta*, *minuteDelta*, *revertFunc*, *jsEvent*, *ui*, *view* ) { }
</div>
`event` is an [Event Object](../event_data/Event_Object) that hold the event's information (date, title, etc).
`dayDelta` holds the number of days the event's end date was moved forward (a positive number) or backwards (a negative number).
`minuteDelta` holds the number of minutes the event's end time was moved forward (a positive number) or backwards (a negative number).
Only useful for the agenda views. In other views, `0` is passed in.
`dayDelta` and `minuteDelta` are elegant for dealing with multi-day and repeating events.
If updating a remote database, just add these values to the *end* of all events with the given `event.id`.
`revertFunc` is a function that, if called, reverts the event's end date to the value before the drag.
This is useful if an ajax call should fail.
`jsEvent` holds the native javascript event with low-level information such as
mouse coordinates.
`ui` holds the [jQuery UI object](http://jqueryui.com/demos/draggable/).
`view` holds the current [View Object](../views/View_Object).
Here is an example demonstrating most of these arguments:
$('#calendar').fullCalendar({
events: [
// events here
],
editable: true,
eventResize: function(event,dayDelta,minuteDelta,revertFunc) {
alert(
"The end date of " + event.title +
"has been moved " +
(dayDelta < 0 ? "back" : "forward") +
dayDelta + " days and " +
(minuteDelta < 0 ? "back : "forward") +
minuteDelta + " minutes."
);
if (!confirm("is this okay?")) {
revertFunc();
}
}
});

View file

@ -0,0 +1,18 @@
eventResizeStart *1.3*
======================
Triggered when event resizing begins.
<div class='spec' markdown='1'>
function( *event*, *jsEvent*, *ui*, *view* ) { }
</div>
`event` is an [Event Object](../event_data/Event_Object) that hold the event's information (date, title, etc).
`jsEvent` holds the native JavaScript event with low-level information such as
click coordinates.
`ui` holds the [jQuery UI object](http://jqueryui.com/demos/draggable/).
`view` holds the current [View Object](../views/View_Object).

View file

@ -0,0 +1,23 @@
eventResizeStop *1.3*
=====================
Triggered when event resizing stops.
<div class='spec' markdown='1'>
function( *event*, *jsEvent*, *ui*, *view* ) { }
</div>
This callback is *guaranteed* to be triggered after the user resizes an event,
even if the event doesn't change in duration. It is triggered before the event's
information has been modified (if changed in duration) and before the
[eventResize]() callback is triggered.
`event` is an [Event Object](../event_data/Event_Object) that hold the event's information (date, title, etc).
`jsEvent` holds the native JavaScript event with low-level information such as
mouse coordinates.
`ui` holds the [jQuery UI object](http://jqueryui.com/demos/draggable/).
`view` holds the current [View Object](../views/View_Object).

18
event_ui/index.txt Normal file
View file

@ -0,0 +1,18 @@
Event Dragging & Resizing
=========================
<ul>
<li class='article'>Requirements</li>
<li>editable</li>
<li>disableDragging</li>
<li>disableResizing</li>
<li>dragRevertDuration</li>
<li>dragOpacity</li>
<li class='callback'><a href='eventDragStart'>eventDragStart</a> <em>(callback)</em></li>
<li class='callback'><a href='eventDragStop'>eventDragStop</a> <em>(callback)</em></li>
<li class='callback'><a href='eventDrop'>eventDrop</a> <em>(callback)</em></li>
<li class='callback'><a href='eventResizeStart'>eventResizeStart</a> <em>(callback)</em></li>
<li class='callback'><a href='eventResizeStop'>eventResizeStop</a> <em>(callback)</em></li>
<li class='callback'><a href='eventResize'>eventResize</a> <em>(callback)</em></li>
</ul>

84
google_calendar.txt Normal file
View file

@ -0,0 +1,84 @@
Google Calendar
===============
FullCalendar can be made to display events from a public [Google Calendar](http://calendar.google.com/).
Google Calendar can serve as a backend that manages and persistently stores event data
(a feature that FullCalendar currently lacks).
**To get started, you must first make your Google Calendar public:**
1. In the Google Calendar interface, locate the "My Calendar" box on the left.
2. Click the arrow next to the calendar you need.
3. A menu will appear. Click "Share this calendar."
4. Check "Make this calendar public."
5. Make sure "Share only my free/busy information" is **unchecked**.
6. Click "Save."
**Then, you must obtain your calendar's XML feed URL:**
1. In the Google Calendar interface, locate the "My Calendar" box on the left
2. Click the arrow next to the calendar you need.
3. A menu will appear. Click "Calendar settings."
4. In the "Calendar Address" section of the screen, click the XML badge.
5. Your feed's URL will appear.
**Now it's time to initialize your calendar in JavaScript.**
You will use the `$.fullCalendar.gcalFeed` function with the `events` option, like so:
$(document).ready(function() {
// page is now ready, initialize the calendar...
$('#calendar').fullCalendar({
events: $.fullCalendar.gcalFeed(
"http://www.google.com/your_feed_url/"
)
});
});
If you wanted to import more than one Google Calendar, you would use the `events` option.
Options
-------
You can tweak the way FullCalendar imports your Google Calendar events through these options:
- **className** - CSS class to attach to each event
- **editable** - whether to allow dragging/resizing (default: `false`)
- **currentTimezone** - a string like "America/Chicago".
Consult [http://php.net/manual/en/timezones.php](http://php.net/manual/en/timezones.php) for a full list.
Here is an example of how you'd use these options:
$('#calendar').fullCalendar({
events: $.fullCalendar.gcalFeed(
"http://www.google.com/your_feed_url/",
{
// put your options here
className: 'gcal-event',
editable: true,
currentTimezone: 'America/Chicago'
}
)
});
Timezones Gotchas
-----------------
Sometimes it can be confusing as to why FullCalendar displays event times differently than the Google Calendar interface.
There are the two factors involved in this:
- *the calendar's timezone*, accessed through "Calendar settings" after clicking the arrow next to the calendar's name
- *your Google Account's timezone*, accessed through the "Settings" link at the top right of the Google Calendar screen (near the "Sign out" link)
When both timezones are the same, you should have no problems. When they are different, FullCalendar will display times in the *calendar's* timezone.
Thus, times will be different than what you see in the Google Calendar interface because they are being adjusted to the GMT of the calendar.
The solution is to use the `currentTimezone` option. If this is set to the same timezone as your Google Account, all dates should appear consistent.

13
index.txt Normal file
View file

@ -0,0 +1,13 @@
- [Basic Usage](usage)
- [Google Calendar](google_calendar)
- [General Display](display)
- [Views](views)
- [Agenda Options](agenda)
- [Current Date](current_date)
- [Text/Time Customization](text_customization)
- [Clicking & Hovering](mouse)
- [Event Data](event_data)
- [Event Rendering](event_rendering)
- [Event Dragging & Resizing](event_ui)
- [Utilities](utilities)

46
mouse/dayClick.txt Normal file
View file

@ -0,0 +1,46 @@
dayClick
========
Triggered when the user clicks on a day.
<div class='spec' markdown='1'>
function( *date*, *allDay*, *jsEvent*, *view* ) { }
</div>
`date` holds a Date object for the current day. If user has clicked on a slot in the
agendaWeek or agendaDay views, `date` will also have its time set.
`allDay` will be set to true `false` if the user has clicked on a slot in the
agendaWeek or agendaDay views. Otherwise, it will be `true`.
`jsEvent` holds the native JavaScript event with low-level information such as click coordinates.
`view` is set to the current [View Object](../views/View_Object).
Within the callback function, `this` is set to the TD element of the clicked day.
Here is an example that demonstrates all of these variables:
$('#calendar').fullCalendar({
dayClick: function(date, allDay, jsEvent, view) {
if (allDay) {
alert('Clicked on the entire day: ' + date);
}else{
alert('Clicked on the slot: ' + date);
}
alert('Coordinates: ' + jsEvent.pageX + ',' + jsEvent.pageY);
alert('Current view: ' + view.name);
// change the day's background color just for fun
$(this).css('background-color', 'red');
}
});
<div class='version-info' markdown='1'>
The *allDay* parameter has only been available since version 1.4.
</div>

54
mouse/eventClick.txt Normal file
View file

@ -0,0 +1,54 @@
eventClick
==========
Triggered when the user clicks an event.
<div class='spec' markdown='1'>
function( *calEvent*, *jsEvent*, *view* ) { }
</div>
`calEvent` is an [Event Object](../event_data/Event_Object) that holds the event's information (date, title, etc).
`jsEvent` holds the native JavaScript event with low-level information such as click coordinates.
`view` holds the current [View Object](../views/View_Object).
Within the callback function, `this` is set to the event's `<div>` element.
Here is an example demonstrating all these variables:
$('#calendar').fullCalendar({
eventClick: function(calEvent, jsEvent, view) {
alert('Event: ' + calEvent.title);
alert('Coordinates: ' + jsEvent.pageX + ',' + jsEvent.pageY);
alert('View: ' + view.name);
// change the text color of the event
$(this).css('color', 'red');
}
});
Return Value
------------
Normally, if the [Event Object](../event_data/Event_Object) has its `url` property set, a click on the event
will cause the browser to visit the event's url (in the same window/tab).
Returning `false` from within your function will prevent this from happening.
Often developers want an event's `url` to open in a different tab or a popup window.
The following example shows how to do this:
$('#calendar').fullCalendar({
eventClick: function(calEvent, jsEvent, view) {
if (calEvent.url) {
window.open(calEvent.url);
return false;
}
}
});
The `window.open` function can take [many other options](http://www.w3schools.com/jsref/met_win_open.asp).

17
mouse/eventMouseout.txt Normal file
View file

@ -0,0 +1,17 @@
eventMouseout
=============
Triggered when the user mouses out of an event.
<div class='spec' markdown='1'>
function( *calEvent*, *jsEvent*, *view* ) { }
</div>
`calEvent` is an [Event Object](../event_data/Event_Object) that holds the event's information (date, title, etc).
`jsEvent` holds the native JavaScript event with low-level information such as click coordinates.
`view` holds the current [View Object](../views/View_Object).
Within the callback function, `this` is set to the event's `<div>` element.

18
mouse/eventMouseover.txt Normal file
View file

@ -0,0 +1,18 @@
eventMouseover
==============
Triggered when the user mouses over an event.
<div class='spec' markdown='1'>
function( *calEvent*, *jsEvent*, *view* ) { }
</div>
`calEvent` is an [Event Object](../event_data/Event_Object) that holds the event's information (date, title, etc).
`jsEvent` holds the native JavaScript event with low-level information such as click coordinates.
`view` holds the current [View Object](../views/View_Object).
Within the callback function, `this` is set to the event's `<div>` element.

10
mouse/index.txt Normal file
View file

@ -0,0 +1,10 @@
Clicking & Hovering
===================
<ul>
<li class='callback'><a href='dayClick'>dayClick</a> <em>(callback)</em></li>
<li class='callback'><a href='eventClick'>eventClick</a> <em>(callback)</em></li>
<li class='callback'><a href='eventMouseover'>eventMouseover</a> <em>(callback)</em></li>
<li class='callback'><a href='eventMouseout'>eventMouseout</a> <em>(callback)</em></li>
</ul>

View file

@ -0,0 +1,13 @@
abbrevDayHeadings
=================
<div class='removed-notice' markdown='1'>
This option was removed in version 1.3. Use [columnFormat](../text_customization/columnFormat) instead.
</div>
Whether to display "Sun" versus "Sunday" for days of the week.
<div class='spec' markdown='1'>
Boolean, *default*: `true`
</div>

14
removed/addEvent.txt Normal file
View file

@ -0,0 +1,14 @@
addEvent
========
<div class='removed-notice' markdown='1'>
This method was removed in version 1.3. Please use [renderEvent](../event_rendering/renderEvent) with the *stick* parameter
set to `true` to achieve the same effect.
</div>
Dynamically adds an [Event Object](../event_data/Event_Object) to the calendar.
<div class='spec' markdown='1'>
.fullCalendar( 'addEvent', *event* )
</div>

32
removed/buttons.txt Normal file
View file

@ -0,0 +1,32 @@
buttons
=======
<div class='removed-notice' markdown='1'>
This option was removed in 1.3 in favor of [header](../display/header) and [buttonText](../text_customization/buttonText).
</div>
Defines the buttons and button-text at the top of the calendar.
<div class='spec' markdown='1'>
Boolean/Object, *default*: `true`
</div>
`true` will display a previous-month, next-month, and "today" button.
The "today" button will only be visible for months other than the current.
`false` will display absolutely no buttons.
An object hash can be provided to display only *certain* buttons.
The hash can have the following properties:
{
today: bool/string,
prevYear: bool/string,
prevMonth: bool/string,
nextMonth: bool/string,
nextYear: bool/string
}
A value of `false` will not display the button. A value of `true` will display the button with some default text.
A string value will display the button *and* customize its text.

16
removed/draggable.txt Normal file
View file

@ -0,0 +1,16 @@
draggable
=========
<div class='removed-notice' markdown='1'>
This option was removed in version 1.3. Use [editable](../event_ui/editable) and
[disableDragging](../event_ui/disableDragging) instead.
</div>
Enables/disables dragging.
<div class='spec' markdown='1'>
Boolean, *default*: `false`
</div>
jQuery UI core & draggables required.

View file

@ -0,0 +1,7 @@
eventDragOpacity
================
<div class='removed-notice' markdown='1'>
In version 1.3, this option was renamed to [dragOpacity](../event_ui/dragOpacity).
</div>

View file

@ -0,0 +1,7 @@
eventRevertDuration
===================
<div class='removed-notice' markdown='1'>
In version 1.3, this option was renamed to [dragRevertDuration](../event_ui/dragRevertDuration).
</div>

15
removed/fixedWeeks.txt Normal file
View file

@ -0,0 +1,15 @@
fixedWeeks
==========
<div class='removed-notice' markdown='1'>
This option was removed in version 1.3. Use [weekMode](../display/weekMode) instead.
</div>
Determines the number of weeks shown in each month.
<div class='spec' markdown='1'>
Boolean, *default*: `true`
</div>
If `true`, the calendar will always be 6 weeks tall. If `false`, the calendars height will vary per month.

13
removed/getEventsById.txt Normal file
View file

@ -0,0 +1,13 @@
getEventsById
=============
<div class='removed-notice' markdown='1'>
In version 1.3, this method was removed in favor of [clientEvents](../event_data/clientEvents).
</div>
Retrieves all locally-stored events with the given ID.
<div class='spec' markdown='1'>
.fullCalendar( 'getEventsById', *id* )
</div>

21
removed/index.txt Normal file
View file

@ -0,0 +1,21 @@
Renamed/Removed
---------------
- prevMonth
- nextMonth
- draggable
- fixedWeeks
- abbrevDayHeadings
- buttons
- title
- eventDragOpacity
- eventRevertDuration
- weekStart
- rightToLeft
- addEvent
- removeEvent
- getEventsById
- refresh
- monthDisplay
- resize

15
removed/monthDisplay.txt Normal file
View file

@ -0,0 +1,15 @@
monthDisplay
============
<div class='removed-notice' markdown='1'>
In version 1.3, this callback was removed in favor of [viewDisplay](../display/viewDisplay).
</div>
Triggered once when the calendar loads and every time the calendar's month is changed.
<div class='spec' markdown='1'>
function( *year*, *month*, *monthTitle* )
</div>
`month` is **zero-based**. `monthTitle` contains the new title of the month (ex: "January 2009")

13
removed/nextMonth.txt Normal file
View file

@ -0,0 +1,13 @@
nextMonth
=========
<div class='removed-notice' markdown='1'>
In version 1.3, this method was renamed to [next](../current_date/next).
</div>
Moves the calendar forward one month.
<div class='spec' markdown='1'>
.fullCalendar( 'nextMonth' )
</div>

13
removed/prevMonth.txt Normal file
View file

@ -0,0 +1,13 @@
prevMonth
=========
<div class='removed-notice' markdown='1'>
In version 1.3, this method was renamed to [prev](../current_date/prev).
</div>
Moves the calendar back one month.
<div class='spec' markdown='1'>
.fullCalendar( 'prevMonth' )
</div>

14
removed/refresh.txt Normal file
View file

@ -0,0 +1,14 @@
refresh
=======
<div class='removed-notice' markdown='1'>
This method was removed in version 1.3 in favor of [refetchEvents](../event_data/refetchEvents)
and [rerenderEvents](../event_rendering/rerenderEvents).
</div>
Refetches and redraws the events for the current month.
<div class='spec' markdown='1'>
.fullCalendar( 'refresh' )
</div>

13
removed/removeEvent.txt Normal file
View file

@ -0,0 +1,13 @@
removeEvent
===========
<div class='removed-notice' markdown='1'>
In version 1.3, this method was removed in favor of [removeEvents](../event_data/removeEvents).
</div>
Remove an event with a given ID.
<div class='spec' markdown='1'>
.fullCalendar( 'removeEvent', *id* )
</div>

7
removed/resize.txt Normal file
View file

@ -0,0 +1,7 @@
resize
======
<div class='removed-notice' markdown='1'>
In version 1.3, this callback was renamed to [windowResize](../display/windowResize).
</div>

7
removed/rightToLeft.txt Normal file
View file

@ -0,0 +1,7 @@
rightToLeft
===========
<div class='removed-notice' markdown='1'>
In version 1.3, this option was renamed to [isRTL](../display/isRTL).
</div>

13
removed/title.txt Normal file
View file

@ -0,0 +1,13 @@
title
=====
<div class='removed-notice' markdown='1'>
This option was removed in version 1.3 in favor of the [header](../display/header) system.
</div>
Determines whether a title such as "January 2009" will be displayed at the top of the calendar.
<div class='spec' markdown='1'>
Boolean, *default:* `true`
</div>

7
removed/weekStart.txt Normal file
View file

@ -0,0 +1,7 @@
weekStart
=========
<div class='removed-notice' markdown='1'>
In version 1.3, this option was renamed to [firstDay](../display/firstDay).
</div>

View file

@ -0,0 +1,30 @@
buttonText *1.3*
================
Text that will be displayed on buttons of the header.
<div class='spec' markdown='1'>
Object, *default*:
{
prev: '&nbsp;&#9668;&nbsp;', // left triangle
next: '&nbsp;&#9658;&nbsp;', // right triangle
prevYear: '&nbsp;&lt;&lt;&nbsp;', // <<
nextYear: '&nbsp;&gt;&gt;&nbsp;', // >>
today: 'today',
month: 'month',
week: 'week',
day: 'day'
}
</div>
If you wanted to change the prev/next buttons to use &lt; and &gt; characters,
here what you would do:
$('#calendar').fullCalendar({
buttonText: {
prev: '&lt;',
next: '&gt;'
}
});

View file

@ -0,0 +1,24 @@
columnFormat *1.3*
==================
Determines the text that will be displayed on the calendar's column headings.
<div class='spec' markdown='1'>
String/[View Option Hash](../views/View_Option_Hash), *default*:
{
month: 'ddd', // Mon
week: 'ddd M/d', // Mon 9/7
day: 'dddd M/d' // Monday 9/7
}
</div>
Uses [formatDate](../utilities/formatDate) formatting rules.
A single string will set the title format for all views. A [View Option Hash](../views/View_Option_Hash) may be provided to target specific views
(this is what the default does).
<div class='version-info'>
A View Option Hash can only be provided in version 1.4 and later.
</div>

View file

@ -0,0 +1,16 @@
dayNames *1.3*
==============
Full names of days-of-week.
<div class='spec' markdown='1'>
Array, *default*:
['Sunday', 'Monday', 'Tuesday', 'Wednesday',
'Thursday', 'Friday', 'Saturday']
</div>
<div class='version-info' markdown='1'>
Prior to version 1.3, this was possible by setting $.fullCalendar.dayNames
</div>

Some files were not shown because too many files have changed in this diff Show more