scenic_clock v0.8.0 Scenic.Clock.Components View Source
A set of helper functions to make it easy to add, or modify, clocks to a graph.
Link to this section Summary
Link to this section Functions
Add an analog clock to a graph.
There is no required data, only styles.
Styles
Analog Clocks honor the following styles
:hidden
- Iffalse
the clock is rendered. If true, it is skipped. The default isfalse
.:theme
- The color set used to draw. See below. The default is:dark
Additional Styles
Analog clocks honor the following list of additional styles.
:radius
- the radius of the clock’s main circle.:timezone
- which timezone to display the time in. Should be one of the timezones supported by the Timex Hex package. SeeTimex.timezones()
. The default is whatever Timex says is the system timezone.:seconds
-true
orfalse
. Show the seconds hand. Note: Showing the seconds hand uses more energy by rendering the scene every second. The default isfalse
.:ticks
-true
orfalse
. Show ticks marking the hour positions. Default istrue
if the radius is >= 30.
Theme
To pass in a custom theme, supply a map with at least the following entries:
:border
- the color of the ring around the clock:background
- the normal background of the clock
The following theme colors are optional. If they are not supplied, :border
will be used.
:hours
- the color of the hours hand:minutes
- the color of the minutes hand:seconds
- the color of the seconds hand
Examples
The following example creates an analog clock it on the screen.
graph
|> analog_clock( translate: {20, 20} )
The next example makes the same clock as before, but shows the seconds hand.
graph
|> analog_clock( seconds: true, translate: {20, 20} )
Add an digital clock to a graph.
There is no required data, only configuration options.
Styles
Digital Clocks honors all the styles you would expect to render text.
Additional Styles
Digital clocks honor the following list of additional styles.
:timezone
- which timezone to display the time in. Should be one of the timezones supported by the Timex Hex package. SeeTimex.timezones()
. The default is whatever Timex sais is the system timexone.:format
- strftime format for the time string. Default is"%a %l:%M %p"
.
Theme
The Digital clock does not use the current theme for coloring. Add a :fill style instead, just as you would for a text primitive.
Examples
The following example creates an analog clock it on the screen.
graph
|> digital_clock( translate: {20, 20} )