View Source Luminous.TimeRangeSelector (luminous v1.3.2)

A selector represents the widget in the dashboard that allows for selecting a time range/period. It is defined at compile time and populated at compile time (current value). It can also be updated with a new value.

Link to this section Summary

Functions

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

Populate the selector's dynamic properties (e.g. current time range) at runtime.

Returns a list with the available time range presets.

Updates the current time range of the selector.

Link to this section Types

@type preset() :: binary()
@type t() :: %Luminous.TimeRangeSelector{
  current_time_range: nil | Luminous.TimeRange.t()
}
@type time_zone() :: binary()

Link to this section Functions

Link to this function

get_time_range_for(preset, time_zone)

View Source
@spec get_time_range_for(preset(), 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

populate(selector, default_time_range)

View Source
@spec populate(t(), time_zone()) :: t()

Populate the selector's dynamic properties (e.g. current time range) at runtime.

@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.