Libro

Options define las opciones para leer y escribir hojas de cálculo.

type Options struct {
    MaxCalcIterations uint
    Password          string
    RawCellValue      bool
    UnzipSizeLimit    int64
    UnzipXMLSizeLimit int64
    ShortDatePattern  string
    LongDatePattern   string
    LongTimePattern   string
    CultureInfo       CultureName
}

MaxCalcIterations especifica las iteraciones máximas para el cálculo iterativo, el valor predeterminado es 0.

Password especifica la contraseña de la hoja de cálculo en texto plano.

RawCellValue especifica si se aplica el formato de número para el valor de la celda o se obtiene el valor sin procesar.

UnzipSizeLimit especifica el límite de tamaño de descompresión en bytes al abrir la hoja de cálculo, este valor debe ser mayor o igual que UnzipXMLSizeLimit, el límite de tamaño predeterminado es 16GB.

UnzipXMLSizeLimit especifica el límite de memoria al descomprimir la hoja de trabajo y la tabla de cadenas compartidas en bytes, la hoja de trabajo XML se extraerá al directorio temporal del sistema cuando el tamaño del archivo supere este valor, este valor debe ser menor o igual a UnzipSizeLimit, el valor predeterminado El valor es 16MB.

ShortDatePattern especifica el código de formato de número de fecha corta. En las aplicaciones de hojas de cálculo, los formatos de fecha muestran números de serie de fecha y hora como valores de fecha. Los formatos de fecha que comienzan con un asterisco (*) responden a cambios en la configuración regional de fecha y hora que se especifican para el sistema operativo. Los formatos sin asterisco no se ven afectados por la configuración del sistema operativo. El ShortDatePattern usado para especifica aplicar formatos de fecha que comienzan con un asterisco.

LongDatePattern especifica el código de formato de número de fecha larga.

LongTimePattern especifica el código de formato de número de larga duración.

CultureInfo especifica el código de país para aplicar el código de formato de número de idioma integrado que se aplica a la configuración de idioma local del sistema.

Crear una hoja de cálculo

func NewFile(opts ...Options) *File

NewFile proporciona una función para crear un nuevo archivo de forma predeterminada. El libro recién creado contendrá de forma predeterminada una hoja de cálculo denominada Sheet1. Por ejemplo:

Abierto

func OpenFile(filename string, opts ...Options) (*File, error)

OpenFile toma el nombre de un archivo de hoja de cálculo y devuelve una estructura de archivo de hoja de cálculo rellenada para él. Por ejemplo, abra una hoja de cálculo con protección con contraseña:

f, err := excelize.OpenFile("Book1.xlsx", excelize.Options{Password: "password"})
if err != nil {
    return
}

Cierre el archivo por Close() después de abrir la hoja de cálculo.

Flujo de datos abiertos

func OpenReader(r io.Reader, opts ...Options) (*File, error)

OpenReader lee el flujo de datos de io.Reader y devuelva un archivo de hoja de cálculo rellenado.

Por ejemplo, cree un servidor HTTP para manejar la plantilla de carga y, a continuación, el archivo de descarga de respuesta con la nueva hoja de cálculo agregada:

package main

import (
    "fmt"
    "net/http"

    "github.com/xuri/excelize/v2"
)

func process(w http.ResponseWriter, req *http.Request) {
    file, _, err := req.FormFile("file")
    if err != nil {
        fmt.Fprint(w, err.Error())
        return
    }
    defer file.Close()
    f, err := excelize.OpenReader(file)
    if err != nil {
        fmt.Fprint(w, err.Error())
        return
    }
    f.Path = "Book1.xlsx"
    f.NewSheet("NewSheet")
    w.Header().Set("Content-Disposition", fmt.Sprintf("attachment; filename=%s", f.Path))
    w.Header().Set("Content-Type", req.Header.Get("Content-Type"))
    if err := f.Write(w); err != nil {
        fmt.Fprint(w, err.Error())
    }
}

func main() {
    http.HandleFunc("/process", process)
    http.ListenAndServe(":8090", nil)
}

