excel

package module

Go to main page

Versions in this module

v0

v0.8.1

Mar 31, 2025

v0.8.0

Mar 16, 2025

Changes in this version

+ const TagColumn

+ const TagDefault

+ const TagEncoding

+ const TagFormat

+ const TagIgnore

+ const TagKeyIn

+ const TagKeyMain

+ const TagKeyOut

+ const TagRequired

+ const TagSplit

+ var ErrSheetIsNil = errors.New("excel: the sheet is nil")

type Excel

+ func (e *Excel) SetActiveSheetName(name string) error

v0.7.0

Dec 11, 2024

v0.6.1

Dec 22, 2023

v0.6.0

Nov 16, 2023

Changes in this version

+ var ErrSheetIndex = errors.New("excel: the sheet index is not valid")

+ var ErrSheetNameEmpty = errors.New("excel: the sheet name is empty")

+ var ErrSheetNotFound = errors.New("excel: the sheet is not found")

+ var ErrTableNameEmpty = errors.New("excel: the table name is empty")

+ var ErrTableRange = errors.New("excel: the table range is not valid")

type Excel

+ func (e *Excel) AddTable(table *Table) error

+ func (e *Excel) DeleteTable(name string) error

+ func (e *Excel) DeleteTableContent(name string) error

+ func (e *Excel) GetActiveSheet() *Sheet

+ func (e *Excel) GetSheet(name string) *Sheet

+ func (e *Excel) GetSheetFromIndex(index int) *Sheet

+ func (e *Excel) GetTable(name string) (*Table, error)

+ func (e *Excel) GetTableSheet(name string) (*Sheet, error)

+ func (e *Excel) GetTables() ([]Table, error)

+ func (e *Excel) ResizeTable(table *Table, newRange string) error

+ func (e *Excel) SetActiveSheet(sheet *Sheet)

+ func (e *Excel) SetSheet(sheet *Sheet)

+ func (e *Excel) SetSheetFromIndex(index int)

+ func (e *Excel) SetSheetFromName(name string)

+ func (e *Excel) Sheet() *Sheet

+ type Range struct

+ EndColumn int

+ EndName string

+ EndRow int

+ StartColumn int

+ StartName string

+ StartRow int

+ func MinRange(startName string) (*Range, error)

+ func ToRange(ref string) (*Range, error)

+ func (r *Range) AddColumns(columns int) error

+ func (r *Range) AddRows(rows int) error

+ func (r *Range) ColumnAsRange(column int) (*Range, error)

+ func (r *Range) Columns() int

+ func (r *Range) FirstColumnAsRange() (*Range, error)

+ func (r *Range) FirstRowAsRange() (*Range, error)

+ func (r *Range) LastColumnAsRange() (*Range, error)

+ func (r *Range) LastRowAsRange() (*Range, error)

+ func (r *Range) RemoveColumns(columns int) error

+ func (r *Range) RemoveRows(rows int) error

+ func (r *Range) RowAsRange(row int) (*Range, error)

+ func (r *Range) Rows() int

+ func (r *Range) SetColumns(columns int) error

+ func (r *Range) SetRows(rows int) error

+ func (r *Range) ToRef() string

+ func (r *Range) UpdateNames() error

type Sheet

+ func (s *Sheet) GetComment(cell string) *excelize.Comment

+ func (s *Sheet) IsValid() bool

+ func (s *Sheet) IsValidError() error

+ type Table struct

+ Sheet *Sheet

+ func (t *Table) Delete() error

+ func (t *Table) DeleteContent() error

+ func (t *Table) GetColumn(title string) (int, error)

+ func (t *Table) GetColumnAt(index int) (string, error)

+ func (t *Table) GetDataRange() (*Range, error)

+ func (t *Table) GetHeaderRange() (*Range, error)

+ func (t *Table) GetRange() (*Range, error)

+ func (t *Table) IsValid() bool

+ func (t *Table) IsValidError() error

+ func (t *Table) Resize(newRange string) error

v0.5.1

Jul 6, 2023

v0.5.0

May 30, 2023

Changes in this version

type Reader

+ Result *ReaderResult

+ type ReaderResult struct

+ Columns int

+ Rows int

type Writer

+ Result *WriterResult

+ type WriterResult struct

