row

Documentation

Index

• type Option
  • func Collapse() Option
  • func HideTitle() Option
  • func RepeatFor(variable string) Option
  • func ShowTitle() Option
  • func WithGraph(title string, options ...graph.Option) Option
  • func WithHeatmap(title string, options ...heatmap.Option) Option
  • func WithLogs(title string, options ...logs.Option) Option
  • func WithSingleStat(title string, options ...singlestat.Option) Option
  • func WithStat(title string, options ...stat.Option) Option
  • func WithTable(title string, options ...table.Option) Option
  • func WithText(title string, options ...text.Option) Option
  • func WithTimeSeries(title string, options ...timeseries.Option) Option
• type Row
  • func New(board *sdk.Board, title string, options ...Option) (*Row, error)
  • func (row *Row) Alerts() []*alert.Alert

Types

type Option

type Option func(row *Row) error

Option represents an option that can be used to configure a row.

func Collapse

func Collapse() Option

Collapse makes the row collapsed by default.

func HideTitle

func HideTitle() Option

HideTitle ensures that the title of the row will NOT be displayed.

func RepeatFor

func RepeatFor(variable string) Option

RepeatFor will repeat the row for all values of the given variable.

func ShowTitle

func ShowTitle() Option

ShowTitle ensures that the title of the row will be displayed.

func WithGraph

func WithGraph(title string, options ...graph.Option) Option

WithGraph adds a "graph" panel in the row. Deprecated: use WithTimeSeries() instead.

func WithHeatmap

func WithHeatmap(title string, options ...heatmap.Option) Option

WithHeatmap adds a "heatmap" panel in the row.

func WithLogs

func WithLogs(title string, options ...logs.Option) Option

WithLogs adds a "logs" panel in the row.

func WithSingleStat

func WithSingleStat(title string, options ...singlestat.Option) Option

WithSingleStat adds a "single stat" panel in the row. Deprecated: use WithStat() instead

func WithStat

func WithStat(title string, options ...stat.Option) Option

WithStat adds a "stat" panel in the row.

func WithTable

func WithTable(title string, options ...table.Option) Option

WithTable adds a "table" panel in the row.

func WithText

func WithText(title string, options ...text.Option) Option

WithText adds a "text" panel in the row.

func WithTimeSeries

func WithTimeSeries(title string, options ...timeseries.Option) Option

WithTimeSeries adds a "timeseries" panel in the row.

type Row

type Row struct {
	// contains filtered or unexported fields
}

Row represents a dashboard row.

func New

func New(board *sdk.Board, title string, options ...Option) (*Row, error)

New creates a new row.

func (*Row) Alerts

func (row *Row) Alerts() []*alert.Alert

Alerts returns a list of alerts defined within this row.