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

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.

Summary

Callbacks

Return the modules that represent cards on the dashboard.

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

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

Types

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

Callbacks

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

Return the modules that represent cards on the dashboard.

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

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

@callback title() :: String.t()
@callback uri() :: String.t()

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

Functions

Link to this function

cards_to_json(dashboard_module, conn)

View Source