HeatmapBuilder is an enum containing static methods for building heatmap view models from activity data. It handles date conversions, level calculations, and grid construction for activity heatmaps.
Properties
dayLabels
public static let dayLabels: [(key: String, label: String)]
[
("sun", ""),
("mon", "Mon"),
("tue", ""),
("wed", "Wed"),
("thu", ""),
("fri", "Fri"),
("sat", ""),
]
Methods
toDateKey
public static func toDateKey(_ date: Date) -> String
YYYY-MM-DD format.
The date to convert to a string key
YYYY-MM-DD (e.g., “2024-03-15”)
Example:
let date = Date()
let key = HeatmapBuilder.toDateKey(date)
// Returns: "2024-03-15"
getLevel
public static func getLevel(miles: Double, maxMiles: Double) -> Int
The maximum mileage across all days
- 0: No activity (miles or maxMiles is 0 or negative)
- 1-4: Increasing intensity levels based on the ratio of miles to maxMiles
Example:
let level = HeatmapBuilder.getLevel(miles: 5.0, maxMiles: 10.0)
// Returns: 2
let noActivity = HeatmapBuilder.getLevel(miles: 0, maxMiles: 10.0)
// Returns: 0
buildHeatmapView
public static func buildHeatmapView(
heatmap: [HeatmapDay],
weeksToShow: Int = 52
) -> HeatmapViewModel
Array of heatmap day data containing dates, miles, and activity counts
Number of weeks to display in the heatmap (defaults to 52 for one year)
HeatmapViewModel containing:
weeks: Array of HeatmapWeek objects with 7 cells eachmaxMiles: The maximum mileage value across all days in the gridtotalMiles: Sum of all mileage in the gridtoday: The current date (start of day)
Example:
let heatmapData: [HeatmapDay] = [
HeatmapDay(date: "2024-01-01", miles: 5.2, activityCount: 1),
HeatmapDay(date: "2024-01-02", miles: 3.8, activityCount: 2),
// ... more days
]
let viewModel = HeatmapBuilder.buildHeatmapView(
heatmap: heatmapData,
weeksToShow: 26
)
print("Max miles: \(viewModel.maxMiles)")
print("Total miles: \(viewModel.totalMiles)")
print("Weeks: \(viewModel.weeks.count)")