spreadsheet

package
v1.0.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Apr 25, 2026 License: MIT Imports: 39 Imported by: 0

Documentation

Overview

Copyright 2017 FoxyUtils ehf. All rights reserved.

Use of this software package and source code is governed by the terms of the UniDoc End User License Agreement (EULA) that is available at: https://unidoc.io/eula/ A trial license code for evaluation can be obtained at https://unidoc.io.

Index

Constants

View Source 
const (
	DVCompareTypeWholeNumber = DVCompareType(_agf.ST_DataValidationTypeWhole)
	DVCompareTypeDecimal     = DVCompareType(_agf.ST_DataValidationTypeDecimal)
	DVCompareTypeDate        = DVCompareType(_agf.ST_DataValidationTypeDate)
	DVCompareTypeTime        = DVCompareType(_agf.ST_DataValidationTypeTime)
	DVompareTypeTextLength   = DVCompareType(_agf.ST_DataValidationTypeTextLength)
)
View Source 
const (
	DVCompareOpEqual        = DVCompareOp(_agf.ST_DataValidationOperatorEqual)
	DVCompareOpBetween      = DVCompareOp(_agf.ST_DataValidationOperatorBetween)
	DVCompareOpNotBetween   = DVCompareOp(_agf.ST_DataValidationOperatorNotBetween)
	DVCompareOpNotEqual     = DVCompareOp(_agf.ST_DataValidationOperatorNotEqual)
	DVCompareOpGreater      = DVCompareOp(_agf.ST_DataValidationOperatorGreaterThan)
	DVCompareOpGreaterEqual = DVCompareOp(_agf.ST_DataValidationOperatorGreaterThanOrEqual)
	DVCompareOpLess         = DVCompareOp(_agf.ST_DataValidationOperatorLessThan)
	DVCompareOpLessEqual    = DVCompareOp(_agf.ST_DataValidationOperatorLessThanOrEqual)
)
View Source 
const (
	DVOpGreater = _agf.ST_DataValidationOperatorGreaterThanOrEqual
)

Variables

View Source 
var ErrorNotFound = _dg.New("\u006eo\u0074\u0020\u0066\u006f\u0075\u006ed")

Functions

func PasswordHash 

func PasswordHash(s string) string

PasswordHash returns the password hash for a workbook using the modified spreadsheetML password hash that is compatible with Excel.

Types

type AbsoluteAnchor 

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

AbsoluteAnchor has a fixed top-left corner in distance units as well as a fixed height/width.

func (AbsoluteAnchor) BottomRight 

func (_cdf AbsoluteAnchor) BottomRight() CellMarker

BottomRight is a no-op.

func (AbsoluteAnchor) MoveTo 

func (_ddd AbsoluteAnchor) MoveTo(x, y int32)

MoveTo is a no-op.

func (AbsoluteAnchor) SetColOffset 

func (_aa AbsoluteAnchor) SetColOffset(m _ac.Distance)

SetColOffset sets the column offset of the top-left of the image in fixed units.

func (AbsoluteAnchor) SetHeight 

func (_ae AbsoluteAnchor) SetHeight(h _ac.Distance)

SetHeight sets the height of the anchored object.

func (AbsoluteAnchor) SetHeightCells 

func (_cf AbsoluteAnchor) SetHeightCells(int32)

SetHeightCells is a no-op.

func (AbsoluteAnchor) SetRowOffset 

func (_ed AbsoluteAnchor) SetRowOffset(m _ac.Distance)

SetRowOffset sets the row offset of the top-left of the image in fixed units.

func (AbsoluteAnchor) SetWidth 

func (_fe AbsoluteAnchor) SetWidth(w _ac.Distance)

SetWidth sets the width of the anchored object.

func (AbsoluteAnchor) SetWidthCells 

func (_af AbsoluteAnchor) SetWidthCells(int32)

SetWidthCells is a no-op.

func (AbsoluteAnchor) TopLeft 

func (_fg AbsoluteAnchor) TopLeft() CellMarker

TopLeft is a no-op.

func (AbsoluteAnchor) Type 

func (_eba AbsoluteAnchor) Type() AnchorType

Type returns the type of anchor

type Anchor 

type Anchor interface {

	// BottomRight returns the CellMaker for the bottom right corner of the
	// anchor.
	BottomRight() CellMarker

	// TopLeft returns the CellMaker for the top left corner of the anchor.
	TopLeft() CellMarker

	// MoveTo repositions the anchor without changing the objects size.
	MoveTo(_cce, _ddgd int32)

	// SetWidth sets the width of the anchored object. It is not compatible with
	// SetWidthCells.
	SetWidth(_ad _ac.Distance)

	// SetWidthCells sets the height the anchored object by moving the right
	// hand side. It is not compatible with SetWidth.
	SetWidthCells(_gd int32)

	// SetHeight sets the height of the anchored object. It is not compatible
	// with SetHeightCells.
	SetHeight(_daa _ac.Distance)

	// SetHeightCells sets the height the anchored object by moving the bottom.
	// It is not compatible with SetHeight.
	SetHeightCells(_fd int32)

	// SetColOffset sets the column offset of the top-left anchor.
	SetColOffset(_ccc _ac.Distance)

	// SetRowOffset sets the row offset of the top-left anchor.
	SetRowOffset(_egb _ac.Distance)

	// Type returns the type of anchor
	Type() AnchorType
}

Anchor is the interface implemented by anchors. It's modeled after the most common anchor (Two cell variant with a from/to position), but will also be used for one-cell anchors. In that case the only non-noop methods are TopLeft/MoveTo/SetColOffset/SetRowOffset.

type AnchorType 

type AnchorType byte

AnchorType is the type of anchor. 

const (
	AnchorTypeAbsolute AnchorType = iota
	AnchorTypeOneCell
	AnchorTypeTwoCell
)

type Border 

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

Border is a cell border configuraton.

func (Border) Index 

func (_be Border) Index() uint32

Index returns the index of the border for use with a cell style.

func (Border) InitializeDefaults 

func (_egbd Border) InitializeDefaults()

InitializeDefaults initializes a border to its defaulte empty values.

func (Border) SetBottom 

func (_fb Border) SetBottom(style _agf.ST_BorderStyle, c _cb.Color)

func (Border) SetDiagonal 

func (_cfd Border) SetDiagonal(style _agf.ST_BorderStyle, c _cb.Color, up, down bool)

func (Border) SetLeft 

func (_df Border) SetLeft(style _agf.ST_BorderStyle, c _cb.Color)

func (Border) SetRight 

func (_ecc Border) SetRight(style _agf.ST_BorderStyle, c _cb.Color)

func (Border) SetTop 

func (_gg Border) SetTop(style _agf.ST_BorderStyle, c _cb.Color)

func (Border) X 

func (_bbg Border) X() *_agf.CT_Border

X returns the inner wrapped XML type.

type Cell 

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

Cell is a single cell within a sheet. 

func (_dfcb Cell) AddHyperlink(url string)

AddHyperlink creates and sets a hyperlink on a cell.

func (Cell) Clear 

func (_efd Cell) Clear()

Clear clears the cell's value and type.

func (Cell) Column 

func (_ebd Cell) Column() (string, error)

Column returns the cell column

func (Cell) GetCachedFormulaResult 

func (_cceg Cell) GetCachedFormulaResult() string

GetCachedFormulaResult returns the cached formula result if it exists. If the cell type is not a formula cell, the result will be the cell value if it's a string/number/bool cell.

func (Cell) GetFormattedValue 

func (_ebac Cell) GetFormattedValue() string

GetFormattedValue returns the formatted cell value as it would appear in Excel. This involves determining the format string to apply, parsing it, and then formatting the value according to the format string. This should only be used if you care about replicating what Excel would show, otherwise GetValueAsNumber()/GetValueAsTime

func (Cell) GetFormula 

func (_cbec Cell) GetFormula() string

GetFormula returns the formula for a cell.

func (Cell) GetRawValue 

func (_dbc Cell) GetRawValue() (string, error)

func (Cell) GetString 

func (_fcg Cell) GetString() string

GetString returns the string in a cell if it's an inline or string table string. Otherwise it returns an empty string.

func (Cell) GetValueAsBool 

func (_ddb Cell) GetValueAsBool() (bool, error)

GetValueAsBool retrieves the cell's value as a boolean

func (Cell) GetValueAsNumber 

func (_ebb Cell) GetValueAsNumber() (float64, error)

GetValueAsNumber retrieves the cell's value as a number

func (Cell) GetValueAsTime 

