sheet

package

Go to main page

Versions in this module

v0

v0.8.0

Oct 1, 2026

v0.6.0

Sep 30, 2026

Changes in this version

+ var ErrNoSource = errors.New("There's no linked source by that name")

+ var ErrSourceEdit = errors.New("A linked source is read-only: its rows are the file's")

+ var ErrWhole = errors.New("this change does more than set cells: it can only be accepted whole")

+ func PivotCols(p Pivot) []int

+ type AskKind uint8

+ const AskCall

+ const AskCell

+ const AskPivot

+ const AskRange

type Condition

+ func (c Condition) Test() func(v Value, shown string) bool

type LinkSource

+ Order *SourceOrder

+ Paged bool

+ type PivotGroups struct

+ func GatherPivot(p Pivot, shape SourceShape, ...) (*PivotGroups, error)

+ func (g *PivotGroups) Records() int

+ type Proposal struct

+ Book bool

+ Cells []Proposed

+ Label string

+ Other []string

+ Remote bool

+ Sheets []string

+ func Propose(w *Workbook, label string, fn func(*Workbook) error) (*Proposal, error)

+ func (p *Proposal) Apply(w *Workbook, pick func(i int) bool) error

+ func (p *Proposal) Empty() bool

+ func (p *Proposal) Result() *Workbook

+ func (p *Proposal) Whole() bool

+ type Proposed struct

+ At Addr

+ Look bool

+ Now string

+ Sheet string

+ Was string

type Sheet

+ func (s *Sheet) IsSource() bool

+ func (s *Sheet) Source() (SourceInfo, bool)

+ type SourceAnswer struct

+ A *functions.Array

+ Pivot *PivotGroups

+ V Value

+ Why string

+ type SourceFilter struct

+ Col int

+ Cond Condition

+ type SourceHost interface

+ Answer func(q SourceQuestion) (SourceAnswer, bool)

+ type SourceInfo struct

+ Err string

+ Known bool

+ Name string

+ Shape SourceShape

+ Sheet *Sheet

+ Source LinkSource

+ type SourceOrder struct

+ Filter []SourceFilter

+ Sort []SourceSort

+ func (o *SourceOrder) IsZero() bool

+ type SourceQuestion struct

+ At Addr

+ Call functions.StreamCall

+ Kind AskKind

+ Pivot Pivot

+ R Rect

+ Source string

+ func (q SourceQuestion) Key() string

+ func (q SourceQuestion) Sources() []string

+ type SourceShape struct

+ Cols []string

+ Formats []Format

+ Numeric []bool

+ Rows int

+ type SourceSort struct

+ Col int

+ Desc bool

type Workbook

+ func (w *Workbook) AddSource(name string, src LinkSource, after *Sheet) (*Sheet, error)

+ func (w *Workbook) Adopt(author int)

+ func (w *Workbook) LookupSource(name string) (SourceInfo, bool)

+ func (w *Workbook) RecalcSourced(keys []string)

+ func (w *Workbook) SetSourceOrder(name string, o *SourceOrder) error

+ func (w *Workbook) SetSourceShape(name string, shape SourceShape, err string)

+ func (w *Workbook) SetSources(h SourceHost)

+ func (w *Workbook) SourceChanged(name string)

+ func (w *Workbook) Sources() []SourceInfo

v0.5.0

Sep 30, 2026

Changes in this version

+ func FitWidth(text string) int

+ type Blocked struct

+ Author int

+ Label string

+ type Op struct

+ Author int

+ Kind OpKind

+ Seq uint64

+ type OpKind int

+ const OpDo

+ const OpRedo

+ const OpUndo

type Workbook

+ func (w *Workbook) Author() int

+ func (w *Workbook) Checkpoint() int

+ func (w *Workbook) EndStep()

+ func (w *Workbook) InStep() (bool, int)

+ func (w *Workbook) LastOp() uint64

+ func (w *Workbook) OpsSince(seq uint64) ([]Op, uint64)

+ func (w *Workbook) RedoBlocked() (Blocked, bool)

+ func (w *Workbook) SetAuthor(a int)

+ func (w *Workbook) ShareHistory()

+ func (w *Workbook) UndoBlocked() (Blocked, bool)

+ func (w *Workbook) UndoTo(c int)

+ func (w *Workbook) Version() uint64

v0.4.0

Sep 29, 2026

v0.3.0

Sep 29, 2026

Changes in this version

+ const FmtSize

+ const MaxRowHeight

+ const MaxStepBytes

+ var ErrLinkedEdit = errors.New(...)

+ var ErrMergeMany = fmt.Errorf("That would make more than %d merged cells", maxMerges)

+ var ErrMergeOne = errors.New("Select more than one cell to merge")

+ var ErrNoRegion = errors.New("There's no region by that name")

+ var ErrNoTable = errors.New("There's no table by that name")

+ var ErrOutputEdit = errors.New(...)

+ var ErrSortMerged = errors.New("Can't sort a range with merged cells; unmerge them first")

+ var ErrTableOverlap = errors.New("A table can't overlap another table, a region or a pivot table")

+ var OnLive func(trace any, i LiveInfo)

+ func CanonicalArg(arg string, loc *locale.Locale) string

+ func CanonicalEntry(typed string, loc *locale.Locale) string

+ func CondArg(op CondOp, typed string, loc *locale.Locale) string

+ func DefaultLocale() *locale.Locale

+ func EntryValue(input string) (Value, Format)

+ func EscapeColumn(name string) string

+ func FormatTextIn(v Value, f Format, loc *locale.Locale) string

+ func IsPeriod(arg string) bool

+ func LocalArg(arg string, loc *locale.Locale) string

+ func LocalCondArg(op CondOp, arg string, loc *locale.Locale) string

+ func LocalEntry(input string, loc *locale.Locale) string

+ func LocalizeError(err error, loc *locale.Locale) error

+ func Periods() []string

+ func SetDefaultLocale(l *locale.Locale)

+ func ValidRegionName(name string) error

+ func ValidTableName(name string) error

type Align

+ func DisplayIn(v Value, f Format, width int, loc *locale.Locale) (string, Align)

+ type BorderKind uint8

+ const BorderAll

+ const BorderBottom

+ const BorderInner

+ const BorderLeft

+ const BorderNone

+ const BorderOuter

+ const BorderRight

+ const BorderTop

+ func ParseBorderKind(s string) (BorderKind, bool)

+ func (k BorderKind) String() string

+ type Borders uint32

+ func BordersOf(top, bottom, left, right Line) Borders

+ func (b Borders) Bottom() Line

+ func (b Borders) Color(e Edge) Color

+ func (b Borders) IsZero() bool

+ func (b Borders) Left() Line

+ func (b Borders) Line(e Edge) Line

+ func (b Borders) Right() Line

+ func (b Borders) Stroke(e Edge) Stroke

+ func (b Borders) Top() Line

+ func (b Borders) With(e Edge, l Line) Borders

+ func (b Borders) WithColor(e Edge, c Color) Borders

+ func (b Borders) WithStroke(e Edge, st Stroke) Borders

type Chart

+ func ParseChart(line string) (Chart, error)

+ func (c Chart) JSON() string

type Clip

+ func (c *Clip) TextIn(loc *locale.Locale) [][]string

type CondFormat

+ Bar Color

+ BarOnly bool

+ Icons IconSet

+ Reverse bool

+ func (f CondFormat) IsBar() bool

+ func (f CondFormat) IsIcons() bool

type CondOp

+ func (op CondOp) OnText() bool

type Criteria

+ func ParseCriteria(line string) (Criteria, error)

+ func (cr Criteria) JSON() string

+ type DropDisplay uint8

+ const DropArrow

+ const DropChip

+ const DropPlain

+ func DropDisplays() []DropDisplay

+ func ParseDropDisplay(s string) (DropDisplay, bool)

+ func (d DropDisplay) String() string

+ func (d DropDisplay) Title() string

+ type Edge uint8

+ const EdgeBottom

+ const EdgeLeft

+ const EdgeRight

+ const EdgeTop

type FilterValue

+ Label string

+ type IconSet uint8

+ const IconsArrows

+ const IconsCircles

+ const IconsNone

+ const IconsRating

+ const IconsSymbols

+ func IconSets() []IconSet

+ func ParseIconSet(s string) (IconSet, bool)

+ func (i IconSet) Glyphs(n int) []string

+ func (i IconSet) IconColor(k, n int) Color

+ func (i IconSet) Sizes() []int

+ func (i IconSet) String() string

+ func (i IconSet) Title() string

+ type Line uint8

+ const LineDouble

+ const LineNone

+ const LineThick

+ const LineThin

+ func Heavier(a, b Line) Line

+ func ParseLine(s string) (Line, bool)

+ func (l Line) String() string

+ type Link struct

+ Kind LinkKind

+ Name string

+ func (l Link) OnGrid() bool

+ type LinkKind uint8

+ const LinkFile

+ const LinkName

+ const LinkOutput

+ const LinkRef

+ const LinkRegion

+ const LinkSpill

+ const LinkTable

+ type LinkSource struct

+ Format string

+ Path string

+ Query string

+ Table string

+ Window int

+ type LinkedRegion struct

+ Anchor Addr

+ Area Rect

+ Dropped int

+ Err string

+ Name string

+ Note string

+ Paused bool

+ Rows int

+ Sheet *Sheet

+ Source LinkSource

+ Stale bool

+ Updated time.Time

+ type LiveCell struct

+ F Format

+ V Value

+ type LiveInfo struct

+ Cells int

+ Duration time.Duration

+ Reset bool

+ Rows int

+ type LiveOp struct

+ At time.Time

+ Err string

+ Header LiveRow

+ Note string

+ Region string

+ Reset bool

+ Rows []LiveRow

+ type LiveRow []LiveCell

type Look

+ Bar bool

+ BarColor Color

+ BarLen float64

+ Display DropDisplay

+ Icon string

+ IconColor Color

+ ValueHidden bool

+ type MergeKind uint8

+ const MergeAll

+ const MergeHorizontally

+ const MergeVertically

type Pivot

+ func ParsePivot(line string) (Pivot, error)

+ func (p Pivot) JSON() string

+ type Region struct

+ At Addr

+ File LinkSource

+ Name string

+ Output bool

+ func (r Region) FormulaName() string

+ func (r Region) Linked() bool

type RuleOp

+ const RuleAboveAverage

+ const RuleBelowAverage

+ const RuleBottom

+ const RuleBottomPercent

+ const RuleDuplicate

+ const RuleTop

+ const RuleTopPercent

+ const RuleUnique

+ func (op RuleOp) OnText() bool

+ func (op RuleOp) Ranks() bool

+ type Segment struct

+ Next bool

+ Text string

+ Value bool

type Sheet

+ func (s *Sheet) AddLinked(a Addr, src LinkSource) (string, error)

+ func (s *Sheet) AddRegion(r Region) error

+ func (s *Sheet) BorderedIn(r Rect) []Addr

+ func (s *Sheet) CheckboxInput(a Addr, on bool) string

+ func (s *Sheet) ColsWidth(from, to int) int

+ func (s *Sheet) CreateTable(name string, r Rect) error

+ func (s *Sheet) DeleteRegion(name string) error

