sheet.go 46.4 KB
Newer Older
xurime's avatar
xurime 已提交
1
// Copyright 2016 - 2019 The excelize Authors. All rights reserved. Use of
xurime's avatar
xurime 已提交
2 3 4 5 6 7 8
// this source code is governed by a BSD-style license that can be found in
// the LICENSE file.
//
// Package excelize providing a set of functions that allow you to write to
// and read from XLSX files. Support reads and writes XLSX file generated by
// Microsoft Excel™ 2007 and later. Support save file without losing original
// charts of XLSX. This library needs Go version 1.8 or later.
xurime's avatar
xurime 已提交
9

xurime's avatar
xurime 已提交
10 11 12
package excelize

import (
13
	"bytes"
xurime's avatar
xurime 已提交
14
	"encoding/json"
xurime's avatar
xurime 已提交
15
	"encoding/xml"
16
	"errors"
17
	"fmt"
18
	"io/ioutil"
19 20
	"os"
	"path"
21
	"reflect"
R
r-uchino 已提交
22
	"regexp"
xurime's avatar
xurime 已提交
23 24
	"strconv"
	"strings"
25
	"unicode/utf8"
26 27

	"github.com/mohae/deepcopy"
xurime's avatar
xurime 已提交
28 29
)

S
Sebastian Willing 已提交
30
// NewSheet provides function to create a new sheet by given worksheet name.
xurime's avatar
xurime 已提交
31 32
// When creating a new XLSX file, the default sheet will be created. Returns
// the number of sheets in the workbook (file) after appending the new sheet.
33
func (f *File) NewSheet(name string) int {
34 35 36 37
	// Check if the worksheet already exists
	if f.GetSheetIndex(name) != 0 {
		return f.SheetCount
	}
38
	f.DeleteSheet(name)
39
	f.SheetCount++
40 41 42 43 44 45 46 47
	wb := f.workbookReader()
	sheetID := 0
	for _, v := range wb.Sheets.Sheet {
		if v.SheetID > sheetID {
			sheetID = v.SheetID
		}
	}
	sheetID++
xurime's avatar
xurime 已提交
48
	// Update docProps/app.xml
49
	f.setAppXML()
xurime's avatar
xurime 已提交
50
	// Update [Content_Types].xml
51
	f.setContentTypes(sheetID)
xurime's avatar
xurime 已提交
52
	// Create new sheet /xl/worksheets/sheet%d.xml
53
	f.setSheet(sheetID, name)
xurime's avatar
xurime 已提交
54
	// Update xl/_rels/workbook.xml.rels
55
	rID := f.addXlsxWorkbookRels(sheetID)
xurime's avatar
xurime 已提交
56
	// Update xl/workbook.xml
57 58
	f.setWorkbook(name, sheetID, rID)
	return sheetID
xurime's avatar
xurime 已提交
59 60
}

xurime's avatar
xurime 已提交
61
// contentTypesReader provides a function to get the pointer to the
xurime's avatar
xurime 已提交
62 63 64 65
// [Content_Types].xml structure after deserialization.
func (f *File) contentTypesReader() *xlsxTypes {
	if f.ContentTypes == nil {
		var content xlsxTypes
66
		_ = xml.Unmarshal(namespaceStrictToTransitional(f.readXML("[Content_Types].xml")), &content)
xurime's avatar
xurime 已提交
67 68 69 70 71
		f.ContentTypes = &content
	}
	return f.ContentTypes
}

xurime's avatar
xurime 已提交
72
// contentTypesWriter provides a function to save [Content_Types].xml after
xurime's avatar
xurime 已提交
73 74 75 76
// serialize structure.
func (f *File) contentTypesWriter() {
	if f.ContentTypes != nil {
		output, _ := xml.Marshal(f.ContentTypes)
77
		f.saveFileList("[Content_Types].xml", output)
xurime's avatar
xurime 已提交
78 79 80
	}
}

xurime's avatar
xurime 已提交
81
// workbookReader provides a function to get the pointer to the xl/workbook.xml
xurime's avatar
xurime 已提交
82 83 84 85
// structure after deserialization.
func (f *File) workbookReader() *xlsxWorkbook {
	if f.WorkBook == nil {
		var content xlsxWorkbook
86
		_ = xml.Unmarshal(namespaceStrictToTransitional(f.readXML("xl/workbook.xml")), &content)
xurime's avatar
xurime 已提交
87 88 89 90 91
		f.WorkBook = &content
	}
	return f.WorkBook
}

92
// workBookWriter provides a function to save xl/workbook.xml after serialize
xurime's avatar
xurime 已提交
93
// structure.
94
func (f *File) workBookWriter() {
xurime's avatar
xurime 已提交
95 96
	if f.WorkBook != nil {
		output, _ := xml.Marshal(f.WorkBook)
97
		f.saveFileList("xl/workbook.xml", replaceRelationshipsBytes(replaceRelationshipsNameSpaceBytes(output)))
xurime's avatar
xurime 已提交
98 99 100
	}
}

101
// workSheetWriter provides a function to save xl/worksheets/sheet%d.xml after
xurime's avatar
xurime 已提交
102
// serialize structure.
103
func (f *File) workSheetWriter() {
104
	for p, sheet := range f.Sheet {
xurime's avatar
xurime 已提交
105
		if sheet != nil {
106
			for k, v := range sheet.SheetData.Row {
107
				f.Sheet[p].SheetData.Row[k].C = trimCell(v.C)
108
			}
xurime's avatar
xurime 已提交
109
			output, _ := xml.Marshal(sheet)
110
			f.saveFileList(p, replaceRelationshipsBytes(replaceWorkSheetsRelationshipsNameSpaceBytes(output)))
111
			ok := f.checked[p]
112
			if ok {
113
				f.checked[p] = false
114
			}
xurime's avatar
xurime 已提交
115 116
		}
	}
xurime's avatar
xurime 已提交
117 118
}

xurime's avatar
xurime 已提交
119
// trimCell provides a function to trim blank cells which created by completeCol.
120
func trimCell(column []xlsxC) []xlsxC {
121 122
	col := make([]xlsxC, len(column))
	i := 0
123
	for _, c := range column {
xurime's avatar
xurime 已提交
124
		if c.S != 0 || c.V != "" || c.F != nil || c.T != "" {
125 126
			col[i] = c
			i++
127 128
		}
	}
129
	return col[0:i]
130 131
}

132 133
// setContentTypes provides a function to read and update property of contents
// type of XLSX.
134
func (f *File) setContentTypes(index int) {
xurime's avatar
xurime 已提交
135
	content := f.contentTypesReader()
xurime's avatar
xurime 已提交
136
	content.Overrides = append(content.Overrides, xlsxOverride{
137 138
		PartName:    "/xl/worksheets/sheet" + strconv.Itoa(index) + ".xml",
		ContentType: "application/vnd.openxmlformats-officedocument.spreadsheetml.worksheet+xml",
xurime's avatar
xurime 已提交
139 140 141
	})
}

142
// setSheet provides a function to update sheet property by given index.
143
func (f *File) setSheet(index int, name string) {
xurime's avatar
xurime 已提交
144
	var xlsx xlsxWorksheet
145
	xlsx.Dimension.Ref = "A1"
xurime's avatar
xurime 已提交
146
	xlsx.SheetViews.SheetView = append(xlsx.SheetViews.SheetView, xlsxSheetView{
xurime's avatar
xurime 已提交
147
		WorkbookViewID: 0,
xurime's avatar
xurime 已提交
148
	})
149
	path := "xl/worksheets/sheet" + strconv.Itoa(index) + ".xml"
150
	f.sheetMap[trimSheetName(name)] = path
xurime's avatar
xurime 已提交
151
	f.Sheet[path] = &xlsx
xurime's avatar
xurime 已提交
152 153
}

