WeekHeaderSettings class

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

Allows to customize the startDateFormat, endDateFormat, height, textAlign, backgroundColor and weekTextStyle in week label style of schedule view in calendar.

See also:

• MonthHeaderSettings, which used to customize the month header view of the schedule view in calendar.
• DayHeaderSettings, which used to customize the day header view of the schedule view in calendar.
• ScheduleViewSettings.hideEmptyScheduleWeek, which used to hide the week header if the week doesn't have any appointment on it.
• Knowledge base: How to customize day, week, month header of schedule view
• 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(
           weekHeaderSettings: WeekHeaderSettings(
               startDateFormat: 'dd MMM ',
               endDateFormat: 'dd MMM, yy',
               height: 50,
               textAlign: TextAlign.center,
               backgroundColor: Colors.red,
               weekTextStyle: TextStyle(
                 color: Colors.white,
                 fontWeight: FontWeight.w400,
                 fontSize: 15,
               ))),
     ),
   );
 }

Mixed-in types

• Diagnosticable

Annotations

• @immutable

Constructors

WeekHeaderSettings({String? startDateFormat, String? endDateFormat, double height = 30, TextAlign textAlign = TextAlign.start, Color backgroundColor = Colors.transparent, TextStyle? weekTextStyle})

Creates a week header settings for schedule view in calendar.

const

Properties

backgroundColor → Color

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

final

endDateFormat → String?

Formats the week end date text in the week label of SfCalendar schedule view.

final

hashCode → int

The hash code for this object.

no setter, override

height → double

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

final

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

startDateFormat → String?

Formats the week start date text in the week label of SfCalendar schedule view.

final

textAlign → TextAlign

How the text should be aligned horizontally in SfCalendar week label of schedule view.

final

weekTextStyle → TextStyle?

The text style for the text in the week text of week label in SfCalendar 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