+ func (s *Sheet) DependentLinks(a Addr, max int) (links []Link, more bool)

+ func (s *Sheet) Discard() bool

+ func (s *Sheet) EdgeAbove(a Addr) Line

+ func (s *Sheet) EdgeLeft(a Addr) Line

+ func (s *Sheet) EvaluateSteps(a Addr) *Steps

+ func (s *Sheet) Filled(a Addr) bool

+ func (s *Sheet) FreezeRegion(name string) error

+ func (s *Sheet) Grow(r Rect) Rect

+ func (s *Sheet) HasLinked() bool

+ func (s *Sheet) HasRegions() bool

+ func (s *Sheet) HasTables() bool

+ func (s *Sheet) Heights() map[int]int

+ func (s *Sheet) InRegion(r Rect) (Addr, Region, bool)

+ func (s *Sheet) InvalidIn(r Rect) []*InvalidEntry

+ func (s *Sheet) IsNotebook() bool

+ func (s *Sheet) LinkedAt(a Addr) (LinkedRegion, bool)

+ func (s *Sheet) LinkedRegions() []LinkedRegion

+ func (s *Sheet) LoadFitWidths()

+ func (s *Sheet) LoadMerge(r Rect)

+ func (s *Sheet) LoadRowHeight(row, h int)

+ func (s *Sheet) LoadTable(t Table) error

+ func (s *Sheet) LocalText(a Addr) string

+ func (s *Sheet) Locale() *locale.Locale

+ func (s *Sheet) MakeNotebook()

+ func (s *Sheet) Merge(r Rect, k MergeKind) error

+ func (s *Sheet) MergeAcross(rows bool, n int) (Rect, bool)

+ func (s *Sheet) MergeAt(a Addr) (Rect, bool)

+ func (s *Sheet) MergeLoses(r Rect, k MergeKind) (Addr, bool)

+ func (s *Sheet) Merges() []Rect

+ func (s *Sheet) MergesIn(r Rect) []Rect

+ func (s *Sheet) NamedTables(a Addr) []string

+ func (s *Sheet) NotebookCells() []notebook.Cell

+ func (s *Sheet) PrecedentLinks(a Addr) []Link

+ func (s *Sheet) Reactive() bool

+ func (s *Sheet) Reads(u Addr, t *Sheet, r Rect) bool

+ func (s *Sheet) RegionAt(a Addr) (Region, bool)

+ func (s *Sheet) RegionTable(name string) (Rect, bool)

+ func (s *Sheet) Regions() []Region

+ func (s *Sheet) RowHeight(row int) (int, bool)

+ func (s *Sheet) RuleAbove(row int) bool

+ func (s *Sheet) SetBorderStroke(r Rect, k BorderKind, st Stroke)

+ func (s *Sheet) SetBorders(r Rect, k BorderKind, l Line)

+ func (s *Sheet) SetNotebookCells(label string, cells []notebook.Cell)

+ func (s *Sheet) SetReactive(on bool)

+ func (s *Sheet) SetRowHeight(from, to, h int)

+ func (s *Sheet) Shaped() bool

+ func (s *Sheet) StrokeAbove(a Addr) Stroke

+ func (s *Sheet) StrokeLeft(a Addr) Stroke

+ func (s *Sheet) TableAt(a Addr) (Table, bool)

+ func (s *Sheet) TableLook(a Addr) (header, band bool)

+ func (s *Sheet) Tables() []Table

+ func (s *Sheet) UndoCost(r Rect) int64

+ func (s *Sheet) Unmerge(r Rect) int

+ func (s *Sheet) Version() uint64

+ func (s *Sheet) WrappedIn(row int) []int

+ type Steps struct

+ func (st *Steps) CanStepIn() bool

+ func (st *Steps) Cell() (*Sheet, Addr)

+ func (st *Steps) Done() bool

+ func (st *Steps) Into() *Steps

+ func (st *Steps) Next() (expr, value string, ok bool)

+ func (st *Steps) Progress() (done, total int)

+ func (st *Steps) Restart()

+ func (st *Steps) Result() string

+ func (st *Steps) Step()

+ func (st *Steps) Text() []Segment

+ type Stroke struct

+ Color Color

+ Line Line

type Style

+ Borders Borders

+ VAlign VAlign

+ Wrap Wrap

+ type Table struct

+ Banded bool

+ Cols []string

+ Header bool

+ Name string

+ Range Rect

+ func (t Table) Col(name string) int

+ func (t Table) Data() Rect

+ type TableInfo struct

+ Cols []string

+ Name string

+ Range Rect

+ Region bool

+ Sheet *Sheet

+ func (t TableInfo) Shown() bool

+ type VAlign uint8

+ const VAlignAuto

+ const VAlignBottom

+ const VAlignMiddle

+ const VAlignTop

+ func ParseVAlign(s string) (VAlign, bool)

+ func (v VAlign) Offset(k, n int, merged bool) int

+ func (v VAlign) String() string

type Validation

+ Display DropDisplay

+ func (v Validation) CheckboxValues() (checked, unchecked string, custom bool)

type Workbook

+ func (w *Workbook) AddNotebook(name string, after *Sheet) (*Sheet, error)

+ func (w *Workbook) ApplyLive(op LiveOp) error

+ func (w *Workbook) Discard() bool

+ func (w *Workbook) FreeCellName(base string) string

+ func (w *Workbook) LinkedRegion(name string) (LinkedRegion, bool)

+ func (w *Workbook) LinkedRegions() []LinkedRegion

+ func (w *Workbook) LoadNotes() []string

+ func (w *Workbook) Locale() *locale.Locale

+ func (w *Workbook) LocaleTag() string

