Skip to content

clock_ratio

Fraction of the current period elapsed so far, as a 0..=1 value for gauge and progress-bar renderers. period selects which period (day, hour, week, month, quarter, year).

KindSafetyShapes
realtimeSaferatio
OptionTypeRequiredDefaultDescription
timezoneIANA timezone (e.g. "Asia/Tokyo")nosystem localTimezone the ratio is computed in. Omit to follow the system clock.
period"day" | "year" | "month" | "week" | "quarter" | "hour"no"day"Named period whose elapsed fraction becomes the ratio.
ShapeRenderers
ratioanimated_boot, animated_postfx, animated_scanlines, animated_splitflap, animated_wave, gauge_battery, gauge_circle, gauge_line, gauge_segment, gauge_thermometer
                                        
    ┌─────────────────────────────┐     
day │█████████████░░░░░░░░░░░░░░░░│▮ 45%
    └─────────────────────────────┘     
                                        
[[widget]]
id = "clock_ratio"
fetcher = "clock_ratio"
render = "gauge_battery"
██████████████████                      
██████████████████day                   
██████████████████                      
[[widget]]
id = "clock_ratio"
fetcher = "clock_ratio"
render = "gauge_circle"
day: ▓▓▓▓▓▓▓▓▓▓▓▓▓▓░░░░░░░░░░░░░░░░ 45% 
[[widget]]
id = "clock_ratio"
fetcher = "clock_ratio"
render = "gauge_line"
                                        
                                        
day ▰▰▱▱▱ 45%                           
                                        
                                        
[[widget]]
id = "clock_ratio"
fetcher = "clock_ratio"
render = "gauge_segment"
    ╭─╮             
    │░│             
    │░│             
    │░│             
day │█│ 45%         
    │█│             
    │█│             
    ╰●╯             
[[widget]]
id = "clock_ratio"
fetcher = "clock_ratio"
render = "gauge_thermometer"