154 155
// setWorkbook update workbook property of XLSX. Maximum 31 characters are
// allowed in sheet title.
156
func (f *File) setWorkbook(name string, sheetID, rid int) {
xurime's avatar
xurime 已提交
157
	content := f.workbookReader()
xurime's avatar
xurime 已提交
158
	content.Sheets.Sheet = append(content.Sheets.Sheet, xlsxSheet{
159
		Name:    trimSheetName(name),
160
		SheetID: sheetID,
161
		ID:      "rId" + strconv.Itoa(rid),
xurime's avatar
xurime 已提交
162
	})
xurime's avatar
xurime 已提交
163 164
}

xurime's avatar
xurime 已提交
165
// workbookRelsReader provides a function to read and unmarshal workbook
xurime's avatar
xurime 已提交
166 167 168 169
// relationships of XLSX file.
func (f *File) workbookRelsReader() *xlsxWorkbookRels {
	if f.WorkBookRels == nil {
		var content xlsxWorkbookRels
170
		_ = xml.Unmarshal(namespaceStrictToTransitional(f.readXML("xl/_rels/workbook.xml.rels")), &content)
xurime's avatar
xurime 已提交
171
		f.WorkBookRels = &content
xurime's avatar
xurime 已提交
172
	}
xurime's avatar
xurime 已提交
173
	return f.WorkBookRels
xurime's avatar
xurime 已提交
174 175
}

176
// workBookRelsWriter provides a function to save xl/_rels/workbook.xml.rels after
xurime's avatar
xurime 已提交
177
// serialize structure.
178
func (f *File) workBookRelsWriter() {
xurime's avatar
xurime 已提交
179 180
	if f.WorkBookRels != nil {
		output, _ := xml.Marshal(f.WorkBookRels)
181
		f.saveFileList("xl/_rels/workbook.xml.rels", output)
xurime's avatar
xurime 已提交
182
	}
xurime's avatar
xurime 已提交
183 184
}

185
// addXlsxWorkbookRels update workbook relationships property of XLSX.
186
func (f *File) addXlsxWorkbookRels(sheet int) int {
xurime's avatar
xurime 已提交
187
	content := f.workbookRelsReader()
188 189 190 191 192 193 194 195
	rID := 0
	for _, v := range content.Relationships {
		t, _ := strconv.Atoi(strings.TrimPrefix(v.ID, "rId"))
		if t > rID {
			rID = t
		}
	}
	rID++
196
	ID := bytes.Buffer{}
197
	ID.WriteString("rId")
198 199
	ID.WriteString(strconv.Itoa(rID))
	target := bytes.Buffer{}
200
	target.WriteString("worksheets/sheet")
201
	target.WriteString(strconv.Itoa(sheet))
202
	target.WriteString(".xml")
xurime's avatar
xurime 已提交
203
	content.Relationships = append(content.Relationships, xlsxWorkbookRelation{
204 205
		ID:     ID.String(),
		Target: target.String(),
206
		Type:   SourceRelationshipWorkSheet,
xurime's avatar
xurime 已提交
207
	})
208
	return rID
xurime's avatar
xurime 已提交
209 210
}

211
// setAppXML update docProps/app.xml file of XML.
212
func (f *File) setAppXML() {
213
	f.saveFileList("docProps/app.xml", []byte(templateDocpropsApp))
xurime's avatar
xurime 已提交
214 215
}

216 217 218 219 220 221 222 223 224
// replaceRelationshipsBytes; Some tools that read XLSX files have very strict
// requirements about the structure of the input XML. This function is a
// horrible hack to fix that after the XML marshalling is completed.
func replaceRelationshipsBytes(content []byte) []byte {
	oldXmlns := []byte(`xmlns:relationships="http://schemas.openxmlformats.org/officeDocument/2006/relationships" relationships`)
	newXmlns := []byte("r")
	return bytes.Replace(content, oldXmlns, newXmlns, -1)
}

225 226 227 228 229 230 231
// replaceRelationshipsNameSpaceBytes; Some tools that read XLSX files have
// very strict requirements about the structure of the input XML. In
// particular both Numbers on the Mac and SAS dislike inline XML namespace
// declarations, or namespace prefixes that don't match the ones that Excel
// itself uses. This is a problem because the Go XML library doesn't multiple
// namespace declarations in a single element of a document. This function is
// a horrible hack to fix that after the XML marshalling is completed.
232 233 234 235 236 237
func replaceRelationshipsNameSpaceBytes(workbookMarshal []byte) []byte {
	oldXmlns := []byte(`<workbook xmlns="http://schemas.openxmlformats.org/spreadsheetml/2006/main">`)
	newXmlns := []byte(`<workbook xmlns="http://schemas.openxmlformats.org/spreadsheetml/2006/main" xmlns:r="http://schemas.openxmlformats.org/officeDocument/2006/relationships" xmlns:mc="http://schemas.openxmlformats.org/markup-compatibility/2006" mc:Ignorable="x15" xmlns:x15="http://schemas.microsoft.com/office/spreadsheetml/2010/11/main">`)
	return bytes.Replace(workbookMarshal, oldXmlns, newXmlns, -1)
}

238
// SetActiveSheet provides function to set default active worksheet of XLSX by
S
Sebastian Willing 已提交
239 240
// given index. Note that active index is different from the index returned by
// function GetSheetMap(). It should be greater than 0 and less than total
241
// worksheet numbers.
242
func (f *File) SetActiveSheet(index int) {
xurime's avatar
xurime 已提交
243 244 245
	if index < 1 {
		index = 1
	}
246 247 248 249 250 251 252 253 254 255 256
	wb := f.workbookReader()
	for activeTab, sheet := range wb.Sheets.Sheet {
		if sheet.SheetID == index {
			if len(wb.BookViews.WorkBookView) > 0 {
				wb.BookViews.WorkBookView[0].ActiveTab = activeTab
			} else {
				wb.BookViews.WorkBookView = append(wb.BookViews.WorkBookView, xlsxWorkBookView{
					ActiveTab: activeTab,
				})
			}
		}
xurime's avatar
xurime 已提交
257
	}
258
	for idx, name := range f.GetSheetMap() {
xurime's avatar
xurime 已提交
259
		xlsx, _ := f.workSheetReader(name)
260 261 262
		if len(xlsx.SheetViews.SheetView) > 0 {
			xlsx.SheetViews.SheetView[0].TabSelected = false
		}
263
		if index == idx {
xurime's avatar
xurime 已提交
264 265 266 267 268 269 270 271 272 273 274
			if len(xlsx.SheetViews.SheetView) > 0 {
				xlsx.SheetViews.SheetView[0].TabSelected = true
			} else {
				xlsx.SheetViews.SheetView = append(xlsx.SheetViews.SheetView, xlsxSheetView{
					TabSelected: true,
				})
			}
		}
	}
}

xurime's avatar
xurime 已提交
275 276
// GetActiveSheetIndex provides a function to get active sheet index of the
// XLSX. If not found the active sheet will be return integer 0.
277
func (f *File) GetActiveSheetIndex() int {
278
	for idx, name := range f.GetSheetMap() {
xurime's avatar
xurime 已提交
279
		xlsx, _ := f.workSheetReader(name)
280 281
		for _, sheetView := range xlsx.SheetViews.SheetView {
			if sheetView.TabSelected {
282
				return idx
283
			}
284 285
		}
	}
286
	return 0
287 288
}