+ func (w *Workbook) LookupTable(name string) (TableInfo, bool)

+ func (w *Workbook) NewCellID() int

+ func (w *Workbook) NextTableName() string

+ func (w *Workbook) Notebook() *Sheet

+ func (w *Workbook) Output(id int) *notebook.Output

+ func (w *Workbook) OutputCaps() notebook.Caps

+ func (w *Workbook) OutputsChanged() int

+ func (w *Workbook) PauseLinked(name string, paused bool)

+ func (w *Workbook) RebaseLinks(fn func(string) string)

+ func (w *Workbook) Region(name string) (*Sheet, Region, bool)

+ func (w *Workbook) ReloadLinked(name string)

+ func (w *Workbook) RemoveTable(name string) error

+ func (w *Workbook) RenameRegion(old, name string) error

+ func (w *Workbook) RenameTable(old, name string) error

+ func (w *Workbook) ResizeTable(name string, r Rect) error

+ func (w *Workbook) SetLinkSource(name string, src LinkSource) error

+ func (w *Workbook) SetLocale(tag string) bool

+ func (w *Workbook) SetOutput(id int, o *notebook.Output)

+ func (w *Workbook) SetOutputCaps(c notebook.Caps)

+ func (w *Workbook) SetTableStyle(name string, banded, header bool) error

+ func (w *Workbook) StaleOutputs() []string

+ func (w *Workbook) Table(name string) (*Sheet, Table, bool)

+ func (w *Workbook) TableInfos() []TableInfo

+ func (w *Workbook) TableRange(ref string) (s *Sheet, r Rect, ok bool, err error)

+ func (w *Workbook) Try(fn func() error, takeBack func() bool) (bool, error)

+ func (w *Workbook) Unlink(name string) error

+ func (w *Workbook) UnsavedOutputs() []string

+ func (w *Workbook) WithoutUndo(fn func())

+ type Wrap uint8

+ const WrapClip

+ const WrapOn

+ const WrapOverflow

+ func ParseWrap(s string) (Wrap, bool)

+ func (w Wrap) String() string

v0.2.0

Sep 27, 2026

Changes in this version

+ const MaxNote

+ const NumColors

+ var ErrSpillEdit = errors.New("That cell holds part of an array result: edit the formula it spills from")

+ func CleanNote(text string) string

+ func RangesText(rs []Rect) string

type Cell

+ Note string

+ func (c *Cell) Spilled() bool

type ChartFate

+ Removed bool

+ type ChartLegend int

+ const LegendBottom

+ const LegendNone

+ const LegendRight

+ func ParseChartLegend(s string) (ChartLegend, bool)

+ func (l ChartLegend) String() string

+ type ChartOptions struct

+ HasMax bool

+ HasMin bool

+ Legend ChartLegend

+ Log bool

+ Max float64

+ Min float64

+ NoGrid bool

+ Stack ChartStack

+ Trend bool

+ type ChartStack int

+ const StackNone

+ const StackNormal

+ const StackPercent

+ func ParseChartStack(s string) (ChartStack, bool)

+ func (s ChartStack) String() string

+ func (s ChartStack) Title() string

type ChartType

+ const ChartArea

+ const ChartScatter

+ func (t ChartType) Stackable() bool

+ type Color uint8

+ const ColorBlue

+ const ColorCyan

+ const ColorGreen

+ const ColorMagenta

+ const ColorNone

+ const ColorRed

+ const ColorYellow

+ func Colors() []Color

+ func ParseColor(s string) (Color, bool)

+ func (c Color) String() string

+ func (c Color) Title() string

+ type CondFormat struct

+ Args [2]string

+ Op RuleOp

+ Ranges []Rect

+ Scale []ScalePoint

+ Style RuleStyle

+ func ParseCondFormat(line string) (CondFormat, error)

+ func (f CondFormat) Check() error

+ func (f CondFormat) IsScale() bool

+ func (f CondFormat) JSON() string

+ func (f CondFormat) Summary() string

+ type InvalidEntry struct

+ Addr Addr

+ Help string

+ Reject bool

+ func (e *InvalidEntry) Error() string

+ type Look struct

+ Checkbox bool

+ Checked bool

+ Dropdown bool

+ From Color

+ Invalid bool

+ Pos float64

+ Scaled bool

+ Style RuleStyle

+ Styled bool

+ To Color

+ type PointKind uint8

+ const PointMax

+ const PointMin

+ const PointNumber

+ const PointPercent

+ const PointPercentile

+ func ParsePointKind(s string) (PointKind, bool)

+ func PointKinds() []PointKind

+ func (k PointKind) String() string

+ func (k PointKind) TakesValue() bool

+ func (k PointKind) Title() string

+ type Protection struct

+ Desc string

+ Range Rect

+ Sheet bool

+ func (p Protection) Label() string

type Rect

+ func ParseRanges(s string) ([]Rect, bool)

+ type RuleOp uint8

+ const RuleBetween

+ const RuleContains

+ const RuleDateAfter

+ const RuleDateBefore

+ const RuleDateIs

+ const RuleEmpty

+ const RuleEndsWith

+ const RuleEqual

+ const RuleExactly

+ const RuleFormula

+ const RuleGreater

+ const RuleGreaterEq

+ const RuleLess

+ const RuleLessEq

+ const RuleNone

+ const RuleNotBetween

+ const RuleNotContains

+ const RuleNotEmpty

+ const RuleNotEqual

+ const RuleStartsWith

+ func CompareOps() []RuleOp

+ func CondFormatOps() []RuleOp

+ func ParseRuleOp(s string) (RuleOp, bool)

+ func (op RuleOp) Args() int

