luminous

View Source Luminous.TimeRangeSelector (luminous v2.6.1)

A selector supports the widget in the dashboard that allows for selecting a time range/period. It can also be updated with a new value.

Link to this section Summary

Types

preset()
t()

Functions

get_current(selector)

Get the selector's current time range value

get_time_range_for(preset, time_zone)

Calculates and returns the time range for the given preset in the given time zone.

hook()
id()
new(selector)

Create and return a new selector

presets()

Returns a list with the available time range presets.

update_current(selector, time_range)

Updates the current time range of the selector.

Link to this section Types

Link to this type

preset()

View Source 
@type preset() :: binary()
Link to this type

t()

View Source 
@type t() :: %Luminous.TimeRangeSelector{
  current_time_range: nil | Luminous.TimeRange.t(),
  id: term()
}

Link to this section Functions

Link to this function

get_current(selector)

View Source 
@spec get_current(t()) :: Luminous.TimeRange.t() | nil

Get the selector's current time range value

Link to this function

get_time_range_for(preset, time_zone)

View Source 
@spec get_time_range_for(preset(), Luminous.TimeRange.time_zone()) ::
  Luminous.TimeRange.t() | nil

Calculates and returns the time range for the given preset in the given time zone.

Link to this function

hook()

View Source
Link to this function

id()

View Source
Link to this function

new(selector)

View Source 
@spec new(t()) :: t()

Create and return a new selector

Link to this function

presets()

View Source 
@spec presets() :: [preset()]

Returns a list with the available time range presets.

Link to this function

update_current(selector, time_range)

View Source 
@spec update_current(t(), Luminous.TimeRange.t()) :: t()

Updates the current time range of the selector.