wijevcal jQuery Widget

Add, edit, and manage appointments in a fully functional schedule with an offline data source.

Syntax

Javascript (Usage)
Javascript (Specification)

$(function () {
    var options; // Type:  wijmo.evcal.wijevcal.options
     
    $(".selector").wijevcal(options);
});

function wijevcal() : any;

Options

	Name	Description
	appointments	Default value: [] The event objects array. This option is read-only. This option is deprecated: please, use eventsData option, instead.
	calendar	Default value: null A value that indicates calendar's options in evets calendar.
	calendars	Default value: [] Available calendar objects array. This option is read-only. Use addCalendar/updateCalendar/deleteCalendar methods in order to add/edit or delete a calendar.
	colors	Default value: null The colors option specifies the name of the colors that will be shown in the color name drop-down list. "blue", "cornflowerblue", "yellow", "bronze"]
	culture	Default value: "" Determines the culture to be used, for example, "de-DE" is German. Date and time formatting depends on the culture option.
	cultureCalendar	Default value: "" Determines the culture calendar to be used. This option must work with culture option.
	dataSource	Default value: null A dataview object to bind to events data
	dataStorage	Data storage methods. Use this option in order to implement custom data storage layer.
	dayHeaderFormat	Default value: '{0:d }' Format of the text for the day cell header(month view). Format argument: {0} = Day date.
	dayViewHeaderFormat	Format of the text for the day header in the day view. Format argument: {0} = Day date.
	disabled	Default value: false Specifies whether the events calendar is disabled.
	editCalendarTemplate	Default value: "" The calendar dialog box template.
	enableLogs	Default value: false Enables a built-in log console.
	ensureEventDialogOnBody	Default value: false Indicates whether to append the event dialog element to the body element rather than to the event calendar container.
	eventsData	Default value: null The event objects array.
	eventTitleFormat	Default value: '{2}' Format of the title text for the event. Format arguments: {0} = Start, {1} = End, {2} = Subject, {3} = Location, {4} = Icons, {5} = Description.
	firstDayOfWeek	Default value: 0 The first day of the week (from 0 to 6). Sunday is 0, Monday is 1, and so on.
	firstRowDayHeaderFormat	Default value: '{0:ddd d}' Format of the text for the first cell header in the first row of the month view. Format argument: {0} = Day date.
	headerBarVisible	Default value: true Indicates whether the header bar will be visible.
	localization	Default value: null Use the localization option in order to localize text which not depends on culture option.
	navigationBarVisible	Default value: true Indicates whether the bottom navigation bar will be visible.
	readOnly	Default value: false Set this option to true if you want to prevent users to edit events data.
	rightPaneVisible	Default value: false Indicates whether the right pane will be visible. By default the right pane are empty. You can use this pane in order to provide additional custom UI.
	selectedDate	Default value: null The selected date.
	selectedDates	Default value: null The selected dates.
	statusBarVisible	Default value: false Indicates whether the status bar will be visible.
	timeInterval	Default value: 30 The time interval in minutes for the Day view.
	timeIntervalHeight	Default value: 15 The Day view time interval row height in pixels.
	timeRulerFormat	Default value: '{0:h tt}' Time ruler format for the Day view.
	timeRulerInterval	Default value: 60 Time ruler interval for the Day view (in minutes).
	titleFormat	The title text format that will be shown under the header bar. {0} = start date. {1} = end date.
	views	Default value: [] Array of the view types which need to be shown.
	viewType	Default value: 'day' The active view type. Possible values are: day, week, month, list. If it is a custom view, the viewType should be its name.
	visibleCalendars	Default value: [] Array of the calendar names which need to be shown.
	webServiceUrl	Default value: "" Determines the URL of the web service which will be used to store information about events.

Top

Methods

	Name	Description
	addCalendar	Adds a new calendar.
	addEvent	Adds a new event.
	beginUpdate	Use beginUpdate and endUpdate when making a large number of changes to widget options.
	deleteCalendar	Deletes the existing calendar from the current data source.
	deleteEvent	Deletes the event.
	destroy	Removes the wijevcal functionality completely. This returns the element to its pre-init state.
	endUpdate	Use beginUpdate and endUpdate when making a large number of changes to widget options.
	exportEventsCalendar	Exports the EventsCalendar in a graphic format. The export method only works when wijmo.exporter.eventscalendarExport's reference is on the page.
	findEventById	Find event object by id
	getOccurrences	Retrieves the array which contains the full list of Event objects in the specified time interval. Note, this method will create instances of the Event object for recurring events.
	goLeft	Navigates to the previous date.
	goRight	Navigates to the next date.
	goToDate	Navigates to the date given by parameter dt.
	goToday	Navigates to today's date.
	goToEvent	Navigates to the event given by the parameter id.
	goToTime	Scrolls view to time given by parameter time.
	hideLoadingLabel	hide the loading label
	invalidate	Invalidates the entire surface of the control and causes the control to be redrawn.
	isAllDayEvent	Tests to see if event duration is more or equals to one day.
	localizeString	Get the localized string by key
	log	Sends a log message to built-in log console. Note: n order to use this method, you must set the enableLogs option to true.
	refresh	Invalidates the entire surface of the control and causes the control to be redrawn.
	showEditCalendarDialog	Call this method in order to display built-in "edit calendar" dialog box.
	showEditEventDialog	Call this method in order to display built-in "edit event" dialog box.
	status	Changes status label text.
	updateCalendar	Updates the existing calendar.
	updateEvent	Updates the existing event.
	widget	Returns a jQuery object containing the original element or other relevant generated element.

Top

Events

	Name	Description
	beforeAddCalendar	Occurs before the add calendar action. Return false or call event.preventDefault() in order to cancel event and prevent the add action.
	beforeAddEvent	Occurs before the add event action. Return false or call event.preventDefault() in order to cancel event and prevent the add action.
	beforeDeleteCalendar	Occurs before the delete calendar action. Return false or call event.preventDefault() in order to cancel event and prevent the delete action.
	beforeDeleteEvent	Occurs before the delete action. Return false or call event.preventDefault() in order to cancel event and prevent the delete action.
	beforeEditEventDialogShow	Occurs before the built-in event dialog is shown. Return false or call event.preventDefault() in order to cancel event and prevent the built-in dialog to be shown.
	beforeUpdateCalendar	Occurs before the update calendar action. Return false or call event.preventDefault() in order to cancel event and prevent the update action.
	beforeUpdateEvent	Occurs before the update event action. Return false or call event.preventDefault() in order to cancel event and prevent the update action.
	calendarsChanged	Occurs when calendars option has been changed.
	eventCreating	Occurs when event markup is creating.
	eventsDataChanged	Occurs when the eventsData option is changed.
	initialized	Occurs when events calendar is constructed and events data is loaded from an external or local data source.
	selectedDatesChanged	Occurs when selectedDates option has been changed. Event type: wijevcalselecteddateschanged
	viewTypeChanged	Occurs when viewType option has been changed.

Top

Widgets

EventsCalendar

Reference

wijevcal jQuery Widget