+ func (op RuleOp) String() string

+ func (op RuleOp) Title() string

+ type RuleStyle struct

+ Bold bool

+ Fill Color

+ Italic bool

+ Strikethrough bool

+ Text Color

+ Underline bool

+ func (s RuleStyle) IsZero() bool

+ type ScalePoint struct

+ Color Color

+ Kind PointKind

+ Value string

+ func (p ScalePoint) String() string

type Sheet

+ func (s *Sheet) AddCondFormat(f CondFormat) error

+ func (s *Sheet) AddValidation(v Validation) error

+ func (s *Sheet) CheckEntry(a Addr, input string) *InvalidEntry

+ func (s *Sheet) ClearCondFormats(cr Rect)

+ func (s *Sheet) ClearNotes(r Rect) int

+ func (s *Sheet) ClearValidations(cr Rect)

+ func (s *Sheet) CondFormats() []CondFormat

+ func (s *Sheet) DeleteCondFormat(i int)

+ func (s *Sheet) DeleteValidation(i int)

+ func (s *Sheet) DropdownItems(a Addr) []string

+ func (s *Sheet) HasRules() bool

+ func (s *Sheet) HasSpills() bool

+ func (s *Sheet) InSpill(r Rect) (Addr, bool)

+ func (s *Sheet) LoadCondFormats(fs []CondFormat) (skipped int)

+ func (s *Sheet) LoadNote(a Addr, text string)

+ func (s *Sheet) LoadProtection(p Protection)

+ func (s *Sheet) LoadValidations(vs []Validation) (skipped int)

+ func (s *Sheet) Look(a Addr) Look

+ func (s *Sheet) MoveCondFormat(i, to int)

+ func (s *Sheet) Note(a Addr) string

+ func (s *Sheet) NotesIn(r Rect) []Addr

+ func (s *Sheet) Protect(p Protection)

+ func (s *Sheet) Protecting(r Rect) (Protection, bool)

+ func (s *Sheet) Protections() []Protection

+ func (s *Sheet) SetCondFormat(i int, f CondFormat) error

+ func (s *Sheet) SetNote(a Addr, text string) error

+ func (s *Sheet) SetValidation(i int, v Validation) error

+ func (s *Sheet) SpillAnchor(a Addr) (Addr, bool)

+ func (s *Sheet) SpillArea(a Addr) (Rect, bool)

+ func (s *Sheet) Unprotect(i int)

+ func (s *Sheet) UnprotectRange(r Rect) int

+ func (s *Sheet) Validation(a Addr) (Validation, bool)

+ func (s *Sheet) Validations() []Validation

+ type ValidKind uint8

+ const ValidCheckbox

+ const ValidDate

+ const ValidFormula

+ const ValidLength

+ const ValidList

+ const ValidNumber

+ const ValidRange

+ func ParseValidKind(s string) (ValidKind, bool)

+ func ValidKinds() []ValidKind

+ func (k ValidKind) Compares() bool

+ func (k ValidKind) Dropdown() bool

+ func (k ValidKind) String() string

+ func (k ValidKind) Title() string

+ type Validation struct

+ Args [2]string

+ Help string

+ Items []string

+ Kind ValidKind

+ Op RuleOp

+ Ranges []Rect

+ Reject bool

+ Source string

+ func ParseValidation(line string) (Validation, error)

+ func (v Validation) Check() error

+ func (v Validation) HelpText() string

+ func (v Validation) JSON() string

+ func (v Validation) SourceRange() (string, Rect, bool)

+ func (v Validation) Summary() string

v0.1.0

Sep 27, 2026

Changes in this version

+ const Bool

+ const DefaultMaxCells

+ const DefaultWidth

+ const Empty

+ const Error

+ const FileExt

+ const FmtAccounting

+ const FmtAuto

+ const FmtCurrency

+ const FmtCustom

+ const FmtDate

+ const FmtDateTime

+ const FmtDuration

+ const FmtFinancial

+ const FmtNumber

+ const FmtPercent

+ const FmtScientific

+ const FmtText

+ const FmtTime

+ const MacroAPI

+ const MaxChartH

+ const MaxChartW

+ const MaxCols

+ const MaxDecimals

+ const MaxFrozen

+ const MaxRows

+ const MaxUndo

+ const MaxUndoBytes

+ const MinChartH

+ const MinChartW

+ const Number

+ const Text

+ var ChartTypes = func() []ChartType { ... }()

+ var ErrDiv0 = value.ErrDiv0

+ var ErrFillTooBig = errors.New("That would write more cells than max-cells allows (see File > Settings)")

+ var ErrNA = value.ErrNA

+ var ErrName = value.ErrName

+ var ErrNoRemote = functions.ErrNoRemote

+ var ErrNum = value.ErrNum

+ var ErrPasteEdge = errors.New("The paste doesn't fit: it would go past the edge of the sheet")

+ var ErrPivotEdit = errors.New(...)

+ var ErrPushedOff = errors.New("There's data at the edge of the sheet that would be pushed off")

+ var ErrRef = value.ErrRef

+ var ErrRemote = functions.ErrRemote

+ var ErrValue = value.ErrValue

+ var OnBegin func(trace any, op string)

+ var OnPivot func(trace any, i PivotInfo)

+ var OnRecalc func(trace any, i RecalcInfo)

+ var Pending = functions.Pending

+ func ColName(c int) string

+ func FormatNumber(v float64, width int) string

+ func FormatPattern(v float64, pat string) string

+ func FormatText(v Value, f Format) string

+ func FormatValue(v Value, width int) string

+ func IsFormulaEntry(input string) bool

+ func IsPending(v Value) bool

+ func MaxCells() int

+ func ParseCol(s string) (int, bool)

+ func ParseNumber(s string) (float64, bool)

+ func Qualified(sheet string, r Rect) string

+ func QuoteSheet(name string) string

+ func SetMaxCells(n int)

+ func ShiftEntry(input string, dc, dr int) (string, error)

+ func SplitSheet(s string) (sheet, rest string)

+ func ValidMacroName(name string) error

+ func ValidName(name string) error

+ func ValidSheetName(name string) error

+ type Addr = formula.Addr

+ func ParseAddr(s string) (Addr, bool)

+ type Align uint8

+ const AlignAuto

+ const AlignCenter

+ const AlignFill

+ const AlignLeft

+ const AlignRight

+ func Display(v Value, f Format, width int) (string, Align)

+ func ParseAlign(s string) (Align, bool)

+ func (a Align) String() string

+ type Cell struct

+ Format Format

+ Input string

+ Style Style

+ Value Value

+ func (c *Cell) Blank() bool

+ func (c *Cell) IsFormula() bool

+ type Change struct

+ Focus Rect

+ Label string

+ Macros bool

+ Sheet *Sheet

+ Tabs bool

+ type Chart struct

+ At Addr

+ ByRow bool

+ Data Rect

+ H int

+ Header bool

+ Labels bool

+ Title string

+ Type ChartType

+ W int

+ type ChartData struct

+ Categories []string

+ Format Format

+ Series []ChartSeries

+ type ChartFate struct

+ Empty bool

+ Name string

+ Now Rect

+ Was Rect

+ type ChartSeries struct

+ Name string

+ Values []float64

+ type ChartType int

+ const ChartBar

+ const ChartColumn

+ const ChartLine

+ const ChartPie

+ func ParseChartType(s string) (ChartType, bool)

+ func (t ChartType) String() string

+ func (t ChartType) Title() string

+ type Clip struct

+ Range Rect

+ Src Rect

+ func (c *Clip) MoveRange(to Addr) Rect

+ func (c *Clip) Size() (cols, rows int)

+ func (c *Clip) Text() [][]string

+ type CondOp uint8

+ const CondContains

+ const CondEmpty

+ const CondEndsWith

+ const CondEqual

+ const CondExactly

+ const CondGreater

+ const CondGreaterEq

+ const CondLess

+ const CondLessEq

+ const CondNone

+ const CondNotContains

+ const CondNotEmpty

+ const CondNotEqual

+ const CondStartsWith

+ func CondOps() []CondOp

+ func ParseCondOp(s string) (CondOp, bool)

+ func (op CondOp) String() string

+ func (op CondOp) TakesArg() bool

+ func (op CondOp) Title() string

+ type Condition struct

+ Arg string

+ Op CondOp

+ func (c Condition) Matches(v Value, shown string) bool

+ type Criteria struct

+ Cond Condition

+ Hidden []string

+ func (c Criteria) IsZero() bool

+ type Filter struct

+ Cols map[int]Criteria

+ Range Rect

+ type FilterValue struct

+ Count int

+ Shown bool

+ Text string

+ type FindOptions struct

+ InFormulas bool

+ MatchCase bool

+ Regex bool

+ WholeCell bool

+ Within *Rect

+ type Format = value.Format

+ func ParseValue(s string) (float64, Format, bool)

+ func Preset(k FormatKind) Format

+ type FormatKind = value.FormatKind

+ func ParseFormatKind(s string) (FormatKind, bool)

+ type FuncDef = functions.FuncDef

+ func Funcs() []*FuncDef

+ func LookupFunc(name string) (*FuncDef, bool)

+ type ImportResult struct

+ Names int

+ Renamed map[string]string

+ Sheets []*Sheet

+ type Kind = value.Kind

+ type Macro struct

+ API int

+ Key string

+ Name string

+ Source string

+ type Name struct

+ Lost bool

+ Name string

+ Range Rect

+ Sheet *Sheet

+ func (n Name) Gone() bool

+ func (n Name) Ref() string

+ type Node = formula.Node

+ func Parse(src string) (Node, error)

+ type ParseError = formula.ParseError

+ type Pivot struct

+ ColumnTotals bool

+ Columns []PivotGroup

+ Filters []PivotFilter

+ Lost bool

+ Range Rect

+ RowTotals bool

+ Rows []PivotGroup

+ Source string

+ Values []PivotValue

+ func FrequencyPivot(src *Sheet, r Rect, col int) Pivot

+ func NewPivot(src *Sheet, r Rect) Pivot

+ type PivotFilter struct

+ Col int

+ Criteria Criteria

+ type PivotGroup struct

+ Col int

+ Desc bool

+ SortBy int

+ type PivotInfo struct

+ Cells int

+ Duration time.Duration

+ Failed bool

+ Groups int

+ Records int

+ type PivotValue struct

+ Col int

+ Name string

+ ShowAs ShowAs

+ Summarize Summarize

+ type RecalcInfo struct

+ Cells int

+ Circular bool

+ Duration time.Duration

+ Evaluated int

+ Full bool

+ Volatile int

+ type Rect = formula.Rect

+ func NewRect(a, b Addr) Rect

+ func ParseRange(s string) (Rect, bool)

+ type RemoteAnswer = functions.RemoteAnswer

+ type RemoteCall = functions.RemoteCall

+ type RemoteSource = functions.RemoteSource

+ type Sheet struct

+ func New() *Sheet

+ func Read(r io.Reader) (*Sheet, error)

+ func ReadTraced(r io.Reader, trace any) (*Sheet, error)

+ func (s *Sheet) AddChart(c Chart) int

+ func (s *Sheet) Addrs() []Addr

