text

Documentation

Index

• type Option
  • func Description(content string) Option
  • func HTML(content string) Option
  • func Height(height string) Option
  • func Links(panelLinks ...links.Link) Option
  • func Markdown(content string) Option
  • func Span(span float32) Option
  • func Transparent() Option
• type Text
  • func New(title string, options ...Option) (*Text, error)

Types

type Option

type Option func(text *Text) error

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

func Description

func Description(content string) Option

Description annotates the current visualization with a human-readable description.

func HTML

func HTML(content string) Option

HTML sets the content of the panel, to be rendered as HTML.

func Height

func Height(height string) Option

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

func Links

func Links(panelLinks ...links.Link) Option

Links adds links to be displayed on this panel.

func Markdown

func Markdown(content string) Option

Markdown sets the content of the panel, to be rendered as markdown.

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 Transparent

func Transparent() Option

Transparent makes the background transparent.

type Text

type Text struct {
	Builder *sdk.Panel
}

Text represents a text panel.

func New

func New(title string, options ...Option) (*Text, error)

New creates a new text panel.