MonthViewSettings class

The settings have properties which allow to customize the month view of the SfCalendar.

Allows to customize the dayFormat, numberOfWeeksInView, appointmentDisplayMode, showAgenda, appointmentDisplayCount showTrailingAndLeadingDates and navigationDirection in month view of SfCalendar.


Widget build(BuildContext context) {
   return Container(
     child: SfCalendar(
       view: CalendarView.month,
       monthViewSettings: MonthViewSettings(
           dayFormat: 'EEE',
           numberOfWeeksInView: 4,
           appointmentDisplayCount: 2,
           appointmentDisplayMode: MonthAppointmentDisplayMode.appointment,
           showAgenda: false,
           navigationDirection: MonthNavigationDirection.horizontal),
     ),
   );
 }
Annotations

Constructors

MonthViewSettings({int appointmentDisplayCount: 4, int numberOfWeeksInView: 6, MonthAppointmentDisplayMode appointmentDisplayMode: MonthAppointmentDisplayMode.indicator, bool showAgenda: false, MonthNavigationDirection navigationDirection: MonthNavigationDirection.horizontal, String dayFormat: 'EE', double agendaItemHeight: -1, bool showTrailingAndLeadingDates, double agendaViewHeight, MonthCellStyle monthCellStyle, AgendaStyle agendaStyle})
Creates a Month view settings for calendar. [...]
const

Properties

agendaItemHeight → double
The height for each appointment view to layout within this in month agenda view of SfCalendar,. [...]
final
agendaStyle → AgendaStyle
Sets the style to customize SfCalendar month agenda view. [...]
final
agendaViewHeight → double
The height for agenda view to layout within this in SfCalendar month view. [...]
final
appointmentDisplayCount → int
The number of appointments to be displayed in month cell of SfCalendar. [...]
final
appointmentDisplayMode → MonthAppointmentDisplayMode
Defines the appointment display mode for the month cell in SfCalendar. [...]
final
dayFormat → String
Formats the text in the SfCalendar month view view header. [...]
final
hashCode → int
The hash code for this object. [...]
read-only, override
monthCellStyle → MonthCellStyle
Sets the style to customize SfCalendar month cells. [...]
final
The direction tht SfCalendar month view is navigating in. [...]
final
numberOfWeeksInView → int
The number of weeks to display in SfCalendar 's month view. [...]
final
runtimeType → Type
A representation of the runtime type of the object.
read-only, inherited
showAgenda → bool
Makes SfCalendar agenda view visible on month view. [...]
final
showTrailingAndLeadingDates → bool
Makes the leading and trailing dates visible for the SfCalendar month view. [...]
final

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a non-existent method or property is accessed. [...]
inherited
toString() → String
Returns a string representation of this object.
inherited

Operators

operator ==(dynamic other) → bool
The equality operator. [...]
override