DayView<T extends Object?> class
- Inheritance
-
- Object
- DiagnosticableTree
- Widget
- StatefulWidget
- DayView
Constructors
-
DayView({Key? key, EventTileBuilder<
T> ? eventTileBuilder, StringProvider? dateStringBuilder, StringProvider? timeStringBuilder, EventController<T> ? controller, bool showVerticalLine = true, Duration pageTransitionDuration = const Duration(milliseconds: 300), Curve pageTransitionCurve = Curves.ease, double? width, DateTime? minDay, DateTime? maxDay, DateTime? initialDay, HourIndicatorSettings? hourIndicatorSettings, CustomHourLinePainter? hourLinePainter, double heightPerMinute = 0.7, DateWidgetBuilder? timeLineBuilder, double? timeLineWidth, double timeLineOffset = 0, bool showLiveTimeLineInAllDays = false, LiveTimeIndicatorSettings? liveTimeIndicatorSettings, CalendarPageChangeCallBack? onPageChange, DateWidgetBuilder? dayTitleBuilder, EventArranger<T> ? eventArranger, double verticalLineOffset = 10, Color? backgroundColor = Colors.white, double? scrollOffset, CellTapCallback<T> ? onEventTap, DatePressCallback? onDateLongPress, DateTapCallback? onDateTap, MinuteSlotSize minuteSlotSize = MinuteSlotSize.minutes60, HeaderStyle headerStyle = const HeaderStyle(), FullDayEventBuilder<T> ? fullDayEventBuilder, SafeAreaOption safeAreaOption = const SafeAreaOption(), ScrollPhysics? scrollPhysics, ScrollPhysics? pageViewPhysics, DetectorBuilder<Object?> ? dayDetectorBuilder, bool showHalfHours = false, bool showQuarterHours = false, HourIndicatorSettings? halfHourIndicatorSettings, int? startHour, HourIndicatorSettings? quarterHourIndicatorSettings, Duration startDuration = const Duration(hours: 0), HeaderTitleCallback? onHeaderTitleTap, double emulateVerticalOffsetBy = 0}) -
Main widget for day view.
const
Properties
- backgroundColor → Color?
-
Background colour of day view page.
final
-
controller
→ EventController<
T> ? -
A required parameters that controls events for day view.
final
- dateStringBuilder → StringProvider?
-
A function to generate the DateString in the calendar title.
Useful for I18n
final
-
dayDetectorBuilder
→ DetectorBuilder<
Object?> ? -
Builds custom PressDetector widget
final
- dayTitleBuilder → DateWidgetBuilder?
-
Builds day title bar.
final
- emulateVerticalOffsetBy → double
-
Emulate vertical line offset from hour line starts.
final
-
eventArranger
→ EventArranger<
T> ? -
Defines how events are arranged in day view.
User can define custom event arranger by implementing EventArranger
class and pass object of that class as argument.
final
-
eventTileBuilder
→ EventTileBuilder<
T> ? -
A function that returns a Widget that determines appearance of each
cell in day calendar.
final
-
fullDayEventBuilder
→ FullDayEventBuilder<
T> ? -
Display full day event builder.
final
- halfHourIndicatorSettings → HourIndicatorSettings?
-
Defines settings for half hour indication lines.
final
- hashCode → int
-
The hash code for this object.
no setterinherited
- headerStyle → HeaderStyle
-
Style for DayView header.
final
- heightPerMinute → double
-
Defines height occupied by one minute of interval.
This will be used to calculate total height of day view.
final
- hourIndicatorSettings → HourIndicatorSettings?
-
Defines settings for hour indication lines.
final
- hourLinePainter → CustomHourLinePainter?
-
A funtion that returns a CustomPainter.
final
- initialDay → DateTime?
-
Defines initial display day.
final
- key → Key?
-
Controls how one widget replaces another widget in the tree.
finalinherited
- liveTimeIndicatorSettings → LiveTimeIndicatorSettings?
-
Defines settings for live time indicator.
final
- maxDay → DateTime?
-
Determines upper boundary user can scroll.
final
- minDay → DateTime?
-
Determines the lower boundary user can scroll.
final
- minuteSlotSize → MinuteSlotSize
-
Defines size of the slots that provides long press callback on area
where events are not there.
final
- onDateLongPress → DatePressCallback?
-
This method will be called when user long press on calendar.
final
- onDateTap → DateTapCallback?
-
Called when user taps on day view page.
final
-
onEventTap
→ CellTapCallback<
T> ? -
This method will be called when user taps on event tile.
final
- onHeaderTitleTap → HeaderTitleCallback?
-
Callback for the Header title
final
- onPageChange → CalendarPageChangeCallBack?
-
This callback will run whenever page will change.
final
- pageTransitionCurve → Curve
-
Page transition curve used when user try to change page using
DayViewState.nextPage or DayViewState.previousPage
final
- pageTransitionDuration → Duration
-
Page transition duration used when user try to change page using
DayViewState.nextPage or DayViewState.previousPage
final
- pageViewPhysics → ScrollPhysics?
-
Use this field to disable the page view scrolling behavior
final
- quarterHourIndicatorSettings → HourIndicatorSettings?
-
Defines settings for quarter hour indication lines.
final
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- safeAreaOption → SafeAreaOption
-
Option for SafeArea.
final
- scrollOffset → double?
-
Defines initial offset of first page that will be displayed when
DayView is initialized.
final
- scrollPhysics → ScrollPhysics?
-
Use this field to disable the calendar scrolling
final
- showHalfHours → bool
-
Show half hour indicator
final
- showLiveTimeLineInAllDays → bool
-
if parsed true then live time line will be displayed in all days.
else it will be displayed in DateTime.now only.
final
- showQuarterHours → bool
-
Show quarter hour indicator(15min & 45min).
final
- showVerticalLine → bool
-
If true this will display vertical line in day view.
final
- startDuration → Duration
-
It define the starting duration from where day view page will be visible
By default it will be Duration(hours:0)
final
- startHour → int?
-
First hour displayed in the layout, goes from 0 to 24
final
- timeLineBuilder → DateWidgetBuilder?
-
A function that returns a Widget that will be displayed left side of
day view.
final
- timeLineOffset → double
-
Defines offset for timeline.
final
- timeLineWidth → double?
-
Defines the width of timeline. If null then it will
occupies 13% of width.
final
- timeStringBuilder → StringProvider?
-
A function to generate the TimeString in the timeline.
Useful for I18n
final
- verticalLineOffset → double
-
Defines offset of vertical line from hour line starts.
final
- width → double?
-
Width of day page.
final
Methods
-
createElement(
) → StatefulElement -
Creates a StatefulElement to manage this widget's location in the tree.
inherited
-
createState(
) → DayViewState< T> -
Creates the mutable state for this widget at a given location in the tree.
override
-
debugDescribeChildren(
) → List< DiagnosticsNode> -
Returns a list of
DiagnosticsNode
objects describing this node's children.inherited -
debugFillProperties(
DiagnosticPropertiesBuilder properties) → void -
Add additional properties associated with the node.
inherited
-
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
-
toStringDeep(
{String prefixLineOne = '', String? prefixOtherLines, DiagnosticLevel minLevel = DiagnosticLevel.debug}) → String -
Returns a string representation of this node and its descendants.
inherited
-
toStringShallow(
{String joiner = ', ', DiagnosticLevel minLevel = DiagnosticLevel.debug}) → String -
Returns a one-line detailed description of the object.
inherited
-
toStringShort(
) → String -
A short, textual description of this widget.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited