newqf

Documentation

Index

• type Config
  • func NewConfig(fns []ConfigFunc) *Config
• type ConfigFunc
  • func ColumnOrder(columns ...string) ConfigFunc
  • func Enums(columns map[string][]string) ConfigFunc

Types

type Config

type Config struct {
	ColumnOrder []string
	EnumColumns map[string][]string
}

Config holds configuration for creating new QFrames using the New constructor. It should be considered a private implementation detail and should never be referenced or used directly outside of the QFrame code. To manipulate it use the functions returning ConfigFunc below.

func NewConfig

func NewConfig(fns []ConfigFunc) *Config

NewConfig creates a new Config object. This function should never be called from outside QFrame.

type ConfigFunc

type ConfigFunc func(c *Config)

ConfigFunc is a function that operates on a Config object.

func ColumnOrder

func ColumnOrder(columns ...string) ConfigFunc

ColumnOrder provides the order in which columns are displayed, etc.

func Enums

func Enums(columns map[string][]string) ConfigFunc

Enums lists columns that should be considered enums. The map key specifies the columns name, the value if there is a fixed set of values and their internal ordering. If value is nil or empty list the values will be derived from the columns content and the ordering unspecified.