orrery-compose/me.kozakov.orrery.compose/ScheduleState

ScheduleState

State holder for DaySchedule and WeekSchedule: the horizontally paged date window, the shared vertical scroll of the 24-hour grid, and the zoomable hourHeight.

Types

Companion

object Companion

Properties

endDate

var endDate: LocalDate?

Inclusive range end; null pages unboundedly into the future.

firstDayOfWeek

var firstDayOfWeek: DayOfWeek

firstVisibleDate

var firstVisibleDate: LocalDate

First visible date: the shown day in DaySchedule; in WeekSchedule the page's first day after a swipe, or the date passed to scrollToDate.

hourHeight

var hourHeight: Dp

Height of one 60-minute slot; mutable for pinch-to-zoom or programmatic zoom. Values are clamped to minHourHeight..maxHourHeight.

maxHourHeight

val maxHourHeight: Dp

minHourHeight

val minHourHeight: Dp

startDate

var startDate: LocalDate?

Inclusive range start; null pages unboundedly into the past.

verticalScrollState

val verticalScrollState: ScrollState

Vertical scroll state of the 24-hour time grid (shared across columns and pages).

Functions

animateScrollToDate

suspend fun animateScrollToDate(date: LocalDate)

animateScrollToTime

suspend fun animateScrollToTime(time: LocalTime, density: Density)

Animates the vertical time grid so time is at the top of the viewport.

scrollToDate

suspend fun scrollToDate(date: LocalDate)

scrollToTime

suspend fun scrollToTime(time: LocalTime, density: Density)

Scrolls the vertical time grid so time is at the top of the viewport.