func (_cgd Cell) GetValueAsTime() (_ea.Time, error)

GetValueAsTime retrieves the cell's value as a time. There is no difference in SpreadsheetML between a time/date cell other than formatting, and that typically a date cell won't have a fractional component. GetValueAsTime will work for date cells as well.

func (Cell) HasFormula 

func (_dgaf Cell) HasFormula() bool

HasFormula returns true if the cell has an asoociated formula.

func (Cell) IsBool 

func (_gge Cell) IsBool() bool

IsBool returns true if the cell is a boolean type cell.

func (Cell) IsEmpty 

func (_cfcc Cell) IsEmpty() bool

IsEmpty returns true if the cell is empty.

func (Cell) IsError 

func (_cafe Cell) IsError() bool

IsError returns true if the cell is an error type cell.

func (Cell) IsNumber 

func (_ged Cell) IsNumber() bool

IsNumber returns true if the cell is a number type cell.

func (Cell) Reference 

func (_aca Cell) Reference() string

Reference returns the cell reference (e.g. "A4"). This is not required, however both gooffice and Excel will always set it.

func (Cell) SetBool 

func (_afe Cell) SetBool(v bool)

SetBool sets the cell type to boolean and the value to the given boolean value.

func (Cell) SetCachedFormulaResult 

func (_gdge Cell) SetCachedFormulaResult(s string)

SetCachedFormulaResult sets the cached result of a formula. This is normally not needed but is used internally when expanding an array formula.

func (Cell) SetDate 

func (_abd Cell) SetDate(d _ea.Time)

SetDate sets the cell value to a date. It's stored as the number of days past th sheet epoch. When we support v5 strict, we can store an ISO 8601 date string directly, however that's not allowed with v5 transitional (even though it works in Excel). The cell is not styled via this method, so it will display as a number. SetDateWithStyle should normally be used instead.

func (Cell) SetDateWithStyle 

func (_afd Cell) SetDateWithStyle(d _ea.Time)

SetDateWithStyle sets a date with the default date style applied.

func (Cell) SetError 

func (_bcbb Cell) SetError(msg string)

SetError sets the cell type to error and the value to the given error message.

func (Cell) SetFormulaArray 

func (_bg Cell) SetFormulaArray(s string)

SetFormulaArray sets the cell type to formula array, and the raw formula to the given string. This is equivlent to entering a formula and pressing Ctrl+Shift+Enter in Excel.

func (Cell) SetFormulaRaw 

func (_fbd Cell) SetFormulaRaw(s string)

SetFormulaRaw sets the cell type to formula, and the raw formula to the given string

func (Cell) SetFormulaShared 

func (_cad Cell) SetFormulaShared(formulaStr string, rows, cols uint32) error

SetFormulaShared sets the cell type to formula shared, and the raw formula to the given string. The range is the range of cells that the formula applies to, and is used to conserve disk space. 

func (_fae Cell) SetHyperlink(hl _dag.Hyperlink)

SetHyperlink sets a hyperlink on a cell.

func (Cell) SetInlineString 

func (_dfd Cell) SetInlineString(s string)

SetInlineString adds a string inline instead of in the shared strings table.

func (Cell) SetNumber 

func (_ccd Cell) SetNumber(v float64)

SetNumber sets the cell type to number, and the value to the given number

func (Cell) SetNumberWithStyle 

func (_bdg Cell) SetNumberWithStyle(v float64, f StandardFormat)

SetNumberWithStyle sets a number and applies a standard format to the cell.

func (Cell) SetRichTextString 

func (_bcf Cell) SetRichTextString() RichText

SetRichTextString sets the cell to rich string mode and returns a struct that can be used to add formatted text to the cell.

func (Cell) SetString 

func (_ggd Cell) SetString(s string) int

SetString sets the cell type to string, and the value to the given string, returning an ID from the shared strings table. To reuse a string, call SetStringByID with the ID returned.

func (Cell) SetStringByID 

func (_fcf Cell) SetStringByID(id int)

SetStringByID sets the cell type to string, and the value a string in the shared strings table.

func (Cell) SetStyle 

func (_gfg Cell) SetStyle(cs CellStyle)

SetStyle applies a style to a cell avoiding redundancy. The function checks if the given style already exists in the saved styles. If found, the existing style is reused; otherwise, the new style is added to the saved styles collection. The style is then applied to the cell. This style is referenced in the generated XML via CellStyle.Index().

func (Cell) SetStyleIndex 

func (_dce Cell) SetStyleIndex(idx uint32)

SetStyleIndex directly sets a style index to the cell. This should only be called with an index retrieved from CellStyle.Index()

func (Cell) SetTime 

func (_bfd Cell) SetTime(d _ea.Time)

SetTime sets the cell value to a date. It's stored as the number of days past th sheet epoch. When we support v5 strict, we can store an ISO 8601 date string directly, however that's not allowed with v5 transitional (even though it works in Excel).

func (Cell) X 

func (_cde Cell) X() *_agf.CT_Cell

X returns the inner wrapped XML type.

type CellMarker 

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

CellMarker represents a cell position

func (CellMarker) Col 

func (_bfc CellMarker) Col() int32

Col returns the column of the cell marker.

func (CellMarker) ColOffset 

func (_dac CellMarker) ColOffset() _ac.Distance

ColOffset returns the offset from the row cell.

func (CellMarker) Row 

func (_caa CellMarker) Row() int32

Row returns the row of the cell marker.

func (CellMarker) RowOffset 

func (_fgd CellMarker) RowOffset() _ac.Distance

RowOffset returns the offset from the row cell.

func (CellMarker) SetCol 

func (_ffg CellMarker) SetCol(col int32)

SetCol set the column of the cell marker.

func (CellMarker) SetColOffset 

func (_dbfd CellMarker) SetColOffset(m _ac.Distance)

SetColOffset sets a column offset in absolute distance.

func (CellMarker) SetRow 

func (_geee CellMarker) SetRow(row int32)

SetRow set the row of the cell marker.

func (CellMarker) SetRowOffset 

func (_gga CellMarker) SetRowOffset(m _ac.Distance)

SetRowOffset sets a column offset in absolute distance.

func (CellMarker) X 

func (_fef CellMarker) X() *_cgg.CT_Marker

X returns the inner wrapped XML type.

type CellStyle 

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

CellStyle is a formatting style for a cell. CellStyles are spreadsheet global and can be applied to cells across sheets.

func (CellStyle) ClearBorder 

func (_cda CellStyle) ClearBorder()

ClearBorder clears any border configuration from the cell style.

func (CellStyle) ClearFill 

func (_acde CellStyle) ClearFill()

ClearFill clears any fill configuration from the cell style.

func (CellStyle) ClearFont 

func (_eca CellStyle) ClearFont()

ClearFont clears any font configuration from the cell style.

func (CellStyle) ClearNumberFormat 

func (_affg CellStyle) ClearNumberFormat()

ClearNumberFormat removes any number formatting from the style.

func (CellStyle) GetBorder 

func (_dff CellStyle) GetBorder() *_agf.CT_Border

GetBorder gets a Border from a cell style.

func (CellStyle) GetFill 

func (_cbbg CellStyle) GetFill() *_agf.CT_Fill

GetFill gets a Fill from a cell style.

func (CellStyle) GetFont 

func (_gdd CellStyle) GetFont() *_agf.CT_Font

GetFont gets a Font from a cell style.

func (CellStyle) GetHorizontalAlignment 

func (_eaad CellStyle) GetHorizontalAlignment() _agf.ST_HorizontalAlignment

GetHorizontalAlignment sets the horizontal alignment of a cell style.

func (CellStyle) GetVerticalAlignment 

func (_gcgb CellStyle) GetVerticalAlignment() _agf.ST_VerticalAlignment

GetVerticalAlignment sets the vertical alignment of a cell style.

func (CellStyle) HasNumberFormat 

func (_bgf CellStyle) HasNumberFormat() bool

HasNumberFormat returns true if the cell style has a number format applied.

func (CellStyle) Index 

func (_dfb CellStyle) Index() uint32

func (CellStyle) IsEmpty 

func (_aec CellStyle) IsEmpty() bool

IsEmpty checks if the cell style contains nothing.

func (CellStyle) NumberFormat 

func (_fbc CellStyle) NumberFormat() uint32

NumberFormat returns the number format that the cell style uses, or zero if it is not set.

func (CellStyle) SetBorder 

func (_ece CellStyle) SetBorder(b Border)

