Classeur

Options définit les options de lecture et d'écriture de feuilles de calcul.

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

MaxCalcIterations spécifie le nombre maximum d'itérations pour le calcul itératif, la valeur par défaut est 0.

Password spécifie le mot de passe de la feuille de calcul en texte brut.

RawCellValue spécifie si appliquer le format numérique pour la valeur de la cellule ou obtenir la valeur brute.

UnzipSizeLimit spécifie la taille limite de décompression en octets à l'ouverture de la feuille de calcul, cette valeur doit être supérieure ou égale à UnzipXMLSizeLimit, la taille limite par défaut est de 16Go.

UnzipXMLSizeLimit spécifie la limite de mémoire pour décompresser la feuille de calcul et la table de chaînes partagée en octets, la feuille de calcul XML sera extraite dans le répertoire temporaire du système lorsque la taille du fichier dépasse cette valeur, cette valeur doit être inférieure ou égale à UnzipSizeLimit, la valeur par défaut la valeur est de 16 Mo.

ShortDatePattern spécifie le code de format de numéro de date court. Dans les applications de feuille de calcul, les formats de date affichent les numéros de série de date et d'heure sous forme de valeurs de date. Les formats de date commençant par un astérisque (*) répondent aux modifications des paramètres de date et d'heure régionaux spécifiés pour le système d'exploitation. Les formats sans astérisque ne sont pas affectés par les paramètres du système d'exploitation. Le ShortDatePattern utilisé pour spécifie les formats de date à appliquer qui commencent par un astérisque.

LongDatePattern spécifie le code de format de numéro de date long.

LongTimePattern spécifie le code de format de nombre de temps long.

CultureInfo spécifie le code du pays pour l'application du code de format de numéro de langue intégré, qui s'effectue en fonction des paramètres de langue locale du système.

HeaderFooterImagePositionType est le type de position de l'image d'en-tête et de pied de page.

type HeaderFooterImagePositionType byte

Cette section définit l'énumération des types de position d'image d'en-tête et de pied de page de la feuille de calcul.

const (
    HeaderFooterImagePositionLeft HeaderFooterImagePositionType = iota
    HeaderFooterImagePositionCenter
    HeaderFooterImagePositionRight
)

Créer un document Excel

func NewFile(opts ...Options) *File

NewFile fournit une fonction pour créer un nouveau fichier par le modèle par défaut. Le classeur nouvellement créé contiendra par défaut une feuille de calcul appelée Sheet1. Par exemple:

Ouvrir

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

OpenFile prend le nom d'un fichier de feuille de calcul et renvoie une structure de fichier de feuille de calcul remplie pour celui-ci. Par exemple, ouvrez une feuille de calcul avec une protection par mot de passe:

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

Fermez le fichier par Close() après avoir ouvert la feuille de calcul.

Flux de données ouvert

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

OpenReader lit le flux de données depuis io.Reader et renvoie un fichier de feuille de calcul rempli.

Par exemple, créez un serveur HTTP pour gérer le modèle de téléchargement, puis le fichier de téléchargement des réponses avec une nouvelle feuille de calcul ajoutée:

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)
}

Testez avec cURL:

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

Enregistrer

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

Save fournit une fonction pour remplacer le fichier xlsx avec le chemin d'origine.

Enregistrer sous

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

SaveAs fournit une fonction pour créer ou mettre à jour un fichier xlsx sur le chemin fourni.

Fermer le classeur

func (f *File) Close() error

Close ferme et nettoie le fichier temporaire ouvert pour la feuille de calcul.

Créer une feuille de calcul

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

NewSheet fournit la fonction pour créer une nouvelle feuille en donnant un nom de feuille de calcul et renvoie l'index des feuilles dans le classeur (feuille de calcul) après l'ajout. Notez que lors de la création d'un nouveau fichier de feuille de calcul, la feuille de calcul par défaut nommée Sheet1 sera créée.

Supprimer la feuille de calcul

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