+ Columns int

+ Rows int

v0.4.0

May 22, 2023

Changes in this version

+ var ErrContainerNotMap = errors.New("excel: the Container must be a map")

+ var ErrContainerNotSlice = errors.New("excel: the Container must be a slice")

+ var ErrMapKeyNotString = errors.New("excel: the map key must be a string")

+ type Container struct

+ Pointer bool

+ Type reflect.Type

+ Value reflect.Value

type Excel

+ Reader *Reader

+ Struct *Struct

+ Writer *Writer

+ type Field struct

+ Index int

+ MainTags *Tags

+ Name string

+ ReadTags *Tags

+ Type reflect.Type

+ WriteTags *Tags

+ func (f *Field) GetReadColumnName() string

+ func (f *Field) GetReadDefault() interface{}

+ func (f *Field) GetReadEncoding() string

+ func (f *Field) GetReadFormat() string

+ func (f *Field) GetReadIgnore() bool

+ func (f *Field) GetReadRequired() bool

+ func (f *Field) GetReadSplit() string

+ func (f *Field) GetWriteColumnName() string

+ func (f *Field) GetWriteDefault() interface{}

+ func (f *Field) GetWriteEncoding() string

+ func (f *Field) GetWriteFormat() string

+ func (f *Field) GetWriteIgnore() bool

+ func (f *Field) GetWriteRequired() bool

+ func (f *Field) GetWriteSplit() string

+ type Fields []*Field

+ func (f *Fields) Count() int

+ func (f *Fields) CountReadIgnored() int

+ func (f *Fields) CountWriteIgnored() int

+ type IReadTags interface

+ GetReadTags func() map[string]*Tags

+ type IReader interface

+ SetColumnsTags func(tags map[string]*Tags)

+ Unmarshall func() error

+ type ITags interface

+ GetTags func() map[string]*Tags

+ type IWriteTags interface

+ GetWriteTags func() map[string]*Tags

+ type IWriter interface

+ Marshall func(data any) error

+ SetColumnsTags func(tags map[string]*Tags)

+ type MapWriter struct

+ Writer *Writer

+ func (w *MapWriter) Marshall(data any) error

+ func (w *MapWriter) SetColumnsTags(_ map[string]*Tags)

type Reader

+ Axis Axis

+ Sheet Sheet

+ type SliceReader struct

+ Reader *Reader

+ func (r *SliceReader) SetColumnsTags(_ map[string]*Tags)

+ func (r *SliceReader) Unmarshall() error

+ type SliceWriter struct

+ Writer *Writer

+ func (w *SliceWriter) Marshall(data any) error

+ func (w *SliceWriter) SetColumnsTags(_ map[string]*Tags)

+ type Struct struct

+ Fields Fields

+ Type reflect.Type

+ func (s *Struct) GetField(index int) *Field

+ type StructReader struct

+ Reader *Reader

+ Struct *Struct

+ func (r *StructReader) SetColumnsTags(tags map[string]*Tags)

+ func (r *StructReader) Unmarshall() error

+ type StructWriter struct

+ Struct *Struct

+ Writer *Writer

+ func (w *StructWriter) Marshall(data any) error

+ func (w *StructWriter) SetColumnsTags(tags map[string]*Tags)

+ type Tags struct

+ Column string

+ Default interface{}

+ Encoding string

+ Format string

+ Ignore bool

+ Required bool

+ Split string

type Writer

+ Axis Axis

+ Sheet Sheet

v0.3.0

Feb 9, 2023

Changes in this version

type Reader

+ SetColumnsOptions func(options map[string]*FieldTags)

v0.2.0

Feb 9, 2023

Changes in this version

type FieldInfo

+ Index int

+ Name string

+ Type reflect.Type

type Writer

+ SetColumnsOptions func(options map[string]*FieldTags)

v0.1.0

Feb 3, 2023

Changes in this version

+ var ErrAxisNotValid = errors.New("excel: the axis is not valid")

+ var ErrColumnRequired = errors.New("excel: required colum")

+ var ErrConfigNotValid = errors.New("excel: the configuration is not valid")

+ var ErrContainerInvalid = errors.New("excel: the ContainerInfo must be a slice or a pointer")

+ var ErrFileIsNil = errors.New("excel: the file is nil")

