Wijmo UI for the Web
wijcalendar jQuery Widget
Show a single month or a table of months with customizable styles and navigation elements.
Syntax
Javascript (Usage) 
$(function () {
    var options; // Type:  wijmo.calendar.wijcalendar.options
     
    $(".selector").wijcalendar(options);
});
Javascript (Specification) 
function wijcalendar() : any;
Browser Compatibility
7
5
5
Options
 NameDescription
public OptionallowPreview

Default value: false

Allows users to preview the next and previous months by hovering over the previousPreview and nextPreview buttons.

 
public OptionallowQuickPick

Default value: true

Determines whether users can change the view to month/year/decade while clicking on the calendar title.

 
public OptionautoHide

Default value: true

A Boolean property that determines whether to autohide the calendar in pop-up mode when clicking outside of the calendar.

 
public OptioncalendarWeekRule

Default value: 'firstDay'

Defines different rules for determining the first week of the year.

 
public Optionculture

Default value: ""

Assigns the string value of the culture ID that appears on the calendar for the weekday and title names.

 
public OptioncustomizeDate

Default value: null

Function used for customizing the content, style and attributes of a day cell.

 
public OptiondayCols

Default value: 7

Gets or sets the number of day columns that appear in the calendar. This is useful if you want to view more or less calendar days on the calendar month.

 
public OptiondayRows

Default value: 6

Gets or sets the number of day rows that appear in the calendar. This is useful if you want to view more or less calendar days on the calendar month.

 
public Optiondirection

Default value: 'horizontal'

Determines the month slide direction.

 
public OptiondisplayDate

Gets or sets the display date for the first month view. You can specify the date via a Date object.

 
public Optionduration

Default value: 250

Gets or sets the animation duration in milliseconds.

 
public Optioneasing

Default value: 'easeInQuad'

Sets the type of animation easing effect that users experience when they click the previous or next buttons on the wijcalendar.

 
public OptionmaxDate

Determines the maximum date to display. You can specify the maxDate via a Date object.

 
public OptionminDate

Determines the minimum date to display. You can specify the minDate via a Date object.

 
public OptionmonthCols

Default value: 1

Gets or sets the number of calendar months in horizontal direction.

 
public OptionmonthRows

Default value: 1

Gets or sets the number of calendar months in vertical direction.

 
public OptionnavButtons

Default value: 'default'

Determines the display type of navigation buttons.

 
public OptionnextPreviewTooltip

Default value: ""

Gets or sets the "next preview" button's ToolTip.

 
public OptionnextTooltip

Default value: 'Next'

Gets or sets the text for the 'next' button's ToolTip.

 
public OptionpopupMode

Default value: false

A Boolean property that determines whether the wijcalendar widget is a pop-up calendar.

 
public OptionprevPreviewTooltip

Default value: ""

Gets or sets the "previous preview" button's ToolTip.

 
public OptionprevTooltip

Default value: 'Previous'

Gets or sets the text for the 'previous' button's ToolTip.

 
public OptionquickNavStep

Default value: 12

Determines the increase/decrease steps when clicking the quick navigation button.

 
public OptionquickNextTooltip

Default value: 'Quick Next'

Gets or sets the "quick next" button's ToolTip.

 
public OptionquickPrevTooltip

Default value: 'Quick Previous'

Gets or sets the "quick previous" button's ToolTip.

 
public OptionselectionMode

Gets or sets the date selection mode on the calendar control that specifies whether the user can select a single day, a week, or an entire month.

 
public OptionshowDayPadding

Default value: false

Determines whether to add zeroes to days with only one digit

 
public OptionshowOtherMonthDays

Default value: true

Determines whether to display the days of the next and/or previous month.

 
public OptionshowTitle

Default value: true

A Boolean property that determines whether to display the calendar's title.

 
public OptionshowWeekDays

Default value: true

A Boolean property that determines whether to display week days.

 
public OptionshowWeekNumbers

Default value: false

Determines whether to display week numbers.

 
public Optiontitle

Default value: null

A callback function used to customizing the title text on month view.

 
public OptiontitleFormat

Default value: 'MMMM yyyy'

Gets or sets the format for the title text.

 
public OptiontoolTipFormat

Default value: 'dddd, MMMM dd, yyyy'

Gets or sets the format for the ToolTip.

 
public OptionweekDayFormat

Default value: 'short'

Gets or sets the format for the week day.

 
Top
Methods
 NameDescription
public MethodcloseCloses the calendar if it is in the pop-up state.  
public MethoddestroyRemove the functionality completely. This will return the element back to its pre-init state.  
public MethodgetDisplayDateGets the valid display date.  
public MethodgetSelectedDateGets the currently selected date.  
public MethodisPopupShowingDetermines whether the calendar is in the pop-up state.  
public MethodpopupPops up the calendar at specifies position.  
public MethodpopupAtPops up the calendar at the specified X and Y coordinates in the document.  
public MethodrefreshRefreshes the calendar.  
public MethodrefreshDateRefereshes a single date on the calendar.  
public MethodselectDateSelects the specified date.  
public MethodunSelectAllClears any selections from dates on the calendar, removing them from the selectedDates collection.  
public MethodunSelectDateClears any selection from the specified date.  
public MethodwidgetReturns a jQuery object containing the original element or other relevant generated element.  
Top
Events
 NameDescription
public EventafterSelectThe afterSelect event handler. A function called after user selects a day by mouse.  
public EventafterSlideThe afterSlide event handler. A function called after the calendar view slided to another month. Cancellable.  
public EventbeforeSelectThe beforeSelect event handler. A function called before user selects a day by mouse. Cancellable.  
public EventbeforeSlideThe beforeSlide event handler. A function called before the calendar view slides to another month. Cancellable.  
public EventselectedDatesChangedThe selectedDatesChanged event handler. A function called after the selectedDates collection changed.  
Top

See Also

Widgets

Calendar

Reference

wijcalendar jQuery Widget

 

 


© 2013 All Rights Reserved.

Send comments on this topic.