SetBorder applies a border to a cell style avoiding redundancy. The function checks if the given border already exists in the saved borders. If found, the existing border is reused; otherwise, the new border is added to the saved borders collection. The border is then applied to the cell style, affecting all styles that reference it by index.

func (CellStyle) SetFill 

func (_dae CellStyle) SetFill(f Fill)

SetFill applies a fill to a cell style avoiding redundancy. The function checks if the given fill already exists in the saved fills. If found, the existing fill is reused; otherwise, the new fill is added to the saved fills collection. The fill is then applied to the cell style, affecting all styles that reference it by index.

func (CellStyle) SetFont 

func (_bdef CellStyle) SetFont(f Font)

SetFont applies a font to a cell style avoiding redundancy. The function checks if the given font already exists in the saved fonts. If found, the existing font is reused; otherwise, the new font is added to the saved fonts collection. The font is then applied to the cell style, affecting all styles that reference it by index.

func (CellStyle) SetHorizontalAlignment 

func (_cge CellStyle) SetHorizontalAlignment(a _agf.ST_HorizontalAlignment)

SetHorizontalAlignment sets the horizontal alignment of a cell style.

func (CellStyle) SetNumberFormat 

func (_gaa CellStyle) SetNumberFormat(s string)

SetNumberFormat applies a number format to a cell style avoiding redundancy. The function checks if the given string already exists in the saved number formats. If found, the existing number format is reused; otherwise, the new number format is added to the saved number formats collection. The number format is then applied to the cell style, affecting all styles that reference it by index.

func (CellStyle) SetNumberFormatStandard 

func (_cff CellStyle) SetNumberFormatStandard(s StandardFormat)

SetNumberFormatStandard sets the format based off of the ECMA 376 standard formats. These formats are standardized and don't need to be defined in the styles.

func (CellStyle) SetProtection 

func (_cfdg CellStyle) SetProtection(protected bool, hidden bool)

SetProtectedAndHidden sets protected and hidden for given cellStyle

func (CellStyle) SetRotation 

func (_fee CellStyle) SetRotation(deg uint8)

SetRotation configures the cell to be rotated.

func (CellStyle) SetShrinkToFit 

func (_gbga CellStyle) SetShrinkToFit(b bool)

func (CellStyle) SetVerticalAlignment 

func (_bee CellStyle) SetVerticalAlignment(a _agf.ST_VerticalAlignment)

SetVerticalAlignment sets the vertical alignment of a cell style.

func (CellStyle) SetWrapped 

func (_faa CellStyle) SetWrapped(b bool)

SetWrapped configures the cell to wrap text.

func (CellStyle) Wrapped 

func (_aag CellStyle) Wrapped() bool

Wrapped returns true if the cell will wrap text.

type CellText 

type CellText struct {
	Text string
	Cell Cell
}

CellText is used for keeping text with references to a cell where it is located.

type ColorScale 

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

ColorScale colors a cell background based off of the cell value.

func (ColorScale) AddFormatValue 

func (_bab ColorScale) AddFormatValue(t _agf.ST_CfvoType, val string)

AddFormatValue adds a format value to be used to determine the cell background.

func (ColorScale) AddGradientStop 

func (_gfe ColorScale) AddGradientStop(color _cb.Color)

AddGradientStop adds a color gradient stop.

func (ColorScale) X 

func (_aeb ColorScale) X() *_agf.CT_ColorScale

X returns the inner wrapped XML type.

type Column 

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

Column represents a column within a sheet. It's only used for formatting purposes, so it's possible to construct a sheet without configuring columns.

func (Column) SetHidden 

func (_ebae Column) SetHidden(b bool)

SetHidden controls the visibility of a column.

func (Column) SetStyle 

func (_aef Column) SetStyle(cs CellStyle)

SetStyle sets the cell style for an entire column.

func (Column) SetWidth 

func (_gec Column) SetWidth(w _ac.Distance)

SetWidth controls the width of a column.

func (Column) X 

func (_ace Column) X() *_agf.CT_Col

X returns the inner wrapped XML type.

type Comment 

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

Comment is a single comment within a sheet.

func (Comment) Author 

func (_cbg Comment) Author() string

Author returns the author of the comment

func (Comment) CellReference 

func (_gefe Comment) CellReference() string

CellReference returns the cell reference within a sheet that a comment refers to (e.g. "A1")

func (Comment) SetAuthor 

func (_efda Comment) SetAuthor(author string)

SetAuthor sets the author of the comment. If the comment body contains the author's name (as is the case with Excel and Comments.AddCommentWithStyle, it will not be changed). This method only changes the metadata author of the comment.

func (Comment) SetCellReference 

func (_edc Comment) SetCellReference(cellRef string)

SetCellReference sets the cell reference within a sheet that a comment refers to (e.g. "A1")

func (Comment) X 

func (_ggf Comment) X() *_agf.CT_Comment

X returns the inner wrapped XML type.

type Comments 

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

Comments is the container for comments for a single sheet.

func MakeComments 

func MakeComments(w *Workbook, x *_agf.Comments) Comments

MakeComments constructs a new Comments wrapper.

func (Comments) AddComment 

func (_fac Comments) AddComment(cellRef string, author string) RichText

AddComment adds a new comment and returns a RichText which will contain the styled comment text.

func (Comments) AddCommentWithStyle 

func (_ebf Comments) AddCommentWithStyle(cellRef string, author string, comment string) error

AddCommentWithStyle adds a new comment styled in a default way

func (Comments) Comments 

func (_fad Comments) Comments() []Comment

Comments returns the list of comments for this sheet

func (Comments) X 

func (_eab Comments) X() *_agf.Comments

X returns the inner wrapped XML type.

type Comparer 

type Comparer struct{ Order SortOrder }

Comparer is used to compare rows based off a column and cells based off of their value.

func (Comparer) LessCells 

func (_bbgg Comparer) LessCells(lhs, rhs Cell) bool

LessCells returns true if the lhs value is less than the rhs value. If the cells contain numeric values, their value interpreted as a floating point is compared. Otherwise their string contents are compared.

func (Comparer) LessRows 

func (_bge Comparer) LessRows(column string, lhs, rhs Row) bool

LessRows compares two rows based off of a column. If the column doesn't exist in one row, that row is 'less'.

type ConditionalFormatting 

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

ConditionalFormatting controls the formatting styles and rules for a range of cells with the same conditional formatting.

func (ConditionalFormatting) AddRule 

func (_accb ConditionalFormatting) AddRule() ConditionalFormattingRule

AddRule adds and returns a new rule that can be configured.

func (ConditionalFormatting) X 

func (_bdd ConditionalFormatting) X() *_agf.CT_ConditionalFormatting

X returns the inner wrapped XML type.

type ConditionalFormattingRule 

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

func (ConditionalFormattingRule) InitializeDefaults 

func (_edcf ConditionalFormattingRule) InitializeDefaults()

func (ConditionalFormattingRule) Operator 

func (_gca ConditionalFormattingRule) Operator() _agf.ST_ConditionalFormattingOperator

Operator returns the operator for the rule

func (ConditionalFormattingRule) Priority 

func (_fag ConditionalFormattingRule) Priority() int32

Priority returns the rule priority

func (ConditionalFormattingRule) SetColorScale 

func (_ced ConditionalFormattingRule) SetColorScale() ColorScale

SetColorScale configures the rule as a color scale, removing existing configuration.

func (ConditionalFormattingRule) SetConditionValue 

func (_ggfd ConditionalFormattingRule) SetConditionValue(v string)

SetConditionValue sets the condition value to be used for style applicaton.

func (ConditionalFormattingRule) SetDataBar 

func (_cfdga ConditionalFormattingRule) SetDataBar() DataBarScale

SetDataBar configures the rule as a data bar, removing existing configuration.

func (ConditionalFormattingRule) SetIcons 

func (_bfcc ConditionalFormattingRule) SetIcons() IconScale

SetIcons configures the rule as an icon scale, removing existing configuration.

func (ConditionalFormattingRule) SetOperator 

func (_daee ConditionalFormattingRule) SetOperator(t _agf.ST_ConditionalFormattingOperator)

SetOperator sets the operator for the rule.

func (ConditionalFormattingRule) SetPriority 

func (_aebc ConditionalFormattingRule) SetPriority(p int32)

SetPriority sets the rule priority

func (ConditionalFormattingRule) SetStyle 

func (_fde ConditionalFormattingRule) SetStyle(d DifferentialStyle)

SetStyle sets the style to be used for conditional rules

func (ConditionalFormattingRule) SetType 

func (_cag ConditionalFormattingRule) SetType(t _agf.ST_CfType)

