SfCalendarThemeData class

Holds the color and typography values for a SfCalendarTheme. Use this class to configure a SfCalendarTheme widget

To obtain the current theme, use SfCalendarTheme.of.

Widget build(BuildContext context) {
  return Scaffold(
    body: SfCalendarTheme(
      data: SfCalendarThemeData(
        brightness: Brightness.dark,
        backgroundColor: Colors.grey
      ),
      child: SfCalendar()
    ),
  );
}

Mixed-in types

• Diagnosticable

Annotations

• @immutable

Constructors

SfCalendarThemeData({Brightness? brightness, Color? backgroundColor, Color? headerBackgroundColor, Color? agendaBackgroundColor, Color? cellBorderColor, Color? activeDatesBackgroundColor, Color? todayBackgroundColor, Color? trailingDatesBackgroundColor, Color? leadingDatesBackgroundColor, Color? selectionBorderColor, Color? todayHighlightColor, Color? viewHeaderBackgroundColor, Color? weekNumberBackgroundColor, Color? allDayPanelColor, TextStyle? todayTextStyle, TextStyle? agendaDayTextStyle, TextStyle? agendaDateTextStyle, TextStyle? headerTextStyle, TextStyle? viewHeaderDateTextStyle, TextStyle? viewHeaderDayTextStyle, TextStyle? timeTextStyle, TextStyle? activeDatesTextStyle, TextStyle? trailingDatesTextStyle, TextStyle? leadingDatesTextStyle, TextStyle? blackoutDatesTextStyle, TextStyle? displayNameTextStyle, TextStyle? weekNumberTextStyle, TextStyle? timeIndicatorTextStyle})

Create a SfCalendarThemeData that's used to configure a SfCalendarTheme.

factory

SfCalendarThemeData.raw({required Brightness? brightness, required Color? backgroundColor, required TextStyle? headerTextStyle, required Color? headerBackgroundColor, required Color? agendaBackgroundColor, required Color? cellBorderColor, required TextStyle? viewHeaderDateTextStyle, required TextStyle? viewHeaderDayTextStyle, required Color? viewHeaderBackgroundColor, required TextStyle? agendaDayTextStyle, required TextStyle? agendaDateTextStyle, required TextStyle? timeTextStyle, required TextStyle? activeDatesTextStyle, required Color? activeDatesBackgroundColor, required Color? todayBackgroundColor, required Color? trailingDatesBackgroundColor, required Color? leadingDatesBackgroundColor, required TextStyle? trailingDatesTextStyle, required TextStyle? blackoutDatesTextStyle, required TextStyle? displayNameTextStyle, required TextStyle? leadingDatesTextStyle, required TextStyle? todayTextStyle, required Color? todayHighlightColor, required Color? weekNumberBackgroundColor, required Color? selectionBorderColor, required TextStyle? weekNumberTextStyle, required TextStyle? timeIndicatorTextStyle, required Color? allDayPanelColor})

Create a SfCalendarThemeData given a set of exact values. All the values must be specified.

const

Properties

activeDatesBackgroundColor → Color?

Specifies the background color for the current month cells.

final

activeDatesTextStyle → TextStyle?

Specifies the current month text style color of calendar widgets.

final

agendaBackgroundColor → Color?

Specifies the agenda view background color.

final

agendaDateTextStyle → TextStyle?

Specifies the agenda view date text style.

final

agendaDayTextStyle → TextStyle?

Specifies the agenda view day text style.

final

allDayPanelColor → Color?

Specifies the background for all day panel.

final

backgroundColor → Color?

Specifies the background color of calendar widgets.

final

blackoutDatesTextStyle → TextStyle?

Specifies the text style for the blackout dates text in calendar.

final

brightness → Brightness?

The brightness of the overall theme of the application for the calendar widgets.

final

cellBorderColor → Color?

Specifies the cell border color of calendar widgets.

final

displayNameTextStyle → TextStyle?

Specifies the text style for the text in the resource view of calendar.

final

hashCode → int

The hash code for this object.

no setter, override

headerBackgroundColor → Color?

Specifies the calendar Header background color.

final

headerTextStyle → TextStyle?

Specifies the calendar header text style.

final

leadingDatesBackgroundColor → Color?

Specifies the background for the leading dates month cells.

final

leadingDatesTextStyle → TextStyle?

Specifies the text style for the leading month cell dates.

final

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

selectionBorderColor → Color?

Specifies the border color the default BoxDecoration , border color.

final

timeIndicatorTextStyle → TextStyle?

Specifies the text style for the timeIndicator text of dragging appointment in calendar.

final

timeTextStyle → TextStyle?

Specifies the time label text style in days and timeline views.

final

todayBackgroundColor → Color?

Specifies the background for the today month cell.

final

todayHighlightColor → Color?

Specifies the today highlight color.

final

todayTextStyle → TextStyle?

Specifies the text style for the today month cell.

final

trailingDatesBackgroundColor → Color?

Specifies the background for the trailing dates month cells.

final

trailingDatesTextStyle → TextStyle?

Specifies the text style for the trailing month cell dates.

final

viewHeaderBackgroundColor → Color?

Specifies the agenda view background color.

final

viewHeaderDateTextStyle → TextStyle?

Specifies the date text style for the view header.

final

viewHeaderDayTextStyle → TextStyle?

Specifies the day text style for the view header.

final

weekNumberBackgroundColor → Color?

Specifies the background for the week number panel.

final

weekNumberTextStyle → TextStyle?

Specifies the text style for the week number text in calendar.

final

Methods

copyWith({Brightness? brightness, Color? backgroundColor, TextStyle? headerTextStyle, Color? headerBackgroundColor, Color? agendaBackgroundColor, Color? cellBorderColor, TextStyle? viewHeaderDateTextStyle, TextStyle? viewHeaderDayTextStyle, TextStyle? agendaDayTextStyle, TextStyle? agendaDateTextStyle, TextStyle? timeTextStyle, TextStyle? activeDatesTextStyle, Color? activeDatesBackgroundColor, Color? todayBackgroundColor, Color? trailingDatesBackgroundColor, Color? leadingDatesBackgroundColor, TextStyle? trailingDatesTextStyle, TextStyle? blackoutDatesTextStyle, TextStyle? displayNameTextStyle, TextStyle? leadingDatesTextStyle, TextStyle? todayTextStyle, TextStyle? weekNumberTextStyle, TextStyle? timeIndicatorTextStyle, Color? todayHighlightColor, Color? viewHeaderBackgroundColor, Color? weekNumberBackgroundColor, Color? selectionBorderColor, Color? allDayPanelColor}) → SfCalendarThemeData

Creates a copy of this theme but with the given fields replaced with the new values.

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

Static Methods

lerp(SfCalendarThemeData? a, SfCalendarThemeData? b, double t) → SfCalendarThemeData?

Linearly interpolate between two themes.