2023-08-21 17:42:50 +08:00
|
|
|
//
|
|
|
|
|
// writer.go
|
|
|
|
|
// Copyright (C) 2023 tiglog <me@tiglog.com>
|
|
|
|
|
//
|
|
|
|
|
// Distributed under terms of the MIT license.
|
|
|
|
|
//
|
|
|
|
|
|
2023-08-20 13:50:39 +08:00
|
|
|
package table
|
|
|
|
|
|
|
|
|
|
import (
|
|
|
|
|
"io"
|
|
|
|
|
)
|
|
|
|
|
|
|
|
|
|
// Writer declares the interfaces that can be used to setup and render a table.
|
|
|
|
|
type Writer interface {
|
|
|
|
|
AppendFooter(row Row, configs ...RowConfig)
|
|
|
|
|
AppendHeader(row Row, configs ...RowConfig)
|
|
|
|
|
AppendRow(row Row, configs ...RowConfig)
|
|
|
|
|
AppendRows(rows []Row, configs ...RowConfig)
|
|
|
|
|
AppendSeparator()
|
|
|
|
|
Length() int
|
|
|
|
|
Render() string
|
|
|
|
|
RenderCSV() string
|
|
|
|
|
RenderHTML() string
|
|
|
|
|
RenderMarkdown() string
|
|
|
|
|
ResetFooters()
|
|
|
|
|
ResetHeaders()
|
|
|
|
|
ResetRows()
|
|
|
|
|
SetAllowedRowLength(length int)
|
|
|
|
|
SetAutoIndex(autoIndex bool)
|
|
|
|
|
SetCaption(format string, a ...interface{})
|
|
|
|
|
SetColumnConfigs(configs []ColumnConfig)
|
|
|
|
|
SetIndexColumn(colNum int)
|
|
|
|
|
SetOutputMirror(mirror io.Writer)
|
|
|
|
|
SetPageSize(numLines int)
|
|
|
|
|
SetRowPainter(painter RowPainter)
|
|
|
|
|
SetStyle(style Style)
|
|
|
|
|
SetTitle(format string, a ...interface{})
|
|
|
|
|
SortBy(sortBy []SortBy)
|
|
|
|
|
Style() *Style
|
|
|
|
|
SuppressEmptyColumns()
|
|
|
|
|
|
|
|
|
|
// deprecated; in favor of Style().HTML.CSSClass
|
|
|
|
|
SetHTMLCSSClass(cssClass string)
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
// NewWriter initializes and returns a Writer.
|
|
|
|
|
func NewWriter() Writer {
|
|
|
|
|
return &Table{}
|
|
|
|
|
}
|
