FullCalendar 官方文档翻译2
1、基本語法：
首先，fullcalendar和JQUERY一樣，以面向對象的方式來組織代碼。當然，這里的面向對象僅僅是指可以把整個fullcalendar理解 為一個類，這個類里包括有很多的屬性、方法、委托(函數回調)作為成員變量。通過為這些成員變量賦值，即可實例化出一個符合自己需求的 fullcalendar實例出來，即最終在瀏覽器里渲染出的日歷。換句話說，我們所做的絕大多數工作就是按照fullcalendar的語法約定去配置 出一個符合我們需求的fullcalendar實例。除非對于極少的特殊需求，fullcalendar向我們提供的接口不足以滿足，才會去修改 fullcalendar本身的js文件。
作為一種JQUERY插件，可以把fullcalendar理解為向 jquery對象集里添加了一個日歷相關的對象，這個對象里相關方法、屬性、的調用方式，即為fullcalendar的基本語法。整個語法分為兩種：
第一種和日歷本身無關，僅僅是利用fullcalendar提供的方法來進行字符串和日期間的轉換，形式如下：
$.fullCalendar.formatDate();
第二種則是與和配置fullcalendar實例相關的，這最終會影響到fullcalendar在瀏覽器里的渲染，形式如下$(‘#someId’) .fullCalendar(content);
$(‘#someId’)將得到一個jquery對象，其中someId為你希望渲染日歷的元素id。重點是后面一部分.fullCalendar(content);
Content有三種形式：
①為屬性賦值 {key:value,…}
$('#calendar').fullCalendar({
weekends: false // will hide Saturdays and Sundays
});
這里即得到一個fullcalendar實例，其中weekends屬性為false,即月日歷不會顯示周末。
②方法調用'methodName','para'
$('#calendar').fullCalendar('next')
這里會調用fullcalendar實例的next方法，其結果是瀏覽器的日歷向后翻一月(日)
③為方法回調賦值
$('#calendar').fullCalendar({
dayClick: function() { alert('a day has been clicked!'); }
});
這里是為日歷控件的dayClick事件賦值為相應的匿名函數，其結果是日歷的每日被點擊時，會彈出對話框。
我想先有這樣一種觀念更便于后面的理解，需要渲染一個fullcalendar控件時，通常是直接在實例化一個fullcalendar時即完成它的絕大 多數屬性 和委托的賦值，如此即得到一個會被瀏覽器渲染成日歷的fullcalendar對象（A），當這個對象已經被渲染后，如果需要動態的修改它的相關配置，可 以通過$('#calendar').fullCalendar('option','aspectRatio', 1.8); 的形式去修改。
如果需要對象A發生某些變化，也可以調用A的某些方法，比如說翻頁。
2、內容框架
整個fullcalendar由兩部分組成
日歷+事件
其中日歷即為由js腳本在瀏覽器描繪出的日歷控件，這一部分完全由js控制，和服務器無需相關聯。
事件則是日歷功能的擴展，可以把事件理解為一個個會議安排。這些會議安排通常是保存在服務器的，在每次頁面加載時，fullcalendar得到會議安排的集合，然后按照其中的日期去把事件描繪到日歷對應的地方。
3、知識點概要
余下詳細的知識點均為fullcalendar官方文檔的翻譯和組合。每一部分均按照屬性、方法、函數回調的順序來組織。通常會有相關知識點的簡介，對于比較復雜或者關鍵的點，會有相關聯的代碼作為事例。同樣，這些事例也出之于fullcalendar官方文檔。
以下是對這所有知識點的歸納和概覽
日歷部分：
視圖：日歷的不同的展現模式。當前共有5中視圖
視圖的通用配置：這一部分的配置通常可以對5中視圖均有效。
視圖對象：fullcalendar的視圖Module
獲取視圖對象以及跳轉到指定視圖的方法
議程相關：即對議程視圖模式下，相關細節的配置
日期相關：涉及到日歷系統里日期的顯示格式，日歷加載的日期，以及獲取相關日期或者日歷改變日期的相關方法
時間和文本的自定義設置：涉及到自定義或者本地化的相關配置大多在這里完成
鼠標的相關事件捕獲：比如鼠標單擊到某個特殊地方（日歷中的某一天等）等觸發的方法在這里配置
選中元素的配置：這一部分是來配置當鼠標點擊某一日歷元素時，是否選中該元素以及與此相關的事件
事件部分如下：
事件Module包含的信息
事件的產生：包括事件源的管理和事件的管理
事件的描繪：把一個事件描繪到瀏覽器的整個過程包含在這里
拖拽事件：用鼠標拖拽以移動某個時間，這需要其他JQUERY ui插件的支持
從日歷外拖拽事件到日歷內以添加事件：對日歷內拖拽事件的擴展
4、詳細知識點
4.1、合法的視圖
month-see example 月視圖
basicWeek-see example周視圖（一周內事件和日期的集合）
basicDay-see example(一日內事件和日期的集合)
agendaWeek-see example(周日程表)
agendaDay-see example(日日程表)
4.2、視圖的通用配置
header
頭部顯示的信息，分left , center, right三個部位
合法的屬性值：title,prev,next,prevYear,nextYear,today, avaibleViewName
header:{
left:'title',
center:'prevYear,nextYear',
right:'prev,today,next,agendaDay,month'
}
theme
當為true時，可以配合JQUERY-UI，配置日歷的皮膚
buttonIcons：http://jqueryui.com/themeroller/
buttonIcons:{
prev:'circle-triangle-w',
next:'circle-triangle-e'
}
注意去掉.ui-icon-
firstDay：每周開始的日期：0為周日
isRTL：是否從右至左組織日歷
weekends：是否顯示周末
weekMode：周的顯示模式：
fixed：每月始終顯示6周
liquid：周數不定，每周的高度可變，整個日歷高度不變
variable：周數不定，每周的高度固定，整個日歷的高度可變
height整個日歷的高度（包括header和content）
contentHeight內容高度：
aspectRatio寬和高的比例
$('#calendar').fullCalendar('option','aspectRatio', 1.8); 可以動態設置
viewDisplay(callback)函數回調，每次view顯示時均會調用
function(view) { }
View是view對象
windowResize(callback)函數回調，每次窗口大小改變時調用，
viewDisplay
render(method)立刻顯示view
destroy(method)釋放calendar，包括相關數據
defaultView：日歷初始化時的視圖，默認為month
4.3、視圖對象viewObject
|
name |
可用的5個視圖名之一 |
|
title |
視圖部分的title 2012.9.1 |
|
start |
當天view開始的第一天 |
|
end |
|
|
visStart |
Visible Start Day |
|
visEnd |
在相關方法回調中均會有次對象
4.4、獲取視圖對象
.fullCalendar( 'getView' )
切換視圖
.fullCalendar( 'changeView',viewName)
4.5、議程相關——控制日程相關的視圖的顯示信息
allDaySlot是否顯示全天日程
allDayText顯示的文字
axisFormat日期顯示的格式
slotMinutes間隔時間
defaultEventMinutes默認的事件持續事件
firstHour在日程view里可見的起始時間，可通過滾動條滾動到在此時間之前的時間
minTime整日日程的起始時間
maxTime整日日程的結束時間
4.6、日期相關
year日歷加載時的年份
month日歷加載時的月份（從0開始）
date日歷加載時在月份的天數（對周視圖和日視圖有效）
prev(method)日歷跳轉到前一天
next(method)日歷跳轉到后一天
prevYear(method)日歷跳轉到前一年
nextYear(method)日歷跳轉到后一年
today(method)日歷跳轉到當前日期
gotoDate(method)日歷跳轉到指定日期
incrementDate(method)日歷向前（向后）跳轉一段時間
getDate(method)獲取日歷的當前日期 Date類型
4.7、時間和文本的自定義
timeFormat每個事件默認顯示的時間格式
columnFormat每個視圖列名顯示的格式、
{ month: 'ddd', // Mon
week: 'ddd M/d', // Mon9/7
day: 'dddd M/d' // Monday9/7 }
titleFormat每個視圖里title顯示的格式
{ month: 'MMMM yyyy', // September 2009
week: "MMM d[ yyyy]{'—'[ MMM] d yyyy}", // Sep 7 - 13 2009
day: 'dddd, MMM d, yyyy'// Tuesday, Sep 8, 2009 }
buttonText視圖里每個button顯示的文字
{ prev: ' ◄ ', // left triangle
next:' ► ', // right triangle
prevYear:' << ', // <<
nextYear:' >> ', // >>
today: 'today',
month: 'month',
week: 'week',
day: 'day' }
monthNames月的全稱
monthNamesShort月的簡稱
dayNames星期的全稱
dayNamesShort星期的簡稱
4.8、相關點擊事件
dayClick(callback)當某天被點擊時觸發
function(date,allDay,jsEvent,view) { }
date：當前點擊到的日期
allDay：是否是全天性的
jsEvent：底層的JS事件
view：當前的view對象
this關鍵字指代為<td>
eventClick(callback)當一個事件給點擊時觸發
function(event,jsEvent,view) { }
event：當前的event對象
jsEvent：底層的JS事件
view：當前的view
this：指代的<td>里的<div>元素
eventMouseover(callback)鼠標滑動到事件上觸發，同eventClick類似
eventMouseout(callback)鼠標離開到事件上觸發，同eventClick類似
4.9、選中相關：當點擊或者拖拽到相關位置時，非否選中對應元素
selectable是否選中對應元素
selectHelper
在日程表相關的view里，當選中對應時刻時，是否顯示相關信息
unselectAuto
當點擊頁面日歷以外的位置時，是否自動取消當前的選中
unselectCancel
指定哪些元素不會清空當前的選中，以JQUERY選擇器的方式指定 '#someId'
select(callback)被選中時的函數回調
function(startDate,endDate,allDay,jsEvent,view)
unselect(callback)選中被取消時的回調
select(method)選中某個時間
.fullCalendar( 'select',startDate,endDate,allDay)
unselect(method)取消選中
.fullCalendar( 'unselect' )
4.10、Event相關
EventObject事件對象
|
id |
可選，事件唯一標識，重復的事件具有相同的 |
|
title |
必須，事件在日歷上顯示的title |
|
allDay |
可選，是否是整日事件 |
|
start |
必須，事件的開始時間 |
|
end |
可選，結束時間 |
|
url |
可選，當指定后，事件被點擊將打開對應url |
|
className |
指定事件的樣式 |
|
editable |
是否可拖拽 |
|
source |
指向次event的eventsource對象 |
|
color |
背景和邊框顏色 |
|
backgroundColor |
背景顏色 |
|
borderColor |
邊框顏色 |
|
textColor |
文本顏色 |
EventSource Object
EVENTS:在日歷界面里，參數event的對象：分array，json feed，function三種類型
Eventsource:
{
events: [
{ title: 'Event1',
start: '2011-04-04' },
{ title: 'Event2',
start: '2011-05-05' } // etc... ],
color: 'yellow', // anoption!
textColor: 'black' // an option!
}
eventsource可選的配置選項
|
className |
指定事件的樣式 |
|
editable |
是否可拖拽 |
|
source |
指向次event的eventsource對象 |
|
color |
背景和邊框顏色 |
|
backgroundColor |
背景顏色 |
|
borderColor |
邊框顏色 |
|
textColor |
文本顏色 |
events(asan array)數組形式組織的事件集
$('#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
}
]
});
events(asa json feed)JSON源方式獲取的events
每次當view的時間改變時，均會獲取json。其中start和end為對應view的start和end，插入_是默認不訪問瀏覽器緩存。可通過cache:true來默認讀取瀏覽器緩存
$('#calendar').fullCalendar({
events: '/myfeed.php'
});
會被轉換為如下url請求
/myfeed.php?start=1262332800&end=1265011200&_=1263178646
events(asa function)
作為方法的形式獲得event
$('#calendar').fullCalendar({
events: function(start,end, callback) {
$.ajax({
url:'myxmlfeed.php',
dataType: 'xml',
data: {
// ourhypothetical 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() {
events.push({
title:$(this).attr('title'),
start:$(this).attr('start') // will be parsed
});
});
callback(events);
}
});
}
});
start和end同之前開始和結束時間（默認為-1970的毫秒）
callback為當獲取到event后，會調用的改回調函數，把數據放入fullcalendar里的events里。
eventSources
可以放置多個eventSource（events）
$('#calendar').fullCalendar({
eventSources: [
'/feed1.php',
'/feed2.php'
]
});
allDayDefault
當event object里的allDay為指定時，其默認值
ignoreTimezone忽略timeZone
2008-11-05T08:15:30-05:00
startParam傳遞給服務器的start參數名
endParam同上
lazyFetching
當view改變時，是否從緩存信息獲取event。比如從月視圖切換到周視圖，默認為是
loading(callback)function(isLoading,view)
當調用ajax獲取event是觸發。
updateEvent(method)
在客戶端更新event并在頁面上重新描繪
clientEvents(method)
獲取客戶端保存的所有events對象
.fullCalendar( 'clientEvents' [,idOrFilter]) -> Array
removeEvents(method)
刪除event并重新描繪
refetchEvents(method)
重新獲取events并重新描繪
addEventSource(method)
添加eventSource，并立刻在頁面上描繪
.fullCalendar( 'addEventSource',source)
removeEventSource(method)
同上
4.11、事件描繪（對應于整個callendar里的事件）
eventColor
eventBackgroundColor
eventBorderColor
eventTextColor
eventRender(callback)
當描繪事件時觸發
function(event,element,view) { }
event為改事件，element為用來渲染改事件的div元素
eventAfterRender(callback)
同上
renderEvent(method)
.fullCalendar( 'renderEvent',event[,stick] )
rerenderEvents(method)
.fullCalendar( 'rerenderEvents' )
同refetchEvents
4.12、拖拽事件
需要添加JQUERY UIDraggable 插件，并把editable設置為true。相關屬性和方法同事件類似
editable
Determines whether the events on the calendar can be modified.
disableDragging
Disables all event dragging, even when events are editable.
disableResizing
Disables all event resizing, even when events are editable.
dragRevertDuration
Time it takes for an event to revert to its original position afteran unsuccessful drag.
dragOpacity
The opacity of an event while it is being dragged.
eventDragStart(callback)
Triggered when event dragging begins.
eventDragStop(callback)
Triggered when event dragging stops.
eventDrop(callback)
Triggered when dragging stops and the event has moved to a differentday/time.
eventResizeStart(callback)
Triggered when event resizing begins.
eventResizeStop(callback)
Triggered when event resizing stops.
eventResize(callback)
Triggered when resizing stops and the event has changed in duration.
4.13、從日歷外拖拽事件到日歷中
額外需求：
①需要jquery-ui相關控件的支持jquery-ui-1.8.17.custom.min.js
②日歷的dropple屬性需設置為true
基本思路
①在日歷胖構建好用來拖拽的元素<div>
②設置相應div的drop操作
$('#external-events div.external-event').each(function() {
// create an Event Object
// it doesn't need to have a start or end
var eventObject = {
title: $.trim($(this).text()) // use the element's text as the eventtitle
};
// store the Event Object in the DOM element so we can get to itlater
$(this).data('eventObject', eventObject);
// make the event draggable using jQuery UI
$(this).draggable({
zIndex: 999,
revert: true, // willcause the event to go back to its
revertDuration: 0 // original position after the drag
});
});
③在日歷中的drop回調中進行構造event并描繪
drop: function(date, allDay) { // this function is called whensomething is dropped
// retrieve the dropped element's stored Event Object
var originalEventObject = $(this).data('eventObject');
// we need to copy it, so that multiple events don't have areference to the same object
var copiedEventObject = $.extend({}, originalEventObject);
// assign it the date that was reported
copiedEventObject.start = date;
copiedEventObject.allDay = allDay;
// render the event on the calendar
// the last `true` argument determines if the event"sticks" (http://arshaw.com/fullcalendar/docs/event_rendering/renderEvent/)
$('#calendar').fullCalendar('renderEvent', copiedEventObject, true);
// is the "remove after drop" checkbox checked?
if ($('#drop-remove').is(':checked')) {
// if so, remove the element from the "Draggable Events"list
$(this).remove();
}
}
4.14、日期轉換工具
formatDate(function)
Formats a Date object into a string.
formatDates(function)
Formats a date range (two Date objects)into a string.
parseDate(function)
Parses a string into a Date object.
parseISO8601(function)
Parses an ISO8601 string into a Dateobject.
總結
以上是生活随笔為你收集整理的FullCalendar 官方文档翻译2的全部內容，希望文章能夠幫你解決所遇到的問題。
- 上一篇： vis是什么(车架号是什么)
- 下一篇： ofd是什么格式的文件