ExTeal.Dashboard behaviour (ExTeal v0.21.0) View Source

Module used to represent a dashboard which contains a grid of metrics, this will one day be extendable to include plugin or custom cards in the future.

Link to this section Summary

Types

range()

Callbacks

cards(t)

Return the modules that represent cards on the dashboard.

display?(t)

Show or Hide a dashboard based on the current connection. Defaults to true

title()

uri()

Unique URI that allows the dashboard to look up cards. Should be url safe.

Functions

cards_to_json(dashboard_module, conn)

map_to_json(modules)

Link to this section Types

range()

Specs

range() :: %{label: String.t(), unit: String.t(), value: integer()}

Link to this section Callbacks

cards(t)

Specs

cards(Plug.Conn.t()) :: [module()]

Return the modules that represent cards on the dashboard.

display?(t)

Specs

display?(Plug.Conn.t()) :: boolean()

Show or Hide a dashboard based on the current connection. Defaults to true

title()

Specs

title() :: String.t()

uri()

Specs

uri() :: String.t()

Unique URI that allows the dashboard to look up cards. Should be url safe.

Link to this section Functions

cards_to_json(dashboard_module, conn)