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.

See also:

• TimeSlotViewSettings, which is used to customize the timeslot view of calendar.
• SfCalendar.monthCellBuilder, which used to set the custom widget for month cell in calendar.
• SfCalendar.monthViewSettings, to know more about the customization of month view in calendar.
• SfCalendar.blackoutDates, which allows to restrict the interaction for a particular date in month views of calendar.
• SfCalendar.blackoutDatesTextStyle, which used to customize the blackout dates text style in the month view of calendar.
• Knowledge base: How to customize agenda view height based on widget height
• Knowledge base: How to customize agenda item height
• Knowledge base: How to show appointment in agenda view using programmatic date selection
• Knowledge base: How to customize the blackout dates
• Knowledge base: How to customize the leading and trailing dates
• Knowledge base: How to style the month cell
• Knowledge base: How to change the number of weeks
• Knowledge base: How to customize the agenda view appointment
• Knowledge base: How to customize the month cell with appointment count
• Knowledge base: How to customize the month cell based on the appointment using builder
• Knowledge base: How to clear the appointment in month agenda view using onViewChanged callback

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),
     ),
   );
 }

Mixed-in types

• Diagnosticable

Annotations

• @immutable

Constructors

MonthViewSettings.new({int appointmentDisplayCount = 3, int numberOfWeeksInView = 6, MonthAppointmentDisplayMode appointmentDisplayMode = MonthAppointmentDisplayMode.indicator, bool showAgenda = false, MonthNavigationDirection navigationDirection = MonthNavigationDirection.horizontal, String dayFormat = 'EE', double agendaItemHeight = -1, bool showTrailingAndLeadingDates = true, double agendaViewHeight = -1, MonthCellStyle monthCellStyle = const MonthCellStyle(), AgendaStyle agendaStyle = const 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.

no setter, override

monthCellStyle → MonthCellStyle

Sets the style to customize SfCalendar month cells.

final

navigationDirection → MonthNavigationDirection

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.

no setter, 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

debugFillProperties(DiagnosticPropertiesBuilder properties) → void

Add additional properties associated with the node.

override

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

toDiagnosticsNode({String? name, DiagnosticsTreeStyle? style}) → DiagnosticsNode

Returns a debug representation of the object that is used by debugging tools and by DiagnosticsNode.toStringDeep.

inherited

toString({DiagnosticLevel minLevel = DiagnosticLevel.info}) → String

A string representation of this object.

inherited

toStringShort() → String

A brief description of this object, usually just the runtimeType and the hashCode.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

override