notes

Documentation

Index

• Constants
• type Chart
• type Lines
  • func (l *Lines) Plot(t *tables.Table)
• type MarkdownCell
  • func (*MarkdownCell) RenderHTML(wr io.Writer) (err error)
• type Page
  • func (Page) Create(output iokit.Output) (pw *PageWriter, err error)
  • func (pg Page) LuckyCreate(output iokit.Output) *PageWriter
• type PageWriter
  • func (pw *PageWriter) Commit() (err error)
  • func (pg *PageWriter) Display(title string, a interface{})
  • func (pw *PageWriter) End()
  • func (pw *PageWriter) Ensure()
  • func (pg *PageWriter) Head(title string, a tables.AnyData, n int)
  • func (pg *PageWriter) Info(title string, a tables.AnyData)
  • func (pg *PageWriter) Markdown(text string)
  • func (pg *PageWriter) Markdownf(format string, a ...interface{})
  • func (pg *PageWriter) Plot(title string, a tables.AnyData, charts ...Chart)
  • func (pg *PageWriter) SaveAs(output iokit.Output) (err error)
  • func (pg *PageWriter) Show(brawser ...string)
  • func (pg *PageWriter) Tail(title string, a tables.AnyData, n int)

Constants

const MaxColumnsDefault = 30

const MaxRowsDefault = 30

Types

type Chart

type Chart interface {
	Plot(*tables.Table)
}

type Lines

type Lines struct {
	X string
	Y []string
	Z string
}

func (*Lines) Plot

func (l *Lines) Plot(t *tables.Table)

type MarkdownCell

type MarkdownCell struct {
	// contains filtered or unexported fields
}

func (*MarkdownCell) RenderHTML

func (*MarkdownCell) RenderHTML(wr io.Writer) (err error)

type Page

type Page struct {
	Title      string
	Header     string
	Footer     string
	MaxRows    int /* MaxRowsDefault if not specified */
	MaxColumns int /* MaxColumnsDefault if not specified */
}

func (Page) Create

func (Page) Create(output iokit.Output) (pw *PageWriter, err error)

func (Page) LuckyCreate

func (pg Page) LuckyCreate(output iokit.Output) *PageWriter

type PageWriter

type PageWriter struct {
	// contains filtered or unexported fields
}

func (*PageWriter) Commit

func (pw *PageWriter) Commit() (err error)

func (*PageWriter) Display

func (pg *PageWriter) Display(title string, a interface{})

Display renders any if can

func (*PageWriter) End

func (pw *PageWriter) End()

func (*PageWriter) Ensure

func (pw *PageWriter) Ensure()

func (*PageWriter) Head

func (pg *PageWriter) Head(title string, a tables.AnyData, n int)

func (*PageWriter) Info

func (pg *PageWriter) Info(title string, a tables.AnyData)

func (*PageWriter) Markdown

func (pg *PageWriter) Markdown(text string)

func (*PageWriter) Markdownf

func (pg *PageWriter) Markdownf(format string, a ...interface{})

func (*PageWriter) Plot

func (pg *PageWriter) Plot(title string, a tables.AnyData, charts ...Chart)

func (*PageWriter) SaveAs

func (pg *PageWriter) SaveAs(output iokit.Output) (err error)

SaveAs saves notes page as HTML file

	pg.SaveAs(iokit.Lzma2(fu.External("s3://$/reports/last.html.xz")))
    pg.SaveAs(iokit.ZipFile("report.html",iokit.External("gc://$/reports/last.zip")))

func (*PageWriter) Show

func (pg *PageWriter) Show(brawser ...string)

Show opens html notes page in the default browser

func (*PageWriter) Tail

func (pg *PageWriter) Tail(title string, a tables.AnyData, n int)