DeleteSheet fournit une fonction pour supprimer une feuille de calcul dans un classeur par nom de feuille de calcul donné, les noms de feuille ne sont pas sensibles à la casse. Utilisez cette méthode avec prudence, car cela affectera les modifications apportées aux références telles que les formules, les graphiques, etc. S'il existe une valeur référencée de la feuille de calcul supprimée, cela provoquera une erreur de fichier lorsque vous l'ouvrirez. Cette fonction sera invalide lorsqu'il ne reste qu'une seule feuille de calcul.

Déplacer la feuille de travail

func (f *File) MoveSheet(source, target string) error

MoveSheet déplace une feuille vers une position spécifiée dans le classeur. La fonction déplace la feuille source avant la feuille cible. Après le déplacement, les autres feuilles seront décalées vers la gauche ou la droite. Si la feuille est déjà à la position cible, la fonction n'effectuera aucune action. Cette fonction ne dégroupera pas toutes les feuilles après le déplacement. Par exemple, déplacez Sheet2 avant Sheet1:

err := f.MoveSheet("Sheet2", "Sheet1")

Copier la feuille de calcul

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

CopySheet fournit une fonction pour dupliquer une feuille de calcul en donnant l'index de la feuille de calcul source et cible. Notez que les classeurs en double contenant des tableaux, des graphiques ou des images ne sont actuellement pas pris en charge. Par exemple:

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

Feuilles de travail de groupe

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

GroupSheets fournit une fonction pour regrouper les feuilles de calcul par noms de feuilles de calcul donnés. Les feuilles de travail de groupe doivent contenir une feuille de travail active.

Dissocier les feuilles de calcul

func (f *File) UngroupSheets() error

UngroupSheets fournit une fonction pour dissocier les feuilles de calcul.

Arrière-plan de la feuille de travail

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

SetSheetBackground fournit une fonction pour définir l'image d'arrière-plan en fonction du nom de la feuille de calcul et du chemin d'accès au fichier. Types d'images pris en charge: BMP, EMF, EMZ, GIF, JPEG, JPG, PNG, SVG, TIF, TIFF, WMF et WMZ.

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

SetSheetBackgroundFromBytes fournit une fonction pour définir l'image d'arrière-plan en fonction du nom de la feuille de calcul, du nom de l'extension et des données d'image. Types d'images pris en charge: BMP, EMF, EMZ, GIF, JPEG, JPG, PNG, SVG, TIF, TIFF, WMF et WMZ.

Définir la feuille de calcul par défaut

func (f *File) SetActiveSheet(index int)

SetActiveSheet fournit une fonction pour définir la feuille active par défaut du classeur en fonction d'un index donné. Notez que l'index actif est différent de l'ID retourné par la fonction GetSheetMap. Il doit être supérieur ou égal à 0 et inférieur au nombre total de feuilles de calcul.

Obtenir l'index de feuille actif

func (f *File) GetActiveSheetIndex() int

GetActiveSheetIndex fournit une fonction pour obtenir une feuille active de XLSX. S'il n'est pas trouvé, la feuille active retournera l'entier 0.

Définir la feuille de calcul visible

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

SetSheetVisible fournit une fonction permettant de définir une feuille de calcul visible par son nom. Un classeur doit contenir au moins une feuille de calcul visible. Si la feuille de calcul donnée a été activée, ce paramètre sera invalidé. Le troisième paramètre optionnel veryHidden ne fonctionne que lorsque visible était false.

Par exemple, masquer Sheet1:

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

Obtenir la feuille de calcul visible

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

GetSheetVisible fournit une fonction permettant d'obtenir une feuille de calcul visible par son nom. Par exemple, obtenez l'état visible de Sheet1:

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

Définir les propriétés d'une feuille de calcul

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

SetSheetProps fournit une fonction permettant de définir les propriétés de la feuille de calcul. Les propriétés qui peuvent être définies sont les suivantes:

Par exemple, rendre les lignes de feuille de calcul par défaut masquées:

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")

Obtenir les propriétés de la feuille de calcul

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

GetSheetProps fournit une fonction pour obtenir des propriétés de feuille de calcul.

Définir les propriétés de la vue de feuille de calcul

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

SetSheetView définit les propriétés de l'affichage de feuille. Le viewIndex peut être négatif et, le cas échéant, est compté à rebours (-1 est la dernière vue). Les propriétés qui peuvent être définies sont les suivantes :

Obtenir les propriétés d'affichage de la feuille de calcul

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

GetSheetView obtient la valeur des propriétés d'affichage de feuille. Le viewIndex peut être négatif et, le cas échéant, est compté à rebours (-1 est la dernière vue).

Définir la mise en page de feuille de calcul

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

SetPageLayout fournit une fonction permettant de définir la mise en page de la feuille de calcul. Options disponibles:

Size fournit une méthode pour définir le format de papier de la feuille de calcul. Le format de papier par défaut de la feuille de calcul est Papier à lettre (8.5 pouces × 11 pouces). Le tableau ci-dessous présente le format de papier trié par numéro d'index Excelize:

Orientation a spécifié l'orientation de la feuille de calcul, l'orientation par défaut est portrait. Les valeurs possibles pour ce champ sont portrait et landscape.

FirstPageNumber a spécifié le numéro de la première page imprimée. Si aucune valeur n'est spécifiée, "automatique" est supposé.

AdjustTo a spécifié la mise à l'échelle de l'impression. Cet attribut est limité à des valeurs comprises entre 10 (10%) et 400 (400%). Ce paramètre est remplacé lorsque FitToWidth et/ou FitToHeight sont utilisés.

FitToHeight a spécifié le nombre de pages verticales sur lesquelles tenir.

FitToWidth spécifiait le nombre de pages horizontales sur lesquelles tenir.

BlackAndWhite a spécifié l'impression en noir et blanc.

PageOrder spécifie l'ordre de plusieurs pages. Valeurs acceptées: overThenDown et downThenOver.

Par exemple, définissez la mise en page pour Sheet1 avec impression en noir et blanc, premier numéro de page imprimée à partir de 2, petit papier A4 paysage (210 mm sur 297 mm), 2 pages verticales pour s'adapter et 2 pages horizontales pour s'adapter:

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)
}

Obtenir la mise en page de feuille de calcul

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

GetPageLayout fournit une fonction pour obtenir la mise en page de la feuille de calcul.

Définissez les marges de page de feuille de calcul

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

SetPageMargins fournit une fonction permettant de définir les marges des pages de la feuille de calcul. Options disponibles:

Obtenir les marges des pages de la feuille de calcul

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

GetPageMargins fournit une fonction pour obtenir les marges des pages de la feuille de calcul.

Définir les propriétés du classeur

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

SetWorkbookProps fournit une fonction pour définir les propriétés du classeur. Options disponibles:

Obtenir les propriétés du classeur

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

GetWorkbookProps fournit une fonction pour obtenir les propriétés du classeur.

Définir l'en-tête et le pied de page

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

SetHeaderFooter fournit une fonction permettant de définir les en-têtes et les pieds de page en fonction du nom de la feuille de calcul et des caractères de contrôle.

Les en-têtes et les pieds de page sont spécifiés à l'aide des champs de paramètres suivants:

Champs｜La description ---|--- AlignWithMargins | Aligner les marges de l'en-tête et du pied de page avec les marges de la page DifferentFirst | Indicateur d'en-tête et de pied de page de première page différent DifferentOddEven | Différents en-têtes et pieds de page pairs et impairs ScaleWithDoc | Mettre à l'échelle l'en-tête et le pied de page avec la mise à l'échelle du document OddFooter | Pied de page impair ou pied de page principal si DifferentOddEven est false OddHeader | En-tête impair ou en-tête de page principal si DifferentOddEven est false EvenFooter | Pied de page pair EvenHeader | En-tête de page pair FirstFooter | Pied de page de la première page FirstHeader | En-tête de la première page