+ func (s *Sheet) AdjustDecimals(r Rect, delta int)

+ func (s *Sheet) Batch(c Change, fn func() error) error

+ func (s *Sheet) Book() *Workbook

+ func (s *Sheet) CanRedo() bool

+ func (s *Sheet) CanUndo() bool

+ func (s *Sheet) Cell(a Addr) *Cell

+ func (s *Sheet) CellFormat(a Addr) Format

+ func (s *Sheet) CellStyle(a Addr) Style

+ func (s *Sheet) ChartData(c Chart) ChartData

+ func (s *Sheet) Charts() []Chart

+ func (s *Sheet) ClearFormatting(r Rect)

+ func (s *Sheet) ClearHistory()

+ func (s *Sheet) ColFormats() map[int]Format

+ func (s *Sheet) ColStyles() map[int]Style

+ func (s *Sheet) ColWidth(c int) int

+ func (s *Sheet) ColumnFiltered(col int) bool

+ func (s *Sheet) Copy(r Rect) *Clip

+ func (s *Sheet) CreateFilter(r Rect)

+ func (s *Sheet) Decimal() bool

+ func (s *Sheet) DefineName(name string, r Rect) error

+ func (s *Sheet) DeleteChart(i int)

+ func (s *Sheet) DeleteCols(at, n int)

+ func (s *Sheet) DeleteName(name string) error

+ func (s *Sheet) DeleteRows(at, n int)

+ func (s *Sheet) Dependents(a Addr) []Target

+ func (s *Sheet) DisplayFormat(a Addr) Format

+ func (s *Sheet) Edge(a Addr, dc, dr int) Addr

+ func (s *Sheet) EditName(old, name string, r Rect) error

+ func (s *Sheet) EraseRange(r Rect)

+ func (s *Sheet) ExplainError(a Addr) string

+ func (s *Sheet) FillDown(r Rect) (Rect, error)

+ func (s *Sheet) FillEntry(r Rect, origin Addr, input string) error

+ func (s *Sheet) FillRight(r Rect) (Rect, error)

+ func (s *Sheet) FillSeries(src, dst Rect) (Rect, error)

+ func (s *Sheet) FilledBounds(r Rect) (Rect, bool)

+ func (s *Sheet) Filter() *Filter

+ func (s *Sheet) FilterColumn(col int, cr Criteria)

+ func (s *Sheet) FilterRange() (Rect, bool)

+ func (s *Sheet) FilterValues(col int) []FilterValue

+ func (s *Sheet) Find(query string, o FindOptions) ([]Addr, error)

+ func (s *Sheet) Frozen() (rows, cols int)

+ func (s *Sheet) GuessChart(r Rect) Chart

+ func (s *Sheet) Hidden() bool

+ func (s *Sheet) HiddenRows() int

+ func (s *Sheet) InPivot(r Rect) bool

+ func (s *Sheet) InsertCols(at, n int) error

+ func (s *Sheet) InsertRows(at, n int) error

+ func (s *Sheet) Len() int

+ func (s *Sheet) Link(a Addr) string

+ func (s *Sheet) Live() bool

+ func (s *Sheet) Load(a Addr, input string, f Format, st Style) error

+ func (s *Sheet) LoadColWidth(c, w int)

+ func (s *Sheet) LoadFilter(f *Filter)

+ func (s *Sheet) LoadFrozen(rows, cols int)

+ func (s *Sheet) LoadLineFormat(row bool, n int, f Format, st Style)

+ func (s *Sheet) LookupName(name string) (Name, bool)

+ func (s *Sheet) Move(src Rect, to Addr) (Rect, error)

+ func (s *Sheet) MoveTo(dst *Sheet, src Rect, to Addr) (Rect, error)

+ func (s *Sheet) Name() string

+ func (s *Sheet) NameUsers(name string) int

+ func (s *Sheet) NamedSheets(a Addr) []string

+ func (s *Sheet) Names() []Name

+ func (s *Sheet) NextFilledCol(row, col, dir, limit int) (int, bool)

+ func (s *Sheet) NextShownRow(r, d int) (int, bool)

+ func (s *Sheet) Paste(c *Clip, dst Rect, values bool) (Rect, error)

+ func (s *Sheet) Pivot() (Pivot, bool)

+ func (s *Sheet) PivotError() string

+ func (s *Sheet) PivotRange() (Rect, bool)

+ func (s *Sheet) PivotSource() *Sheet

+ func (s *Sheet) Precedents(a Addr) []Target

+ func (s *Sheet) RangeStats(r Rect) Stats

+ func (s *Sheet) RecalcAll()

+ func (s *Sheet) RecalcVolatile()

+ func (s *Sheet) Redo() (Change, bool)

+ func (s *Sheet) Region(a Addr) Rect

+ func (s *Sheet) RemoteCalls(a Addr) []RemoteCall

+ func (s *Sheet) RemoveFilter()

+ func (s *Sheet) Replace(a Addr, query, repl string, o FindOptions) (bool, error)

+ func (s *Sheet) ReplaceAll(query, repl string, o FindOptions) (int, error)

+ func (s *Sheet) RowFormats() map[int]Format

+ func (s *Sheet) RowHidden(r int) bool

+ func (s *Sheet) RowStyles() map[int]Style

+ func (s *Sheet) Seal()

+ func (s *Sheet) Set(a Addr, input string) error

+ func (s *Sheet) SetChart(i int, c Chart, label string)

+ func (s *Sheet) SetColWidth(c, w int)

+ func (s *Sheet) SetDecimal(on bool)

+ func (s *Sheet) SetFormat(r Rect, f Format)

+ func (s *Sheet) SetFrozen(rows, cols int)

