DataViews
- Common
- Core
- Layouts
  - Grid
  - CardLayout
  - Masonry
- Groupings
- Miscellaneous
  - Gantt
  - SearchBox
- Interops
  - Angular
  - React
  - Vue

ICalendarGroupingOptions Interface

Defines calendar grouping options.

Heirarchy

ICalendarGroupingOptions

Properties

Optional daysColHeaderHeight

daysColHeaderHeight: number

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

Optional daysEndTime

daysEndTime: Date

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

Optional daysEventEndField

daysEventEndField: string

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

Optional daysEventStartField

daysEventStartField: string

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

Optional daysHeaderFormatter

daysHeaderFormatter: string

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

Optional daysRowHeaderWidth

daysRowHeaderWidth: number

Specifies width of the row header when view mode is day or week. Default value is 60

Optional daysRowHeight

daysRowHeight: number

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

Optional daysStartTime

daysStartTime: Date

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

Optional daysTimeUnit

daysTimeUnit: number

Specifies time unit that CalendarGrouping displays when view mode is day or week. Default value is 1

Optional defaultGroupingInfo

defaultGroupingInfo: Partial<IGroupDescriptor>

Specifies default options of data grouping

Optional linkButtonTemplate

linkButtonTemplate: string

Specifies template for event detail link button

Optional localeResource

localeResource: ILocaleResource

The locale strings that can be overridden

Optional monthHeaderFormatter

monthHeaderFormatter: string

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

Optional monthHeaderHeight

monthHeaderHeight: number

The height of the header when view mode is Month. Default value is 25

Optional rowHeaderFormatter

rowHeaderFormatter: string

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

Optional startDate

startDate: Date

Specifies start date that CalendarGrouping displays. Default value is new Date()

Optional viewMode

viewMode: ViewMode

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

Optional weekStartDay

weekStartDay: number

Specifies start day of the week. This is relevant for week view. Default value is 0 (sunday)