Les codes de formatage suivants peuvent être utilisés dans 6 champs de type chaîne: OddHeader, OddFooter, EvenHeader, EvenFooter, FirstFooter, FirstHeader

Par exemple:

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`,
})

Cet exemple montre:

• La première page a son propre en-tête et pied de page
• Les pages impaires et paires ont des en-têtes et des pieds de page différents
• Numéro de page actuel dans la partie droite des en-têtes de pages impaires
• Nom du fichier du classeur actuel dans la section centrale des pieds de page impairs
• Numéro de page actuel dans la partie gauche des en-têtes de pages paires
• La date actuelle dans la partie gauche et l'heure actuelle dans la partie droite du pied de page pair
• Le texte "Center Bold Header" sur la première ligne de la section centrale de la première page et la date sur la deuxième ligne de la section centrale de cette page
• Pas de pied de page sur la première page

Ajouter une image d'en-tête et de pied de page

func (f *File) AddHeaderFooterImage(sheet string, opts *HeaderFooterImageOptions) error

AddHeaderFooterImage fournit un mécanisme pour définir les graphiques qui peuvent être référencés dans les définitions d'en-tête et de pied de page via &G, types d'images pris en charge: EMF, EMZ, GIF, JPEG, JPG, PNG, SVG, TIF, TIFF, WMF et WMZ.

Définir le nom défini

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

SetDefinedName fournit une fonction permettant de définir les noms définis du classeur ou de la feuille de calcul. S'il n'est pas spécifié scopr, l'étendue par défaut est classeur. Par exemple:

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

Paramètres de la zone d'impression et des titres d'impression pour la feuille de calcul:

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

Si vous remplissez la propriété RefersTo avec une seule plage de colonnes sans virgule, elle fonctionnera uniquement comme "Colonnes à répéter à gauche". Par exemple:

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

Si vous remplissez la propriété RefersTo avec une seule plage de lignes sans virgule, elle fonctionnera uniquement comme "Lignes à répéter en haut". Par exemple:

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

Obtenir le nom défini

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

GetDefinedName fournit une fonction pour obtenir les noms définis du classeur ou de la feuille de calcul.

Supprimer le nom défini

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

DeleteDefinedName fournit une fonction pour supprimer les noms définis du classeur ou de la feuille de calcul. Si la portée n'est pas spécifiée, la portée par défaut est classeur. Par exemple:

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

Définir les propriétés de l'application

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

SetAppProps fournit une fonction pour définir les propriétés de l'application de document. Les propriétés qui peuvent être définies sont :

Par exemple:

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

Obtenir les propriétés de l'application

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

GetAppProps fournit une fonction pour obtenir les propriétés d'application de document.

Définir les propriétés du document

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

SetDocProps fournit une fonction permettant de définir les propriétés principales du document. Les propriétés pouvant être définies sont:

Par exemple:

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",
})

Obtenir les propriétés du document

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

GetDocProps fournit une fonction pour obtenir les propriétés de base du document.

Protéger le classeur

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

ProtectWorkbook fournit une fonction pour empêcher d'autres utilisateurs de modifier, déplacer ou supprimer accidentellement ou délibérément des données dans un classeur. Le champ facultatif AlgorithmName a spécifié l'algorithme de hachage, prend en charge XOR, MD4, MD5, SHA-1, SHA2-56, SHA-384 et SHA-512 actuellement, si aucun algorithme de hachage n'est spécifié, utilisera l'algorithme XOR par défaut. Par exemple, protégez le classeur avec les paramètres de protection:

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

WorkbookProtectionOptions mappe directement les paramètres de protection du classeur.

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

Déprotéger le classeur

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

UnprotectWorkbook fournit une fonction pour supprimer la protection du classeur, a spécifié le paramètre de mot de passe facultatif pour supprimer la protection du classeur avec vérification du mot de passe.