Prueba con cURL:

curl --location --request GET 'http://127.0.0.1:8090/process' \
--form 'file=@/tmp/template.xltx' -O -J

Salvar

func (f *File) Save(opts ...Options) error

Save proporciona una función para invalidar el archivo de hoja de cálculo con la ruta de origen.

Guardar como

func (f *File) SaveAs(name string, opts ...Options) error

SaveAs proporciona una función para crear o actualizar el archivo de hoja de cálculo en la ruta proporcionada.

Cerrar libro de trabajo

func (f *File) Close() error

Close cierra y limpia el archivo temporal abierto para la hoja de cálculo.

Crear hoja de trabajo

func (f *File) NewSheet(sheet string) (int, error)

NewSheet proporciona la función para crear una nueva hoja por un nombre de hoja de cálculo y devuelve el índice de las hojas en el libro (hoja de cálculo) después de anexar. Tenga en cuenta que al crear un nuevo archivo de hoja de cálculo, se creará la hoja de cálculo predeterminada denominada Sheet1.

Eliminar hoja de trabajo

func (f *File) DeleteSheet(sheet string) error

DeleteSheet proporciona una función para eliminar la hoja de trabajo en un libro de trabajo por el nombre de la hoja de trabajo dado, los nombres de las hojas no distinguen entre mayúsculas y minúsculas. Utilice este método con precaución, ya que afectará los cambios en las referencias, como fórmulas, gráficos, etc. Si hay algún valor de referencia de la hoja de cálculo eliminada, se producirá un error de archivo cuando lo abra. Esta función no será válida cuando solo quede una hoja de trabajo.

Copiar hoja de trabajo

func (f *File) CopySheet(from, to int) error

CopySheet proporciona una función para duplicar una hoja de cálculo mediante el índice de hoja de cálculo de origen y destino dado. Tenga en cuenta que actualmente no admite libros de trabajo duplicados que contengan tablas, gráficos o imágenes. Por ejemplo:

// Sheet1 ya existe...
index, err := f.NewSheet("Sheet2")
if err != nil {
    fmt.Println(err)
    return
}
err := f.CopySheet(1, index)

Hojas de trabajo grupales

func (f *File) GroupSheets(sheets []string) error

GroupSheets proporciona una función para agrupar hojas de trabajo por nombres de hojas de trabajo dados. Las hojas de trabajo grupales deben contener una hoja de trabajo activa.

Desagrupar hojas de trabajo

func (f *File) UngroupSheets() error

UngroupSheets proporciona una función para desagrupar hojas de trabajo.

Establecer el fondo de la hoja de trabajo

func (f *File) SetSheetBackground(sheet, picture string) error

SetSheetBackground proporciona una función para configurar la imagen de fondo según el nombre de la hoja de trabajo y la ruta del archivo. Tipos de imágenes compatibles: BMP, EMF, EMZ, GIF, JPEG, JPG, PNG, SVG, TIF, TIFF, WMF y WMZ.

func (f *File) SetSheetBackgroundFromBytes(sheet, extension string, picture []byte) error

SetSheetBackgroundFromBytes proporciona una función para configurar la imagen de fondo según el nombre de la hoja de trabajo, el nombre de la extensión y los datos de la imagen. Tipos de imágenes compatibles: BMP, EMF, EMZ, GIF, JPEG, JPG, PNG, SVG, TIF, TIFF, WMF y WMZ.

Establecer la hoja de trabajo predeterminada

func (f *File) SetActiveSheet(index int)

SetActiveSheet proporciona una función para establecer la hoja activa predeterminada del libro por un índice determinado. Tenga en cuenta que el índice activo es diferente del identificador devuelto por la función GetSheetMap. Debe ser mayor o igual que 0 y menor que el total de números de hoja de cálculo.

Obtener índice de hoja activo

func (f *File) GetActiveSheetIndex() int

GetActiveSheetIndex proporciona una función para obtener una hoja de cálculo activa del libro. Si no se encuentra, la hoja activa devolverá el entero '0'.

Establecer la hoja de trabajo visible