+ var ErrNoReaderFound = errors.New("excel: unable to create an appropriate reader")

+ var ErrNoWriterFound = errors.New("excel: unable to create an appropriate writer")

+ var ErrNotImplemented = errors.New("excel: not implemented")

+ var ErrSheetNotValid = errors.New("excel: the sheet name is not valid")

+ type Axis struct

+ Axis string

+ Col int

+ Row int

+ type ContainerInfo struct

+ type Excel struct

+ File *excelize.File

+ ReaderInfo *ReaderInfo

+ WriterInfo *WriterInfo

+ func NewReader(file *excelize.File) (*Excel, error)

+ func NewWriter(file *excelize.File) (*Excel, error)

+ func (e *Excel) GetSheetIndex() int

+ func (e *Excel) GetSheetName() string

+ func (e *Excel) Marshal(container any) error

+ func (e *Excel) SetAxis(axis string)

+ func (e *Excel) SetAxisCoordinates(col int, row int)

+ func (e *Excel) SetSheetIndex(index int)

+ func (e *Excel) SetSheetName(sheet string)

+ func (e *Excel) Unmarshal(container any) error

+ func (e *Excel) Validate() error

+ type FieldInfo struct

+ FieldIndex int

+ FieldType reflect.Type

+ Tags *FieldTags

+ TagsIn *FieldTags

+ TagsOut *FieldTags

+ func (f *FieldInfo) ColumnNameIn() string

+ func (f *FieldInfo) ColumnNameOut() string

+ func (f *FieldInfo) DefaultValueIn() interface{}

+ func (f *FieldInfo) DefaultValueOut() interface{}

+ func (f *FieldInfo) EncodingIn() string

+ func (f *FieldInfo) EncodingOut() string

+ func (f *FieldInfo) FormatIn() string

+ func (f *FieldInfo) FormatOut() string

+ func (f *FieldInfo) IgnoreIn() bool

+ func (f *FieldInfo) IgnoreOut() bool

+ func (f *FieldInfo) IsRequiredIn() bool

+ func (f *FieldInfo) IsRequiredOut() bool

+ func (f *FieldInfo) SplitIn() string

+ func (f *FieldInfo) SplitOut() string

+ type FieldTags struct

+ ColumnName string

+ DefaultValue interface{}

+ Encoding string

+ Format string

+ Ignore bool

+ IsRequired bool

+ Split string

+ type FieldsTags interface

+ GetFieldsTags func() map[string]*FieldTags

+ type FieldsTagsIn interface

+ GetFieldsTagsIn func() map[string]*FieldTags

+ type FieldsTagsOut interface

+ GetFieldsTagsOut func() map[string]*FieldTags

+ type Marshaller interface

+ Marshall func() (interface{}, error)

+ type Reader interface

+ Unmarshall func() error

+ type ReaderInfo struct

+ Axis Axis

+ Sheet Sheet

+ func (r *ReaderInfo) GetSheetIndex() (int, error)

+ func (r *ReaderInfo) GetSheetName() string

+ func (r *ReaderInfo) SetAxis(axis string)

+ func (r *ReaderInfo) SetAxisCoordinates(col int, row int)

+ func (r *ReaderInfo) SetSheetIndex(i int)

+ func (r *ReaderInfo) SetSheetName(n string)

+ func (r *ReaderInfo) Validate() error

+ type Sheet struct

+ Index int

+ Name string

+ type StructInfo struct

+ Fields []*FieldInfo

+ StructType reflect.Type

+ func (s *StructInfo) GetFieldFromFieldIndex(index int) *FieldInfo

+ type Unmarshaller interface

+ Unmarshall func(s string) error

+ type Writer interface

+ Marshall func(data any) error

+ type WriterInfo struct

+ Axis Axis

+ Sheet Sheet

+ func (w *WriterInfo) GetSheetIndex() (int, error)

+ func (w *WriterInfo) GetSheetName() string

+ func (w *WriterInfo) SetAxis(axis string)

+ func (w *WriterInfo) SetAxisCoordinates(col int, row int)

+ func (w *WriterInfo) SetSheetIndex(i int)

+ func (w *WriterInfo) SetSheetName(n string)

+ func (w *WriterInfo) Validate() error

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