table

Documentation

Index

• type Aggregation
• type AggregationType
• type Option
  • func AsAnnotations() Option
  • func AsJSON() Option
  • func AsTable() Option
  • func AsTimeSeriesAggregations(aggregations []Aggregation) Option
  • func DataSource(source string) Option
  • func Editable() Option
  • func Height(height string) Option
  • func HideColumn(columnLabelPattern string) Option
  • func ReadOnly() Option
  • func Span(span float32) Option
  • func TimeSeriesToColumns() Option
  • func TimeSeriesToRows() Option
  • func WithPrometheusTarget(query string, options ...prometheus.Option) Option
• type Table
  • func New(title string, options ...Option) *Table

Types

type Aggregation

type Aggregation struct {
	Label string
	Type  AggregationType
}

type AggregationType

type AggregationType string

AggregationType represents an aggregation function used on values returned by the query.

const AVG AggregationType = "avg"

AVG aggregates results by computing the average.

const Count AggregationType = "count"

Count aggregates results by counting them.

const Current AggregationType = "current"

Current aggregates results by keeping only the current value.

const Max AggregationType = "max"

Max aggregates results by keeping only the largest value.

const Min AggregationType = "min"

Min aggregates results by keeping only the smallest value.

type Option

type Option func(table *Table)

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

func AsAnnotations

func AsAnnotations() Option

AsAnnotations displays the data as annotations.

func AsJSON

func AsJSON() Option

AsJSON displays the data as JSON.

func AsTable

func AsTable() Option

AsTable displays the data as a table.

func AsTimeSeriesAggregations

func AsTimeSeriesAggregations(aggregations []Aggregation) Option

AsTimeSeriesAggregations displays the data according to the given aggregation methods.

func DataSource

func DataSource(source string) Option

DataSource sets the data source to be used by the table.

func Editable

func Editable() Option

Editable marks the graph as editable.

func Height

func Height(height string) Option

Height sets the height of the panel, in pixels. Example: "400px".

func HideColumn

func HideColumn(columnLabelPattern string) Option

HideColumn hides the column having a label matching the given pattern.

func ReadOnly

func ReadOnly() Option

ReadOnly marks the graph as non-editable.

func Span

func Span(span float32) Option

Span sets the width of the panel, in grid units. Should be a positive number between 1 and 12. Example: 6.

func TimeSeriesToColumns

func TimeSeriesToColumns() Option

TimeSeriesToColumns displays the data in columns.

func TimeSeriesToRows

func TimeSeriesToRows() Option

TimeSeriesToRows displays the data in rows.

func WithPrometheusTarget

func WithPrometheusTarget(query string, options ...prometheus.Option) Option

WithPrometheusTarget adds a prometheus target to the table.

type Table

type Table struct {
	Builder *sdk.Panel
}

Table represents a table panel.

func New

func New(title string, options ...Option) *Table

New creates a new table panel.