func (f *File) SetSheetVisible(sheet string, visible bool, veryHidden ...bool) error

SetSheetVisible proporciona una función para establecer la hoja de cálculo visible por el nombre de la hoja de cálculo dado. Un libro de trabajo debe contener al menos una hoja de cálculo visible. Si se ha activado la hoja de cálculo determinada, esta configuración se invalidará. El tercer parámetro opcional veryHidden solo funciona cuando visible es false.

Por ejemplo, ocultar Sheet1:

err := f.SetSheetVisible("Sheet1", false)

Obtener la hoja de trabajo visible

func (f *File) GetSheetVisible(sheet string) (bool, error)

GetSheetVisible proporciona una función para que la hoja de cálculo sea visible con el nombre de la hoja de cálculo especificado. Por ejemplo, obtenga el estado visible de Sheet1:

visible, err := f.GetSheetVisible("Sheet1")

Establecer propiedades de hoja

func (f *File) SetSheetProps(sheet string, opts *SheetPropsOptions) error

SetSheetProps proporciona una función para establecer las propiedades de la hoja de cálculo. Las propiedades que se pueden establecer son:

Por ejemplo, haga que las filas de la hoja de cálculo sean predeterminadas como ocultas:

f, enable := excelize.NewFile(), true
if err := f.SetSheetProps("Sheet1", &excelize.SheetPropsOptions{
    ZeroHeight: &enable,
}); err != nil {
    fmt.Println(err)
}
if err := f.SetRowVisible("Sheet1", 10, true); err != nil {
    fmt.Println(err)
}
f.SaveAs("Book1.xlsx")

Obtener propiedades de la hoja

func (f *File) GetSheetProps(sheet string) (SheetPropsOptions, error)

GetSheetProps proporciona una función para obtener las propiedades de la hoja de cálculo.

Establecer propiedades de vista de hoja de cálculo

func (f *File) SetSheetView(sheet string, viewIndex int, opts *ViewOptions) error

SetSheetView establece las propiedades de la vista de hoja. El viewIndex puede ser negativo y, de ser así, se cuenta hacia atrás (-1 es la última vista). Las propiedades que se pueden establecer son:

Obtener propiedades de vista de hoja de cálculo

func (f *File) GetSheetView(sheet string, viewIndex int) (ViewOptions, error)

GetSheetView obtiene el valor de las propiedades de la vista de hoja. El viewIndex puede ser negativo y, de ser así, se cuenta hacia atrás (-1 es la última vista).

Establecer el diseño de la página de la hoja de trabajo

func (f *File) SetPageLayout(sheet string, opts *PageLayoutOptions) error

SetPageLayout proporciona una función para establecer el diseño de página de hoja de cálculo. Opciones disponibles:

Size proporciona un método para establecer el tamaño del papel de la hoja de trabajo, el tamaño de papel predeterminado de la hoja de trabajo es "Papel carta (8.5 pulgadas por 11 pulgadas)". A continuación se muestra el tamaño del papel ordenado por el número de índice de Excelize:

Orientación especificó la orientación de la hoja de cálculo, la orientación predeterminada es portrait. Los valores posibles para este campo son portrait y landscape.

FirstPageNumber especificó el primer número de página impreso. Si no se especifica ningún valor, se asume "automático".

AdjustTo especificó la escala de impresión. Este atributo está restringido a valores que van desde 10 (10%) a 400 (400%). Esta configuración se anula cuando FitToWidth y/o FitToHeight están en uso.

FitToHeight especificaba el número de páginas verticales en las que cabría.

FitToWidth especificaba el número de páginas horizontales en las que cabría.

BlackAndWhite especificó la impresión en blanco y negro.

Por ejemplo, configure el diseño de página para Sheet1 con impresión en blanco y negro, primer número de página impresa desde 2, papel pequeño A4 horizontal (210 mm por 297 mm), 2 páginas verticales para ajustar, 2 páginas verticales para encajar y 2 páginas horizontales para encajar:

f := excelize.NewFile()
var (
    size                 = 10
    orientation          = "landscape"
    firstPageNumber uint = 2
    adjustTo        uint = 100
    fitToHeight          = 2
    fitToWidth           = 2
    blackAndWhite        = true
)
if err := f.SetPageLayout("Sheet1", &excelize.PageLayoutOptions{
    Size:            &size,
    Orientation:     &orientation,
    FirstPageNumber: &firstPageNumber,
    AdjustTo:        &adjustTo,
    FitToHeight:     &fitToHeight,
    FitToWidth:      &fitToWidth,
    BlackAndWhite:   &blackAndWhite,
}); err != nil {
    fmt.Println(err)
}

Obtener el diseño de la página de la hoja de trabajo

func (f *File) GetPageLayout(sheet string) (PageLayoutOptions, error)

GetPageLayout proporciona una función para obtener el diseño de página de la hoja de cálculo.

Establecer márgenes de página de hoja de cálculo

func (f *File) SetPageMargins(sheet string, opts *PageLayoutMarginsOptions) error

SetPageMargins proporciona una función para establecer los márgenes de la página de la hoja de cálculo. Opciones disponibles:

Obtener márgenes de página de la hoja de trabajo

func (f *File) GetPageMargins(sheet string) (PageLayoutMarginsOptions, error)

GetPageMargins proporciona una función para obtener márgenes de página de hoja de cálculo.

Establecer las propiedades del libro de trabajo

func (f *File) SetWorkbookProps(opts *WorkbookPropsOptions) error

SetWorkbookProps proporciona una función para establecer las propiedades del libro. Opciones Disponibles:

Obtener propiedades del libro de trabajo

func (f *File) GetWorkbookProps() (WorkbookPropsOptions, error)

GetWorkbookProps proporciona una función para obtener las propiedades del libro de trabajo.

Establecer encabezado y pie de página

func (f *File) SetHeaderFooter(sheet string, opts *HeaderFooterOptions) error

SetHeaderFooter proporciona una función para establecer encabezados y pies de página por el nombre de la hoja de cálculo y los caracteres de control.

Los encabezados y pies de página se especifican mediante los siguientes campos de configuración:

Los siguientes códigos de formato se pueden utilizar en 6 campos de tipo de cadena: OddHeader, OddFooter, EvenHeader, EvenFooter, FirstFooter, FirstHeader

Por ejemplo:

err := f.SetHeaderFooter("Sheet1", &excelize.HeaderFooterOptions{
    DifferentFirst:   true,
    DifferentOddEven: true,
    OddHeader:        "&R&P",
    OddFooter:        "&C&F",
    EvenHeader:       "&L&P",
    EvenFooter:       "&L&D&R&T",
    FirstHeader:      `&CCenter &"-,Bold"Bold&"-,Regular"HeaderU+000A&D`,
})

Este ejemplo muestra:

• La primera página tiene su propio encabezado y pie de página
• Las páginas impares e pares tienen diferentes encabezados y pies de página
• Número de página actual en la sección derecha de los encabezados de página impar
• Nombre de archivo del libro de trabajo actual en la sección central de pies de página impar
• Número de página actual en la sección izquierda de encabezados de página par
• Fecha actual en la sección izquierda y la hora actual en la sección derecha de pies de página pares
• El texto "Center Bold Header" en la primera línea de la sección central de la primera página, y la fecha en la segunda línea de la sección central de esa misma página
• No hay pie de página en la primera página

Establecer nombre definido

func (f *File) SetDefinedName(definedName *DefinedName) error

SetDefinedName proporciona una función para establecer los nombres definidos del libro o la hoja de cálculo. Si no se especifica el ámbito, el ámbito predeterminado es el libro. Por ejemplo:

err := f.SetDefinedName(&excelize.DefinedName{
    Name:     "Amount",
    RefersTo: "Hoja1!$A$2:$D$5",
    Comment:  "defined name comment",
    Scope:    "Hoja2",
})

Configuración del área de impresión e impresión de títulos para la hoja de trabajo:

