mirror of
https://github.com/wassname/fullcalendar.git
synced 2026-09-09 11:22:41 +08:00
initially commit for new docs branch
This commit is contained in:
@@ -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.
|
||||
@@ -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);
|
||||
});
|
||||
@@ -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).
|
||||
@@ -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>
|
||||
@@ -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>
|
||||
@@ -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.
|
||||
@@ -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>
|
||||
@@ -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.
|
||||
@@ -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>
|
||||
@@ -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.
|
||||
@@ -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');
|
||||
});
|
||||
@@ -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.
|
||||
Reference in New Issue
Block a user