table

Documentation

Index

• Constants
• func Table(options ...Option) panel.Option
• type Align
• type Builder
• type CellSettings
• type ColumnSettings
• type Condition
  • func (c *Condition) UnmarshalJSON(data []byte) error
  • func (c *Condition) UnmarshalYAML(unmarshal func(interface{}) error) error
• type ConditionKind
• type Density
• type MiscConditionSpec
• type MiscValue
• type Option
  • func Transform(transforms []common.Transform) Option
  • func WithCellSettings(settings []CellSettings) Option
  • func WithColumnSettings(settings []ColumnSettings) Option
  • func WithDefaultColumHeight(height int) Option
  • func WithDefaultColumWidth(width int) Option
  • func WithDefaultColumnHidden(hidden bool) Option
  • func WithDefaultPagination(enabled bool) Option
  • func WithDensity(density Density) Option
• type PluginSpec
• type RangeConditionSpec
• type RegexConditionSpec
• type Sort
• type ValueConditionSpec

Constants

const PluginKind = "Table"

Functions

func Table

func Table(options ...Option) panel.Option

Types

type Align

type Align string

const (
	LeftAlign   Align = "left"
	CenterAlign Align = "center"
	RightAlign  Align = "right"
)

type Builder

type Builder struct {
	PluginSpec `json:",inline" yaml:",inline"`
}

type CellSettings

type CellSettings struct {
	Condition       Condition `json:"condition" yaml:"condition"`
	Text            string    `json:"text,omitempty" yaml:"text,omitempty"`
	Prefix          string    `json:"prefix,omitempty" yaml:"prefix,omitempty"`
	Suffix          string    `json:"suffix,omitempty" yaml:"suffix,omitempty"`
	TextColor       string    `json:"textColor,omitempty" yaml:"textColor,omitempty"`
	BackgroundColor string    `json:"backgroundColor,omitempty" yaml:"backgroundColor,omitempty"`
}

type ColumnSettings

type ColumnSettings struct {
	Name              string         `json:"name" yaml:"name"`
	Header            string         `json:"header,omitempty" yaml:"header,omitempty"`
	HeaderDescription string         `json:"headerDescription,omitempty" yaml:"headerDescription,omitempty"`
	CellDescription   string         `json:"cellDescription,omitempty" yaml:"cellDescription,omitempty"`
	Format            *common.Format `json:"format,omitempty" yaml:"format,omitempty"`
	Align             Align          `json:"align,omitempty" yaml:"align,omitempty"`
	EnableSorting     bool           `json:"enableSorting,omitempty" yaml:"enableSorting,omitempty"`
	Sort              Sort           `json:"sort,omitempty" yaml:"sort,omitempty"`
	Width             float64        `json:"width,omitempty" yaml:"width,omitempty"`
	Hide              bool           `json:"hide,omitempty" yaml:"hide,omitempty"`
	CellSettings      []CellSettings `json:"cellSettings,omitempty" yaml:"cellSettings,omitempty"`
}

type Condition

type Condition struct {
	Kind ConditionKind `json:"kind" yaml:"kind"`
	Spec interface{}   `json:"spec" yaml:"spec"`
}

func (*Condition) UnmarshalJSON

func (c *Condition) UnmarshalJSON(data []byte) error

func (*Condition) UnmarshalYAML

func (c *Condition) UnmarshalYAML(unmarshal func(interface{}) error) error

type ConditionKind

type ConditionKind string

const (
	ValueConditionKind ConditionKind = "Value"
	RangeConditionKind ConditionKind = "Range"
	RegexConditionKind ConditionKind = "Regex"
	MiscConditionKind  ConditionKind = "Misc"
)

type Density

type Density string

const (
	CompactDensity  Density = "auto"
	StandardDensity Density = "always"
)

type MiscConditionSpec

type MiscConditionSpec struct {
	Value MiscValue `json:"value" yaml:"value"`
}

type MiscValue

type MiscValue string

var (
	EmptyValue MiscValue = "empty"
	NullValue  MiscValue = "null"
	NaNValue   MiscValue = "NaN"
	TrueValue  MiscValue = "true"
	FalseValue MiscValue = "false"
)

type Option

type Option func(plugin *Builder) error

func Transform

func Transform(transforms []common.Transform) Option

func WithCellSettings

func WithCellSettings(settings []CellSettings) Option

func WithColumnSettings

func WithColumnSettings(settings []ColumnSettings) Option

func WithDefaultColumHeight

func WithDefaultColumHeight(height int) Option

func WithDefaultColumWidth

func WithDefaultColumWidth(width int) Option

func WithDefaultColumnHidden

func WithDefaultColumnHidden(hidden bool) Option

func WithDefaultPagination

func WithDefaultPagination(enabled bool) Option

func WithDensity

func WithDensity(density Density) Option

type PluginSpec

type PluginSpec struct {
	Density             Density            `json:"density,omitempty" yaml:"density,omitempty"`
	DefaultColumnWidth  int                `json:"defaultColumnWidth,omitempty" yaml:"defaultColumnWidth,omitempty"`
	DefaultColumnHeight int                `json:"defaultColumnHeight,omitempty" yaml:"defaultColumnHeight,omitempty"`
	DefaultColumnHidden bool               `json:"defaultColumnHidden,omitempty" yaml:"defaultColumnHidden,omitempty"`
	Pagination          bool               `json:"pagination,omitempty" yaml:"pagination,omitempty"`
	ColumnSettings      []ColumnSettings   `json:"columnSettings,omitempty" yaml:"columnSettings,omitempty"`
	CellSettings        []CellSettings     `json:"cellSettings,omitempty" yaml:"cellSettings,omitempty"`
	Transforms          []common.Transform `json:"transforms,omitempty" yaml:"transforms,omitempty"`
}

type RangeConditionSpec

type RangeConditionSpec struct {
	Min float64 `json:"min,omitempty" yaml:"min,omitempty"`
	Max float64 `json:"max,omitempty" yaml:"max,omitempty"`
}

type RegexConditionSpec

type RegexConditionSpec struct {
	Expr string `json:"expr" yaml:"expr"`
}

type Sort

type Sort string

const (
	AscSort  Sort = "asc"
	DescSort Sort = "desc"
)

type ValueConditionSpec

type ValueConditionSpec struct {
	Value string `json:"value" yaml:"value"`
}