if err := f.SetDefinedName(&excelize.DefinedName{
    Name:     "_xlnm.Print_Area",
    RefersTo: "Hoja1!$A$1:$Z$100",
    Scope:    "Hoja1",
}); err != nil {
    fmt.Println(err)
}
if err := f.SetDefinedName(&excelize.DefinedName{
    Name:     "_xlnm.Print_Titles",
    RefersTo: "Hoja1!$A:$A,Hoja1!$1:$1",
    Scope:    "Hoja1",
}); err != nil {
    fmt.Println(err)
}

Obtener el nombre definido

func (f *File) GetDefinedName() []DefinedName

GetDefinedName proporciona una función para obtener los nombres definidos del libro o la hoja de cálculo.

Eliminar nombre definido

func (f *File) DeleteDefinedName(definedName *DefinedName) error

DeleteDefinedName proporciona una función para eliminar los nombres definidos del libro o la hoja de cálculo. Si no se especifica el ámbito, el ámbito predeterminado es el libro. Por ejemplo:

err := f.DeleteDefinedName(&excelize.DefinedName{
    Name:     "Amount",
    Scope:    "Hoja2",
})

Establecer propiedades de la aplicación

func (f *File) SetAppProps(appProperties *AppProperties) error

SetAppProps proporciona una función para establecer las propiedades de la aplicación de documentos. Las propiedades que se pueden configurar son:

Por ejemplo:

err := f.SetAppProps(&excelize.AppProperties{
    Application:       "Microsoft Excel",
    ScaleCrop:         true,
    DocSecurity:       3,
    Company:           "Company Name",
    LinksUpToDate:     true,
    HyperlinksChanged: true,
    AppVersion:        "16.0000",
})

Obtener propiedades de la aplicación

func (f *File) GetAppProps() (*AppProperties, error)

GetAppProps proporciona una función para obtener propiedades de la aplicación de documentos.

Establecer las propiedades del documento

func (f *File) SetDocProps(docProperties *DocProperties) error

SetDocProps proporciona una función para establecer las propiedades del núcleo del documento. Las propiedades que se pueden establecer son:

Por ejemplo:

err := f.SetDocProps(&excelize.DocProperties{
    Category:       "category",
    ContentStatus:  "Draft",
    Created:        "2019-06-04T22:00:10Z",
    Creator:        "Go Excelize",
    Description:    "This file created by Go Excelize",
    Identifier:     "xlsx",
    Keywords:       "Spreadsheet",
    LastModifiedBy: "Go Author",
    Modified:       "2019-06-04T22:00:10Z",
    Revision:       "0",
    Subject:        "Test Subject",
    Title:          "Test Title",
    Language:       "en-US",
    Version:        "1.0.0",
})

Obtener propiedades del documento

func (f *File) GetDocProps() (*DocProperties, error)

GetDocProps proporciona una función para obtener las propiedades principales del documento.

Proteger el libro de trabajo

func (f *File) ProtectWorkbook(opts *WorkbookProtectionOptions) error

ProtectWorkbook proporciona una función para evitar que otros usuarios cambien, muevan o eliminen datos en un libro de forma accidental o deliberada. El algoritmo hash especificado del campo opcional AlgorithmName, compatible con XOR, MD4, MD5, SHA-1, SHA2-56, SHA-384 y SHA-512 actualmente, si no se especifica ningún algoritmo hash, utilizará el algoritmo XOR de forma predeterminada. Por ejemplo, proteja el libro de trabajo con la configuración de protección:

err := f.ProtectWorkbook(&excelize.WorkbookProtectionOptions{
    Password:      "password",
    LockStructure: true,
})

WorkbookProtectionOptions asigna directamente la configuración de la protección del libro.

type WorkbookProtectionOptions struct {
    AlgorithmName string
    Password      string
    LockStructure bool
    LockWindows   bool
}

Desproteger libro de trabajo

func (f *File) UnprotectWorkbook(password ...string) error

UnprotectWorkbook proporciona una función para eliminar la protección del libro de trabajo, especificó el parámetro de contraseña opcional para eliminar la protección del libro de trabajo con verificación de contraseña.