289 290 291 292 293
// SetSheetName provides a function to set the worksheet name be given old and
// new worksheet name. Maximum 31 characters are allowed in sheet title and
// this function only changes the name of the sheet and will not update the
// sheet name in the formula or reference associated with the cell. So there
// may be problem formula error or reference missing.
294
func (f *File) SetSheetName(oldName, newName string) {
295 296
	oldName = trimSheetName(oldName)
	newName = trimSheetName(newName)
xurime's avatar
xurime 已提交
297
	content := f.workbookReader()
298 299 300
	for k, v := range content.Sheets.Sheet {
		if v.Name == oldName {
			content.Sheets.Sheet[k].Name = newName
301 302
			f.sheetMap[newName] = f.sheetMap[oldName]
			delete(f.sheetMap, oldName)
303 304 305 306
		}
	}
}

xurime's avatar
xurime 已提交
307
// GetSheetName provides a function to get worksheet name of XLSX by given
308 309
// worksheet index. If given sheet index is invalid, will return an empty
// string.
310
func (f *File) GetSheetName(index int) string {
xurime's avatar
xurime 已提交
311
	content := f.workbookReader()
312 313 314 315 316 317 318 319 320
	rels := f.workbookRelsReader()
	for _, rel := range rels.Relationships {
		rID, _ := strconv.Atoi(strings.TrimSuffix(strings.TrimPrefix(rel.Target, "worksheets/sheet"), ".xml"))
		if rID == index {
			for _, v := range content.Sheets.Sheet {
				if v.ID == rel.ID {
					return v.Name
				}
			}
321 322
		}
	}
323
	return ""
324 325
}

xurime's avatar
xurime 已提交
326
// GetSheetIndex provides a function to get worksheet index of XLSX by given sheet
327 328
// name. If given worksheet name is invalid, will return an integer type value
// 0.
329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344
func (f *File) GetSheetIndex(name string) int {
	content := f.workbookReader()
	rels := f.workbookRelsReader()
	for _, v := range content.Sheets.Sheet {
		if v.Name == name {
			for _, rel := range rels.Relationships {
				if v.ID == rel.ID {
					rID, _ := strconv.Atoi(strings.TrimSuffix(strings.TrimPrefix(rel.Target, "worksheets/sheet"), ".xml"))
					return rID
				}
			}
		}
	}
	return 0
}

xurime's avatar
xurime 已提交
345
// GetSheetMap provides a function to get worksheet name and index map of XLSX.
346
// For example:
347
//
xurime's avatar
xurime 已提交
348
//    f, err := excelize.OpenFile("./Book1.xlsx")
349
//    if err != nil {
350
//        return
351
//    }
xurime's avatar
xurime 已提交
352
//    for index, name := range f.GetSheetMap() {
353
//        fmt.Println(index, name)
354 355 356
//    }
//
func (f *File) GetSheetMap() map[int]string {
xurime's avatar
xurime 已提交
357
	content := f.workbookReader()
358
	rels := f.workbookRelsReader()
359 360
	sheetMap := map[int]string{}
	for _, v := range content.Sheets.Sheet {
361
		for _, rel := range rels.Relationships {
362 363 364
			relStr := strings.SplitN(rel.Target, "worksheets/sheet", 2)
			if rel.ID == v.ID && len(relStr) == 2 {
				rID, _ := strconv.Atoi(strings.TrimSuffix(relStr[1], ".xml"))
365 366 367
				sheetMap[rID] = v.Name
			}
		}
368 369
	}
	return sheetMap
xurime's avatar
xurime 已提交
370
}
371

372 373
// getSheetMap provides a function to get worksheet name and XML file path map
// of XLSX.
374
func (f *File) getSheetMap() map[string]string {
375 376 377 378 379 380 381 382 383
	content := f.workbookReader()
	rels := f.workbookRelsReader()
	maps := map[string]string{}
	for _, v := range content.Sheets.Sheet {
		for _, rel := range rels.Relationships {
			if rel.ID == v.ID {
				maps[v.Name] = fmt.Sprintf("xl/%s", rel.Target)
			}
		}
384 385 386 387
	}
	return maps
}

xurime's avatar
xurime 已提交
388
// SetSheetBackground provides a function to set background picture by given
389
// worksheet name and file path.
390 391 392 393 394 395
func (f *File) SetSheetBackground(sheet, picture string) error {
	var err error
	// Check picture exists first.
	if _, err = os.Stat(picture); os.IsNotExist(err) {
		return err
	}
396
	ext, ok := supportImageTypes[path.Ext(picture)]
397
	if !ok {
xurime's avatar
xurime 已提交
398
		return errors.New("unsupported image extension")
399
	}
400
	file, _ := ioutil.ReadFile(picture)
xurime's avatar
xurime 已提交
401 402 403
	name := f.addMedia(file, ext)
	rID := f.addSheetRelationships(sheet, SourceRelationshipImage, strings.Replace(name, "xl", "..", 1), "")
	f.addSheetPicture(sheet, rID)
404 405 406
	f.setContentTypePartImageExtensions()
	return err
}
407

xurime's avatar
xurime 已提交
408
// DeleteSheet provides a function to delete worksheet in a workbook by given
409
// worksheet name. Use this method with caution, which will affect changes in
410 411 412 413
// references such as formulas, charts, and so on. If there is any referenced
// value of the deleted worksheet, it will cause a file error when you open it.
// This function will be invalid when only the one worksheet is left.
func (f *File) DeleteSheet(name string) {
xurime's avatar
xurime 已提交
414
	content := f.workbookReader()
415
	for k, v := range content.Sheets.Sheet {
xurime's avatar
xurime 已提交
416 417
		if v.Name == trimSheetName(name) && len(content.Sheets.Sheet) > 1 {
			content.Sheets.Sheet = append(content.Sheets.Sheet[:k], content.Sheets.Sheet[k+1:]...)
418 419
			sheet := "xl/worksheets/sheet" + strconv.Itoa(v.SheetID) + ".xml"
			rels := "xl/worksheets/_rels/sheet" + strconv.Itoa(v.SheetID) + ".xml.rels"
xurime's avatar
xurime 已提交
420 421
			target := f.deleteSheetFromWorkbookRels(v.ID)
			f.deleteSheetFromContentTypes(target)
422
			f.deleteCalcChain(v.SheetID, "") // Delete CalcChain
xurime's avatar
xurime 已提交
423 424 425 426 427
			delete(f.sheetMap, name)
			delete(f.XLSX, sheet)
			delete(f.XLSX, rels)
			delete(f.Sheet, sheet)
			f.SheetCount--
428 429
		}
	}
430
	f.SetActiveSheet(len(f.GetSheetMap()))
431 432
}

xurime's avatar
xurime 已提交
433
// deleteSheetFromWorkbookRels provides a function to remove worksheet
434 435
// relationships by given relationships ID in the file
// xl/_rels/workbook.xml.rels.
436
func (f *File) deleteSheetFromWorkbookRels(rID string) string {
xurime's avatar
xurime 已提交
437
	content := f.workbookRelsReader()
438
	for k, v := range content.Relationships {
xurime's avatar
xurime 已提交
439 440 441
		if v.ID == rID {
			content.Relationships = append(content.Relationships[:k], content.Relationships[k+1:]...)
			return v.Target
442 443 444 445 446
		}
	}
	return ""
}

xurime's avatar
xurime 已提交
447
// deleteSheetFromContentTypes provides a function to remove worksheet
448
// relationships by given target name in the file [Content_Types].xml.
449
func (f *File) deleteSheetFromContentTypes(target string) {
xurime's avatar
xurime 已提交
450
	content := f.contentTypesReader()
451
	for k, v := range content.Overrides {
xurime's avatar
xurime 已提交
452 453
		if v.PartName == "/xl/"+target {
			content.Overrides = append(content.Overrides[:k], content.Overrides[k+1:]...)
454 455 456
		}
	}
}
457

