View Source Luminous.Dashboard (luminous v1.1.0)
A dashboard is a high-level component initialized by the dashboard
live view. It contains all the necessary dashboard attributes such as the
panels, variables and the time range selector. It is initialized at
compile time using define/4
and populated at runtime using populate/1
.
Link to this section Summary
Functions
Returns the dashboard's default time range.
Initialize and return a dashboard at compile time.
Returns the LV path for the specific dashboard based on its configuration.
Populate the dashboard's dynamic properties (e.g. variable values, time range etc.) at runtime.
Update the dashboard's current time range with a new one.
Update the dashboard's variables with a new list.
Link to this section Types
@type t() :: %Luminous.Dashboard{ action: atom(), panels: [Luminous.Panel.t()], path: (... -> binary()), time_range_selector: Luminous.TimeRangeSelector.t(), time_zone: binary(), title: binary(), variables: [Luminous.Variable.t()] }
Link to this section Functions
@spec default_time_range(t()) :: Luminous.TimeRange.t()
Returns the dashboard's default time range.
@spec define( binary(), {(... -> binary()), atom()}, Luminous.TimeRangeSelector.t(), Keyword.t() ) :: t()
Initialize and return a dashboard at compile time.
@spec path(t(), Phoenix.LiveView.Socket.t(), Keyword.t()) :: binary()
Returns the LV path for the specific dashboard based on its configuration.
Populate the dashboard's dynamic properties (e.g. variable values, time range etc.) at runtime.
@spec update_current_time_range(t(), Luminous.TimeRange.t()) :: t()
Update the dashboard's current time range with a new one.
@spec update_variables(t(), [Luminous.Variable.t()]) :: t()
Update the dashboard's variables with a new list.