projects/components/widgets/input/calendar/src/calendar.component.doc.ts
The wmCalendar component defines the Calendar widget.
Methods |
Inputs |
gotoDate |
gotoDate()
|
It shows the calendar view to specific date given for the calendar.
Returns :
void
|
gotoMonth |
gotoMonth()
|
It shows the calendar view to specific month given for the calendar.
Returns :
void
|
gotoNextMonth |
gotoNextMonth()
|
This method renders the present view for the next month.
Returns :
void
|
gotoNextYear |
gotoNextYear()
|
This method renders the present view for the next year.
Returns :
void
|
gotoPrevMonth |
gotoPrevMonth()
|
This method renders the present view for the previous month.
Returns :
void
|
gotoPrevYear |
gotoPrevYear()
|
This method renders the present view (i.e. month/week view will be the same) for the next year.
Returns :
void
|
onEventclick | ||||||||||||||||
onEventclick($event: Event, $data: any, $view: any)
|
||||||||||||||||
Callback function which will be triggered when resizing of the event in calendar stops and the event has changed in duration..
Parameters :
Returns :
void
|
onEventdrop | ||||||||||||||||||||||||||||||||
onEventdrop($event: Event, $newData: any, $oldData: any, $delta: any, $revertFunc: Function, $ui: any, $view: any)
|
||||||||||||||||||||||||||||||||
Callback function which will be triggered when dragging of an event in calendar stops and the event has moved to a different day/time..
Parameters :
Returns :
void
|
onEventrender | ||||||||||||||||
onEventrender($event: Event, $data: any, $view: any)
|
||||||||||||||||
Callback function which will be triggered when an event is rendered.
Parameters :
Returns :
void
|
onEventresize | ||||||||||||||||||||||||||||||||
onEventresize($event: Event, $newData: any, $oldData: any, $delta: any, $revertFunc: Function, $ui: any, $view: any)
|
||||||||||||||||||||||||||||||||
Callback function which will be triggered when resizing of the event in calendar stops and the event has changed in duration..
Parameters :
Returns :
void
|
onSelect | ||||||||||||||||||||
onSelect($start: number, $end: number, $view: any, $data: Array
|
||||||||||||||||||||
Callback function which will be triggered when dates are selected in the calendar.
Parameters :
Returns :
void
|
onViewrender | ||||||||
onViewrender($view: any)
|
||||||||
Callback function which will be triggered when the calender view is changed or when the calendar is rendered.
Parameters :
Returns :
void
|
rerenderEvents |
rerenderEvents()
|
This method rerenders the events from the data set.
Returns :
void
|
selectDate |
selectDate()
|
It highlights the default date given for the calendar.
Returns :
void
|
class |
Type : string
|
Class of the widget. |
controls |
Type : string
|
Default value : 'navigation,today,month,week,day'
|
This property allows to enable the controls for the widget. Allowed Values:
|
dataset |
Type : Array<any>
|
Set this property to a data source to show events on the calendar. Bindable: |
deferload |
Type : boolean
|
Default value : false
|
this property when enabled, the initialization of the widget will be deferred till the widget becomes visible. |
eventallday |
Type : string
|
Whether it is an All day event or not, set from the Dataset fields. |
eventclass |
Type : string
|
Class to be applied to that event, set from the Dataset fields. |
eventend |
Type : string
|
End date or date time for the event, set from the Dataset fields. |
eventstart |
Type : string
|
Start date or date time for the event, set from the Dataset fields. |
eventtitle |
Type : string
|
Title for the Event, set from the Dataset fields. Bindable: |
name |
Type : string
|
Name of the Calendar. |
selectionmode |
Type : string
|
Default value : 'none'
|
This property allows to configure dates selection in the calendar. Allowed Values:
|
show |
Type : boolean
|
Default value : true
|
This property will be used to show/hide the Calendar widget on the web page. Bindable: |
tabindex |
Type : number
|
Default value : 0
|
This property specifies the tab order of the Calendar Widget. |
type |
Type : string
|
Default value : 'basic'
|
This property allows to select different calendar types. Allowed Values:
|
view |
Type : string
|
Default value : 'month'
|
This property allows to change the view of the calendar. Allowed Values:
|