SetType sets the type of the rule.

func (ConditionalFormattingRule) Type 

func (_gfd ConditionalFormattingRule) Type() _agf.ST_CfType

Type returns the type of the rule

func (ConditionalFormattingRule) X 

func (_fgeb ConditionalFormattingRule) X() *_agf.CT_CfRule

X returns the inner wrapped XML type.

type DVCompareOp 

type DVCompareOp byte

DVCompareOp is a comparison operator for a data validation rule.

type DVCompareType 

type DVCompareType byte

DVCompareType is a comparison type for a data validation rule. This restricts the input format of the cell.

type DataBarScale 

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

DataBarScale is a colored scale that fills the cell with a background gradeint depending on the value.

func (DataBarScale) AddFormatValue 

func (_eceac DataBarScale) AddFormatValue(t _agf.ST_CfvoType, val string)

AddFormatValue adds a format value (databars require two).

func (DataBarScale) SetColor 

func (_eaba DataBarScale) SetColor(c _cb.Color)

SetColor sets teh color of the databar.

func (DataBarScale) SetMaxLength 

func (_cfe DataBarScale) SetMaxLength(l uint32)

SetMaxLength sets the maximum bar length in percent.

func (DataBarScale) SetMinLength 

func (_gead DataBarScale) SetMinLength(l uint32)

SetMinLength sets the minimum bar length in percent.

func (DataBarScale) SetShowValue 

func (_acb DataBarScale) SetShowValue(b bool)

SetShowValue controls if the cell value is displayed.

func (DataBarScale) X 

func (_fea DataBarScale) X() *_agf.CT_DataBar

X returns the inner wrapped XML type.

type DataValidation 

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

DataValidation controls cell validation

func (DataValidation) SetAllowBlank 

func (_aba DataValidation) SetAllowBlank(b bool)

SetAllowBlank controls if blank values are accepted.

func (DataValidation) SetComparison 

func (_dgb DataValidation) SetComparison(t DVCompareType, op DVCompareOp) DataValidationCompare

func (DataValidation) SetList 

func (_eae DataValidation) SetList() DataValidationList

func (DataValidation) SetRange 

func (_egd DataValidation) SetRange(cellRange string)

SetRange sets the cell or range of cells that the validation should apply to. It can be a single cell (e.g. "A1") or a range of cells (e.g. "A1:B5")

func (DataValidation) X 

func (_bfdc DataValidation) X() *_agf.CT_DataValidation

X returns the inner wrapped XML type.

type DataValidationCompare 

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

DataValidationCompare is a view on a data validation rule that is oriented towards value comparisons.

func (DataValidationCompare) SetValue 

func (_age DataValidationCompare) SetValue(v string)

SetValue sets the first value to be used in the comparison. For comparisons that need only one value, this is the only value used. For comparisons like 'between' that require two values, SetValue2 must also be used.

func (DataValidationCompare) SetValue2 

func (_efgc DataValidationCompare) SetValue2(v string)

type DataValidationList 

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

DataValidationList is just a view on a DataValidation configured as a list. It presents a drop-down combo box for spreadsheet users to select values. The contents of the dropdown can either pull from a rang eof cells (SetRange) or specified directly (SetValues).

func (DataValidationList) SetRange 

func (_adg DataValidationList) SetRange(cellRange string)

SetRange sets the range that contains the possible values. This is incompatible with SetValues.

func (DataValidationList) SetValues 

func (_fgfd DataValidationList) SetValues(values []string)

SetValues sets the possible values. This is incompatible with SetRange.

type DefinedName 

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

DefinedName is a named range, formula, etc.

func (DefinedName) Content 

func (_fgcg DefinedName) Content() string

Content returns the content of the defined range (the range in most cases)/

func (DefinedName) Name 

func (_ggdga DefinedName) Name() string

Name returns the name of the defined name.

func (DefinedName) SetContent 

func (_beac DefinedName) SetContent(s string)

SetContent sets the defined name content.

func (DefinedName) SetHidden 

func (_ffce DefinedName) SetHidden(b bool)

SetHidden marks the defined name as hidden.

func (DefinedName) SetLocalSheetID 

func (_gfed DefinedName) SetLocalSheetID(id uint32)

SetHidden marks the defined name as hidden.

func (DefinedName) X 

func (_bad DefinedName) X() *_agf.CT_DefinedName

X returns the inner wrapped XML type.

type DifferentialStyle 

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

func (DifferentialStyle) Fill 

func (_abaa DifferentialStyle) Fill() Fill

func (DifferentialStyle) Index 

func (_cee DifferentialStyle) Index() uint32

Index returns the index of the differential style.

func (DifferentialStyle) X 

func (_gaef DifferentialStyle) X() *_agf.CT_Dxf

X returns the inner wrapped XML type.

type Drawing 

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

Drawing is a drawing overlay on a sheet. Only a single drawing is allowed per sheet, so to display multiple charts and images on a single sheet, they must be added to the same drawing.

func (Drawing) AddChart 

func (_efc Drawing) AddChart(at AnchorType) (_gb.Chart, Anchor)

AddChart adds an chart to a drawing, returning the chart and an anchor that can be used to position the chart within the sheet.

func (Drawing) AddImage 

func (_bbba Drawing) AddImage(img _dag.ImageRef, at AnchorType) Anchor

AddImage adds an image with a paricular anchor type, returning an anchor to allow adusting the image size/position.

func (Drawing) X 

func (_fgea Drawing) X() *_cgg.WsDr

X returns the inner wrapped XML type.

type Fill 

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

func (Fill) Index 

func (_fage Fill) Index() uint32

func (Fill) SetPatternFill 

func (_fbfd Fill) SetPatternFill() PatternFill

type Fills 

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

func NewFills 

func NewFills() Fills

func (Fills) AddFill 

func (_ded Fills) AddFill() Fill

AddFill creates a new empty Fill style.

func (Fills) X 

func (_gfge Fills) X() *_agf.CT_Fills

type Font 

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

Font allows editing fonts within a spreadsheet stylesheet.

func (Font) Index 

func (_fgg Font) Index() uint32

func (Font) SetBold 

func (_eee Font) SetBold(b bool)

func (Font) SetColor 

func (_abdc Font) SetColor(c _cb.Color)

func (Font) SetItalic 

func (_eefg Font) SetItalic(b bool)

func (Font) SetName 

func (_ecbe Font) SetName(name string)

func (Font) SetSize 

func (_egc Font) SetSize(size float64)

func (Font) X 

func (_ffed Font) X() *_agf.CT_Font

X returns the inner wrapped XML type.

type IconScale 

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

IconScale maps values to icons.

func (IconScale) AddFormatValue 

func (_fda IconScale) AddFormatValue(t _agf.ST_CfvoType, val string)

AddFormatValue adds a format value to be used in determining which icons to display.

func (IconScale) SetIcons 

func (_afc IconScale) SetIcons(t _agf.ST_IconSetType)

SetIcons sets the icon set to use for display.

func (IconScale) X 

func (_cagb IconScale) X() *_agf.CT_IconSet

X returns the inner wrapped XML type.

type MergedCell 

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

func (MergedCell) Cell 

func (_geab MergedCell) Cell() Cell

Cell returns the actual cell behind the merged region

func (MergedCell) Reference 

func (_afcg MergedCell) Reference() string

Reference returns the region of cells that are merged.

func (MergedCell) SetReference 

func (_gbe MergedCell) SetReference(ref string)

SetReference sets the regin of cells that the merged cell applies to.

func (MergedCell) X 

func (_bdda MergedCell) X() *_agf.CT_MergeCell

X returns the inner wrapped XML type.

type NumberFormat 

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

NumberFormat is a number formatting string that can be applied to a cell style.

func CreateDefaultNumberFormat 

func CreateDefaultNumberFormat(id StandardFormat) NumberFormat

func (NumberFormat) GetFormat 

func (_bcbc NumberFormat) GetFormat() string

GetFormat sets the number format code.

func (NumberFormat) ID 

func (_cbbc NumberFormat) ID() uint32

ID returns the number format ID. This is not an index as there are some predefined number formats which can be used in cell styles and don't need a corresponding NumberFormat.

func (NumberFormat) SetFormat 

func (_dbgd NumberFormat) SetFormat(f string)

SetFormat sets the number format code.

func (NumberFormat) X 

func (_acf NumberFormat) X() *_agf.CT_NumFmt

X returns the inner wrapped XML type.

type OneCellAnchor 

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

OneCellAnchor is anchored to a top-left cell with a fixed with/height in distance.

