struct

TCal::Calendar::HTML::Event

Inherits Struct < Value < Object

Represents an event within a Week.

If starts_this_week or ends_this_week are false, the event should be shown as continuing from the previous week or into the next week. period only includes days within "this" week.

Constructors

new(alert : V3API::Alert::Resource, colors : Calendar::RouteColors | Nil, period : DatePeriod, starts_this_week : Bool, ends_this_week : Bool)
Source

Instance methods

alert
clone
Source
colors
copy_with(alert _alert = @alert, colors _colors = @colors, period _period = @period, starts_this_week _starts_this_week = @starts_this_week, ends_this_week _ends_this_week = @ends_this_week)
Source
description
Source
details
Source
end_column

The 1-based grid column the event ends on.

This is exclusive (the event occupies the columns from start_column up to, but not including, this one). Because of this, it can have the value 8 despite the grid only being expected to contain 7 columns. This is in line with the behavior of grid-column-end in CSS.

Source
ends_this_week
image_alt
Source
image_url
Source
period
sort_key

Provides a key for sorting events.

Events are sorted earlier:

  • when they continue from the previous week and into the next week
  • then when they continue from the previous week
  • then when they start in an earlier column
  • then when they have no associated route colors
  • then when their title is alphabetically earlier
Source
start_column

The 1-based grid column the event starts on.

Source
starts_this_week
title
Source