MultiDayViewConfiguration class Views
The configuration used by the MultiDayBody and MultiDayHeader.
- Inheritance
-
- Object
- ViewConfiguration
- MultiDayViewConfiguration
Constructors
- MultiDayViewConfiguration({required String name, DateTime? initialDateTime, DateTransition dateTransition = DateTransition.carryFocus, DateResolver? dateResolver, NowCallback? nowCallback, MultiDayRule multiDayRule = kDefaultMultiDayRule, required KalenderTimeRange timeOfDayRange, required int numberOfDays, required int firstDayOfWeek, required PageIndexCalculator pageIndexCalculator, required MultiDayViewType type, required KalenderTime initialTimeOfDay, required double initialHeightPerMinute, ScrollTransition scrollTransition = ScrollTransition.preserve, ScrollResolver? scrollResolver, ZoomTransition zoomTransition = ZoomTransition.preserve, ZoomResolver? zoomResolver})
- MultiDayViewConfiguration.custom({String name = 'Custom', DateTime? initialDateTime, DateTransition dateTransition = DateTransition.carryFocus, DateResolver? dateResolver, NowCallback? nowCallback, MultiDayRule multiDayRule = kDefaultMultiDayRule, KalenderDateTimeRange? displayRange, KalenderTimeRange? timeOfDayRange, required int numberOfDays, int firstDayOfWeek = kDefaultFirstDayOfWeek, KalenderTime initialTimeOfDay = kDefaultInitialTimeOfDay, double initialHeightPerMinute = kDefaultHeightPerMinute, ScrollTransition scrollTransition = ScrollTransition.preserve, ScrollResolver? scrollResolver, ZoomTransition zoomTransition = ZoomTransition.preserve, ZoomResolver? zoomResolver})
- Creates a MultiDayViewConfiguration for a custom number of days.
- MultiDayViewConfiguration.freeScroll({String name = 'Free Scroll', DateTime? initialDateTime, DateTransition dateTransition = DateTransition.carryFocus, DateResolver? dateResolver, NowCallback? nowCallback, MultiDayRule multiDayRule = kDefaultMultiDayRule, KalenderDateTimeRange? displayRange, KalenderTimeRange? timeOfDayRange, required int numberOfDays, KalenderTime initialTimeOfDay = kDefaultInitialTimeOfDay, double initialHeightPerMinute = kDefaultHeightPerMinute, ScrollTransition scrollTransition = ScrollTransition.preserve, ScrollResolver? scrollResolver, ZoomTransition zoomTransition = ZoomTransition.preserve, ZoomResolver? zoomResolver})
- Creates a MultiDayViewConfiguration for a free scrolling view.
- MultiDayViewConfiguration.singleDay({String name = 'Day', DateTime? initialDateTime, DateTransition dateTransition = DateTransition.carryFocus, DateResolver? dateResolver, NowCallback? nowCallback, MultiDayRule multiDayRule = kDefaultMultiDayRule, KalenderDateTimeRange? displayRange, KalenderTimeRange? timeOfDayRange, int firstDayOfWeek = kDefaultFirstDayOfWeek, KalenderTime initialTimeOfDay = kDefaultInitialTimeOfDay, double initialHeightPerMinute = kDefaultHeightPerMinute, ScrollTransition scrollTransition = ScrollTransition.preserve, ScrollResolver? scrollResolver, ZoomTransition zoomTransition = ZoomTransition.preserve, ZoomResolver? zoomResolver})
- Creates a MultiDayViewConfiguration for a single day.
- MultiDayViewConfiguration.week({String name = 'Week', DateTime? initialDateTime, DateTransition dateTransition = DateTransition.carryFocus, DateResolver? dateResolver, NowCallback? nowCallback, MultiDayRule multiDayRule = kDefaultMultiDayRule, KalenderDateTimeRange? displayRange, KalenderTimeRange? timeOfDayRange, int firstDayOfWeek = kDefaultFirstDayOfWeek, int numberOfDays = 7, KalenderTime initialTimeOfDay = kDefaultInitialTimeOfDay, double initialHeightPerMinute = kDefaultHeightPerMinute, ScrollTransition scrollTransition = ScrollTransition.preserve, ScrollResolver? scrollResolver, ZoomTransition zoomTransition = ZoomTransition.preserve, ZoomResolver? zoomResolver})
- Creates a MultiDayViewConfiguration for a week.
- MultiDayViewConfiguration.workWeek({String name = 'Work Week', DateTime? initialDateTime, DateTransition dateTransition = DateTransition.carryFocus, DateResolver? dateResolver, NowCallback? nowCallback, MultiDayRule multiDayRule = kDefaultMultiDayRule, KalenderDateTimeRange? displayRange, KalenderTimeRange? timeOfDayRange, int numberOfDays = 5, KalenderTime initialTimeOfDay = kDefaultInitialTimeOfDay, double initialHeightPerMinute = kDefaultHeightPerMinute, ScrollTransition scrollTransition = ScrollTransition.preserve, ScrollResolver? scrollResolver, ZoomTransition zoomTransition = ZoomTransition.preserve, ZoomResolver? zoomResolver})
- Creates a MultiDayViewConfiguration for a work week.
Properties
- dateResolver → DateResolver?
-
An optional resolver for the visible date on a view switch or a change of location.
finalinherited
- dateTimeRange → KalenderDateTimeRange
-
The KalenderDateTimeRange that the calendar can display.
no setterinherited
- dateTransition → DateTransition
-
How the visible date is chosen when switching to this view from another, or when the calendar's location changes.
finalinherited
- firstDayOfWeek → int
-
The first day of the week.
final
- hashCode → int
-
The hash code for this object.
no setteroverride
- initialDateTime → DateTime?
-
The date the view opens on when this configuration is passed to the KalenderController constructor.
finalinherited
- initialHeightPerMinute → double
-
The initial heightPerMinute (zoom level).
final
- initialTimeOfDay → KalenderTime
-
The initial time of day that the calendar should display.
final
- multiDayRule → MultiDayRule
-
Decides which events belong in the multi-day header rather than the day timeline.
finalinherited
- name → String
-
Identifies the configuration. ViewParts.name matches it, and the controller keeps the date, scroll and zoom a
view was left on under it for DateTransition.restorePerView, ScrollTransition.restorePerView and
ZoomTransition.restorePerView.
finalinherited
- nowCallback → NowCallback?
-
An optional callback that overrides how the calendar resolves "now".
finalinherited
- numberOfDays → int
-
The number of days that can be displayed by MultiDayBody widgets using this configuration.
final
- pageIndexCalculator → PageIndexCalculator
-
The functions for navigating the PageView.
final
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- scrollResolver → ScrollResolver?
-
Decides the time of day on a view switch before scrollTransition.
final
- scrollTransition → ScrollTransition
-
How the vertical scroll position (time of day) is chosen when switching to this view from another. Defaults to
ScrollTransition.preserve. Applies when scrollResolver is null or returns null.
final
- timeOfDayRange → KalenderTimeRange
-
The KalenderTimeRange that can be displayed by MultiDayBody widgets using this configuration.
final
- type → MultiDayViewType
-
The type of the MultiDayViewConfiguration.
final
- zoomResolver → ZoomResolver?
-
Decides the zoom on a view switch before zoomTransition.
final
- zoomTransition → ZoomTransition
-
How the zoom (
heightPerMinute) is chosen when switching to this view from another. Defaults to ZoomTransition.preserve. Applies when zoomResolver is null or returns null.final
Methods
-
copyWith(
{String? name, DateTime? initialDateTime, DateTransition? dateTransition, DateResolver? dateResolver, NowCallback? nowCallback, KalenderTimeRange? timeOfDayRange, KalenderDateTimeRange? displayRange, int? numberOfDays, int? firstDayOfWeek, KalenderTime? initialTimeOfDay, ScrollTransition? scrollTransition, ScrollResolver? scrollResolver, ZoomTransition? zoomTransition, ZoomResolver? zoomResolver, MultiDayRule? multiDayRule}) → MultiDayViewConfiguration -
createViewController(
KalenderController controller, ViewTransitionContext? transition) → MultiDayViewController -
Open the returned ViewController on resolveDate, which follows ViewTransitionContext.target when the view is
reopened or navigated while no view is mounted.
override
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
resolveDate(
Location? location, ViewTransitionContext? transition) → FloatingDateTime -
The date the view opens on.
inherited
-
toString(
) → String -
A string representation of this object.
override
Operators
-
operator ==(
Object other) → bool -
The equality operator.
override