MonthHeaderSettings class

Sets the style to customize month label in SfCalendar schedule view.

Allows to customize the monthFormat, height, textAlign, backgroundColor and monthTextStyle in month label style of schedule view in calendar.

See also:

• WeekHeaderSettings, which used to customize the week header view of the schedule view in calendar.
• DayHeaderSettings, which used to customize the day header view of the schedule view in calendar.
• SfCalendar.scheduleViewMonthHeaderBuilder, which used to set custom widget for month header view of schedule view in calendar.
• Knowledge base: How to customize day, week, month header of schedule view
• Knowledge base: How to customize schedule view month header with builder
• Knowledge base: How to view schedule
• Knowledge base: How to customize the schedule view

@override
 Widget build(BuildContext context) {
   return Container(
     child: SfCalendar(
       view: CalendarView.schedule,
       scheduleViewSettings: ScheduleViewSettings(
           monthHeaderSettings: MonthHeaderSettings(
               monthFormat: 'MMMM, yyyy',
               height: 100,
               textAlign: TextAlign.left,
               backgroundColor: Colors.green,
               monthTextStyle: TextStyle(
                   color: Colors.red,
                   fontSize: 25,
                   fontWeight: FontWeight.w400))),
     ),
   );
 }

Mixed-in types

• Diagnosticable

Annotations

• @immutable

Constructors

MonthHeaderSettings({String monthFormat = 'MMMM yyyy', double height = 150, TextAlign textAlign = TextAlign.start, Color backgroundColor = const Color.fromRGBO(17, 178, 199, 1), TextStyle? monthTextStyle})

Creates a month header settings for schedule view in calendar.

const

Properties

backgroundColor → Color

The background color to fill the background of the month label view in SfCalendar schedule view.

final

hashCode → int

The hash code for this object.

no setter, override

height → double

The height for month label to layout within this in SfCalendar schedule view.

final

monthFormat → String

Formats the month label text in the month label SfCalendar schedule view.

final

monthTextStyle → TextStyle?

The text style for the text in the month text of month label SfCalendar schedule view.

final

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

textAlign → TextAlign

How the text should be aligned horizontally in SfCalendar month label of schedule 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 ==(dynamic other) → bool

The equality operator.

override