func (OneCellAnchor) BottomRight 

func (_ffgd OneCellAnchor) BottomRight() CellMarker

BottomRight is a no-op.

func (OneCellAnchor) MoveTo 

func (_ggfb OneCellAnchor) MoveTo(col, row int32)

MoveTo moves the top-left of the anchored object.

func (OneCellAnchor) SetColOffset 

func (_gggd OneCellAnchor) SetColOffset(m _ac.Distance)

SetColOffset sets the column offset of the top-left anchor.

func (OneCellAnchor) SetHeight 

func (_acag OneCellAnchor) SetHeight(h _ac.Distance)

SetHeight sets the height of the anchored object.

func (OneCellAnchor) SetHeightCells 

func (_daabf OneCellAnchor) SetHeightCells(int32)

SetHeightCells is a no-op.

func (OneCellAnchor) SetRowOffset 

func (_agb OneCellAnchor) SetRowOffset(m _ac.Distance)

SetRowOffset sets the row offset of the top-left anchor.

func (OneCellAnchor) SetWidth 

func (_gbbf OneCellAnchor) SetWidth(w _ac.Distance)

SetWidth sets the width of the anchored object.

func (OneCellAnchor) SetWidthCells 

func (_aeac OneCellAnchor) SetWidthCells(int32)

SetWidthCells is a no-op.

func (OneCellAnchor) TopLeft 

func (_ccgd OneCellAnchor) TopLeft() CellMarker

TopLeft returns the top-left corner of the anchored object.

func (OneCellAnchor) Type 

func (_abdb OneCellAnchor) Type() AnchorType

Type returns the type of anchor

type PatternFill 

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

func NewPatternFill 

func NewPatternFill(fills *_agf.CT_Fills) PatternFill

func (PatternFill) ClearBgColor 

func (_cfbaa PatternFill) ClearBgColor()

func (PatternFill) ClearFgColor 

func (_ggfc PatternFill) ClearFgColor()

func (PatternFill) SetBgColor 

func (_gagde PatternFill) SetBgColor(c _cb.Color)

func (PatternFill) SetFgColor 

func (_cdcb PatternFill) SetFgColor(c _cb.Color)

SetFgColor sets the *fill* foreground color. As an example, the solid pattern foreground color becomes the background color of the cell when applied.

func (PatternFill) SetPattern 

func (_ddbd PatternFill) SetPattern(p _agf.ST_PatternType)

SetPattern sets the pattern of the fill.

func (PatternFill) X 

func (_cdff PatternFill) X() *_agf.CT_PatternFill

type RichText 

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

RichText is a container for the rich text within a cell. It's similar to a paragaraph for a document, except a cell can only contain one rich text item.

func (RichText) AddRun 

func (_aabae RichText) AddRun() RichTextRun

AddRun adds a new run of text to the cell.

func (RichText) X 

func (_acef RichText) X() *_agf.CT_Rst

X returns the inner wrapped XML type.

type RichTextRun 

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

RichTextRun is a segment of text within a cell that is directly formatted.

func (RichTextRun) SetBold 

func (_bdec RichTextRun) SetBold(b bool)

SetBold causes the text to be displayed in bold.

func (RichTextRun) SetColor 

func (_ebe RichTextRun) SetColor(c _cb.Color)

SetColor sets the text color.

func (RichTextRun) SetFont 

func (_bfa RichTextRun) SetFont(s string)

SetFont sets the font name for a rich text run.

func (RichTextRun) SetItalic 

func (_gedc RichTextRun) SetItalic(b bool)

SetItalic causes the text to be displayed in italic.

func (RichTextRun) SetSize 

func (_gbd RichTextRun) SetSize(m _ac.Distance)

SetSize sets the text size for a rich text run.

func (RichTextRun) SetText 

func (_cggbe RichTextRun) SetText(s string)

SetText sets the text to be displayed.

func (RichTextRun) SetUnderline 

func (_aed RichTextRun) SetUnderline(u _agf.ST_UnderlineValues)

SetUnderline controls if the run is underlined.

func (RichTextRun) X 

func (_afef RichTextRun) X() *_agf.CT_RElt

X returns the inner wrapped XML type.

type Row 

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

Row is a row within a spreadsheet.

func (Row) AddCell 

func (_bae Row) AddCell() Cell

AddCell adds a cell to a spreadsheet.

func (Row) AddNamedCell 

func (_fecf Row) AddNamedCell(col string) Cell

AddNamedCell adds a new named cell to a row and returns it. You should normally prefer Cell() as it will return the existing cell if the cell already exists, while AddNamedCell will duplicate the cell creating an invaild spreadsheet.

func (Row) Cell 

func (_bfeg Row) Cell(col string) Cell

Cell retrieves or adds a new cell to a row. Col is the column (e.g. 'A', 'B')

func (Row) Cells 

func (_eadgb Row) Cells() []Cell

Cells returns a slice of cells. The cells can be manipulated, but appending to the slice will have no effect.

func (Row) CellsWithEmpty 

func (_baba Row) CellsWithEmpty(lastColIdx uint32) []Cell

CellsWithEmpty returns a slice of cells including empty ones from the first column to the last one used in the sheet. The cells can be manipulated, but appending to the slice will have no effect.

func (Row) IsHidden 

func (_fggd Row) IsHidden() bool

IsHidden returns whether the row is hidden or not.

func (Row) RowNumber 

func (_cfbb Row) RowNumber() uint32

RowNumber returns the row number (1-N), or zero if it is unset.

func (Row) SetHeight 

func (_fgfa Row) SetHeight(d _ac.Distance)

SetHeight sets the row height in points.

func (Row) SetHeightAuto 

func (_baad Row) SetHeightAuto()

SetHeightAuto sets the row height to be automatically determined.

func (Row) SetHidden 

func (_eeeb Row) SetHidden(hidden bool)

SetHidden hides or unhides the row

func (Row) X 

func (_fbfb Row) X() *_agf.CT_Row

X returns the inner wrapped XML type.

type SharedStrings 

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

SharedStrings is a shared strings table, where string data can be placed outside of the sheet contents and referenced from a sheet.

func NewSharedStrings 

func NewSharedStrings() SharedStrings

NewSharedStrings constructs a new Shared Strings table.

func (SharedStrings) AddString 

func (_gccf SharedStrings) AddString(v string) int

AddString adds a string to the shared string cache.

func (SharedStrings) GetString 

func (_gbgd SharedStrings) GetString(id int) (string, error)

GetString retrieves a string from the shared strings table by index.

func (SharedStrings) X 

func (_cdeg SharedStrings) X() *_agf.Sst

X returns the inner wrapped XML type.

type Sheet 

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

Sheet is a single sheet within a workbook.

func (*Sheet) AddConditionalFormatting 

func (_fbff *Sheet) AddConditionalFormatting(cellRanges []string) ConditionalFormatting

AddConditionalFormatting adds conditional formatting to the sheet.

func (*Sheet) AddDataValidation 

func (_beaca *Sheet) AddDataValidation() DataValidation

AddDataValidation adds a data validation rule to a sheet. 

func (_cbfa *Sheet) AddHyperlink(url string) _dag.Hyperlink

AddHyperlink adds a hyperlink to a sheet. Adding the hyperlink to the sheet and setting it on a cell is more efficient than setting hyperlinks directly on a cell.

func (*Sheet) AddMergedCells 

func (_eff *Sheet) AddMergedCells(fromRef, toRef string) MergedCell

AddMergedCells merges cells within a sheet.

func (*Sheet) AddNumberedRow 

func (_fbgd *Sheet) AddNumberedRow(rowNum uint32) Row

AddNumberedRow adds a row with a given row number. If you reuse a row number the resulting file will fail validation and fail to open in Office programs. Use Row instead which creates a new row or returns an existing row.

func (*Sheet) AddRow 

func (_geade *Sheet) AddRow() Row

AddRow adds a new row to a sheet. You can mix this with numbered rows, however it will get confusing. You should prefer to use either automatically numbered rows with AddRow or manually numbered rows with Row/AddNumberedRow

func (*Sheet) AddView 

func (_fbag *Sheet) AddView() SheetView

AddView adds a sheet view.

func (*Sheet) Cell 

func (_dbab *Sheet) Cell(cellRef string) Cell

Cell creates or returns a cell given a cell reference of the form 'A10'

func (*Sheet) ClearAutoFilter 

func (_cabb *Sheet) ClearAutoFilter()

ClearAutoFilter removes the autofilters from the sheet.

func (*Sheet) ClearCachedFormulaResults 

