Class: CalendarGrouping

CalendarGrouping

groupStrategies/calendargrouping.js, line 84

Creates a new instance of the Calendar strategy.

Parameters:
Name Type Description
options Object

An object used to initialize the CalendarGrouping.

Name Type Default Description
viewMode string 'Month' optional

The view mode of CalendarGrouping. The value can be 'Month','Day' or 'Week'.

startDate Date optional

The start date that CalendarGrouping displays. The default value is new Date().

daysStartTime Date optional

The start time that CalendarGrouping displays when view mode is day or week. The default value is 0:00.

daysEndTime Date optional

The end time that CalendarGrouping displays when view mode is day or week. The default value is 24:00.

daysEventStartField string optional

The data field which is used to layout the start location of the event when view mode is day or week.

daysEventEndField string optional

The data field which is used to layout the end location of the event when view mode is day or week.

daysTimeUnit number 1 optional

The time unit that CalendarGrouping displays when view mode is day or week.

daysRowHeaderWidth number 60 optional

The width of the row header when view mode is day or week.

daysColHeaderHeight number 25 optional

The height of the column header when view mode is day or week.

daysRowHeight number 50 optional

The height of the row when view mode is day or week.

monthHeaderHeight number 25 optional

The height of the header when view mode is Month.

daysHeaderFormatter string optional

The format string that is used to format the header value in days view.

monthHeaderFormatter string optional

The format string that is used to format the header value in month view.

rowHeaderFormatter string optional

The format string that is used to format the row header value in the days view.

localeResource.linkText string optional

The display text of link button.

localeResource.moreText string optional

The display text of more button.

localeResource.errorText string optional

The error text.

Events

groupStrategies/calendargrouping.js, line 40

eventClick

Event click event. The event occurs when user clicks on the event area.

Type:
  • object
Properties:
Name Type Description
sender Object

Indicates the data view.

args Object

Provides arguments that are useful for the event.

Properties
Name Type Description
data Object

Indicates the data item.

groupStrategies/calendargrouping.js, line 28

eventLimitClick

Event limit click event. The event fires when the user clicks on more links.

Type:
  • object
Properties:
Name Type Description
sender Object

Indicates the data view.

args Object

Provides arguments that are useful for the event.

Properties
Name Type Description
group Object

Indicates the group information.

cancel boolean

Indicates whether to cancel the default action.

groupStrategies/calendargrouping.js, line 51

popoverClose

popover close event. The event occurs when the user clicks the default pop-over close button.

Type:
  • object
Properties:
Name Type Description
sender Object

Indicates the data view.