xurime's avatar
xurime 已提交
458
// CopySheet provides a function to duplicate a worksheet by gave source and
459 460 461 462
// target worksheet index. Note that currently doesn't support duplicate
// workbooks that contain tables, charts or pictures. For Example:
//
//    // Sheet1 already exists...
xurime's avatar
xurime 已提交
463 464
//    index := f.NewSheet("Sheet2")
//    err := f.CopySheet(1, index)
465
//    return err
466 467 468
//
func (f *File) CopySheet(from, to int) error {
	if from < 1 || to < 1 || from == to || f.GetSheetName(from) == "" || f.GetSheetName(to) == "" {
xurime's avatar
xurime 已提交
469
		return errors.New("invalid worksheet index")
470
	}
xurime's avatar
xurime 已提交
471
	return f.copySheet(from, to)
472 473
}

xurime's avatar
xurime 已提交
474
// copySheet provides a function to duplicate a worksheet by gave source and
475
// target worksheet name.
xurime's avatar
xurime 已提交
476
func (f *File) copySheet(from, to int) error {
477
	sheet, err := f.workSheetReader(f.GetSheetName(from))
xurime's avatar
xurime 已提交
478 479 480
	if err != nil {
		return err
	}
481
	worksheet := deepcopy.Copy(sheet).(*xlsxWorksheet)
482 483 484 485 486 487 488
	path := "xl/worksheets/sheet" + strconv.Itoa(to) + ".xml"
	if len(worksheet.SheetViews.SheetView) > 0 {
		worksheet.SheetViews.SheetView[0].TabSelected = false
	}
	worksheet.Drawing = nil
	worksheet.TableParts = nil
	worksheet.PageSetUp = nil
489
	f.Sheet[path] = worksheet
490 491 492 493 494 495
	toRels := "xl/worksheets/_rels/sheet" + strconv.Itoa(to) + ".xml.rels"
	fromRels := "xl/worksheets/_rels/sheet" + strconv.Itoa(from) + ".xml.rels"
	_, ok := f.XLSX[fromRels]
	if ok {
		f.XLSX[toRels] = f.XLSX[fromRels]
	}
xurime's avatar
xurime 已提交
496
	return err
497
}
498

xurime's avatar
xurime 已提交
499
// SetSheetVisible provides a function to set worksheet visible by given worksheet
500 501
// name. A workbook must contain at least one visible worksheet. If the given
// worksheet has been activated, this setting will be invalidated. Sheet state
502
// values as defined by http://msdn.microsoft.com/en-us/library/office/documentformat.openxml.spreadsheet.sheetstatevalues.aspx
xurime's avatar
xurime 已提交
503 504 505 506 507
//
//    visible
//    hidden
//    veryHidden
//
508 509
// For example, hide Sheet1:
//
xurime's avatar
xurime 已提交
510
//    err := f.SetSheetVisible("Sheet1", false)
511
//
xurime's avatar
xurime 已提交
512
func (f *File) SetSheetVisible(name string, visible bool) error {
513 514
	name = trimSheetName(name)
	content := f.workbookReader()
515 516 517 518 519 520
	if visible {
		for k, v := range content.Sheets.Sheet {
			if v.Name == name {
				content.Sheets.Sheet[k].State = ""
			}
		}
xurime's avatar
xurime 已提交
521
		return nil
522
	}
523 524
	count := 0
	for _, v := range content.Sheets.Sheet {
525
		if v.State != "hidden" {
526 527 528 529
			count++
		}
	}
	for k, v := range content.Sheets.Sheet {
530
		xlsx, err := f.workSheetReader(v.Name)
xurime's avatar
xurime 已提交
531 532 533
		if err != nil {
			return err
		}
534 535 536 537 538
		tabSelected := false
		if len(xlsx.SheetViews.SheetView) > 0 {
			tabSelected = xlsx.SheetViews.SheetView[0].TabSelected
		}
		if v.Name == name && count > 1 && !tabSelected {
539
			content.Sheets.Sheet[k].State = "hidden"
540 541
		}
	}
xurime's avatar
xurime 已提交
542
	return nil
543 544
}

xurime's avatar
xurime 已提交
545
// parseFormatPanesSet provides a function to parse the panes settings.
546
func parseFormatPanesSet(formatSet string) (*formatPanes, error) {
xurime's avatar
xurime 已提交
547
	format := formatPanes{}
548 549
	err := json.Unmarshal([]byte(formatSet), &format)
	return &format, err
xurime's avatar
xurime 已提交
550 551
}

xurime's avatar
xurime 已提交
552
// SetPanes provides a function to create and remove freeze panes and split panes
553
// by given worksheet name and panes format set.
xurime's avatar
xurime 已提交
554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581
//
// activePane defines the pane that is active. The possible values for this
// attribute are defined in the following table:
//
//     Enumeration Value              | Description
//    --------------------------------+-------------------------------------------------------------
//     bottomLeft (Bottom Left Pane)  | Bottom left pane, when both vertical and horizontal
//                                    | splits are applied.
//                                    |
//                                    | This value is also used when only a horizontal split has
//                                    | been applied, dividing the pane into upper and lower
//                                    | regions. In that case, this value specifies the bottom
//                                    | pane.
//                                    |
//    bottomRight (Bottom Right Pane) | Bottom right pane, when both vertical and horizontal
//                                    | splits are applied.
//                                    |
//    topLeft (Top Left Pane)         | Top left pane, when both vertical and horizontal splits
//                                    | are applied.
//                                    |
//                                    | This value is also used when only a horizontal split has
//                                    | been applied, dividing the pane into upper and lower
//                                    | regions. In that case, this value specifies the top pane.
//                                    |
//                                    | This value is also used when only a vertical split has
//                                    | been applied, dividing the pane into right and left
//                                    | regions. In that case, this value specifies the left pane
//                                    |
xurime's avatar
xurime 已提交
582
//    topRight (Top Right Pane)       | Top right pane, when both vertical and horizontal
xurime's avatar
xurime 已提交
583 584 585 586 587 588 589
//                                    | splits are applied.
//                                    |
//                                    | This value is also used when only a vertical split has
//                                    | been applied, dividing the pane into right and left
//                                    | regions. In that case, this value specifies the right
//                                    | pane.
//
590
// Pane state type is restricted to the values supported currently listed in the following table:
xurime's avatar
xurime 已提交
591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618
//
//     Enumeration Value              | Description
//    --------------------------------+-------------------------------------------------------------
//     frozen (Frozen)                | Panes are frozen, but were not split being frozen. In
//                                    | this state, when the panes are unfrozen again, a single
//                                    | pane results, with no split.
//                                    |
//                                    | In this state, the split bars are not adjustable.
//                                    |
//     split (Split)                  | Panes are split, but not frozen. In this state, the split
//                                    | bars are adjustable by the user.
//
// x_split (Horizontal Split Position): Horizontal position of the split, in
// 1/20th of a point; 0 (zero) if none. If the pane is frozen, this value
// indicates the number of columns visible in the top pane.
//
// y_split (Vertical Split Position): Vertical position of the split, in 1/20th
// of a point; 0 (zero) if none. If the pane is frozen, this value indicates the
// number of rows visible in the left pane. The possible values for this
// attribute are defined by the W3C XML Schema double datatype.
//
// top_left_cell: Location of the top left visible cell in the bottom right pane
// (when in Left-To-Right mode).
//
// sqref (Sequence of References): Range of the selection. Can be non-contiguous
// set of ranges.
//
// An example of how to freeze column A in the Sheet1 and set the active cell on
xurime's avatar
xurime 已提交
619
// Sheet1!K16:
xurime's avatar
xurime 已提交
620
//
xurime's avatar
xurime 已提交
621
//    f.SetPanes("Sheet1", `{"freeze":true,"split":false,"x_split":1,"y_split":0,"top_left_cell":"B1","active_pane":"topRight","panes":[{"sqref":"K16","active_cell":"K16","pane":"topRight"}]}`)
xurime's avatar
xurime 已提交
622 623
//
// An example of how to freeze rows 1 to 9 in the Sheet1 and set the active cell
xurime's avatar
xurime 已提交
624
// ranges on Sheet1!A11:XFD11:
xurime's avatar
xurime 已提交
625
//
xurime's avatar
xurime 已提交
626
//    f.SetPanes("Sheet1", `{"freeze":true,"split":false,"x_split":0,"y_split":9,"top_left_cell":"A34","active_pane":"bottomLeft","panes":[{"sqref":"A11:XFD11","active_cell":"A11","pane":"bottomLeft"}]}`)
xurime's avatar
xurime 已提交
627 628 629 630
//
// An example of how to create split panes in the Sheet1 and set the active cell
// on Sheet1!J60:
//
xurime's avatar
xurime 已提交
631
//    f.SetPanes("Sheet1", `{"freeze":false,"split":true,"x_split":3270,"y_split":1800,"top_left_cell":"N57","active_pane":"bottomLeft","panes":[{"sqref":"I36","active_cell":"I36"},{"sqref":"G33","active_cell":"G33","pane":"topRight"},{"sqref":"J60","active_cell":"J60","pane":"bottomLeft"},{"sqref":"O60","active_cell":"O60","pane":"bottomRight"}]}`)
xurime's avatar
xurime 已提交
632 633 634
//
// An example of how to unfreeze and remove all panes on Sheet1:
//
xurime's avatar
xurime 已提交
635
//    f.SetPanes("Sheet1", `{"freeze":false,"split":false}`)
xurime's avatar
xurime 已提交
636
//
xurime's avatar
xurime 已提交
637
func (f *File) SetPanes(sheet, panes string) error {
638
	fs, _ := parseFormatPanesSet(panes)
xurime's avatar
xurime 已提交
639 640 641 642
	xlsx, err := f.workSheetReader(sheet)
	if err != nil {
		return err
	}
xurime's avatar
xurime 已提交
643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666
	p := &xlsxPane{
		ActivePane:  fs.ActivePane,
		TopLeftCell: fs.TopLeftCell,
		XSplit:      float64(fs.XSplit),
		YSplit:      float64(fs.YSplit),
	}
	if fs.Freeze {
		p.State = "frozen"
	}
	xlsx.SheetViews.SheetView[len(xlsx.SheetViews.SheetView)-1].Pane = p
	if !(fs.Freeze) && !(fs.Split) {
		if len(xlsx.SheetViews.SheetView) > 0 {
			xlsx.SheetViews.SheetView[len(xlsx.SheetViews.SheetView)-1].Pane = nil
		}
	}
	s := []*xlsxSelection{}
	for _, p := range fs.Panes {
		s = append(s, &xlsxSelection{
			ActiveCell: p.ActiveCell,
			Pane:       p.Pane,
			SQRef:      p.SQRef,
		})
	}
	xlsx.SheetViews.SheetView[len(xlsx.SheetViews.SheetView)-1].Selection = s
xurime's avatar
xurime 已提交
667
	return err
xurime's avatar
xurime 已提交
668 669
}

xurime's avatar
xurime 已提交
670
// GetSheetVisible provides a function to get worksheet visible by given worksheet
671 672
// name. For example, get visible state of Sheet1:
//
xurime's avatar
xurime 已提交
673
//    f.GetSheetVisible("Sheet1")
674 675
//
func (f *File) GetSheetVisible(name string) bool {
676
	content := f.workbookReader()
677
	visible := false
678
	for k, v := range content.Sheets.Sheet {
xurime's avatar
xurime 已提交
679
		if v.Name == trimSheetName(name) {
680 681 682
			if content.Sheets.Sheet[k].State == "" || content.Sheets.Sheet[k].State == "visible" {
				visible = true
			}
683 684
		}
	}
685
	return visible
686 687
}

688 689 690 691 692 693 694
// SearchSheet provides a function to get coordinates by given worksheet name,
// cell value, and regular expression. The function doesn't support searching
// on the calculated result, formatted numbers and conditional lookup
// currently. If it is a merged cell, it will return the coordinates of the
// upper left corner of the merged area.
//
// An example of search the coordinates of the value of "100" on Sheet1:
695
//
xurime's avatar
xurime 已提交
696
//    result, err := f.SearchSheet("Sheet1", "100")
697
//
698 699
// An example of search the coordinates where the numerical value in the range
// of "0-9" of Sheet1 is described:
R
r-uchino 已提交
700
//
xurime's avatar
xurime 已提交
701
//    result, err := f.SearchSheet("Sheet1", "[0-9]", true)
R
r-uchino 已提交
702
//
703
func (f *File) SearchSheet(sheet, value string, reg ...bool) ([]string, error) {
xurime's avatar
xurime 已提交
704 705 706 707
	var (
		regSearch bool
		result    []string
	)
708 709 710
	for _, r := range reg {
		regSearch = r
	}
xurime's avatar
xurime 已提交
711 712 713 714
	xlsx, err := f.workSheetReader(sheet)
	if err != nil {
		return result, err
	}
R
r-uchino 已提交
715 716
	name, ok := f.sheetMap[trimSheetName(sheet)]
	if !ok {
717
		return result, nil
R
r-uchino 已提交
718 719 720 721 722
	}
	if xlsx != nil {
		output, _ := xml.Marshal(f.Sheet[name])
		f.saveFileList(name, replaceWorkSheetsRelationshipsNameSpaceBytes(output))
	}
723 724 725 726 727 728 729 730 731 732 733
	return f.searchSheet(name, value, regSearch)
}

// searchSheet provides a function to get coordinates by given worksheet name,
// cell value, and regular expression.
func (f *File) searchSheet(name, value string, regSearch bool) ([]string, error) {
	var (
		inElement string
		result    []string
		r         xlsxRow
	)
R
r-uchino 已提交
734 735
	xml.NewDecoder(bytes.NewReader(f.readXML(name)))
	d := f.sharedStringsReader()
xurime's avatar
xurime 已提交
736

R
r-uchino 已提交
737 738 739 740 741 742 743 744 745 746 747 748 749 750
	decoder := xml.NewDecoder(bytes.NewReader(f.readXML(name)))
	for {
		token, _ := decoder.Token()
		if token == nil {
			break
		}
		switch startElement := token.(type) {
		case xml.StartElement:
			inElement = startElement.Name.Local
			if inElement == "row" {
				r = xlsxRow{}
				_ = decoder.DecodeElement(&r, &startElement)
				for _, colCell := range r.C {
					val, _ := colCell.getValueFrom(f, d)
751 752 753 754 755 756 757 758 759
					if regSearch {
						regex := regexp.MustCompile(value)
						if !regex.MatchString(val) {
							continue
						}
					} else {
						if val != value {
							continue
						}
R
r-uchino 已提交
760
					}
761

762 763 764 765 766 767 768 769 770
					cellCol, _, err := CellNameToCoordinates(colCell.R)
					if err != nil {
						return result, err
					}
					cellName, err := CoordinatesToCellName(cellCol, r.R)
					if err != nil {
						return result, err
					}
					result = append(result, cellName)
R
r-uchino 已提交
771 772 773 774 775
				}
			}
		default:
		}
	}
776
	return result, nil
R
r-uchino 已提交
777 778
}

779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927
// SetHeaderFooter provides a function to set headers and footers by given
// worksheet name and the control characters.
//
// Headers and footers are specified using the following settings fields:
//
//     Fields           | Description
//    ------------------+-----------------------------------------------------------
//     AlignWithMargins | Align header footer margins with page margins
//     DifferentFirst   | Different first-page header and footer indicator
//     DifferentOddEven | Different odd and even page headers and footers indicator
//     ScaleWithDoc     | Scale header and footer with document scaling
//     OddFooter        | Odd Page Footer
//     OddHeader        | Odd Header
//     EvenFooter       | Even Page Footer
//     EvenHeader       | Even Page Header
//     FirstFooter      | First Page Footer
//     FirstHeader      | First Page Header
//
// The following formatting codes can be used in 6 string type fields:
// OddHeader, OddFooter, EvenHeader, EvenFooter, FirstFooter, FirstHeader
//
//     Formatting Code        | Description
//    ------------------------+-------------------------------------------------------------------------
//     &&                     | The character "&"
//                            |
//     &font-size             | Size of the text font, where font-size is a decimal font size in points
//                            |
//     &"font name,font type" | A text font-name string, font name, and a text font-type string,
//                            | font type
//                            |
//     &"-,Regular"           | Regular text format. Toggles bold and italic modes to off
//                            |
//     &A                     | Current worksheet's tab name
//                            |
//     &B or &"-,Bold"        | Bold text format, from off to on, or vice versa. The default mode is off
//                            |
//     &D                     | Current date
//                            |
//     &C                     | Center section
//                            |
//     &E                     | Double-underline text format
//                            |
//     &F                     | Current workbook's file name
//                            |
//     &G                     | Drawing object as background
//                            |
//     &H                     | Shadow text format
//                            |
//     &I or &"-,Italic"      | Italic text format
//                            |
//     &K                     | Text font color
//                            |
//                            | An RGB Color is specified as RRGGBB
//                            |
//                            | A Theme Color is specified as TTSNNN where TT is the theme color Id,
//                            | S is either "+" or "-" of the tint/shade value, and NNN is the
//                            | tint/shade value
//                            |
//     &L                     | Left section
//                            |
//     &N                     | Total number of pages
//                            |
//     &O                     | Outline text format
//                            |
//     &P[[+|-]n]             | Without the optional suffix, the current page number in decimal
//                            |
//     &R                     | Right section
//                            |
//     &S                     | Strikethrough text format
//                            |
//     &T                     | Current time
//                            |
//     &U                     | Single-underline text format. If double-underline mode is on, the next
//                            | occurrence in a section specifier toggles double-underline mode to off;
//                            | otherwise, it toggles single-underline mode, from off to on, or vice
//                            | versa. The default mode is off
//                            |
//     &X                     | Superscript text format
//                            |
//     &Y                     | Subscript text format
//                            |
//     &Z                     | Current workbook's file path
//
// For example:
//
//    err := f.SetHeaderFooter("Sheet1", &excelize.FormatHeaderFooter{
//        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`,
//    })
//
// This example shows:
//
// - The first page has its own header and footer
//
// - Odd and even-numbered pages have different headers and footers
//
// - Current page number in the right section of odd-page headers
//
// - Current workbook's file name in the center section of odd-page footers
//
// - Current page number in the left section of even-page headers
//
// - Current date in the left section and the current time in the right section
// of even-page footers
//
// - The text "Center Bold Header" on the first line of the center section of
// the first page, and the date on the second line of the center section of
// that same page
//
// - No footer on the first page
//
func (f *File) SetHeaderFooter(sheet string, settings *FormatHeaderFooter) error {
	xlsx, err := f.workSheetReader(sheet)
	if err != nil {
		return err
	}
	if settings == nil {
		xlsx.HeaderFooter = nil
		return err
	}

	v := reflect.ValueOf(*settings)
	// Check 6 string type fields: OddHeader, OddFooter, EvenHeader, EvenFooter,
	// FirstFooter, FirstHeader
	for i := 4; i < v.NumField()-1; i++ {
		if v.Field(i).Len() >= 255 {
			return fmt.Errorf("field %s must be less than 255 characters", v.Type().Field(i).Name)
		}
	}
	xlsx.HeaderFooter = &xlsxHeaderFooter{
		AlignWithMargins: settings.AlignWithMargins,
		DifferentFirst:   settings.DifferentFirst,
		DifferentOddEven: settings.DifferentOddEven,
		ScaleWithDoc:     settings.ScaleWithDoc,
		OddHeader:        settings.OddHeader,
		OddFooter:        settings.OddFooter,
		EvenHeader:       settings.EvenHeader,
		EvenFooter:       settings.EvenFooter,
		FirstFooter:      settings.FirstFooter,
		FirstHeader:      settings.FirstHeader,
	}
	return err
}

928 929
// ProtectSheet provides a function to prevent other users from accidentally
// or deliberately changing, moving, or deleting data in a worksheet. For
930
// example, protect Sheet1 with protection settings:
931
//
xurime's avatar
xurime 已提交
932
//    err := f.ProtectSheet("Sheet1", &excelize.FormatSheetProtection{
933 934 935 936
//        Password:      "password",
//        EditScenarios: false,
//    })
//
xurime's avatar
xurime 已提交
937 938 939 940 941
func (f *File) ProtectSheet(sheet string, settings *FormatSheetProtection) error {
	xlsx, err := f.workSheetReader(sheet)
	if err != nil {
		return err
	}
942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969
	if settings == nil {
		settings = &FormatSheetProtection{
			EditObjects:       true,
			EditScenarios:     true,
			SelectLockedCells: true,
		}
	}
	xlsx.SheetProtection = &xlsxSheetProtection{
		AutoFilter:          settings.AutoFilter,
		DeleteColumns:       settings.DeleteColumns,
		DeleteRows:          settings.DeleteRows,
		FormatCells:         settings.FormatCells,
		FormatColumns:       settings.FormatColumns,
		FormatRows:          settings.FormatRows,
		InsertColumns:       settings.InsertColumns,
		InsertHyperlinks:    settings.InsertHyperlinks,
		InsertRows:          settings.InsertRows,
		Objects:             settings.EditObjects,
		PivotTables:         settings.PivotTables,
		Scenarios:           settings.EditScenarios,
		SelectLockedCells:   settings.SelectLockedCells,
		SelectUnlockedCells: settings.SelectUnlockedCells,
		Sheet:               true,
		Sort:                settings.Sort,
	}
	if settings.Password != "" {
		xlsx.SheetProtection.Password = genSheetPasswd(settings.Password)
	}
xurime's avatar
xurime 已提交
970
	return err
971 972
}

973
// UnprotectSheet provides a function to unprotect an Excel worksheet.
xurime's avatar
xurime 已提交
974 975 976 977 978
func (f *File) UnprotectSheet(sheet string) error {
	xlsx, err := f.workSheetReader(sheet)
	if err != nil {
		return err
	}
979
	xlsx.SheetProtection = nil
xurime's avatar
xurime 已提交
980
	return err
981 982
}

xurime's avatar
xurime 已提交
983
// trimSheetName provides a function to trim invaild characters by given worksheet
984 985
// name.
func trimSheetName(name string) string {
986 987 988 989 990 991 992 993 994 995 996 997
	if strings.ContainsAny(name, ":\\/?*[]") || utf8.RuneCountInString(name) > 31 {
		r := make([]rune, 0, 31)
		for _, v := range name {
			switch v {
			case 58, 92, 47, 63, 42, 91, 93: // replace :\/?*[]
				continue
			default:
				r = append(r, v)
			}
			if len(r) == 31 {
				break
			}
998
		}
999
		name = string(r)
1000 1001 1002
	}
	return name
}
1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015

// PageLayoutOption is an option of a page layout of a worksheet. See
// SetPageLayout().
type PageLayoutOption interface {
	setPageLayout(layout *xlsxPageSetUp)
}

// PageLayoutOptionPtr is a writable PageLayoutOption. See GetPageLayout().
type PageLayoutOptionPtr interface {
	PageLayoutOption
	getPageLayout(layout *xlsxPageSetUp)
}

1016 1017 1018 1019 1020 1021 1022
type (
	// PageLayoutOrientation defines the orientation of page layout for a
	// worksheet.
	PageLayoutOrientation string
	// PageLayoutPaperSize defines the paper size of the worksheet
	PageLayoutPaperSize int
)
1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045

const (
	// OrientationPortrait indicates page layout orientation id portrait.
	OrientationPortrait = "portrait"
	// OrientationLandscape indicates page layout orientation id landscape.
	OrientationLandscape = "landscape"
)

// setPageLayout provides a method to set the orientation for the worksheet.
func (o PageLayoutOrientation) setPageLayout(ps *xlsxPageSetUp) {
	ps.Orientation = string(o)
}

// getPageLayout provides a method to get the orientation for the worksheet.
func (o *PageLayoutOrientation) getPageLayout(ps *xlsxPageSetUp) {
	// Excel default: portrait
	if ps == nil || ps.Orientation == "" {
		*o = OrientationPortrait
		return
	}
	*o = PageLayoutOrientation(ps.Orientation)
}

1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060
// setPageLayout provides a method to set the paper size for the worksheet.
func (p PageLayoutPaperSize) setPageLayout(ps *xlsxPageSetUp) {
	ps.PaperSize = int(p)
}

// getPageLayout provides a method to get the paper size for the worksheet.
func (p *PageLayoutPaperSize) getPageLayout(ps *xlsxPageSetUp) {
	// Excel default: 1
	if ps == nil || ps.PaperSize == 0 {
		*p = 1
		return
	}
	*p = PageLayoutPaperSize(ps.PaperSize)
}

1061 1062 1063 1064
// SetPageLayout provides a function to sets worksheet page layout.
//
// Available options:
//   PageLayoutOrientation(string)
1065
//   PageLayoutPaperSize(int)
1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112
//
// The following shows the paper size sorted by excelize index number:
//
//     Index | Paper Size
//    -------+-----------------------------------------------
//       1   | Letter paper (8.5 in. by 11 in.)
//       2   | Letter small paper (8.5 in. by 11 in.)
//       3   | Tabloid paper (11 in. by 17 in.)
//       4   | Ledger paper (17 in. by 11 in.)
//       5   | Legal paper (8.5 in. by 14 in.)
//       6   | Statement paper (5.5 in. by 8.5 in.)
//       7   | Executive paper (7.25 in. by 10.5 in.)
//       8   | A3 paper (297 mm by 420 mm)
//       9   | A4 paper (210 mm by 297 mm)
//       10  | A4 small paper (210 mm by 297 mm)
//       11  | A5 paper (148 mm by 210 mm)
//       12  | B4 paper (250 mm by 353 mm)
//       13  | B5 paper (176 mm by 250 mm)
//       14  | Folio paper (8.5 in. by 13 in.)
//       15  | Quarto paper (215 mm by 275 mm)
//       16  | Standard paper (10 in. by 14 in.)
//       17  | Standard paper (11 in. by 17 in.)
//       18  | Note paper (8.5 in. by 11 in.)
//       19  | #9 envelope (3.875 in. by 8.875 in.)
//       20  | #10 envelope (4.125 in. by 9.5 in.)
//       21  | #11 envelope (4.5 in. by 10.375 in.)
//       22  | #12 envelope (4.75 in. by 11 in.)
//       23  | #14 envelope (5 in. by 11.5 in.)
//       24  | C paper (17 in. by 22 in.)
//       25  | D paper (22 in. by 34 in.)
//       26  | E paper (34 in. by 44 in.)
//       27  | DL envelope (110 mm by 220 mm)
//       28  | C5 envelope (162 mm by 229 mm)
//       29  | C3 envelope (324 mm by 458 mm)
//       30  | C4 envelope (229 mm by 324 mm)
//       31  | C6 envelope (114 mm by 162 mm)
//       32  | C65 envelope (114 mm by 229 mm)
//       33  | B4 envelope (250 mm by 353 mm)
//       34  | B5 envelope (176 mm by 250 mm)
//       35  | B6 envelope (176 mm by 125 mm)
//       36  | Italy envelope (110 mm by 230 mm)
//       37  | Monarch envelope (3.875 in. by 7.5 in.).
//       38  | 6 3/4 envelope (3.625 in. by 6.5 in.)
//       39  | US standard fanfold (14.875 in. by 11 in.)
//       40  | German standard fanfold (8.5 in. by 12 in.)
//       41  | German legal fanfold (8.5 in. by 13 in.)
//       42  | ISO B4 (250 mm by 353 mm)
1113
//       43  | Japanese postcard (100 mm by 148 mm)
1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187
//       44  | Standard paper (9 in. by 11 in.)
//       45  | Standard paper (10 in. by 11 in.)
//       46  | Standard paper (15 in. by 11 in.)
//       47  | Invite envelope (220 mm by 220 mm)
//       50  | Letter extra paper (9.275 in. by 12 in.)
//       51  | Legal extra paper (9.275 in. by 15 in.)
//       52  | Tabloid extra paper (11.69 in. by 18 in.)
//       53  | A4 extra paper (236 mm by 322 mm)
//       54  | Letter transverse paper (8.275 in. by 11 in.)
//       55  | A4 transverse paper (210 mm by 297 mm)
//       56  | Letter extra transverse paper (9.275 in. by 12 in.)
//       57  | SuperA/SuperA/A4 paper (227 mm by 356 mm)
//       58  | SuperB/SuperB/A3 paper (305 mm by 487 mm)
//       59  | Letter plus paper (8.5 in. by 12.69 in.)
//       60  | A4 plus paper (210 mm by 330 mm)
//       61  | A5 transverse paper (148 mm by 210 mm)
//       62  | JIS B5 transverse paper (182 mm by 257 mm)
//       63  | A3 extra paper (322 mm by 445 mm)
//       64  | A5 extra paper (174 mm by 235 mm)
//       65  | ISO B5 extra paper (201 mm by 276 mm)
//       66  | A2 paper (420 mm by 594 mm)
//       67  | A3 transverse paper (297 mm by 420 mm)
//       68  | A3 extra transverse paper (322 mm by 445 mm)
//       69  | Japanese Double Postcard (200 mm x 148 mm)
//       70  | A6 (105 mm x 148 mm)
//       71  | Japanese Envelope Kaku #2
//       72  | Japanese Envelope Kaku #3
//       73  | Japanese Envelope Chou #3
//       74  | Japanese Envelope Chou #4
//       75  | Letter Rotated (11in x 8 1/2 11 in)
//       76  | A3 Rotated (420 mm x 297 mm)
//       77  | A4 Rotated (297 mm x 210 mm)
//       78  | A5 Rotated (210 mm x 148 mm)
//       79  | B4 (JIS) Rotated (364 mm x 257 mm)
//       80  | B5 (JIS) Rotated (257 mm x 182 mm)
//       81  | Japanese Postcard Rotated (148 mm x 100 mm)
//       82  | Double Japanese Postcard Rotated (148 mm x 200 mm)
//       83  | A6 Rotated (148 mm x 105 mm)
//       84  | Japanese Envelope Kaku #2 Rotated
//       85  | Japanese Envelope Kaku #3 Rotated
//       86  | Japanese Envelope Chou #3 Rotated
//       87  | Japanese Envelope Chou #4 Rotated
//       88  | B6 (JIS) (128 mm x 182 mm)
//       89  | B6 (JIS) Rotated (182 mm x 128 mm)
//       90  | (12 in x 11 in)
//       91  | Japanese Envelope You #4
//       92  | Japanese Envelope You #4 Rotated
//       93  | PRC 16K (146 mm x 215 mm)
//       94  | PRC 32K (97 mm x 151 mm)
//       95  | PRC 32K(Big) (97 mm x 151 mm)
//       96  | PRC Envelope #1 (102 mm x 165 mm)
//       97  | PRC Envelope #2 (102 mm x 176 mm)
//       98  | PRC Envelope #3 (125 mm x 176 mm)
//       99  | PRC Envelope #4 (110 mm x 208 mm)
//       100 | PRC Envelope #5 (110 mm x 220 mm)
//       101 | PRC Envelope #6 (120 mm x 230 mm)
//       102 | PRC Envelope #7 (160 mm x 230 mm)
//       103 | PRC Envelope #8 (120 mm x 309 mm)
//       104 | PRC Envelope #9 (229 mm x 324 mm)
//       105 | PRC Envelope #10 (324 mm x 458 mm)
//       106 | PRC 16K Rotated
//       107 | PRC 32K Rotated
//       108 | PRC 32K(Big) Rotated
//       109 | PRC Envelope #1 Rotated (165 mm x 102 mm)
//       110 | PRC Envelope #2 Rotated (176 mm x 102 mm)
//       111 | PRC Envelope #3 Rotated (176 mm x 125 mm)
//       112 | PRC Envelope #4 Rotated (208 mm x 110 mm)
//       113 | PRC Envelope #5 Rotated (220 mm x 110 mm)
//       114 | PRC Envelope #6 Rotated (230 mm x 120 mm)
//       115 | PRC Envelope #7 Rotated (230 mm x 160 mm)
//       116 | PRC Envelope #8 Rotated (309 mm x 120 mm)
//       117 | PRC Envelope #9 Rotated (324 mm x 229 mm)
//       118 | PRC Envelope #10 Rotated (458 mm x 324 mm)
//
1188
func (f *File) SetPageLayout(sheet string, opts ...PageLayoutOption) error {
xurime's avatar
xurime 已提交
1189 1190 1191 1192
	s, err := f.workSheetReader(sheet)
	if err != nil {
		return err
	}
1193 1194 1195 1196 1197 1198 1199 1200 1201
	ps := s.PageSetUp
	if ps == nil {
		ps = new(xlsxPageSetUp)
		s.PageSetUp = ps
	}

	for _, opt := range opts {
		opt.setPageLayout(ps)
	}
xurime's avatar
xurime 已提交
1202
	return err
1203 1204 1205 1206 1207 1208
}

// GetPageLayout provides a function to gets worksheet page layout.
//
// Available options:
//   PageLayoutOrientation(string)
1209
//   PageLayoutPaperSize(int)
1210
func (f *File) GetPageLayout(sheet string, opts ...PageLayoutOptionPtr) error {
xurime's avatar
xurime 已提交
1211 1212 1213 1214
	s, err := f.workSheetReader(sheet)
	if err != nil {
		return err
	}
1215 1216 1217 1218 1219
	ps := s.PageSetUp

	for _, opt := range opts {
		opt.getPageLayout(ps)
	}
xurime's avatar
xurime 已提交
1220
	return err
1221
}
1222

1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287
// SetDefinedName provides a function to set the defined names of the workbook
// or worksheet. If not specified scopr, the default scope is workbook.
// For example:
//
//    f.SetDefinedName(&excelize.DefinedName{
//        Name:     "Amount",
//        RefersTo: "Sheet1!$A$2:$D$5",
//        Comment:  "defined name comment",
//        Scope:    "Sheet2",
//    })
//
func (f *File) SetDefinedName(definedName *DefinedName) error {
	wb := f.workbookReader()
	d := xlsxDefinedName{
		Name:    definedName.Name,
		Comment: definedName.Comment,
		Data:    definedName.RefersTo,
	}
	if definedName.Scope != "" {
		if sheetID := f.GetSheetIndex(definedName.Scope); sheetID != 0 {
			sheetID--
			d.LocalSheetID = &sheetID
		}
	}
	if wb.DefinedNames != nil {
		for _, dn := range wb.DefinedNames.DefinedName {
			var scope string
			if dn.LocalSheetID != nil {
				scope = f.GetSheetName(*dn.LocalSheetID + 1)
			}
			if scope == definedName.Scope && dn.Name == definedName.Name {
				return errors.New("the same name already exists on scope")
			}
		}
		wb.DefinedNames.DefinedName = append(wb.DefinedNames.DefinedName, d)
		return nil
	}
	wb.DefinedNames = &xlsxDefinedNames{
		DefinedName: []xlsxDefinedName{d},
	}
	return nil
}

// GetDefinedName provides a function to get the defined names of the workbook
// or worksheet.
func (f *File) GetDefinedName() []DefinedName {
	var definedNames []DefinedName
	wb := f.workbookReader()
	if wb.DefinedNames != nil {
		for _, dn := range wb.DefinedNames.DefinedName {
			definedName := DefinedName{
				Name:     dn.Name,
				Comment:  dn.Comment,
				RefersTo: dn.Data,
				Scope:    "Workbook",
			}
			if dn.LocalSheetID != nil {
				definedName.Scope = f.GetSheetName(*dn.LocalSheetID + 1)
			}
			definedNames = append(definedNames, definedName)
		}
	}
	return definedNames
}

1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304
// workSheetRelsReader provides a function to get the pointer to the structure
// after deserialization of xl/worksheets/_rels/sheet%d.xml.rels.
func (f *File) workSheetRelsReader(path string) *xlsxWorkbookRels {
	if f.WorkSheetRels[path] == nil {
		_, ok := f.XLSX[path]
		if ok {
			c := xlsxWorkbookRels{}
			_ = xml.Unmarshal(namespaceStrictToTransitional(f.readXML(path)), &c)
			f.WorkSheetRels[path] = &c
		}
	}
	return f.WorkSheetRels[path]
}

// workSheetRelsWriter provides a function to save
// xl/worksheets/_rels/sheet%d.xml.rels after serialize structure.
func (f *File) workSheetRelsWriter() {
1305
	for p, r := range f.WorkSheetRels {
1306 1307
		if r != nil {
			v, _ := xml.Marshal(r)
1308 1309 1310 1311 1312
			f.saveFileList(p, v)
		}
	}
}

1313 1314
// fillSheetData ensures there are enough rows, and columns in the chosen
// row to accept data. Missing rows are backfilled and given their row number
1315 1316 1317 1318 1319 1320 1321 1322
func prepareSheetXML(xlsx *xlsxWorksheet, col int, row int) {
	rowCount := len(xlsx.SheetData.Row)
	if rowCount < row {
		// append missing rows
		for rowIdx := rowCount; rowIdx < row; rowIdx++ {
			xlsx.SheetData.Row = append(xlsx.SheetData.Row, xlsxRow{R: rowIdx + 1})
		}
	}
1323 1324 1325 1326 1327 1328 1329 1330 1331 1332
	rowData := &xlsx.SheetData.Row[row-1]
	fillColumns(rowData, col, row)
}

func fillColumns(rowData *xlsxRow, col, row int) {
	cellCount := len(rowData.C)
	if cellCount < col {
		for colIdx := cellCount; colIdx < col; colIdx++ {
			cellName, _ := CoordinatesToCellName(colIdx+1, row)
			rowData.C = append(rowData.C, xlsxC{R: cellName})
1333 1334 1335
		}
	}
}
1336 1337 1338 1339 1340 1341 1342

func makeContiguousColumns(xlsx *xlsxWorksheet, fromRow, toRow, colCount int) {
	for ; fromRow < toRow; fromRow++ {
		rowData := &xlsx.SheetData.Row[fromRow-1]
		fillColumns(rowData, colCount, fromRow)
	}
}