func (_cbge *Sheet) ClearCachedFormulaResults()

ClearCachedFormulaResults clears any computed formula values that are stored in the sheet. This may be required if you modify cells that are used as a formula input to force the formulas to be recomputed the next time the sheet is opened in Excel.

func (*Sheet) ClearProtection 

func (_gfff *Sheet) ClearProtection()

ClearProtection removes any protections applied to teh sheet.

func (*Sheet) ClearSheetViews 

func (_agad *Sheet) ClearSheetViews()

ClearSheetViews clears the list of sheet views. This will clear the results of AddView() or SetFrozen.

func (*Sheet) Column 

func (_dgee *Sheet) Column(idx uint32) Column

Column returns or creates a column that with a given index (1-N). Columns can span multiple column indices, this method will return the column that applies to a column index if it exists or create a new column that only applies to the index passed in otherwise.

func (*Sheet) Comments 

func (_eddf *Sheet) Comments() Comments

Comments returns the comments for a sheet.

func (Sheet) Extents 

func (_aacg Sheet) Extents() string

Extents returns the sheet extents in the form "A1:B15". This requires scanning the entire sheet.

func (Sheet) ExtentsIndex 

func (_fcgg Sheet) ExtentsIndex() (string, uint32, string, uint32)

func (*Sheet) ExtractText 

func (_bebab *Sheet) ExtractText() *SheetText

ExtractText returns text from the sheet as a SheetText object.

func (*Sheet) FormulaContext 

func (_cbfeb *Sheet) FormulaContext() _ef.Context

FormulaContext returns a formula evaluation context that can be used to evaluate formaulas.

func (*Sheet) GetDrawing 

func (_cacd *Sheet) GetDrawing() (*_cgg.WsDr, _dag.Relationships)

GetDrawing return the worksheet drawing and its relationships if exists.

func (*Sheet) InitialView 

func (_cfegd *Sheet) InitialView() SheetView

InitialView returns the first defined sheet view. If there are no views, one is created and returned.

func (*Sheet) InsertRow 

func (_cadd *Sheet) InsertRow(rowNum int) Row

InsertRow inserts a new row into a spreadsheet at a particular row number. This row will now be the row number specified, and any rows after it will be renumbed.

func (Sheet) IsValid 

func (_bgff Sheet) IsValid() bool

func (Sheet) MaxColumnIdx 

func (_ada Sheet) MaxColumnIdx() uint32

MaxColumnIdx returns the max used column of the sheet.

func (*Sheet) MergedCells 

func (_daae *Sheet) MergedCells() []MergedCell

MergedCells returns the merged cell regions within the sheet.

func (Sheet) Name 

func (_dddb Sheet) Name() string

Name returns the sheet name

func (*Sheet) Protection 

func (_bfae *Sheet) Protection() SheetProtection

Protection controls the protection on an individual sheet.

func (Sheet) RangeReference 

func (_fcaa Sheet) RangeReference(n string) string

RangeReference converts a range reference of the form 'A1:A5' to 'Sheet 1'!$A$1:$A$5 . Renaming a sheet after calculating a range reference will invalidate the reference.

func (*Sheet) RecalculateFormulas 

func (_abae *Sheet) RecalculateFormulas()

RecalculateFormulas re-computes any computed formula values that are stored in the sheet. As gooffice formula support is still new and not all functins are supported, if formula execution fails either due to a parse error or missing function, or erorr in the result (even if expected) the cached value will be left empty allowing Excel to recompute it on load.

func (*Sheet) RemoveColumn 

func (_cgaa *Sheet) RemoveColumn(column string) error

RemoveColumn removes column from the sheet and moves all columns to the right of the removed column one step left.

func (*Sheet) RemoveMergedCell 

func (_affb *Sheet) RemoveMergedCell(mc MergedCell)

RemoveMergedCell removes merging from a cell range within a sheet. The cells that made up the merged cell remain, but are no lon merged.

func (*Sheet) Row 

func (_aeaa *Sheet) Row(rowNum uint32) Row

Row will return a row with a given row number, creating a new row if necessary.

func (*Sheet) Rows 

func (_dcfb *Sheet) Rows() []Row

Rows returns all of the rows in a sheet.

func (*Sheet) SetAutoFilter 

func (_gbgag *Sheet) SetAutoFilter(rangeRef string)

SetAutoFilter creates autofilters on the sheet. These are the automatic filters that are common for a header row. The RangeRef should be of the form "A1:C5" and cover the entire range of cells to be filtered, not just the header. SetAutoFilter replaces any existing auto filter on the sheet.

func (*Sheet) SetBorder 

func (_fefg *Sheet) SetBorder(cellRange string, border Border) error

SetBorder is a helper function for creating borders across multiple cells. In the OOXML spreadsheet format, a border applies to a single cell. To draw a 'boxed' border around multiple cells, you need to apply different styles to the cells on the top,left,right,bottom and four corners. This function breaks apart a single border into its components and applies it to cells as needed to give the effect of a border applying to multiple cells.

func (*Sheet) SetDrawing 

func (_efgcc *Sheet) SetDrawing(d Drawing)

SetDrawing sets the worksheet drawing. A worksheet can have a reference to a single drawing, but the drawing can have many charts.

func (*Sheet) SetFrozen 

func (_facbd *Sheet) SetFrozen(firstRow, firstCol bool)

SetFrozen removes any existing sheet views and creates a new single view with either the first row, first column or both frozen.

func (*Sheet) SetName 

func (_cdcda *Sheet) SetName(name string)

SetName sets the sheet name.

func (*Sheet) SheetViews 

func (_bgec *Sheet) SheetViews() []SheetView

SheetViews returns the sheet views defined. This is where splits and frozen rows/cols are configured. Multiple sheet views are allowed, but I'm not aware of there being a use for more than a single sheet view.

func (*Sheet) Sort 

func (_cccae *Sheet) Sort(column string, firstRow uint32, order SortOrder)

Sort sorts all of the rows within a sheet by the contents of a column. As the file format doesn't suppot indicating that a column should be sorted by the viewing/editing program, we actually need to reorder rows and change cell references during a sort. If the sheet contains formulas, you should call RecalculateFormulas() prior to sorting. The column is in the form "C" and specifies the column to sort by. The firstRow is a 1-based index and specifies the firstRow to include in the sort, allowing skipping over a header row.

func (Sheet) Validate 

func (_ebbb Sheet) Validate() error

Validate validates the sheet, returning an error if it is found to be invalid.

func (Sheet) ValidateWithPath 

func (_aeba Sheet) ValidateWithPath(path string) error

ValidateWithPath validates the sheet passing path informaton for a better error message

func (*Sheet) Workbook 

func (_afbe *Sheet) Workbook() *Workbook

Workbook returns sheet's parent workbook.

func (Sheet) X 

func (_dagd Sheet) X() *_agf.Worksheet

X returns the inner wrapped XML type.

type SheetProtection 

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

func (SheetProtection) IsObjectLocked 

func (_cgcf SheetProtection) IsObjectLocked() bool

IsSheetLocked returns whether the sheet objects are locked.

func (SheetProtection) IsSheetLocked 

func (_gbcc SheetProtection) IsSheetLocked() bool

IsSheetLocked returns whether the sheet is locked.

func (SheetProtection) LockObject 

func (_cgda SheetProtection) LockObject(b bool)

LockObject controls the locking of the sheet objects.

func (SheetProtection) LockSheet 

func (_gbaaa SheetProtection) LockSheet(b bool)

LockSheet controls the locking of the sheet.

func (SheetProtection) PasswordHash 

func (_gdcdc SheetProtection) PasswordHash() string

PasswordHash returns the hash of the workbook password.

func (SheetProtection) SetPassword 

func (_edff SheetProtection) SetPassword(pw string)

SetPassword sets the password hash to a hash of the input password.

func (SheetProtection) SetPasswordHash 

func (_gce SheetProtection) SetPasswordHash(pwHash string)

SetPasswordHash sets the password hash to the input.

func (SheetProtection) X 

func (_ggadb SheetProtection) X() *_agf.CT_SheetProtection

X returns the inner wrapped XML type.

type SheetText 

type SheetText struct{ Cells []CellText }

SheetText is an array of extracted text items which has some methods for representing extracted text from a sheet.

func (*SheetText) Text 

func (_edeb *SheetText) Text() string

Text returns text from the sheet as one string separated with line breaks.

type SheetView 

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

SheetView is a view of a sheet. There is typically one per sheet, though more are supported.

func (SheetView) SetShowRuler 

func (_gccfb SheetView) SetShowRuler(b bool)

