row

package
v0.22.1 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Dec 23, 2023 License: MIT Imports: 11 Imported by: 15

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Option

type Option func(row *Row) error

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

func Collapse added in v0.17.0

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 added in v0.12.7

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 WithGauge added in v0.21.12

func WithGauge(title string, options ...gauge.Option) Option

WithGauge adds a "gauge" panel in the row.

func WithGraph

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

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

func WithHeatmap added in v0.13.0

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

WithHeatmap adds a "heatmap" panel in the row.

func WithLogs added in v0.20.7

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

WithLogs adds a "logs" panel in the row.

func WithSingleStat added in v0.3.0

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

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

func WithStat added in v0.21.0

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 added in v0.19.0

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 added in v0.21.0

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

Alerts returns a list of alerts defined within this row.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL