round of changes to docs before releasing
This commit is contained in:
parent
3af5a65f69
commit
68c6da2ade
|
@ -2,7 +2,7 @@
|
|||
axisFormat *1.4*
|
||||
================
|
||||
|
||||
Determines the time-text that will be displayed on the left vertical axis of the agenda views.
|
||||
Determines the time-text that will be displayed on the vertical axis of the agenda views.
|
||||
|
||||
<div class='spec' markdown='1'>
|
||||
String, *default*: `'h(:mm)tt'`
|
||||
|
|
|
@ -2,7 +2,7 @@
|
|||
date *1.3*
|
||||
==========
|
||||
|
||||
The initial date-of-the-month when the calendar loads.
|
||||
The initial date-of-month when the calendar loads.
|
||||
|
||||
<div class='spec' markdown='1'>
|
||||
Integer
|
||||
|
|
|
@ -5,7 +5,7 @@ getDate *1.4.2*
|
|||
Returns a Date object for the current date of the calendar.
|
||||
|
||||
<div class='spec' markdown='1'>
|
||||
.fullCalendar( 'getDate' ) -> Date object
|
||||
.fullCalendar( 'getDate' ) -> Date
|
||||
</div>
|
||||
|
||||
For month view, it will always be sometime between the first and last day of the month.
|
||||
|
|
|
@ -19,10 +19,10 @@ The following example will initialize a calendar who's width is twice its height
|
|||
});
|
||||
|
||||
|
||||
setter
|
||||
Setter
|
||||
------
|
||||
|
||||
You may dynamically set a calendar's aspectRatio after initialization:
|
||||
You can dynamically set a calendar's aspectRatio after initialization:
|
||||
|
||||
$('#calendar').fullCalendar('option', 'aspectRatio', 1.8);
|
||||
|
||||
|
|
|
@ -2,7 +2,7 @@
|
|||
buttonIcons *1.3*
|
||||
=================
|
||||
|
||||
Determines which theme icons appear within the header buttons.
|
||||
Determines which theme icons appear on the header buttons.
|
||||
|
||||
<div class='spec' markdown='1'>
|
||||
Object, *default:*
|
||||
|
@ -13,10 +13,10 @@ Object, *default:*
|
|||
}
|
||||
</div>
|
||||
|
||||
This option only applies to calendars that have the [theme]() option enabled.
|
||||
This option only applies to calendars that have jQuery UI theming enabled with the [theme]() option.
|
||||
|
||||
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).
|
||||
If a button does not have an entry, it falls back to using [buttonText](../text/buttonText).
|
||||
|
|
|
@ -17,9 +17,9 @@ Example usage of `contentHeight`:
|
|||
});
|
||||
|
||||
|
||||
setter
|
||||
Setter
|
||||
------
|
||||
|
||||
You may dynamically set a calendar's contentHeight after initialization:
|
||||
You can dynamically set a calendar's contentHeight after initialization:
|
||||
|
||||
$('#calendar').fullCalendar('option', 'contentHeight', 650);
|
||||
|
|
|
@ -8,4 +8,4 @@ Restores the element to the state before FullCalendar was initialized.
|
|||
.fullCalendar( 'destroy' )
|
||||
</div>
|
||||
|
||||
Removes elements, events handlers, and data.
|
||||
Removes elements, events handlers, and internal data.
|
||||
|
|
|
@ -12,6 +12,8 @@ The value must be a number that represents the day of the week.
|
|||
|
||||
Sunday=`0`, Monday=`1`, Tuesday=`2`, etc.
|
||||
|
||||
This option is useful for UK users who need the week to start on Monday (`1`).
|
||||
|
||||
<div class='version-info' markdown='1'>
|
||||
In versions 1.1 through 1.2.1, this option was known as *weekStart*.
|
||||
</div>
|
||||
|
|
|
@ -17,9 +17,9 @@ Example usage of `height`:
|
|||
});
|
||||
|
||||
|
||||
setter
|
||||
Setter
|
||||
------
|
||||
|
||||
You may dynamically set a calendar's height after initialization:
|
||||
You can dynamically set a calendar's height after initialization:
|
||||
|
||||
$('#calendar').fullCalendar('option', 'height', 700);
|
||||
|
|
|
@ -18,3 +18,5 @@ General Display
|
|||
<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>
|
||||
|
||||
See also: [buttonText](../text/buttonText)
|
||||
|
|
|
@ -8,7 +8,7 @@ Displays the calendar in right-to-left mode.
|
|||
Boolean, *default*: `false`
|
||||
</div>
|
||||
|
||||
This option is meant for right-to-left languages such as Arabic and Hebrew.
|
||||
This option is useful 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*.
|
||||
|
|
|
@ -22,5 +22,5 @@ This is okay, because FullCalendar is smart enough to only render calendars that
|
|||
|
||||
<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.
|
||||
rendered the calendar if it was not already rendered.
|
||||
</div>
|
||||
|
|
|
@ -2,7 +2,7 @@
|
|||
theme *1.3*
|
||||
===========
|
||||
|
||||
Enables/disables use of jQuery UI themes.
|
||||
Enables/disables use of jQuery UI theming.
|
||||
|
||||
<div class='spec' markdown='1'>
|
||||
Boolean, *default*: `false`
|
||||
|
|
|
@ -11,11 +11,11 @@ function( *view* ) { }
|
|||
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).
|
||||
`view` is the current [View Object](../views/View_Object).
|
||||
|
||||
Within the callback function, `this` will be set to the calendar's main element.
|
||||
|
||||
Example:
|
||||
Example usage of viewDisplay:
|
||||
|
||||
$('#calendar').fullCalendar({
|
||||
viewDisplay: function(view) {
|
||||
|
|
|
@ -10,11 +10,11 @@ function( *view* ) { }
|
|||
|
||||
The calendar has automatically adapted to the new size when windowResize is triggered.
|
||||
|
||||
`view` is a [View Object](../views/View_Object).
|
||||
`view` is the current [View Object](../views/View_Object).
|
||||
|
||||
Within the callback function, `this` will be set to the calendar's main element.
|
||||
|
||||
Example:
|
||||
Example usage of windowResize:
|
||||
|
||||
$('#calendar').fullCalendar({
|
||||
windowResize: function(view) {
|
||||
|
|
|
@ -2,10 +2,11 @@
|
|||
Event Object
|
||||
============
|
||||
|
||||
A standard object that FullCalendar uses to store information about an event.
|
||||
A standard object that FullCalendar uses to store information about a calendar 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:
|
||||
An Event Object has a number of properties. When passing new Event Objects to
|
||||
`events` and `eventSources`, only the `title` and `start` properties are required.
|
||||
Here is the full list of properties:
|
||||
|
||||
**id**: String/Integer (optional)
|
||||
: Uniquely identifies the given event. Different instances of repeating events should all have the same `id`.
|
||||
|
@ -46,13 +47,13 @@ for `events`/`eventSources` (the `title` and `start` properties). Here they are:
|
|||
|
||||
**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.
|
||||
For more information on controlling this behavior, see the [eventClick](../mouse/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.
|
||||
: Overrides the master [editable](../event_ui/editable) option for this single event.
|
||||
|
||||
**source**: Array/String/Function (automatically populated)
|
||||
: A reference to the event source (as specified in `events` or `eventSources`)
|
||||
|
@ -67,8 +68,10 @@ For example, developers often include a `description` field for use in callbacks
|
|||
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.
|
||||
Prior to version 1.3, the *end* date was always exclusive, even when *allDay* was set to *true*.
|
||||
|
||||
Prior to version 1.3, the *allDay* property did not exist. *showTime* was used instead.
|
||||
It was set to *true* to show times and *false* to hide them.
|
||||
|
||||
The *className* and *source* properties did not exist prior to version 1.2.
|
||||
</div>
|
||||
|
|
|
@ -5,7 +5,7 @@ clientEvents *1.3*
|
|||
Retrieves events that FullCalendar has in memory.
|
||||
|
||||
<div class='spec' markdown='1'>
|
||||
.fullCalendar( 'clientEvents' [, *idOrFilter* ] )
|
||||
.fullCalendar( 'clientEvents' [, *idOrFilter* ] ) -> Array
|
||||
</div>
|
||||
|
||||
This method will return an array of [Event Objects](Event_Object) that FullCalendar has stored
|
||||
|
|
|
@ -19,3 +19,14 @@ Here is an example calendar that displays two [JSON feeds](events_json_feed):
|
|||
'/feed2.php'
|
||||
]
|
||||
});
|
||||
|
||||
Here is how you would display two Google Calendars:
|
||||
|
||||
$('#calendar').fullCalendar({
|
||||
eventSources: [
|
||||
$.fullCalendar.gcalFeed("http://www.google.com/feed1"),
|
||||
$.fullCalendar.gcalFeed("http://www.google.com/feed2")
|
||||
]
|
||||
});
|
||||
|
||||
More info on displaying Google Calendars can be found [here](../google_calendar).
|
||||
|
|
|
@ -24,3 +24,6 @@ Here is an example of how to specify an array of events:
|
|||
}
|
||||
]
|
||||
});
|
||||
|
||||
Make sure you do not have a comma after the last event in your array!
|
||||
It will make Internet Explorer choke.
|
||||
|
|
|
@ -44,7 +44,6 @@ an XML feed:
|
|||
});
|
||||
|
||||
callback(events);
|
||||
|
||||
}
|
||||
});
|
||||
}
|
||||
|
|
|
@ -20,7 +20,7 @@ Consider the following script:
|
|||
events: "/myfeed.php"
|
||||
});
|
||||
|
||||
Here is a URL that might be visited:
|
||||
Here is a URL that FullCalendar might visit:
|
||||
|
||||
`/myfeed.php?start=1262332800&end=1265011200&_=1263178646`
|
||||
|
||||
|
|
|
@ -21,4 +21,4 @@ Event Data
|
|||
<li class='method'><a href='removeEventSource'>removeEventSource</a> <em>(method)</em></li>
|
||||
</ul>
|
||||
|
||||
See also: [renderEvent]() (for adding an event)
|
||||
See also: [renderEvent](../event_rendering/renderEvent) (for adding an event)
|
||||
|
|
|
@ -10,6 +10,6 @@ function( *isLoading*, *view* )
|
|||
|
||||
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).
|
||||
`view` is the current [View Object](../views/View_Object).
|
||||
|
||||
This function is often used to show/hide a loading indicator.
|
||||
|
|
|
@ -9,8 +9,8 @@ Reports changes to an event and renders them on the calendar.
|
|||
</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),
|
||||
**not** merely a reconstructed object.
|
||||
The original Event Object can obtained by callbacks such as [eventClick](../mouse/eventClick),
|
||||
or by the [clientEvents]() method.
|
||||
|
||||
Here is how you might update an event after a click:
|
||||
|
|
|
@ -24,7 +24,7 @@ Here is an example of the CSS you would write if your `className` was "holiday":
|
|||
}
|
||||
|
||||
If you are using the "default" and "className" techniques together,
|
||||
make sure the CSS for the "default" technique comes first.
|
||||
make sure the CSS for the default technique comes first.
|
||||
|
||||
<p class='abstract' style='display:none'>
|
||||
How to change colors of events through CSS.
|
||||
|
|
|
@ -2,7 +2,7 @@
|
|||
dragOpacity *1.3*
|
||||
=================
|
||||
|
||||
The opacity of an event when it is being dragged.
|
||||
The opacity of an event while it is being dragged.
|
||||
|
||||
<div class='spec' markdown='1'>
|
||||
Float/[View Option Hash](../views/View_Option_Hash), *default*:
|
||||
|
@ -22,7 +22,7 @@ Specify a single number to affect all views, or a [View Option Hash](../views/Vi
|
|||
(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.
|
||||
A *View Option Hash* can only be provided in versions 1.4 and later.
|
||||
|
||||
Prior to version 1.3, this option was known as *eventDragOpacity*
|
||||
Prior to version 1.3, this option was known as *eventDragOpacity*.
|
||||
</div>
|
||||
|
|
|
@ -24,7 +24,7 @@ It will be `false` if dropped on a slot in the agenda views (meaning it has been
|
|||
`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
|
||||
`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/).
|
||||
|
@ -42,9 +42,7 @@ Here is an example demonstrating most of these arguments:
|
|||
|
||||
alert(
|
||||
event.title + " was moved " +
|
||||
(dayDelta < 0 ? "back" : "forward") +
|
||||
dayDelta + " days and " +
|
||||
(minuteDelta < 0 ? "back" : "forward") +
|
||||
minuteDelta + " minutes."
|
||||
);
|
||||
|
||||
|
|
|
@ -24,7 +24,7 @@ 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/).
|
||||
`ui` holds the [jQuery UI object](http://jqueryui.com/demos/resizable/).
|
||||
|
||||
`view` holds the current [View Object](../views/View_Object).
|
||||
|
||||
|
@ -38,11 +38,8 @@ Here is an example demonstrating most of these arguments:
|
|||
eventResize: function(event,dayDelta,minuteDelta,revertFunc) {
|
||||
|
||||
alert(
|
||||
"The end date of " + event.title +
|
||||
"has been moved " +
|
||||
(dayDelta < 0 ? "back" : "forward") +
|
||||
"The end date of " + event.title + "has been moved " +
|
||||
dayDelta + " days and " +
|
||||
(minuteDelta < 0 ? "back : "forward") +
|
||||
minuteDelta + " minutes."
|
||||
);
|
||||
|
||||
|
|
|
@ -11,8 +11,8 @@ function( *event*, *jsEvent*, *ui*, *view* ) { }
|
|||
`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.
|
||||
mouse coordinates.
|
||||
|
||||
`ui` holds the [jQuery UI object](http://jqueryui.com/demos/draggable/).
|
||||
`ui` holds the [jQuery UI object](http://jqueryui.com/demos/resizable/).
|
||||
|
||||
`view` holds the current [View Object](../views/View_Object).
|
||||
|
|
|
@ -18,6 +18,6 @@ information has been modified (if changed in duration) and before the
|
|||
`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/).
|
||||
`ui` holds the [jQuery UI object](http://jqueryui.com/demos/resizable/).
|
||||
|
||||
`view` holds the current [View Object](../views/View_Object).
|
||||
|
|
|
@ -2,8 +2,8 @@
|
|||
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
|
||||
FullCalendar can display events from a public [Google Calendar](http://calendar.google.com/).
|
||||
It 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:**
|
||||
|
@ -38,7 +38,8 @@ You will use the `$.fullCalendar.gcalFeed` function with the `events` option, li
|
|||
|
||||
});
|
||||
|
||||
If you wanted to import more than one Google Calendar, you would use the `events` option.
|
||||
If you wanted to import more than one Google Calendar, you would use the
|
||||
[eventSources](event_data/eventSources) option instead.
|
||||
|
||||
|
||||
|
||||
|
|
|
@ -5,7 +5,7 @@
|
|||
- [Views](views)
|
||||
- [Agenda Options](agenda)
|
||||
- [Current Date](current_date)
|
||||
- [Text/Time Customization](text_customization)
|
||||
- [Text/Time Customization](text)
|
||||
- [Clicking & Hovering](mouse)
|
||||
- [Event Data](event_data)
|
||||
- [Event Rendering](event_rendering)
|
||||
|
|
|
@ -18,7 +18,7 @@ agendaWeek or agendaDay views. Otherwise, it will be `true`.
|
|||
|
||||
`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.
|
||||
Within the callback function, `this` is set to the `<td>` of the clicked day.
|
||||
|
||||
Here is an example that demonstrates all of these variables:
|
||||
|
||||
|
|
|
@ -5,10 +5,10 @@ eventClick
|
|||
Triggered when the user clicks an event.
|
||||
|
||||
<div class='spec' markdown='1'>
|
||||
function( *calEvent*, *jsEvent*, *view* ) { }
|
||||
function( *event*, *jsEvent*, *view* ) { }
|
||||
</div>
|
||||
|
||||
`calEvent` is an [Event Object](../event_data/Event_Object) that holds the event's information (date, title, etc).
|
||||
`event` 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.
|
||||
|
||||
|
@ -25,8 +25,8 @@ Here is an example demonstrating all these variables:
|
|||
alert('Coordinates: ' + jsEvent.pageX + ',' + jsEvent.pageY);
|
||||
alert('View: ' + view.name);
|
||||
|
||||
// change the text color of the event
|
||||
$(this).css('color', 'red');
|
||||
// change the border color just for fun
|
||||
$(this).css('border-color', 'red');
|
||||
|
||||
}
|
||||
});
|
||||
|
@ -39,16 +39,25 @@ Normally, if the [Event Object](../event_data/Event_Object) has its `url` proper
|
|||
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.
|
||||
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);
|
||||
events: [
|
||||
{
|
||||
title: 'My Event',
|
||||
start: '2010-01-01',
|
||||
url: 'http://google.com/'
|
||||
}
|
||||
// other events here
|
||||
],
|
||||
eventClick: function(event) {
|
||||
if (event.url) {
|
||||
window.open(event.url);
|
||||
return false;
|
||||
}
|
||||
}
|
||||
});
|
||||
|
||||
The `window.open` function can take [many other options](http://www.w3schools.com/jsref/met_win_open.asp).
|
||||
|
||||
|
|
|
@ -5,12 +5,12 @@ eventMouseout
|
|||
Triggered when the user mouses out of an event.
|
||||
|
||||
<div class='spec' markdown='1'>
|
||||
function( *calEvent*, *jsEvent*, *view* ) { }
|
||||
function( *event*, *jsEvent*, *view* ) { }
|
||||
</div>
|
||||
|
||||
`calEvent` is an [Event Object](../event_data/Event_Object) that holds the event's information (date, title, etc).
|
||||
`event` 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.
|
||||
`jsEvent` holds the native JavaScript event with low-level information such as mouse coordinates.
|
||||
|
||||
`view` holds the current [View Object](../views/View_Object).
|
||||
|
||||
|
|
|
@ -5,12 +5,12 @@ eventMouseover
|
|||
Triggered when the user mouses over an event.
|
||||
|
||||
<div class='spec' markdown='1'>
|
||||
function( *calEvent*, *jsEvent*, *view* ) { }
|
||||
function( *event*, *jsEvent*, *view* ) { }
|
||||
</div>
|
||||
|
||||
`calEvent` is an [Event Object](../event_data/Event_Object) that holds the event's information (date, title, etc).
|
||||
`event` 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.
|
||||
`jsEvent` holds the native JavaScript event with low-level information such as mouse coordinates.
|
||||
|
||||
`view` holds the current [View Object](../views/View_Object).
|
||||
|
||||
|
|
|
@ -3,7 +3,7 @@ abbrevDayHeadings
|
|||
=================
|
||||
|
||||
<div class='removed-notice' markdown='1'>
|
||||
This option was removed in version 1.3. Use [columnFormat](../text_customization/columnFormat) instead.
|
||||
This option was removed in version 1.3. Use [columnFormat](../text/columnFormat) instead.
|
||||
</div>
|
||||
|
||||
Whether to display "Sun" versus "Sunday" for days of the week.
|
||||
|
|
|
@ -3,7 +3,7 @@ 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).
|
||||
This option was removed in 1.3 in favor of [header](../display/header) and [buttonText](../text/buttonText).
|
||||
</div>
|
||||
|
||||
Defines the buttons and button-text at the top of the calendar.
|
||||
|
|
|
@ -20,7 +20,7 @@ Object, *default*:
|
|||
</div>
|
||||
|
||||
If you wanted to change the prev/next buttons to use < and > characters,
|
||||
here what you would do:
|
||||
here is what you would do:
|
||||
|
||||
$('#calendar').fullCalendar({
|
||||
buttonText: {
|
|
@ -14,11 +14,12 @@ String/[View Option Hash](../views/View_Option_Hash), *default*:
|
|||
}
|
||||
</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.
|
||||
Uses [formatDate](../utilities/formatDate)/[formatDates](../utilities/formatDates) formatting rules.
|
||||
(The formatting rules were much different in versions before 1.3. [See here](../utilities/formatDate_pre_13))
|
||||
|
||||
<div class='version-info' markdown='1'>
|
||||
A *View Option Hash* can only be provided in version 1.4 and later.
|
||||
</div>
|
|
@ -12,5 +12,5 @@ Array, *default*:
|
|||
</div>
|
||||
|
||||
<div class='version-info' markdown='1'>
|
||||
Prior to version 1.3, this was possible by setting $.fullCalendar.dayNames
|
||||
Prior to version 1.3, this was possible by setting *$.fullCalendar.dayNames*
|
||||
</div>
|
|
@ -11,5 +11,5 @@ Array, *default*:
|
|||
</div>
|
||||
|
||||
<div class='version-info' markdown='1'>
|
||||
Prior to version 1.3, this was possible by setting $.fullCalendar.dayAbbrevs
|
||||
Prior to version 1.3, this was possible by setting *$.fullCalendar.dayAbbrevs*
|
||||
</div>
|
|
@ -13,6 +13,6 @@ Text/Time Customization
|
|||
<li>dayNamesShort</li>
|
||||
</ul>
|
||||
|
||||
Related agenda-view options: [allDayText](../agenda/allDayText), [axisFormat](../agenda/axisFormat)
|
||||
Related agenda options: [allDayText](../agenda/allDayText), [axisFormat](../agenda/axisFormat)
|
||||
|
||||
Essential for date/time formatting: [formatDate commands](../utilities/formatDate).
|
||||
Essential for date/time formatting: [formatDate](../utilities/formatDate) commands.
|
|
@ -12,5 +12,5 @@ Array, *default*:
|
|||
</div>
|
||||
|
||||
<div class='version-info' markdown='1'>
|
||||
Prior to version 1.3, this was possible by setting $.fullCalendar.monthNames
|
||||
Prior to version 1.3, this was possible by setting *$.fullCalendar.monthNames*
|
||||
</div>
|
|
@ -12,5 +12,5 @@ Array, *default*:
|
|||
</div>
|
||||
|
||||
<div class='version-info' markdown='1'>
|
||||
Prior to version 1.3, this was possible by setting $.fullCalendar.monthAbbrevs
|
||||
Prior to version 1.3, this was possible by setting *$.fullCalendar.monthAbbrevs*
|
||||
</div>
|
|
@ -17,19 +17,28 @@ String/[View Option Hash](../views/View_Option_Hash), *default*:
|
|||
|
||||
</div>
|
||||
|
||||
A single format string will change the time-text for events in all views.
|
||||
A [View Option Hash](../views/View_Option_Hash) may be provided to target specific views (this is what the default does).
|
||||
|
||||
Uses [formatDate](../utilities/formatDate)/[formatDates](../utilities/formatDates) formatting rules.
|
||||
(The formatting rules were much different in versions before 1.3. [See here](../utilities/formatDate_pre_13))
|
||||
|
||||
Time-text will only be displayed for [Event Objects](../event_data/Event_Object) that have `allDay` equal to `false`.
|
||||
|
||||
A single format string will change the time-text for events in all views.
|
||||
A [View Option Hash](../views/View_Option_Hash) may be provided to target specific views (which is what the default does).
|
||||
|
||||
Here is an example of displaying all events in a 24-hour format:
|
||||
|
||||
$('#calendar').fullCalendar({
|
||||
timeFormat: 'H(:mm)' // uppercase H for military time
|
||||
events: [
|
||||
{
|
||||
title: 'My Event',
|
||||
start: '2010-01-01T14:30:00',
|
||||
allDay: false
|
||||
}
|
||||
// other events here...
|
||||
],
|
||||
timeFormat: 'H(:mm)' // uppercase H for 24-hour clock
|
||||
});
|
||||
|
||||
<div class='version-info'>
|
||||
A View Option Hash can only be provided in version 1.4 and later.
|
||||
<div class='version-info' markdown='1'>
|
||||
A *View Option Hash* can only be provided in version 1.4 and later.
|
||||
</div>
|
|
@ -14,11 +14,12 @@ String/[View Option Hash](../views/View_Option_Hash), *default*:
|
|||
}
|
||||
</div>
|
||||
|
||||
Uses [formatDate](../utilities/formatDate)/[formatDates](../utilities/formatDates) 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.
|
||||
Uses [formatDate](../utilities/formatDate)/[formatDates](../utilities/formatDates) formatting rules.
|
||||
(The formatting rules were much different in versions before 1.3. [See here](../utilities/formatDate_pre_13))
|
||||
|
||||
<div class='version-info' markdown='1'>
|
||||
A *View Option Hash* can only be provided in version 1.4 and later.
|
||||
</div>
|
|
@ -10,8 +10,8 @@ Make sure you are including the FullCalendar stylesheet, as well as the FullCale
|
|||
<script type='text/javascript' src='jquery.js'></script>
|
||||
<script type='text/javascript' src='fullcalendar.js'></script>
|
||||
|
||||
If you plan to do drag & drop, you also need to get your hands on the [jQuery UI](http://jqueryui.com/download)
|
||||
"Core" and "Draggable" (more information [here](event_ui/Requirements)).
|
||||
If you plan on doing dragging or resizing, you need some additional [jQuery UI](http://jqueryui.com/download) files
|
||||
(more information [here](event_ui/Requirements)).
|
||||
|
||||
Once you have your dependencies, you need to write the JavaScript code that initializes the calendar.
|
||||
This code must be executed *after* the page has initialized. The best way to do this is with jQuery's
|
||||
|
|
|
@ -10,7 +10,7 @@ $.fullCalendar.formatDate( *date*, *formatString* [, *options* ] ) -> String
|
|||
|
||||
Prior to version 1.3, formatDate accepted a very different format. [See here](formatDate_pre_13).
|
||||
|
||||
`formatString` can be combinations of any of the following commands:
|
||||
`formatString` is a combination of any of the following commands:
|
||||
|
||||
- **s** - seconds
|
||||
- **ss** - seconds, 2 digits
|
||||
|
@ -51,8 +51,8 @@ Special Characters:
|
|||
|
||||
|
||||
The `options` parameter can be used to override default locale options, such as
|
||||
[monthNames](../text_customization/monthNames),
|
||||
[monthNamesShort](../text_customization/monthNamesShort),
|
||||
[dayNames](../text_customization/dayNames),
|
||||
and [dayNamesShort](../text_customization/dayNamesShort).
|
||||
[monthNames](../text/monthNames),
|
||||
[monthNamesShort](../text/monthNamesShort),
|
||||
[dayNames](../text/dayNames),
|
||||
and [dayNamesShort](../text/dayNamesShort).
|
||||
|
||||
|
|
|
@ -8,7 +8,7 @@ Formats a date range (two Date objects) into a string.
|
|||
$.fullCalendar.formatDates( *date1*, *date2*, *formatString* [, *options* ] ) -> String
|
||||
</div>
|
||||
|
||||
`formatDates` uses all the commands from [formatDate](), but with two more special forms:
|
||||
`formatDates` uses all the commands from [formatDate](), but with two special forms:
|
||||
|
||||
`{...}`
|
||||
: switches to formatting the 2nd date
|
||||
|
|
|
@ -5,7 +5,7 @@ parseISO8601
|
|||
Parses an ISO8601 string into a Date object.
|
||||
|
||||
<div class='spec' markdown='1'>
|
||||
$.fullCalendar.parseISO8601( *string* [, *ignoreTimezone* ] )
|
||||
$.fullCalendar.parseISO8601( *string* [, *ignoreTimezone* ] ) -> Date
|
||||
</div>
|
||||
|
||||
More information about the ISO8601 format can be found [here](http://www.w3.org/TR/NOTE-datetime).
|
||||
|
|
|
@ -6,10 +6,10 @@ FullCalendar has a number of different "views", or ways of displaying days and e
|
|||
The following 5 views are all built in to FullCalendar:
|
||||
|
||||
- **month** - [see example](/js/fullcalendar_views/month.html)
|
||||
- **basicWeek** - [see example](/js/fullcalendar_views/basicWeek.html)
|
||||
- **basicDay** - [see example](/js/fullcalendar_views/basicDay.html)
|
||||
- **agendaWeek** - [see example](/js/fullcalendar_views/agendaWeek.html)
|
||||
- **agendaDay** - [see example](/js/fullcalendar_views/agendaDay.html)
|
||||
- **basicWeek** - [see example](/js/fullcalendar_views/basicWeek.html) (available since version 1.3)
|
||||
- **basicDay** - [see example](/js/fullcalendar_views/basicDay.html) (available since version 1.3)
|
||||
- **agendaWeek** - [see example](/js/fullcalendar_views/agendaWeek.html) (available since version 1.4)
|
||||
- **agendaDay** - [see example](/js/fullcalendar_views/agendaDay.html) (available since version 1.4)
|
||||
|
||||
You can define [header](../display/header) buttons to allow the user to switch between them.
|
||||
You can set the initial view of the calendar with the [defaultView]() option.
|
||||
|
|
|
@ -1,6 +1,6 @@
|
|||
|
||||
View Object
|
||||
===========
|
||||
View Object *1.3*
|
||||
=================
|
||||
|
||||
An object that is passed to every callback, containing info about the current view.
|
||||
|
||||
|
@ -10,13 +10,13 @@ It will be populated with the following properties:
|
|||
: Name of one of the [Available Views]() (a string).
|
||||
|
||||
`title`
|
||||
: Title text that is displayed at the top of the header (such as “September 2009” or “Sep 7 - 13 2009”).
|
||||
: Title text that is displayed at the top of the header (such as "September 2009" or "Sep 7 - 13 2009").
|
||||
|
||||
`start`
|
||||
: A Date object of the first day of the month/week. If day-view, the date of the single day.
|
||||
: A Date object of the first day of the month/week. If in day-view, the date of the single day.
|
||||
|
||||
`end`
|
||||
: A Date object of the day after the last day of the month/week. If day-view, the Date after the single day.
|
||||
: A Date object of the day after the last day of the month/week. If in day-view, the Date after the single day.
|
||||
|
||||
Because this is an exclusive value, if the calendar has a month-view on October 2009, `end` will be November 1st.
|
||||
|
||||
|
|
|
@ -1,17 +1,17 @@
|
|||
|
||||
View Option Hash
|
||||
================
|
||||
View Option Hash *1.4*
|
||||
======================
|
||||
|
||||
A way to specify options on a per-view basis.
|
||||
|
||||
This is specified as an object with key/value pairings. The key tells FullCalendar
|
||||
that the specified option value should only be applied for certain views.
|
||||
that the specified option value should only be applied to certain views.
|
||||
|
||||
Currently, View Option Hashes only work for
|
||||
[dragOpacity](../event_ui/dragOpacity),
|
||||
[titleFormat](../text_customization/titleFormat),
|
||||
[columnFormat](../text_customization/columnFormat),
|
||||
and [timeFormat](../text_customization/timeFormat).
|
||||
[titleFormat](../text/titleFormat),
|
||||
[columnFormat](../text/columnFormat),
|
||||
and [timeFormat](../text/timeFormat).
|
||||
|
||||
Here is how you target certain views:
|
||||
|
||||
|
|
|
@ -5,7 +5,7 @@ getView *1.4.2*
|
|||
Returns the [View Object]() for the current view.
|
||||
|
||||
<div class='spec' markdown='1'>
|
||||
.fullCalendar( 'getView' ) -> View Object
|
||||
.fullCalendar( 'getView' ) -> [View Object]()
|
||||
</div>
|
||||
|
||||
This is useful if you want to get information about the calendar’s title or start/end dates.
|
||||
|
|
Loading…
Reference in a new issue