SetShowRuler controls the visibility of the ruler

func (SheetView) SetState 

func (_ccaf SheetView) SetState(st _agf.ST_PaneState)

SetState sets the sheet view state (frozen/split/frozen-split)

func (SheetView) SetTopLeft 

func (_cagbb SheetView) SetTopLeft(cellRef string)

SetTopLeft sets the top left visible cell after the split.

func (SheetView) SetXSplit 

func (_baab SheetView) SetXSplit(v float64)

SetXSplit sets the column split point

func (SheetView) SetYSplit 

func (_dgfc SheetView) SetYSplit(v float64)

SetYSplit sets the row split point

func (SheetView) SetZoom 

func (_bgbg SheetView) SetZoom(pct uint32)

SetZoom controls the zoom level of the sheet and is measured in percent. The default value is 100.

func (SheetView) X 

func (_faf SheetView) X() *_agf.CT_SheetView

X returns the inner wrapped XML type.

type SortOrder 

type SortOrder byte

SortOrder is a column sort order. 

const (
	SortOrderAscending SortOrder = iota
	SortOrderDescending
)

func (SortOrder) String 

func (_ddcb SortOrder) String() string

type StandardFormat 

type StandardFormat uint32

StandardFormat is a standard ECMA 376 number format. 

const (
	StandardFormatGeneral     StandardFormat = 0
	StandardFormat0           StandardFormat = 0
	StandardFormatWholeNumber StandardFormat = 1
	StandardFormat1           StandardFormat = 1
	StandardFormat2           StandardFormat = 2
	StandardFormat3           StandardFormat = 3
	StandardFormat4           StandardFormat = 4
	StandardFormatPercent     StandardFormat = 9
	StandardFormat9           StandardFormat = 9
	StandardFormat10          StandardFormat = 10
	StandardFormat11          StandardFormat = 11
	StandardFormat12          StandardFormat = 12
	StandardFormat13          StandardFormat = 13
	StandardFormatDate        StandardFormat = 14
	StandardFormat14          StandardFormat = 14
	StandardFormat15          StandardFormat = 15
	StandardFormat16          StandardFormat = 16
	StandardFormat17          StandardFormat = 17
	StandardFormat18          StandardFormat = 18
	StandardFormatTime        StandardFormat = 19
	StandardFormat19          StandardFormat = 19
	StandardFormat20          StandardFormat = 20
	StandardFormat21          StandardFormat = 21
	StandardFormatDateTime    StandardFormat = 22
	StandardFormat22          StandardFormat = 22
	StandardFormat37          StandardFormat = 37
	StandardFormat38          StandardFormat = 38
	StandardFormat39          StandardFormat = 39
	StandardFormat40          StandardFormat = 40
	StandardFormat45          StandardFormat = 45
	StandardFormat46          StandardFormat = 46
	StandardFormat47          StandardFormat = 47
	StandardFormat48          StandardFormat = 48
	StandardFormat49          StandardFormat = 49
)

func (StandardFormat) String 

func (_gffg StandardFormat) String() string

type StyleSheet 

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

StyleSheet is a document style sheet.

func NewStyleSheet 

func NewStyleSheet(wb *Workbook) StyleSheet

NewStyleSheet constructs a new default stylesheet.

func (StyleSheet) AddBorder 

func (_eeac StyleSheet) AddBorder() Border

AddBorder creates a new empty Border style.

func (StyleSheet) AddCellStyle 

func (_afab StyleSheet) AddCellStyle() CellStyle

AddCellStyle creates a new empty cell style.

func (StyleSheet) AddDifferentialStyle 

func (_dcef StyleSheet) AddDifferentialStyle() DifferentialStyle

AddDifferentialStyle adds a new empty differential cell style to the stylesheet.

func (StyleSheet) AddFont 

func (_cbbcg StyleSheet) AddFont() Font

AddFont creates a new empty Font style.

func (StyleSheet) AddNumberFormat 

func (_cbce StyleSheet) AddNumberFormat() NumberFormat

AddNumberFormat adds a new blank number format to the stylesheet.

func (StyleSheet) Borders 

func (_cebc StyleSheet) Borders() []Border

Borders returns the list of borders defined in the stylesheet.

func (StyleSheet) CellStyles 

func (_bfad StyleSheet) CellStyles() []CellStyle

CellStyles returns the list of defined cell styles

func (StyleSheet) Fills 

func (_ecaf StyleSheet) Fills() Fills

Fills returns a Fills object that can be used to add/create/edit fills.

func (StyleSheet) Fonts 

func (_fcaad StyleSheet) Fonts() []Font

Fonts returns the list of fonts defined in the stylesheet.

func (StyleSheet) GetCellStyle 

func (_egcb StyleSheet) GetCellStyle(id uint32) CellStyle

func (StyleSheet) GetNumberFormat 

func (_fcda StyleSheet) GetNumberFormat(id uint32) NumberFormat

func (StyleSheet) GetOrCreateStandardNumberFormat 

func (_fefca StyleSheet) GetOrCreateStandardNumberFormat(f StandardFormat) CellStyle

GetOrCreateStandardNumberFormat gets or creates a cell style with a given standard format. This should only be used when you want to perform number/date/time formatting only. Manipulating the style returned will cause all cells using style returned from this for a given format to be formatted.

func (StyleSheet) RemoveFont 

func (_aaca StyleSheet) RemoveFont(f Font) error

RemoveFont removes a font from the style sheet. It *does not* update styles that refer to this font.

func (StyleSheet) X 

func (_aaedg StyleSheet) X() *_agf.StyleSheet

X returns the inner XML entity for a stylesheet.

type Table 

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

func (Table) Name 

func (_efdab Table) Name() string

Name returns the name of the table

func (Table) Reference 

func (_cccb Table) Reference() string

Reference returns the table reference (the cells within the table)

func (Table) X 

func (_fdfc Table) X() *_agf.Table

X returns the inner wrapped XML type.

type TwoCellAnchor 

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

TwoCellAnchor is an anchor that is attached to a top-left cell with a fixed width/height in cells.

func (TwoCellAnchor) BottomRight 

func (_cebe TwoCellAnchor) BottomRight() CellMarker

BottomRight returns the CellMaker for the bottom right corner of the anchor.

func (TwoCellAnchor) MoveTo 

func (_ebed TwoCellAnchor) MoveTo(col, row int32)

MoveTo repositions the anchor without changing the objects size.

func (TwoCellAnchor) SetColOffset 

func (_dbee TwoCellAnchor) SetColOffset(m _ac.Distance)

SetColOffset sets the column offset of the two cell anchor.

func (TwoCellAnchor) SetHeight 

func (_fed TwoCellAnchor) SetHeight(h _ac.Distance)

SetHeight is a nop-op.

func (TwoCellAnchor) SetHeightCells 

func (_ggabg TwoCellAnchor) SetHeightCells(h int32)

SetHeightCells sets the height the anchored object by moving the bottom. It is not compatible with SetHeight.

func (TwoCellAnchor) SetRowOffset 

func (_bcgd TwoCellAnchor) SetRowOffset(m _ac.Distance)

SetRowOffset sets the row offset of the two cell anchor

func (TwoCellAnchor) SetWidth 

func (_abga TwoCellAnchor) SetWidth(w _ac.Distance)

SetWidth is a no-op.

func (TwoCellAnchor) SetWidthCells 

func (_fgee TwoCellAnchor) SetWidthCells(w int32)

SetWidthCells sets the height the anchored object by moving the right hand side. It is not compatible with SetWidth.

func (TwoCellAnchor) TopLeft 

func (_daece TwoCellAnchor) TopLeft() CellMarker

TopLeft returns the CellMaker for the top left corner of the anchor.

func (TwoCellAnchor) Type 

func (_dgddc TwoCellAnchor) Type() AnchorType

Type returns the type of anchor

type Workbook 

type Workbook struct {
	_dag.DocBase

	StyleSheet    StyleSheet
	SharedStrings SharedStrings
	// contains filtered or unexported fields
}

Workbook is the top level container item for a set of spreadsheets.

func New 

func New() *Workbook

New constructs a new workbook.

func Open 

func Open(filename string) (*Workbook, error)

Open opens and reads a workbook from a file (.xlsx).

func Read 

func Read(r _bd.ReaderAt, size int64) (*Workbook, error)

Read reads a workbook from an io.Reader(.xlsx).

func (*Workbook) AddDefinedName 

func (_fecec *Workbook) AddDefinedName(name, ref string) DefinedName