+ func (s *Sheet) SetPivot(p Pivot, label string) error

+ func (s *Sheet) SetRemote(r RemoteSource)

+ func (s *Sheet) SetStyle(r Rect, fn func(*Style))

+ func (s *Sheet) SheetFormat() (Format, Style)

+ func (s *Sheet) ShownText(a Addr) string

+ func (s *Sheet) SortRange(r Rect, keys []SortKey)

+ func (s *Sheet) StateID() int

+ func (s *Sheet) Undo() (Change, bool)

+ func (s *Sheet) Unload(a Addr)

+ func (s *Sheet) UsedRange() (Rect, bool)

+ func (s *Sheet) Value(a Addr) Value

+ func (s *Sheet) Widths() map[int]int

+ func (s *Sheet) Write(w io.Writer) error

+ type ShowAs uint8

+ const ShowPctColumn

+ const ShowPctRow

+ const ShowPctTotal

+ const ShowValue

+ func ParseShowAs(name string) (ShowAs, bool)

+ func ShowAsList() []ShowAs

+ func (s ShowAs) String() string

+ func (s ShowAs) Title() string

+ type SortKey struct

+ Col int

+ Desc bool

+ type Stats struct

+ Count int

+ Nums int

+ Sum float64

+ type Style struct

+ Align Align

+ Bold bool

+ Italic bool

+ Strikethrough bool

+ Underline bool

+ func (s Style) IsZero() bool

+ type Summarize uint8

+ const AverageBy

+ const CountABy

+ const CountBy

+ const CountRowsBy

+ const CountUniqueBy

+ const MaxBy

+ const MinBy

+ const SumBy

+ func ParseSummarize(name string) (Summarize, bool)

+ func Summaries() []Summarize

+ func (f Summarize) Desc() string

+ func (f Summarize) String() string

+ func (f Summarize) Title() string

+ type Target struct

+ Range Rect

+ Sheet *Sheet

+ type Value = value.Value

+ type Workbook struct

+ Circular bool

+ func NewBook() *Workbook

+ func ReadBook(r io.Reader) (*Workbook, error)

+ func (w *Workbook) Active() int

+ func (w *Workbook) AddSheet(name string, at int) (*Sheet, error)

+ func (w *Workbook) Batch(c Change, fn func() error) error

+ func (w *Workbook) Begin(c Change) (end func())

+ func (w *Workbook) CanRedo() bool

+ func (w *Workbook) CanUndo() bool

+ func (w *Workbook) ClearHistory()

+ func (w *Workbook) CreatePivot(src *Sheet, r Rect, name string, p Pivot) (*Sheet, error)

+ func (w *Workbook) Decimal() bool

+ func (w *Workbook) DefaultSummarize(p Pivot, col int) Summarize

+ func (w *Workbook) DefineName(name string, s *Sheet, r Rect) error

+ func (w *Workbook) DeleteMacro(name string) bool

+ func (w *Workbook) DeleteName(name string) error

+ func (w *Workbook) DeleteSheet(s *Sheet) error

+ func (w *Workbook) DuplicateSheet(s *Sheet) (*Sheet, error)

+ func (w *Workbook) EditName(old, name string, s *Sheet, r Rect) error

+ func (w *Workbook) FieldName(p Pivot, col int) string

+ func (w *Workbook) HiddenSheets() []*Sheet

+ func (w *Workbook) HideSheet(s *Sheet) error

+ func (w *Workbook) HistoryBytes() int64

+ func (w *Workbook) Index(s *Sheet) int

+ func (w *Workbook) InsertBook(src *Workbook, at int, label string) (ImportResult, error)

+ func (w *Workbook) Len() int

+ func (w *Workbook) Lookup(name string) *Sheet

+ func (w *Workbook) LookupName(name string) (Name, bool)

+ func (w *Workbook) Macro(name string) (Macro, bool)

+ func (w *Workbook) MacroForKey(key string) (Macro, bool)

+ func (w *Workbook) MacroOrigin() string

+ func (w *Workbook) Macros() []Macro

+ func (w *Workbook) MoveSheet(s *Sheet, to int)

+ func (w *Workbook) NameUsers(name string) int

+ func (w *Workbook) Names() []Name

+ func (w *Workbook) NextPivotName() string

+ func (w *Workbook) PivotFilterValues(p Pivot, col int) []FilterValue

+ func (w *Workbook) RecalcAll()

+ func (w *Workbook) RecalcAnswered(calls []RemoteCall)

+ func (w *Workbook) Redo() (Change, bool)

+ func (w *Workbook) RenameSheet(s *Sheet, name string) error

+ func (w *Workbook) ReplaceSheet(dst, s *Sheet, label string) ([]ChartFate, error)

+ func (w *Workbook) SaveMacro(old string, mc Macro, label string) error

+ func (w *Workbook) Seal()

+ func (w *Workbook) SetActive(s *Sheet)

+ func (w *Workbook) SetDecimal(on bool)

+ func (w *Workbook) SetMacroOrigin(origin string)

+ func (w *Workbook) SetRemote(r RemoteSource)

+ func (w *Workbook) SetTrace(trace any)

+ func (w *Workbook) Settle()

+ func (w *Workbook) Sheet(i int) *Sheet

+ func (w *Workbook) Sheets() []*Sheet

+ func (w *Workbook) StateID() int

+ func (w *Workbook) Undo() (Change, bool)

+ func (w *Workbook) UndoLabel() string

+ func (w *Workbook) UnhideSheet(s *Sheet) error

+ func (w *Workbook) ValueTitle(p Pivot, v PivotValue) string

+ func (w *Workbook) Visible() []*Sheet

+ func (w *Workbook) Write(out io.Writer) error

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL