ui.calendar

A single-month calendar that allows users to select dates and move to the next/previous month.

The control supports all date and time formats. Besides the days of the month, it can display day headings for the week days, the week number, a title with the month name and year, hour and minite selectors. Customizable and mostly used as a flat calendar. Check calendar documentation for more detailed description.

Constructor

var calendar = webix.ui({   
    view:"calendar",
    date:new Date(2015,3,16),
    events:webix.Date.isHoliday, 
    weekHeader:true
});

Where to start

Methods
adjust adjusts the component to the size of the parent HTML container
attachEvent attaches the handler to an inner event of the component (allows behavior customizations)
bind binds components
blockEvent temporarily blocks triggering of ALL events of the calling object
callEvent calls an inner event
define redefines a single configuration property (or a hash of properties)
destructor destructs the calling object
detachEvent detaches a handler from an event (which was attached before by the attachEvent method)
disable disables the calling view (makes it dimmed and unclickable)
enable enables the calling view that was disabled by the 'disable' method
getChildViews returns child views of the calling component
getFormView returns master form for the input
getNode returns the main HTML container for the calling object
getParentView returns the parent view of the component
getSelectedDate gets the current selected date
getTopParentView returns top parent view
getValue returns the current value of the component
getVisibleDate gets visible date
hasEvent checks whether the component has the specified event
hide hides the view
isEnabled checks whether the view is enabled
isVisible checks whether the view is visible
locate gets the id of an item from the specified HTML event
mapEvent routes events from one object to another
moveSelection moves selection in the specified direction
queryView returns inner element/elements of a widget that correspond to the defined parameters
refresh repaints the component
render renders the specified item or the whole component
resize adjusts the view to a new size
selectDate selects the specified date
setValue sets a new value for the component
show makes the component visible
showCalendar shows the calendar according to the year and month set in the specified date
unbind breaks "bind" link
unblockEvent cancels blocking events that was enabled by the 'blockEvent' command
Events
onAfterContextMenu fires after the context menu was called in the item area
onAfterDateSelect fires after a user has selected a date
onAfterMonthChange called after month in selector is changed.
onAfterRender called after the rendering of calendar is complete.
onAfterScroll occurs when some webix view has been scrolled
onAfterZoom fires after zoom level of the calendar has been changed
onBeforeContextMenu fires before the context menu is called in the item area
onBeforeDateSelect fires when a user clicks on a date but before it is selected in the calendar
onBeforeMonthChange triggered immediately before month in selector is changed.
onBeforeRender triggered immediately before rendering of calendar is started.
onBeforeZoom fires before zoom level of the calendar is changed
onBindRequest fires when the component is ready to receive data from the master component
onBlur fires when focus is moved out of the view
onChange fires when a user changes month, year or time in selector.
onDateClear fires on clicking the [Clear](Calendar) button
onDateSelect fires when a user selects a date.
onDestruct occurs when component destroyed
onFocus fires when a view gets focus
onItemClick fires when a component item was clicked
onItemDblClick fires when a component item was double-clicked
onKeyPress occurs when keyboard key is pressed for the control in focus
onLongTouch fires on holding finger in some position for a certain period of time
onMouseMove fires when the mouse was moved over the specified component
onMouseMoving fires when the mouse was moved over the component
onMouseOut fires when the mouse was moved out from the specified item
onSwipeX occurs on a horizontal swipe movement
onSwipeY occurs on a vertical swipe movement
onTimedKeyPress fires after typing has been finished in the field
onTodaySet fires on clicking the [Today](Calendar) button
onTouchEnd occurs when the touch event is ended
onTouchMove occurs during touch movement
onTouchStart when some webix view has been touched
onViewResize view size was changed by resizer
Properties
animate defines or disables view change animation.
blockDates defines the selectable range
borderless used to hide the component borders
calendarHeader the format for the title with the month name and year
calendarTime defines calendar time format (with timepicker enabled)
calendarWeekHeader specifies the label for the column with weeks numbers
cellHeight the height of the cell with day
container an HTML container (or its id) where the component should be initialized
css the name of a css class that will be applied to the view container
date specifies the year and month that will be shown in the calendar after initialization
dayTemplate defines a template for a calendar day cell
disabled indicates whether an item is enabled
events sets an additional css class that will be applied to days
gravity sets the view gravity (1 by default)
headerHeight total height of the area not taken by calendar body
height sets the height of the component
hidden defines whether the view will be hidden initially
icons sets an array of icons in the calendar or hides them
id the component ID
maxDate set man limit for selected date
maxHeight sets the maximum height for the view
maxTime maximum allowed time
maxWidth sets the maximum width for the view
minDate set min limit for selected date
minHeight sets the minimal height for the view
minTime minimal allowed time
minWidth sets the minimal width for the view
minuteStep step of time selector
monthSelect enables the ability to select month by clicking the "month" panel
mouseEventDelay the delay between a real mouse action and invoking the related events
navigation activates the selection keyboard navigation
on allows attaching custom handlers to inner events of the component
onClick attaches a click behavior for component items with the specified CSS class.
onContext a property used to define custom context-click (right click) handlers for elements in the DataTable cells
onDblClick attaches a dblclick behavior for component items with the specified CSS class.
onMouseMove attaches a mousemove behaviour for component items with the specified CSS class.
select enables date selection within the calendar.
skipEmptyWeeks enables/disables displaying empty weeks (true)
timepicker enables clock displaying for time selection
timepickerHeight sets height of timepicker area
type type of calendar view
weekHeader enables/disables additional header with week days (false)
weekNumber enables/disables additional left column with weeks' numbers (false)
width sets the width of the component
Other
$getSize returns the current size of the component
$height current height of the view
$scope scope for resolving event and method names
$setSize sets the component size
$skin the method which will be called when skin is defined
$view reference to top html element of the view
$width current width of the view
config all options from initial component configuration
name indicates the name of the component (a read-only property)
on_click redefines default click behavior for component items.
on_context a property used to define custom context-click (right click) handlers for elements in the DataTable cells
on_dblclick attaches a dblclick behavior for component items with the specified CSS class
on_mouse_move attaches a mouse move behavior for component items with the specified CSS class
Back to top