AddDefinedName adds a name for a cell or range reference that can be used in formulas and charts.

func (*Workbook) AddDrawing 

func (_bada *Workbook) AddDrawing() Drawing

AddDrawing adds a drawing to a workbook. However the drawing is not actually displayed or used until it's set on a sheet.

func (*Workbook) AddImage 

func (_ddgg *Workbook) AddImage(i _dag.Image) (_dag.ImageRef, error)

AddImage adds an image to the workbook package, returning a reference that can be used to add the image to a drawing.

func (*Workbook) AddSheet 

func (_gacg *Workbook) AddSheet() Sheet

AddSheet adds a new sheet to a workbook.

func (*Workbook) ClearCachedFormulaResults 

func (_cbab *Workbook) ClearCachedFormulaResults()

ClearCachedFormulaResults clears any computed formula values that are stored in the sheet. This may be required if you modify cells that are used as a formula input to force the formulas to be recomputed the next time the sheet is opened in Excel.

func (*Workbook) ClearProtection 

func (_gabb *Workbook) ClearProtection()

ClearProtection clears all workbook protections.

func (*Workbook) Close 

func (_bfegd *Workbook) Close() error

Close closes the workbook, removing any temporary files that might have been created when opening a document.

func (*Workbook) CopySheet 

func (_bbadg *Workbook) CopySheet(ind int, copiedSheetName string) (Sheet, error)

CopySheet copies the existing sheet at index `ind` and puts its copy with the name `copiedSheetName`.

func (*Workbook) CopySheetByName 

func (_caaa *Workbook) CopySheetByName(name, copiedSheetName string) (Sheet, error)

CopySheetByName copies the existing sheet with the name `name` and puts its copy with the name `copiedSheetName`.

func (*Workbook) DeepCopySheet 

func (_dgfcf *Workbook) DeepCopySheet(ind int, copiedSheetName string) (Sheet, error)

DeepCopySheet copies the existing sheet at index `ind` and puts its deep copy with the name `copiedSheetName`. Unlike CopySheet, this creates a fully independent copy of all sheet data including cells, so modifying the copy will not affect the original sheet.

func (*Workbook) DeepCopySheetByName 

func (_fegc *Workbook) DeepCopySheetByName(name, copiedSheetName string) (Sheet, error)

DeepCopySheetByName copies the existing sheet with the name `name` and puts its deep copy with the name `copiedSheetName`. Unlike CopySheetByName, this creates a fully independent copy of all sheet data including cells.

func (*Workbook) DefinedNames 

func (_afec *Workbook) DefinedNames() []DefinedName

DefinedNames returns a slice of all defined names in the workbook.

func (*Workbook) Epoch 

func (_aebeb *Workbook) Epoch() _ea.Time

Epoch returns the point at which the dates/times in the workbook are relative to.

func (*Workbook) ExtractText 

func (_ffad *Workbook) ExtractText() *WorkbookText

ExtractText returns text from the workbook as a WorkbookText object.

func (*Workbook) GetChartByTargetId 

func (_aega *Workbook) GetChartByTargetId(targetAttr string) *_efe.ChartSpace

GetChartByTargetId returns the array of workbook crt.ChartSpace.

func (*Workbook) GetFilename 

func (_decfa *Workbook) GetFilename() string

GetFilename returns the name of file from which workbook was opened with full path to it

func (*Workbook) GetSheet 

func (_ggbcd *Workbook) GetSheet(name string) (Sheet, error)

GetSheet returns a sheet by name, or an error if a sheet by the given name was not found.

func (*Workbook) Protection 

func (_agga *Workbook) Protection() WorkbookProtection

Protection allows control over the workbook protections.

func (*Workbook) RecalculateFormulas 

func (_adea *Workbook) RecalculateFormulas()

RecalculateFormulas re-computes any computed formula values that are stored in the sheet. As gooffice formula support is still new and not all functins are supported, if formula execution fails either due to a parse error or missing function, or erorr in the result (even if expected) the cached value will be left empty allowing Excel to recompute it on load.

func (*Workbook) RemoveCalcChain 

func (_cfccd *Workbook) RemoveCalcChain()

RemoveCalcChain removes the cached caculation chain. This is sometimes needed as we don't update it when rows are added/removed.

func (*Workbook) RemoveDefinedName 

func (_gdce *Workbook) RemoveDefinedName(dn DefinedName) error

RemoveDefinedName removes an existing defined name.

func (*Workbook) RemoveSheet 

func (_fega *Workbook) RemoveSheet(ind int) error

RemoveSheet removes the sheet with the given index from the workbook.

func (*Workbook) RemoveSheetByName 

func (_cae *Workbook) RemoveSheetByName(name string) error

RemoveSheetByName removes the sheet with the given name from the workbook.

func (*Workbook) Save 

func (_aefe *Workbook) Save(w _bd.Writer) error

Save writes the workbook out to a writer in the zipped xlsx format.

func (*Workbook) SaveToFile 

func (_dgef *Workbook) SaveToFile(path string) error

SaveToFile writes the workbook out to a file.

func (*Workbook) SetActiveSheet 

func (_ecfca *Workbook) SetActiveSheet(s Sheet)

SetActiveSheet sets the active sheet which will be the tab displayed when the spreadsheet is initially opened.

func (*Workbook) SetActiveSheetIndex 

func (_feeb *Workbook) SetActiveSheetIndex(idx uint32)

SetActiveSheetIndex sets the index of the active sheet (0-n) which will be the tab displayed when the spreadsheet is initially opened.

func (Workbook) SheetCount 

func (_ebcd Workbook) SheetCount() int

SheetCount returns the number of sheets in the workbook.

func (*Workbook) Sheets 

func (_acfb *Workbook) Sheets() []Sheet

Sheets returns the sheets from the workbook.

func (*Workbook) Tables 

func (_facbg *Workbook) Tables() []Table

Tables returns a slice of all defined tables in the workbook.

func (*Workbook) Themes 

func (_fdfb *Workbook) Themes() []*_efb.Theme

Themes returns the array of workbook dml.Theme.

func (*Workbook) Uses1904Dates 

func (_bfadf *Workbook) Uses1904Dates() bool

Uses1904Dates returns true if the the workbook uses dates relative to 1 Jan 1904. This is uncommon.

func (*Workbook) Validate 

func (_beceg *Workbook) Validate() error

Validate attempts to validate the structure of a workbook.

func (*Workbook) X 

func (_gcbg *Workbook) X() *_agf.Workbook

X returns the inner wrapped XML type.

type WorkbookProtection 

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

func (WorkbookProtection) IsStructureLocked 

func (_ggbg WorkbookProtection) IsStructureLocked() bool

IsStructureLocked returns whether the workbook structure is locked.

func (WorkbookProtection) IsWindowLocked 

func (_acfe WorkbookProtection) IsWindowLocked() bool

IsWindowLocked returns whether the workbook windows are locked.

func (WorkbookProtection) LockStructure 

func (_ccef WorkbookProtection) LockStructure(b bool)

LockStructure controls the locking of the workbook structure.

func (WorkbookProtection) LockWindow 

func (_fbggg WorkbookProtection) LockWindow(b bool)

LockWindow controls the locking of the workbook windows.

func (WorkbookProtection) PasswordHash 

func (_ddcbe WorkbookProtection) PasswordHash() string

PasswordHash returns the hash of the workbook password.

func (WorkbookProtection) SetPassword 

func (_aggb WorkbookProtection) SetPassword(pw string)

SetPassword sets the password hash to a hash of the input password.

func (WorkbookProtection) SetPasswordHash 

func (_dcefd WorkbookProtection) SetPasswordHash(pwHash string)

SetPasswordHash sets the password hash to the input.

func (WorkbookProtection) X 

func (_eagdd WorkbookProtection) X() *_agf.CT_WorkbookProtection

X returns the inner wrapped XML type.

type WorkbookText 

type WorkbookText struct{ Sheets []*SheetText }

WorkbookText is an array of extracted text items which has some methods for representing extracted text from a workbook.

func (*WorkbookText) Text 

func (_bbcf *WorkbookText) Text() string

Text returns text from the workbook as one string separated with line breaks.

Source Files

View all Source files

Directories

Path Synopsis
Package format provides support for parsing and evaluating spreadsheetml/Excel number formats.
 Package format provides support for parsing and evaluating spreadsheetml/Excel number formats.
Package formula provides formula parsing and evaluation.
 Package formula provides formula parsing and evaluation.
Package update contains definitions needed for updating references after removing rows/columns.
 Package update contains definitions needed for updating references after removing rows/columns.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.