2022-01-09 00:20:42 +08:00
|
|
|
// Copyright 2016 - 2022 The excelize Authors. All rights reserved. Use of
|
2018-09-14 00:44:23 +08:00
|
|
|
// this source code is governed by a BSD-style license that can be found in
|
|
|
|
// the LICENSE file.
|
|
|
|
//
|
2022-02-17 00:09:11 +08:00
|
|
|
// Package excelize providing a set of functions that allow you to write to and
|
|
|
|
// read from XLAM / XLSM / XLSX / XLTM / XLTX files. Supports reading and
|
|
|
|
// writing spreadsheet documents generated by Microsoft Excel™ 2007 and later.
|
|
|
|
// Supports complex components by high compatibility, and provided streaming
|
|
|
|
// API for generating or reading data from a worksheet with huge amounts of
|
|
|
|
// data. This library needs Go version 1.15 or later.
|
2018-09-14 00:58:48 +08:00
|
|
|
|
2017-01-17 19:06:42 +08:00
|
|
|
package excelize
|
|
|
|
|
2021-07-06 00:31:04 +08:00
|
|
|
import (
|
|
|
|
"encoding/xml"
|
|
|
|
"sync"
|
|
|
|
)
|
2017-04-30 20:03:43 +08:00
|
|
|
|
2020-08-22 18:58:43 +08:00
|
|
|
// Source relationship and namespace list, associated prefixes and schema in which it was
|
|
|
|
// introduced.
|
2020-07-18 15:15:16 +08:00
|
|
|
var (
|
2021-12-26 14:55:53 +08:00
|
|
|
SourceRelationship = xml.Attr{Name: xml.Name{Local: "r", Space: "xmlns"}, Value: "http://schemas.openxmlformats.org/officeDocument/2006/relationships"}
|
|
|
|
SourceRelationshipCompatibility = xml.Attr{Name: xml.Name{Local: "mc", Space: "xmlns"}, Value: "http://schemas.openxmlformats.org/markup-compatibility/2006"}
|
|
|
|
SourceRelationshipChart20070802 = xml.Attr{Name: xml.Name{Local: "c14", Space: "xmlns"}, Value: "http://schemas.microsoft.com/office/drawing/2007/8/2/chart"}
|
|
|
|
SourceRelationshipChart2014 = xml.Attr{Name: xml.Name{Local: "c16", Space: "xmlns"}, Value: "http://schemas.microsoft.com/office/drawing/2014/chart"}
|
|
|
|
SourceRelationshipChart201506 = xml.Attr{Name: xml.Name{Local: "c16r2", Space: "xmlns"}, Value: "http://schemas.microsoft.com/office/drawing/2015/06/chart"}
|
|
|
|
NameSpaceSpreadSheet = xml.Attr{Name: xml.Name{Local: "xmlns"}, Value: "http://schemas.openxmlformats.org/spreadsheetml/2006/main"}
|
|
|
|
NameSpaceSpreadSheetX14 = xml.Attr{Name: xml.Name{Local: "x14", Space: "xmlns"}, Value: "http://schemas.microsoft.com/office/spreadsheetml/2009/9/main"}
|
|
|
|
NameSpaceDrawingML = xml.Attr{Name: xml.Name{Local: "a", Space: "xmlns"}, Value: "http://schemas.openxmlformats.org/drawingml/2006/main"}
|
|
|
|
NameSpaceDrawingMLChart = xml.Attr{Name: xml.Name{Local: "c", Space: "xmlns"}, Value: "http://schemas.openxmlformats.org/drawingml/2006/chart"}
|
|
|
|
NameSpaceDrawingMLSpreadSheet = xml.Attr{Name: xml.Name{Local: "xdr", Space: "xmlns"}, Value: "http://schemas.openxmlformats.org/drawingml/2006/spreadsheetDrawing"}
|
|
|
|
NameSpaceSpreadSheetX15 = xml.Attr{Name: xml.Name{Local: "x15", Space: "xmlns"}, Value: "http://schemas.microsoft.com/office/spreadsheetml/2010/11/main"}
|
|
|
|
NameSpaceSpreadSheetExcel2006Main = xml.Attr{Name: xml.Name{Local: "xne", Space: "xmlns"}, Value: "http://schemas.microsoft.com/office/excel/2006/main"}
|
|
|
|
NameSpaceMacExcel2008Main = xml.Attr{Name: xml.Name{Local: "mx", Space: "xmlns"}, Value: "http://schemas.microsoft.com/office/mac/excel/2008/main"}
|
|
|
|
NameSpaceDocumentPropertiesVariantTypes = xml.Attr{Name: xml.Name{Local: "vt", Space: "xmlns"}, Value: "http://schemas.openxmlformats.org/officeDocument/2006/docPropsVTypes"}
|
2020-07-18 15:15:16 +08:00
|
|
|
)
|
|
|
|
|
2017-01-17 19:06:42 +08:00
|
|
|
// Source relationship and namespace.
|
|
|
|
const (
|
2021-12-27 23:34:14 +08:00
|
|
|
SourceRelationshipOfficeDocument = "http://schemas.openxmlformats.org/officeDocument/2006/relationships/officeDocument"
|
|
|
|
SourceRelationshipChart = "http://schemas.openxmlformats.org/officeDocument/2006/relationships/chart"
|
|
|
|
SourceRelationshipComments = "http://schemas.openxmlformats.org/officeDocument/2006/relationships/comments"
|
|
|
|
SourceRelationshipImage = "http://schemas.openxmlformats.org/officeDocument/2006/relationships/image"
|
|
|
|
SourceRelationshipTable = "http://schemas.openxmlformats.org/officeDocument/2006/relationships/table"
|
|
|
|
SourceRelationshipDrawingML = "http://schemas.openxmlformats.org/officeDocument/2006/relationships/drawing"
|
|
|
|
SourceRelationshipDrawingVML = "http://schemas.openxmlformats.org/officeDocument/2006/relationships/vmlDrawing"
|
|
|
|
SourceRelationshipHyperLink = "http://schemas.openxmlformats.org/officeDocument/2006/relationships/hyperlink"
|
|
|
|
SourceRelationshipWorkSheet = "http://schemas.openxmlformats.org/officeDocument/2006/relationships/worksheet"
|
|
|
|
SourceRelationshipChartsheet = "http://schemas.openxmlformats.org/officeDocument/2006/relationships/chartsheet"
|
|
|
|
SourceRelationshipDialogsheet = "http://schemas.openxmlformats.org/officeDocument/2006/relationships/dialogsheet"
|
|
|
|
SourceRelationshipPivotTable = "http://schemas.openxmlformats.org/officeDocument/2006/relationships/pivotTable"
|
|
|
|
SourceRelationshipPivotCache = "http://schemas.openxmlformats.org/officeDocument/2006/relationships/pivotCacheDefinition"
|
|
|
|
SourceRelationshipSharedStrings = "http://schemas.openxmlformats.org/officeDocument/2006/relationships/sharedStrings"
|
2020-03-28 23:47:26 +08:00
|
|
|
SourceRelationshipVBAProject = "http://schemas.microsoft.com/office/2006/relationships/vbaProject"
|
|
|
|
NameSpaceXML = "http://www.w3.org/XML/1998/namespace"
|
|
|
|
NameSpaceXMLSchemaInstance = "http://www.w3.org/2001/XMLSchema-instance"
|
|
|
|
StrictSourceRelationship = "http://purl.oclc.org/ooxml/officeDocument/relationships"
|
2020-11-04 00:28:20 +08:00
|
|
|
StrictSourceRelationshipOfficeDocument = "http://purl.oclc.org/ooxml/officeDocument/relationships/officeDocument"
|
2020-03-28 23:47:26 +08:00
|
|
|
StrictSourceRelationshipChart = "http://purl.oclc.org/ooxml/officeDocument/relationships/chart"
|
|
|
|
StrictSourceRelationshipComments = "http://purl.oclc.org/ooxml/officeDocument/relationships/comments"
|
|
|
|
StrictSourceRelationshipImage = "http://purl.oclc.org/ooxml/officeDocument/relationships/image"
|
|
|
|
StrictNameSpaceSpreadSheet = "http://purl.oclc.org/ooxml/spreadsheetml/main"
|
|
|
|
NameSpaceDublinCore = "http://purl.org/dc/elements/1.1/"
|
|
|
|
NameSpaceDublinCoreTerms = "http://purl.org/dc/terms/"
|
2022-01-09 00:20:42 +08:00
|
|
|
NameSpaceDublinCoreMetadataInitiative = "http://purl.org/dc/dcmitype/"
|
2020-03-28 23:47:26 +08:00
|
|
|
ContentTypeDrawing = "application/vnd.openxmlformats-officedocument.drawing+xml"
|
|
|
|
ContentTypeDrawingML = "application/vnd.openxmlformats-officedocument.drawingml.chart+xml"
|
2022-01-23 00:32:34 +08:00
|
|
|
ContentTypeSheetML = "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet.main+xml"
|
|
|
|
ContentTypeTemplate = "application/vnd.openxmlformats-officedocument.spreadsheetml.template.main+xml"
|
|
|
|
ContentTypeAddinMacro = "application/vnd.ms-excel.addin.macroEnabled.main+xml"
|
2020-03-28 23:47:26 +08:00
|
|
|
ContentTypeMacro = "application/vnd.ms-excel.sheet.macroEnabled.main+xml"
|
2022-01-23 00:32:34 +08:00
|
|
|
ContentTypeTemplateMacro = "application/vnd.ms-excel.template.macroEnabled.main+xml"
|
2020-03-28 23:47:26 +08:00
|
|
|
ContentTypeSpreadSheetMLChartsheet = "application/vnd.openxmlformats-officedocument.spreadsheetml.chartsheet+xml"
|
|
|
|
ContentTypeSpreadSheetMLComments = "application/vnd.openxmlformats-officedocument.spreadsheetml.comments+xml"
|
|
|
|
ContentTypeSpreadSheetMLPivotCacheDefinition = "application/vnd.openxmlformats-officedocument.spreadsheetml.pivotCacheDefinition+xml"
|
|
|
|
ContentTypeSpreadSheetMLPivotTable = "application/vnd.openxmlformats-officedocument.spreadsheetml.pivotTable+xml"
|
2020-04-06 00:23:27 +08:00
|
|
|
ContentTypeSpreadSheetMLSharedStrings = "application/vnd.openxmlformats-officedocument.spreadsheetml.sharedStrings+xml"
|
2020-03-28 23:47:26 +08:00
|
|
|
ContentTypeSpreadSheetMLTable = "application/vnd.openxmlformats-officedocument.spreadsheetml.table+xml"
|
|
|
|
ContentTypeSpreadSheetMLWorksheet = "application/vnd.openxmlformats-officedocument.spreadsheetml.worksheet+xml"
|
|
|
|
ContentTypeVBA = "application/vnd.ms-office.vbaProject"
|
|
|
|
ContentTypeVML = "application/vnd.openxmlformats-officedocument.vmlDrawing"
|
2019-10-24 23:18:02 +08:00
|
|
|
// ExtURIConditionalFormattings is the extLst child element
|
|
|
|
// ([ISO/IEC29500-1:2016] section 18.2.10) of the worksheet element
|
|
|
|
// ([ISO/IEC29500-1:2016] section 18.3.1.99) is extended by the addition of
|
|
|
|
// new child ext elements ([ISO/IEC29500-1:2016] section 18.2.7)
|
2019-07-31 23:53:49 +08:00
|
|
|
ExtURIConditionalFormattings = "{78C0D931-6437-407D-A8EE-F0AAD7539E65}"
|
|
|
|
ExtURIDataValidations = "{CCE6A557-97BC-4B89-ADB6-D9C93CAAB3DF}"
|
|
|
|
ExtURISparklineGroups = "{05C60535-1F16-4fd2-B633-F4F36F0B64E0}"
|
2019-08-04 20:24:59 +08:00
|
|
|
ExtURISlicerListX14 = "{A8765BA9-456A-4DAB-B4F3-ACF838C121DE}"
|
|
|
|
ExtURISlicerCachesListX14 = "{BBE1A952-AA13-448e-AADC-164F8A28A991}"
|
|
|
|
ExtURISlicerListX15 = "{3A4CF648-6AED-40f4-86FF-DC5316D8AED3}"
|
2019-07-31 23:53:49 +08:00
|
|
|
ExtURIProtectedRanges = "{FC87AEE6-9EDD-4A0A-B7FB-166176984837}"
|
|
|
|
ExtURIIgnoredErrors = "{01252117-D84E-4E92-8308-4BE1C098FCBB}"
|
|
|
|
ExtURIWebExtensions = "{F7C9EE02-42E1-4005-9D12-6889AFFD525C}"
|
|
|
|
ExtURITimelineRefs = "{7E03D99C-DC04-49d9-9315-930204A7B6E9}"
|
|
|
|
ExtURIDrawingBlip = "{28A0092B-C50C-407E-A947-70E740481C1C}"
|
2019-08-04 20:24:59 +08:00
|
|
|
ExtURIMacExcelMX = "{64002731-A6B0-56B0-2670-7721B7C09600}"
|
2017-01-17 19:06:42 +08:00
|
|
|
)
|
|
|
|
|
2020-05-29 00:26:40 +08:00
|
|
|
// Excel specifications and limits
|
|
|
|
const (
|
2021-08-15 00:06:40 +08:00
|
|
|
UnzipSizeLimit = 1000 << 24
|
2021-04-30 00:14:42 +08:00
|
|
|
StreamChunkSize = 1 << 24
|
2020-09-18 22:20:58 +08:00
|
|
|
MaxFontFamilyLength = 31
|
|
|
|
MaxFontSize = 409
|
2022-05-16 21:05:22 +08:00
|
|
|
MaxFilePathLength = 207
|
2021-11-16 00:40:44 +08:00
|
|
|
MaxFieldLength = 255
|
2020-09-18 22:20:58 +08:00
|
|
|
MaxColumnWidth = 255
|
|
|
|
MaxRowHeight = 409
|
2022-08-11 00:20:48 +08:00
|
|
|
MaxCellStyles = 64000
|
2022-05-23 13:02:11 +08:00
|
|
|
MinFontSize = 1
|
2020-05-29 00:26:40 +08:00
|
|
|
TotalRows = 1048576
|
2022-07-14 23:36:43 +08:00
|
|
|
MinColumns = 1
|
|
|
|
MaxColumns = 16384
|
2020-05-29 00:26:40 +08:00
|
|
|
TotalSheetHyperlinks = 65529
|
|
|
|
TotalCellChars = 32767
|
2021-03-15 23:56:36 +08:00
|
|
|
// pivotTableVersion should be greater than 3. One or more of the
|
|
|
|
// PivotTables chosen are created in a version of Excel earlier than
|
|
|
|
// Excel 2007 or in compatibility mode. Slicer can only be used with
|
|
|
|
// PivotTables created in Excel 2007 or a newer version of Excel.
|
|
|
|
pivotTableVersion = 3
|
2020-05-29 00:26:40 +08:00
|
|
|
)
|
|
|
|
|
2022-08-06 15:23:03 +08:00
|
|
|
// ColorMappingType is the type of color transformation.
|
|
|
|
type ColorMappingType byte
|
|
|
|
|
|
|
|
// Color transformation types enumeration.
|
|
|
|
const (
|
|
|
|
ColorMappingTypeLight1 ColorMappingType = iota
|
|
|
|
ColorMappingTypeDark1
|
|
|
|
ColorMappingTypeLight2
|
|
|
|
ColorMappingTypeDark2
|
|
|
|
ColorMappingTypeAccent1
|
|
|
|
ColorMappingTypeAccent2
|
|
|
|
ColorMappingTypeAccent3
|
|
|
|
ColorMappingTypeAccent4
|
|
|
|
ColorMappingTypeAccent5
|
|
|
|
ColorMappingTypeAccent6
|
|
|
|
ColorMappingTypeHyperlink
|
|
|
|
ColorMappingTypeFollowedHyperlink
|
|
|
|
ColorMappingTypeUnset int = -1
|
|
|
|
)
|
|
|
|
|
2022-05-13 01:03:40 +08:00
|
|
|
// supportedImageTypes defined supported image types.
|
2022-08-21 01:09:32 +08:00
|
|
|
var supportedImageTypes = map[string]string{".gif": ".gif", ".jpg": ".jpeg", ".jpeg": ".jpeg", ".png": ".png", ".tif": ".tiff", ".tiff": ".tiff", ".emf": ".emf", ".wmf": ".wmf", ".emz": ".emz", ".wmz": ".wmz"}
|
2017-03-28 21:18:06 +08:00
|
|
|
|
2022-09-08 22:20:21 +08:00
|
|
|
// supportedContentType defined supported file format types.
|
|
|
|
var supportedContentType = map[string]string{
|
|
|
|
".xlam": ContentTypeAddinMacro,
|
|
|
|
".xlsm": ContentTypeMacro,
|
|
|
|
".xlsx": ContentTypeSheetML,
|
|
|
|
".xltm": ContentTypeTemplateMacro,
|
|
|
|
".xltx": ContentTypeTemplate,
|
|
|
|
}
|
|
|
|
|
2017-01-18 16:05:01 +08:00
|
|
|
// xlsxCNvPr directly maps the cNvPr (Non-Visual Drawing Properties). This
|
|
|
|
// element specifies non-visual canvas properties. This allows for additional
|
|
|
|
// information that does not affect the appearance of the picture to be stored.
|
2017-01-17 19:06:42 +08:00
|
|
|
type xlsxCNvPr struct {
|
2018-02-03 15:02:37 +08:00
|
|
|
ID int `xml:"id,attr"`
|
|
|
|
Name string `xml:"name,attr"`
|
|
|
|
Descr string `xml:"descr,attr"`
|
|
|
|
Title string `xml:"title,attr,omitempty"`
|
|
|
|
HlinkClick *xlsxHlinkClick `xml:"a:hlinkClick"`
|
|
|
|
}
|
|
|
|
|
|
|
|
// xlsxHlinkClick (Click Hyperlink) Specifies the on-click hyperlink
|
|
|
|
// information to be applied to a run of text. When the hyperlink text is
|
|
|
|
// clicked the link is fetched.
|
|
|
|
type xlsxHlinkClick struct {
|
|
|
|
R string `xml:"xmlns:r,attr,omitempty"`
|
|
|
|
RID string `xml:"r:id,attr,omitempty"`
|
|
|
|
InvalidURL string `xml:"invalidUrl,attr,omitempty"`
|
|
|
|
Action string `xml:"action,attr,omitempty"`
|
|
|
|
TgtFrame string `xml:"tgtFrame,attr,omitempty"`
|
|
|
|
Tooltip string `xml:"tooltip,attr,omitempty"`
|
|
|
|
History bool `xml:"history,attr,omitempty"`
|
|
|
|
HighlightClick bool `xml:"highlightClick,attr,omitempty"`
|
|
|
|
EndSnd bool `xml:"endSnd,attr,omitempty"`
|
2017-01-17 19:06:42 +08:00
|
|
|
}
|
|
|
|
|
|
|
|
// xlsxPicLocks directly maps the picLocks (Picture Locks). This element
|
2017-01-18 16:05:01 +08:00
|
|
|
// specifies all locking properties for a graphic frame. These properties inform
|
|
|
|
// the generating application about specific properties that have been
|
|
|
|
// previously locked and thus should not be changed.
|
2017-01-17 19:06:42 +08:00
|
|
|
type xlsxPicLocks struct {
|
|
|
|
NoAdjustHandles bool `xml:"noAdjustHandles,attr,omitempty"`
|
|
|
|
NoChangeArrowheads bool `xml:"noChangeArrowheads,attr,omitempty"`
|
|
|
|
NoChangeAspect bool `xml:"noChangeAspect,attr"`
|
|
|
|
NoChangeShapeType bool `xml:"noChangeShapeType,attr,omitempty"`
|
|
|
|
NoCrop bool `xml:"noCrop,attr,omitempty"`
|
|
|
|
NoEditPoints bool `xml:"noEditPoints,attr,omitempty"`
|
|
|
|
NoGrp bool `xml:"noGrp,attr,omitempty"`
|
|
|
|
NoMove bool `xml:"noMove,attr,omitempty"`
|
|
|
|
NoResize bool `xml:"noResize,attr,omitempty"`
|
|
|
|
NoRot bool `xml:"noRot,attr,omitempty"`
|
|
|
|
NoSelect bool `xml:"noSelect,attr,omitempty"`
|
|
|
|
}
|
|
|
|
|
2022-01-09 00:20:42 +08:00
|
|
|
// xlsxBlip element specifies the existence of an image (binary large image or
|
|
|
|
// picture) and contains a reference to the image data.
|
2017-01-17 19:06:42 +08:00
|
|
|
type xlsxBlip struct {
|
|
|
|
Embed string `xml:"r:embed,attr"`
|
|
|
|
Cstate string `xml:"cstate,attr,omitempty"`
|
|
|
|
R string `xml:"xmlns:r,attr"`
|
|
|
|
}
|
|
|
|
|
2017-01-18 16:05:01 +08:00
|
|
|
// xlsxStretch directly maps the stretch element. This element specifies that a
|
|
|
|
// BLIP should be stretched to fill the target rectangle. The other option is a
|
|
|
|
// tile where a BLIP is tiled to fill the available area.
|
2017-01-17 19:06:42 +08:00
|
|
|
type xlsxStretch struct {
|
|
|
|
FillRect string `xml:"a:fillRect"`
|
|
|
|
}
|
|
|
|
|
2017-01-18 16:05:01 +08:00
|
|
|
// xlsxOff directly maps the colOff and rowOff element. This element is used to
|
|
|
|
// specify the column offset within a cell.
|
2017-01-17 19:06:42 +08:00
|
|
|
type xlsxOff struct {
|
|
|
|
X int `xml:"x,attr"`
|
|
|
|
Y int `xml:"y,attr"`
|
|
|
|
}
|
|
|
|
|
|
|
|
// xlsxExt directly maps the ext element.
|
|
|
|
type xlsxExt struct {
|
|
|
|
Cx int `xml:"cx,attr"`
|
|
|
|
Cy int `xml:"cy,attr"`
|
|
|
|
}
|
|
|
|
|
2017-01-18 16:05:01 +08:00
|
|
|
// xlsxPrstGeom directly maps the prstGeom (Preset geometry). This element
|
|
|
|
// specifies when a preset geometric shape should be used instead of a custom
|
|
|
|
// geometric shape. The generating application should be able to render all
|
|
|
|
// preset geometries enumerated in the ST_ShapeType list.
|
2017-01-17 19:06:42 +08:00
|
|
|
type xlsxPrstGeom struct {
|
|
|
|
Prst string `xml:"prst,attr"`
|
|
|
|
}
|
|
|
|
|
2017-01-18 16:05:01 +08:00
|
|
|
// xlsxXfrm directly maps the xfrm (2D Transform for Graphic Frame). This
|
|
|
|
// element specifies the transform to be applied to the corresponding graphic
|
|
|
|
// frame. This transformation is applied to the graphic frame just as it would
|
|
|
|
// be for a shape or group shape.
|
2017-01-17 19:06:42 +08:00
|
|
|
type xlsxXfrm struct {
|
|
|
|
Off xlsxOff `xml:"a:off"`
|
|
|
|
Ext xlsxExt `xml:"a:ext"`
|
|
|
|
}
|
|
|
|
|
2017-01-18 16:05:01 +08:00
|
|
|
// xlsxCNvPicPr directly maps the cNvPicPr (Non-Visual Picture Drawing
|
|
|
|
// Properties). This element specifies the non-visual properties for the picture
|
|
|
|
// canvas. These properties are to be used by the generating application to
|
|
|
|
// determine how certain properties are to be changed for the picture object in
|
|
|
|
// question.
|
2017-01-17 19:06:42 +08:00
|
|
|
type xlsxCNvPicPr struct {
|
|
|
|
PicLocks xlsxPicLocks `xml:"a:picLocks"`
|
|
|
|
}
|
|
|
|
|
2017-01-18 16:05:01 +08:00
|
|
|
// directly maps the nvPicPr (Non-Visual Properties for a Picture). This element
|
|
|
|
// specifies all non-visual properties for a picture. This element is a
|
|
|
|
// container for the non-visual identification properties, shape properties and
|
|
|
|
// application properties that are to be associated with a picture. This allows
|
|
|
|
// for additional information that does not affect the appearance of the picture
|
|
|
|
// to be stored.
|
2017-01-17 19:06:42 +08:00
|
|
|
type xlsxNvPicPr struct {
|
|
|
|
CNvPr xlsxCNvPr `xml:"xdr:cNvPr"`
|
|
|
|
CNvPicPr xlsxCNvPicPr `xml:"xdr:cNvPicPr"`
|
|
|
|
}
|
|
|
|
|
2017-01-18 16:05:01 +08:00
|
|
|
// xlsxBlipFill directly maps the blipFill (Picture Fill). This element
|
|
|
|
// specifies the kind of picture fill that the picture object has. Because a
|
|
|
|
// picture has a picture fill already by default, it is possible to have two
|
|
|
|
// fills specified for a picture object.
|
2017-01-17 19:06:42 +08:00
|
|
|
type xlsxBlipFill struct {
|
|
|
|
Blip xlsxBlip `xml:"a:blip"`
|
|
|
|
Stretch xlsxStretch `xml:"a:stretch"`
|
|
|
|
}
|
|
|
|
|
2021-09-08 22:05:42 +08:00
|
|
|
// xlsxLineProperties specifies the width of a line in EMUs. This simple type
|
|
|
|
// has a minimum value of greater than or equal to 0. This simple type has a
|
|
|
|
// maximum value of less than or equal to 20116800.
|
|
|
|
type xlsxLineProperties struct {
|
|
|
|
W int `xml:"w,attr,omitempty"`
|
|
|
|
}
|
|
|
|
|
2017-01-22 16:16:03 +08:00
|
|
|
// xlsxSpPr directly maps the spPr (Shape Properties). This element specifies
|
|
|
|
// the visual shape properties that can be applied to a picture. These are the
|
|
|
|
// same properties that are allowed to describe the visual properties of a shape
|
|
|
|
// but are used here to describe the visual appearance of a picture within a
|
|
|
|
// document.
|
2017-01-17 19:06:42 +08:00
|
|
|
type xlsxSpPr struct {
|
2021-09-08 22:05:42 +08:00
|
|
|
Xfrm xlsxXfrm `xml:"a:xfrm"`
|
|
|
|
PrstGeom xlsxPrstGeom `xml:"a:prstGeom"`
|
|
|
|
Ln xlsxLineProperties `xml:"a:ln"`
|
2017-01-17 19:06:42 +08:00
|
|
|
}
|
|
|
|
|
2017-01-18 16:05:01 +08:00
|
|
|
// xlsxPic elements encompass the definition of pictures within the DrawingML
|
|
|
|
// framework. While pictures are in many ways very similar to shapes they have
|
|
|
|
// specific properties that are unique in order to optimize for picture-
|
|
|
|
// specific scenarios.
|
2017-01-17 19:06:42 +08:00
|
|
|
type xlsxPic struct {
|
|
|
|
NvPicPr xlsxNvPicPr `xml:"xdr:nvPicPr"`
|
|
|
|
BlipFill xlsxBlipFill `xml:"xdr:blipFill"`
|
|
|
|
SpPr xlsxSpPr `xml:"xdr:spPr"`
|
|
|
|
}
|
|
|
|
|
|
|
|
// xlsxFrom specifies the starting anchor.
|
|
|
|
type xlsxFrom struct {
|
|
|
|
Col int `xml:"xdr:col"`
|
|
|
|
ColOff int `xml:"xdr:colOff"`
|
|
|
|
Row int `xml:"xdr:row"`
|
|
|
|
RowOff int `xml:"xdr:rowOff"`
|
|
|
|
}
|
|
|
|
|
|
|
|
// xlsxTo directly specifies the ending anchor.
|
|
|
|
type xlsxTo struct {
|
|
|
|
Col int `xml:"xdr:col"`
|
|
|
|
ColOff int `xml:"xdr:colOff"`
|
|
|
|
Row int `xml:"xdr:row"`
|
|
|
|
RowOff int `xml:"xdr:rowOff"`
|
|
|
|
}
|
|
|
|
|
2017-04-30 20:03:43 +08:00
|
|
|
// xdrClientData directly maps the clientData element. An empty element which
|
2017-01-18 16:05:01 +08:00
|
|
|
// specifies (via attributes) certain properties related to printing and
|
|
|
|
// selection of the drawing object. The fLocksWithSheet attribute (either true
|
|
|
|
// or false) determines whether to disable selection when the sheet is
|
|
|
|
// protected, and fPrintsWithSheet attribute (either true or false) determines
|
|
|
|
// whether the object is printed when the sheet is printed.
|
2017-04-30 20:03:43 +08:00
|
|
|
type xdrClientData struct {
|
2017-01-17 19:06:42 +08:00
|
|
|
FLocksWithSheet bool `xml:"fLocksWithSheet,attr"`
|
|
|
|
FPrintsWithSheet bool `xml:"fPrintsWithSheet,attr"`
|
|
|
|
}
|
|
|
|
|
2017-04-30 20:03:43 +08:00
|
|
|
// xdrCellAnchor directly maps the oneCellAnchor (One Cell Anchor Shape Size)
|
2017-03-01 11:00:42 +08:00
|
|
|
// and twoCellAnchor (Two Cell Anchor Shape Size). This element specifies a two
|
|
|
|
// cell anchor placeholder for a group, a shape, or a drawing element. It moves
|
|
|
|
// with cells and its extents are in EMU units.
|
2017-04-30 20:03:43 +08:00
|
|
|
type xdrCellAnchor struct {
|
|
|
|
EditAs string `xml:"editAs,attr,omitempty"`
|
2020-03-28 23:47:26 +08:00
|
|
|
Pos *xlsxPoint2D `xml:"xdr:pos"`
|
2017-04-30 20:03:43 +08:00
|
|
|
From *xlsxFrom `xml:"xdr:from"`
|
|
|
|
To *xlsxTo `xml:"xdr:to"`
|
|
|
|
Ext *xlsxExt `xml:"xdr:ext"`
|
|
|
|
Sp *xdrSp `xml:"xdr:sp"`
|
|
|
|
Pic *xlsxPic `xml:"xdr:pic,omitempty"`
|
|
|
|
GraphicFrame string `xml:",innerxml"`
|
|
|
|
ClientData *xdrClientData `xml:"xdr:clientData"`
|
2017-01-17 19:06:42 +08:00
|
|
|
}
|
|
|
|
|
2020-03-28 23:47:26 +08:00
|
|
|
// xlsxPoint2D describes the position of a drawing element within a spreadsheet.
|
|
|
|
type xlsxPoint2D struct {
|
|
|
|
XMLName xml.Name `xml:"xdr:pos"`
|
|
|
|
X int `xml:"x,attr"`
|
|
|
|
Y int `xml:"y,attr"`
|
|
|
|
}
|
|
|
|
|
2017-01-18 16:05:01 +08:00
|
|
|
// xlsxWsDr directly maps the root element for a part of this content type shall
|
|
|
|
// wsDr.
|
2017-01-17 19:06:42 +08:00
|
|
|
type xlsxWsDr struct {
|
2021-07-06 00:31:04 +08:00
|
|
|
sync.Mutex
|
2022-03-05 14:48:34 +08:00
|
|
|
XMLName xml.Name `xml:"xdr:wsDr"`
|
|
|
|
A string `xml:"xmlns:a,attr,omitempty"`
|
|
|
|
Xdr string `xml:"xmlns:xdr,attr,omitempty"`
|
|
|
|
R string `xml:"xmlns:r,attr,omitempty"`
|
|
|
|
AlternateContent []*xlsxAlternateContent `xml:"mc:AlternateContent"`
|
|
|
|
AbsoluteAnchor []*xdrCellAnchor `xml:"xdr:absoluteAnchor"`
|
|
|
|
OneCellAnchor []*xdrCellAnchor `xml:"xdr:oneCellAnchor"`
|
|
|
|
TwoCellAnchor []*xdrCellAnchor `xml:"xdr:twoCellAnchor"`
|
2017-04-23 00:10:23 +08:00
|
|
|
}
|
|
|
|
|
|
|
|
// xlsxGraphicFrame (Graphic Frame) directly maps the xdr:graphicFrame element.
|
|
|
|
// This element specifies the existence of a graphics frame. This frame contains
|
|
|
|
// a graphic that was generated by an external source and needs a container in
|
|
|
|
// which to be displayed on the slide surface.
|
|
|
|
type xlsxGraphicFrame struct {
|
2017-04-30 20:03:43 +08:00
|
|
|
XMLName xml.Name `xml:"xdr:graphicFrame"`
|
2017-04-23 00:10:23 +08:00
|
|
|
Macro string `xml:"macro,attr"`
|
|
|
|
NvGraphicFramePr xlsxNvGraphicFramePr `xml:"xdr:nvGraphicFramePr"`
|
|
|
|
Xfrm xlsxXfrm `xml:"xdr:xfrm"`
|
|
|
|
Graphic *xlsxGraphic `xml:"a:graphic"`
|
|
|
|
}
|
|
|
|
|
|
|
|
// xlsxNvGraphicFramePr (Non-Visual Properties for a Graphic Frame) directly
|
|
|
|
// maps the xdr:nvGraphicFramePr element. This element specifies all non-visual
|
|
|
|
// properties for a graphic frame. This element is a container for the non-
|
|
|
|
// visual identification properties, shape properties and application properties
|
|
|
|
// that are to be associated with a graphic frame. This allows for additional
|
|
|
|
// information that does not affect the appearance of the graphic frame to be
|
|
|
|
// stored.
|
|
|
|
type xlsxNvGraphicFramePr struct {
|
|
|
|
CNvPr *xlsxCNvPr `xml:"xdr:cNvPr"`
|
|
|
|
ChicNvGraphicFramePr string `xml:"xdr:cNvGraphicFramePr"`
|
|
|
|
}
|
|
|
|
|
|
|
|
// xlsxGraphic (Graphic Object) directly maps the a:graphic element. This
|
|
|
|
// element specifies the existence of a single graphic object. Document authors
|
|
|
|
// should refer to this element when they wish to persist a graphical object of
|
|
|
|
// some kind. The specification for this graphical object is provided entirely
|
|
|
|
// by the document author and referenced within the graphicData child element.
|
|
|
|
type xlsxGraphic struct {
|
|
|
|
GraphicData *xlsxGraphicData `xml:"a:graphicData"`
|
|
|
|
}
|
|
|
|
|
|
|
|
// xlsxGraphicData (Graphic Object Data) directly maps the a:graphicData
|
|
|
|
// element. This element specifies the reference to a graphic object within the
|
|
|
|
// document. This graphic object is provided entirely by the document authors
|
|
|
|
// who choose to persist this data within the document.
|
|
|
|
type xlsxGraphicData struct {
|
|
|
|
URI string `xml:"uri,attr"`
|
|
|
|
Chart *xlsxChart `xml:"c:chart,omitempty"`
|
|
|
|
}
|
|
|
|
|
|
|
|
// xlsxChart (Chart) directly maps the c:chart element.
|
|
|
|
type xlsxChart struct {
|
|
|
|
C string `xml:"xmlns:c,attr"`
|
|
|
|
RID string `xml:"r:id,attr"`
|
|
|
|
R string `xml:"xmlns:r,attr"`
|
|
|
|
}
|
|
|
|
|
2017-04-30 20:03:43 +08:00
|
|
|
// xdrSp (Shape) directly maps the xdr:sp element. This element specifies the
|
|
|
|
// existence of a single shape. A shape can either be a preset or a custom
|
|
|
|
// geometry, defined using the SpreadsheetDrawingML framework. In addition to a
|
|
|
|
// geometry each shape can have both visual and non-visual properties attached.
|
|
|
|
// Text and corresponding styling information can also be attached to a shape.
|
|
|
|
// This shape is specified along with all other shapes within either the shape
|
|
|
|
// tree or group shape elements.
|
|
|
|
type xdrSp struct {
|
|
|
|
Macro string `xml:"macro,attr"`
|
|
|
|
Textlink string `xml:"textlink,attr"`
|
|
|
|
NvSpPr *xdrNvSpPr `xml:"xdr:nvSpPr"`
|
|
|
|
SpPr *xlsxSpPr `xml:"xdr:spPr"`
|
|
|
|
Style *xdrStyle `xml:"xdr:style"`
|
|
|
|
TxBody *xdrTxBody `xml:"xdr:txBody"`
|
|
|
|
}
|
|
|
|
|
|
|
|
// xdrNvSpPr (Non-Visual Properties for a Shape) directly maps the xdr:nvSpPr
|
|
|
|
// element. This element specifies all non-visual properties for a shape. This
|
|
|
|
// element is a container for the non-visual identification properties, shape
|
|
|
|
// properties and application properties that are to be associated with a shape.
|
|
|
|
// This allows for additional information that does not affect the appearance of
|
|
|
|
// the shape to be stored.
|
|
|
|
type xdrNvSpPr struct {
|
|
|
|
CNvPr *xlsxCNvPr `xml:"xdr:cNvPr"`
|
|
|
|
CNvSpPr *xdrCNvSpPr `xml:"xdr:cNvSpPr"`
|
|
|
|
}
|
|
|
|
|
|
|
|
// xdrCNvSpPr (Connection Non-Visual Shape Properties) directly maps the
|
|
|
|
// xdr:cNvSpPr element. This element specifies the set of non-visual properties
|
|
|
|
// for a connection shape. These properties specify all data about the
|
|
|
|
// connection shape which do not affect its display within a spreadsheet.
|
|
|
|
type xdrCNvSpPr struct {
|
|
|
|
TxBox bool `xml:"txBox,attr"`
|
|
|
|
}
|
|
|
|
|
|
|
|
// xdrStyle (Shape Style) directly maps the xdr:style element. The element
|
|
|
|
// specifies the style that is applied to a shape and the corresponding
|
|
|
|
// references for each of the style components such as lines and fills.
|
|
|
|
type xdrStyle struct {
|
|
|
|
LnRef *aRef `xml:"a:lnRef"`
|
|
|
|
FillRef *aRef `xml:"a:fillRef"`
|
|
|
|
EffectRef *aRef `xml:"a:effectRef"`
|
|
|
|
FontRef *aFontRef `xml:"a:fontRef"`
|
|
|
|
}
|
|
|
|
|
|
|
|
// aRef directly maps the a:lnRef, a:fillRef and a:effectRef element.
|
|
|
|
type aRef struct {
|
|
|
|
Idx int `xml:"idx,attr"`
|
|
|
|
ScrgbClr *aScrgbClr `xml:"a:scrgbClr"`
|
|
|
|
SchemeClr *attrValString `xml:"a:schemeClr"`
|
|
|
|
SrgbClr *attrValString `xml:"a:srgbClr"`
|
|
|
|
}
|
|
|
|
|
|
|
|
// aScrgbClr (RGB Color Model - Percentage Variant) directly maps the a:scrgbClr
|
|
|
|
// element. This element specifies a color using the red, green, blue RGB color
|
|
|
|
// model. Each component, red, green, and blue is expressed as a percentage from
|
|
|
|
// 0% to 100%. A linear gamma of 1.0 is assumed.
|
|
|
|
type aScrgbClr struct {
|
|
|
|
R float64 `xml:"r,attr"`
|
|
|
|
G float64 `xml:"g,attr"`
|
|
|
|
B float64 `xml:"b,attr"`
|
|
|
|
}
|
|
|
|
|
|
|
|
// aFontRef (Font Reference) directly maps the a:fontRef element. This element
|
|
|
|
// represents a reference to a themed font. When used it specifies which themed
|
|
|
|
// font to use along with a choice of color.
|
|
|
|
type aFontRef struct {
|
|
|
|
Idx string `xml:"idx,attr"`
|
|
|
|
SchemeClr *attrValString `xml:"a:schemeClr"`
|
|
|
|
}
|
|
|
|
|
|
|
|
// xdrTxBody (Shape Text Body) directly maps the xdr:txBody element. This
|
|
|
|
// element specifies the existence of text to be contained within the
|
|
|
|
// corresponding shape. All visible text and visible text related properties are
|
|
|
|
// contained within this element. There can be multiple paragraphs and within
|
|
|
|
// paragraphs multiple runs of text.
|
|
|
|
type xdrTxBody struct {
|
|
|
|
BodyPr *aBodyPr `xml:"a:bodyPr"`
|
2017-06-19 11:18:58 +08:00
|
|
|
P []*aP `xml:"a:p"`
|
2017-01-17 19:06:42 +08:00
|
|
|
}
|
2017-02-28 12:59:04 +08:00
|
|
|
|
This closes #1358, made a refactor with breaking changes, see details:
This made a refactor with breaking changes:
Motivation and Context
When I decided to add set horizontal centered support for this library to resolve #1358, the reason I made this huge breaking change was:
- There are too many exported types for set sheet view, properties, and format properties, although a function using the functional options pattern can be optimized by returning an anonymous function, these types or property set or get function has no binding categorization, so I change these functions like `SetAppProps` to accept a pointer of options structure.
- Users can not easily find out which properties should be in the `SetSheetPrOptions` or `SetSheetFormatPr` categories
- Nested properties cannot proceed modify easily
Introduce 5 new export data types:
`HeaderFooterOptions`, `PageLayoutMarginsOptions`, `PageLayoutOptions`, `SheetPropsOptions`, and `ViewOptions`
Rename 4 exported data types:
- Rename `PivotTableOption` to `PivotTableOptions`
- Rename `FormatHeaderFooter` to `HeaderFooterOptions`
- Rename `FormatSheetProtection` to `SheetProtectionOptions`
- Rename `SparklineOption` to `SparklineOptions`
Remove 54 exported types:
`AutoPageBreaks`, `BaseColWidth`, `BlackAndWhite`, `CodeName`, `CustomHeight`, `Date1904`, `DefaultColWidth`, `DefaultGridColor`, `DefaultRowHeight`, `EnableFormatConditionsCalculation`, `FilterPrivacy`, `FirstPageNumber`, `FitToHeight`, `FitToPage`, `FitToWidth`, `OutlineSummaryBelow`, `PageLayoutOption`, `PageLayoutOptionPtr`, `PageLayoutOrientation`, `PageLayoutPaperSize`, `PageLayoutScale`, `PageMarginBottom`, `PageMarginFooter`, `PageMarginHeader`, `PageMarginLeft`, `PageMarginRight`, `PageMarginsOptions`, `PageMarginsOptionsPtr`, `PageMarginTop`, `Published`, `RightToLeft`, `SheetFormatPrOptions`, `SheetFormatPrOptionsPtr`, `SheetPrOption`, `SheetPrOptionPtr`, `SheetViewOption`, `SheetViewOptionPtr`, `ShowFormulas`, `ShowGridLines`, `ShowRowColHeaders`, `ShowRuler`, `ShowZeros`, `TabColorIndexed`, `TabColorRGB`, `TabColorTheme`, `TabColorTint`, `ThickBottom`, `ThickTop`, `TopLeftCell`, `View`, `WorkbookPrOption`, `WorkbookPrOptionPtr`, `ZeroHeight` and `ZoomScale`
Remove 2 exported constants:
`OrientationPortrait` and `OrientationLandscape`
Change 8 functions:
- Change the `func (f *File) SetPageLayout(sheet string, opts ...PageLayoutOption) error` to `func (f *File) SetPageLayout(sheet string, opts *PageLayoutOptions) error`
- Change the `func (f *File) GetPageLayout(sheet string, opts ...PageLayoutOptionPtr) error` to `func (f *File) GetPageLayout(sheet string) (PageLayoutOptions, error)`
- Change the `func (f *File) SetPageMargins(sheet string, opts ...PageMarginsOptions) error` to `func (f *File) SetPageMargins(sheet string, opts *PageLayoutMarginsOptions) error`
- Change the `func (f *File) GetPageMargins(sheet string, opts ...PageMarginsOptionsPtr) error` to `func (f *File) GetPageMargins(sheet string) (PageLayoutMarginsOptions, error)`
- Change the `func (f *File) SetSheetViewOptions(sheet string, viewIndex int, opts ...SheetViewOption) error` to `func (f *File) SetSheetView(sheet string, viewIndex int, opts *ViewOptions) error`
- Change the `func (f *File) GetSheetViewOptions(sheet string, viewIndex int, opts ...SheetViewOptionPtr) error` to `func (f *File) GetSheetView(sheet string, viewIndex int) (ViewOptions, error)`
- Change the `func (f *File) SetWorkbookPrOptions(opts ...WorkbookPrOption) error` to `func (f *File) SetWorkbookProps(opts *WorkbookPropsOptions) error`
- Change the `func (f *File) GetWorkbookPrOptions(opts ...WorkbookPrOptionPtr) error` to `func (f *File) GetWorkbookProps() (WorkbookPropsOptions, error)`
Introduce new function to instead of existing functions:
- New function `func (f *File) SetSheetProps(sheet string, opts *SheetPropsOptions) error` instead of `func (f *File) SetSheetPrOptions(sheet string, opts ...SheetPrOption) error` and `func (f *File) SetSheetFormatPr(sheet string, opts ...SheetFormatPrOption
2022-09-29 22:00:21 +08:00
|
|
|
// pictureOptions directly maps the format settings of the picture.
|
|
|
|
type pictureOptions struct {
|
2017-02-28 12:59:04 +08:00
|
|
|
FPrintsWithSheet bool `json:"print_obj"`
|
|
|
|
FLocksWithSheet bool `json:"locked"`
|
|
|
|
NoChangeAspect bool `json:"lock_aspect_ratio"`
|
2020-05-17 17:36:53 +08:00
|
|
|
Autofit bool `json:"autofit"`
|
2017-02-28 12:59:04 +08:00
|
|
|
OffsetX int `json:"x_offset"`
|
|
|
|
OffsetY int `json:"y_offset"`
|
|
|
|
XScale float64 `json:"x_scale"`
|
|
|
|
YScale float64 `json:"y_scale"`
|
2018-02-03 15:02:37 +08:00
|
|
|
Hyperlink string `json:"hyperlink"`
|
|
|
|
HyperlinkType string `json:"hyperlink_type"`
|
2018-04-26 11:41:13 +08:00
|
|
|
Positioning string `json:"positioning"`
|
2017-02-28 12:59:04 +08:00
|
|
|
}
|
2017-04-30 20:03:43 +08:00
|
|
|
|
This closes #1358, made a refactor with breaking changes, see details:
This made a refactor with breaking changes:
Motivation and Context
When I decided to add set horizontal centered support for this library to resolve #1358, the reason I made this huge breaking change was:
- There are too many exported types for set sheet view, properties, and format properties, although a function using the functional options pattern can be optimized by returning an anonymous function, these types or property set or get function has no binding categorization, so I change these functions like `SetAppProps` to accept a pointer of options structure.
- Users can not easily find out which properties should be in the `SetSheetPrOptions` or `SetSheetFormatPr` categories
- Nested properties cannot proceed modify easily
Introduce 5 new export data types:
`HeaderFooterOptions`, `PageLayoutMarginsOptions`, `PageLayoutOptions`, `SheetPropsOptions`, and `ViewOptions`
Rename 4 exported data types:
- Rename `PivotTableOption` to `PivotTableOptions`
- Rename `FormatHeaderFooter` to `HeaderFooterOptions`
- Rename `FormatSheetProtection` to `SheetProtectionOptions`
- Rename `SparklineOption` to `SparklineOptions`
Remove 54 exported types:
`AutoPageBreaks`, `BaseColWidth`, `BlackAndWhite`, `CodeName`, `CustomHeight`, `Date1904`, `DefaultColWidth`, `DefaultGridColor`, `DefaultRowHeight`, `EnableFormatConditionsCalculation`, `FilterPrivacy`, `FirstPageNumber`, `FitToHeight`, `FitToPage`, `FitToWidth`, `OutlineSummaryBelow`, `PageLayoutOption`, `PageLayoutOptionPtr`, `PageLayoutOrientation`, `PageLayoutPaperSize`, `PageLayoutScale`, `PageMarginBottom`, `PageMarginFooter`, `PageMarginHeader`, `PageMarginLeft`, `PageMarginRight`, `PageMarginsOptions`, `PageMarginsOptionsPtr`, `PageMarginTop`, `Published`, `RightToLeft`, `SheetFormatPrOptions`, `SheetFormatPrOptionsPtr`, `SheetPrOption`, `SheetPrOptionPtr`, `SheetViewOption`, `SheetViewOptionPtr`, `ShowFormulas`, `ShowGridLines`, `ShowRowColHeaders`, `ShowRuler`, `ShowZeros`, `TabColorIndexed`, `TabColorRGB`, `TabColorTheme`, `TabColorTint`, `ThickBottom`, `ThickTop`, `TopLeftCell`, `View`, `WorkbookPrOption`, `WorkbookPrOptionPtr`, `ZeroHeight` and `ZoomScale`
Remove 2 exported constants:
`OrientationPortrait` and `OrientationLandscape`
Change 8 functions:
- Change the `func (f *File) SetPageLayout(sheet string, opts ...PageLayoutOption) error` to `func (f *File) SetPageLayout(sheet string, opts *PageLayoutOptions) error`
- Change the `func (f *File) GetPageLayout(sheet string, opts ...PageLayoutOptionPtr) error` to `func (f *File) GetPageLayout(sheet string) (PageLayoutOptions, error)`
- Change the `func (f *File) SetPageMargins(sheet string, opts ...PageMarginsOptions) error` to `func (f *File) SetPageMargins(sheet string, opts *PageLayoutMarginsOptions) error`
- Change the `func (f *File) GetPageMargins(sheet string, opts ...PageMarginsOptionsPtr) error` to `func (f *File) GetPageMargins(sheet string) (PageLayoutMarginsOptions, error)`
- Change the `func (f *File) SetSheetViewOptions(sheet string, viewIndex int, opts ...SheetViewOption) error` to `func (f *File) SetSheetView(sheet string, viewIndex int, opts *ViewOptions) error`
- Change the `func (f *File) GetSheetViewOptions(sheet string, viewIndex int, opts ...SheetViewOptionPtr) error` to `func (f *File) GetSheetView(sheet string, viewIndex int) (ViewOptions, error)`
- Change the `func (f *File) SetWorkbookPrOptions(opts ...WorkbookPrOption) error` to `func (f *File) SetWorkbookProps(opts *WorkbookPropsOptions) error`
- Change the `func (f *File) GetWorkbookPrOptions(opts ...WorkbookPrOptionPtr) error` to `func (f *File) GetWorkbookProps() (WorkbookPropsOptions, error)`
Introduce new function to instead of existing functions:
- New function `func (f *File) SetSheetProps(sheet string, opts *SheetPropsOptions) error` instead of `func (f *File) SetSheetPrOptions(sheet string, opts ...SheetPrOption) error` and `func (f *File) SetSheetFormatPr(sheet string, opts ...SheetFormatPrOption
2022-09-29 22:00:21 +08:00
|
|
|
// shapeOptions directly maps the format settings of the shape.
|
|
|
|
type shapeOptions struct {
|
|
|
|
Macro string `json:"macro"`
|
|
|
|
Type string `json:"type"`
|
|
|
|
Width int `json:"width"`
|
|
|
|
Height int `json:"height"`
|
|
|
|
Format pictureOptions `json:"format"`
|
|
|
|
Color shapeColorOptions `json:"color"`
|
|
|
|
Line lineOptions `json:"line"`
|
|
|
|
Paragraph []shapeParagraphOptions `json:"paragraph"`
|
2017-04-30 20:03:43 +08:00
|
|
|
}
|
|
|
|
|
This closes #1358, made a refactor with breaking changes, see details:
This made a refactor with breaking changes:
Motivation and Context
When I decided to add set horizontal centered support for this library to resolve #1358, the reason I made this huge breaking change was:
- There are too many exported types for set sheet view, properties, and format properties, although a function using the functional options pattern can be optimized by returning an anonymous function, these types or property set or get function has no binding categorization, so I change these functions like `SetAppProps` to accept a pointer of options structure.
- Users can not easily find out which properties should be in the `SetSheetPrOptions` or `SetSheetFormatPr` categories
- Nested properties cannot proceed modify easily
Introduce 5 new export data types:
`HeaderFooterOptions`, `PageLayoutMarginsOptions`, `PageLayoutOptions`, `SheetPropsOptions`, and `ViewOptions`
Rename 4 exported data types:
- Rename `PivotTableOption` to `PivotTableOptions`
- Rename `FormatHeaderFooter` to `HeaderFooterOptions`
- Rename `FormatSheetProtection` to `SheetProtectionOptions`
- Rename `SparklineOption` to `SparklineOptions`
Remove 54 exported types:
`AutoPageBreaks`, `BaseColWidth`, `BlackAndWhite`, `CodeName`, `CustomHeight`, `Date1904`, `DefaultColWidth`, `DefaultGridColor`, `DefaultRowHeight`, `EnableFormatConditionsCalculation`, `FilterPrivacy`, `FirstPageNumber`, `FitToHeight`, `FitToPage`, `FitToWidth`, `OutlineSummaryBelow`, `PageLayoutOption`, `PageLayoutOptionPtr`, `PageLayoutOrientation`, `PageLayoutPaperSize`, `PageLayoutScale`, `PageMarginBottom`, `PageMarginFooter`, `PageMarginHeader`, `PageMarginLeft`, `PageMarginRight`, `PageMarginsOptions`, `PageMarginsOptionsPtr`, `PageMarginTop`, `Published`, `RightToLeft`, `SheetFormatPrOptions`, `SheetFormatPrOptionsPtr`, `SheetPrOption`, `SheetPrOptionPtr`, `SheetViewOption`, `SheetViewOptionPtr`, `ShowFormulas`, `ShowGridLines`, `ShowRowColHeaders`, `ShowRuler`, `ShowZeros`, `TabColorIndexed`, `TabColorRGB`, `TabColorTheme`, `TabColorTint`, `ThickBottom`, `ThickTop`, `TopLeftCell`, `View`, `WorkbookPrOption`, `WorkbookPrOptionPtr`, `ZeroHeight` and `ZoomScale`
Remove 2 exported constants:
`OrientationPortrait` and `OrientationLandscape`
Change 8 functions:
- Change the `func (f *File) SetPageLayout(sheet string, opts ...PageLayoutOption) error` to `func (f *File) SetPageLayout(sheet string, opts *PageLayoutOptions) error`
- Change the `func (f *File) GetPageLayout(sheet string, opts ...PageLayoutOptionPtr) error` to `func (f *File) GetPageLayout(sheet string) (PageLayoutOptions, error)`
- Change the `func (f *File) SetPageMargins(sheet string, opts ...PageMarginsOptions) error` to `func (f *File) SetPageMargins(sheet string, opts *PageLayoutMarginsOptions) error`
- Change the `func (f *File) GetPageMargins(sheet string, opts ...PageMarginsOptionsPtr) error` to `func (f *File) GetPageMargins(sheet string) (PageLayoutMarginsOptions, error)`
- Change the `func (f *File) SetSheetViewOptions(sheet string, viewIndex int, opts ...SheetViewOption) error` to `func (f *File) SetSheetView(sheet string, viewIndex int, opts *ViewOptions) error`
- Change the `func (f *File) GetSheetViewOptions(sheet string, viewIndex int, opts ...SheetViewOptionPtr) error` to `func (f *File) GetSheetView(sheet string, viewIndex int) (ViewOptions, error)`
- Change the `func (f *File) SetWorkbookPrOptions(opts ...WorkbookPrOption) error` to `func (f *File) SetWorkbookProps(opts *WorkbookPropsOptions) error`
- Change the `func (f *File) GetWorkbookPrOptions(opts ...WorkbookPrOptionPtr) error` to `func (f *File) GetWorkbookProps() (WorkbookPropsOptions, error)`
Introduce new function to instead of existing functions:
- New function `func (f *File) SetSheetProps(sheet string, opts *SheetPropsOptions) error` instead of `func (f *File) SetSheetPrOptions(sheet string, opts ...SheetPrOption) error` and `func (f *File) SetSheetFormatPr(sheet string, opts ...SheetFormatPrOption
2022-09-29 22:00:21 +08:00
|
|
|
// shapeParagraphOptions directly maps the format settings of the paragraph in
|
2017-06-19 11:18:58 +08:00
|
|
|
// the shape.
|
This closes #1358, made a refactor with breaking changes, see details:
This made a refactor with breaking changes:
Motivation and Context
When I decided to add set horizontal centered support for this library to resolve #1358, the reason I made this huge breaking change was:
- There are too many exported types for set sheet view, properties, and format properties, although a function using the functional options pattern can be optimized by returning an anonymous function, these types or property set or get function has no binding categorization, so I change these functions like `SetAppProps` to accept a pointer of options structure.
- Users can not easily find out which properties should be in the `SetSheetPrOptions` or `SetSheetFormatPr` categories
- Nested properties cannot proceed modify easily
Introduce 5 new export data types:
`HeaderFooterOptions`, `PageLayoutMarginsOptions`, `PageLayoutOptions`, `SheetPropsOptions`, and `ViewOptions`
Rename 4 exported data types:
- Rename `PivotTableOption` to `PivotTableOptions`
- Rename `FormatHeaderFooter` to `HeaderFooterOptions`
- Rename `FormatSheetProtection` to `SheetProtectionOptions`
- Rename `SparklineOption` to `SparklineOptions`
Remove 54 exported types:
`AutoPageBreaks`, `BaseColWidth`, `BlackAndWhite`, `CodeName`, `CustomHeight`, `Date1904`, `DefaultColWidth`, `DefaultGridColor`, `DefaultRowHeight`, `EnableFormatConditionsCalculation`, `FilterPrivacy`, `FirstPageNumber`, `FitToHeight`, `FitToPage`, `FitToWidth`, `OutlineSummaryBelow`, `PageLayoutOption`, `PageLayoutOptionPtr`, `PageLayoutOrientation`, `PageLayoutPaperSize`, `PageLayoutScale`, `PageMarginBottom`, `PageMarginFooter`, `PageMarginHeader`, `PageMarginLeft`, `PageMarginRight`, `PageMarginsOptions`, `PageMarginsOptionsPtr`, `PageMarginTop`, `Published`, `RightToLeft`, `SheetFormatPrOptions`, `SheetFormatPrOptionsPtr`, `SheetPrOption`, `SheetPrOptionPtr`, `SheetViewOption`, `SheetViewOptionPtr`, `ShowFormulas`, `ShowGridLines`, `ShowRowColHeaders`, `ShowRuler`, `ShowZeros`, `TabColorIndexed`, `TabColorRGB`, `TabColorTheme`, `TabColorTint`, `ThickBottom`, `ThickTop`, `TopLeftCell`, `View`, `WorkbookPrOption`, `WorkbookPrOptionPtr`, `ZeroHeight` and `ZoomScale`
Remove 2 exported constants:
`OrientationPortrait` and `OrientationLandscape`
Change 8 functions:
- Change the `func (f *File) SetPageLayout(sheet string, opts ...PageLayoutOption) error` to `func (f *File) SetPageLayout(sheet string, opts *PageLayoutOptions) error`
- Change the `func (f *File) GetPageLayout(sheet string, opts ...PageLayoutOptionPtr) error` to `func (f *File) GetPageLayout(sheet string) (PageLayoutOptions, error)`
- Change the `func (f *File) SetPageMargins(sheet string, opts ...PageMarginsOptions) error` to `func (f *File) SetPageMargins(sheet string, opts *PageLayoutMarginsOptions) error`
- Change the `func (f *File) GetPageMargins(sheet string, opts ...PageMarginsOptionsPtr) error` to `func (f *File) GetPageMargins(sheet string) (PageLayoutMarginsOptions, error)`
- Change the `func (f *File) SetSheetViewOptions(sheet string, viewIndex int, opts ...SheetViewOption) error` to `func (f *File) SetSheetView(sheet string, viewIndex int, opts *ViewOptions) error`
- Change the `func (f *File) GetSheetViewOptions(sheet string, viewIndex int, opts ...SheetViewOptionPtr) error` to `func (f *File) GetSheetView(sheet string, viewIndex int) (ViewOptions, error)`
- Change the `func (f *File) SetWorkbookPrOptions(opts ...WorkbookPrOption) error` to `func (f *File) SetWorkbookProps(opts *WorkbookPropsOptions) error`
- Change the `func (f *File) GetWorkbookPrOptions(opts ...WorkbookPrOptionPtr) error` to `func (f *File) GetWorkbookProps() (WorkbookPropsOptions, error)`
Introduce new function to instead of existing functions:
- New function `func (f *File) SetSheetProps(sheet string, opts *SheetPropsOptions) error` instead of `func (f *File) SetSheetPrOptions(sheet string, opts ...SheetPrOption) error` and `func (f *File) SetSheetFormatPr(sheet string, opts ...SheetFormatPrOption
2022-09-29 22:00:21 +08:00
|
|
|
type shapeParagraphOptions struct {
|
2020-03-10 00:04:23 +08:00
|
|
|
Font Font `json:"font"`
|
|
|
|
Text string `json:"text"`
|
2017-06-19 11:18:58 +08:00
|
|
|
}
|
|
|
|
|
This closes #1358, made a refactor with breaking changes, see details:
This made a refactor with breaking changes:
Motivation and Context
When I decided to add set horizontal centered support for this library to resolve #1358, the reason I made this huge breaking change was:
- There are too many exported types for set sheet view, properties, and format properties, although a function using the functional options pattern can be optimized by returning an anonymous function, these types or property set or get function has no binding categorization, so I change these functions like `SetAppProps` to accept a pointer of options structure.
- Users can not easily find out which properties should be in the `SetSheetPrOptions` or `SetSheetFormatPr` categories
- Nested properties cannot proceed modify easily
Introduce 5 new export data types:
`HeaderFooterOptions`, `PageLayoutMarginsOptions`, `PageLayoutOptions`, `SheetPropsOptions`, and `ViewOptions`
Rename 4 exported data types:
- Rename `PivotTableOption` to `PivotTableOptions`
- Rename `FormatHeaderFooter` to `HeaderFooterOptions`
- Rename `FormatSheetProtection` to `SheetProtectionOptions`
- Rename `SparklineOption` to `SparklineOptions`
Remove 54 exported types:
`AutoPageBreaks`, `BaseColWidth`, `BlackAndWhite`, `CodeName`, `CustomHeight`, `Date1904`, `DefaultColWidth`, `DefaultGridColor`, `DefaultRowHeight`, `EnableFormatConditionsCalculation`, `FilterPrivacy`, `FirstPageNumber`, `FitToHeight`, `FitToPage`, `FitToWidth`, `OutlineSummaryBelow`, `PageLayoutOption`, `PageLayoutOptionPtr`, `PageLayoutOrientation`, `PageLayoutPaperSize`, `PageLayoutScale`, `PageMarginBottom`, `PageMarginFooter`, `PageMarginHeader`, `PageMarginLeft`, `PageMarginRight`, `PageMarginsOptions`, `PageMarginsOptionsPtr`, `PageMarginTop`, `Published`, `RightToLeft`, `SheetFormatPrOptions`, `SheetFormatPrOptionsPtr`, `SheetPrOption`, `SheetPrOptionPtr`, `SheetViewOption`, `SheetViewOptionPtr`, `ShowFormulas`, `ShowGridLines`, `ShowRowColHeaders`, `ShowRuler`, `ShowZeros`, `TabColorIndexed`, `TabColorRGB`, `TabColorTheme`, `TabColorTint`, `ThickBottom`, `ThickTop`, `TopLeftCell`, `View`, `WorkbookPrOption`, `WorkbookPrOptionPtr`, `ZeroHeight` and `ZoomScale`
Remove 2 exported constants:
`OrientationPortrait` and `OrientationLandscape`
Change 8 functions:
- Change the `func (f *File) SetPageLayout(sheet string, opts ...PageLayoutOption) error` to `func (f *File) SetPageLayout(sheet string, opts *PageLayoutOptions) error`
- Change the `func (f *File) GetPageLayout(sheet string, opts ...PageLayoutOptionPtr) error` to `func (f *File) GetPageLayout(sheet string) (PageLayoutOptions, error)`
- Change the `func (f *File) SetPageMargins(sheet string, opts ...PageMarginsOptions) error` to `func (f *File) SetPageMargins(sheet string, opts *PageLayoutMarginsOptions) error`
- Change the `func (f *File) GetPageMargins(sheet string, opts ...PageMarginsOptionsPtr) error` to `func (f *File) GetPageMargins(sheet string) (PageLayoutMarginsOptions, error)`
- Change the `func (f *File) SetSheetViewOptions(sheet string, viewIndex int, opts ...SheetViewOption) error` to `func (f *File) SetSheetView(sheet string, viewIndex int, opts *ViewOptions) error`
- Change the `func (f *File) GetSheetViewOptions(sheet string, viewIndex int, opts ...SheetViewOptionPtr) error` to `func (f *File) GetSheetView(sheet string, viewIndex int) (ViewOptions, error)`
- Change the `func (f *File) SetWorkbookPrOptions(opts ...WorkbookPrOption) error` to `func (f *File) SetWorkbookProps(opts *WorkbookPropsOptions) error`
- Change the `func (f *File) GetWorkbookPrOptions(opts ...WorkbookPrOptionPtr) error` to `func (f *File) GetWorkbookProps() (WorkbookPropsOptions, error)`
Introduce new function to instead of existing functions:
- New function `func (f *File) SetSheetProps(sheet string, opts *SheetPropsOptions) error` instead of `func (f *File) SetSheetPrOptions(sheet string, opts ...SheetPrOption) error` and `func (f *File) SetSheetFormatPr(sheet string, opts ...SheetFormatPrOption
2022-09-29 22:00:21 +08:00
|
|
|
// shapeColorOptions directly maps the color settings of the shape.
|
|
|
|
type shapeColorOptions struct {
|
2017-04-30 20:03:43 +08:00
|
|
|
Line string `json:"line"`
|
|
|
|
Fill string `json:"fill"`
|
|
|
|
Effect string `json:"effect"`
|
|
|
|
}
|
2021-09-08 22:05:42 +08:00
|
|
|
|
This closes #1358, made a refactor with breaking changes, see details:
This made a refactor with breaking changes:
Motivation and Context
When I decided to add set horizontal centered support for this library to resolve #1358, the reason I made this huge breaking change was:
- There are too many exported types for set sheet view, properties, and format properties, although a function using the functional options pattern can be optimized by returning an anonymous function, these types or property set or get function has no binding categorization, so I change these functions like `SetAppProps` to accept a pointer of options structure.
- Users can not easily find out which properties should be in the `SetSheetPrOptions` or `SetSheetFormatPr` categories
- Nested properties cannot proceed modify easily
Introduce 5 new export data types:
`HeaderFooterOptions`, `PageLayoutMarginsOptions`, `PageLayoutOptions`, `SheetPropsOptions`, and `ViewOptions`
Rename 4 exported data types:
- Rename `PivotTableOption` to `PivotTableOptions`
- Rename `FormatHeaderFooter` to `HeaderFooterOptions`
- Rename `FormatSheetProtection` to `SheetProtectionOptions`
- Rename `SparklineOption` to `SparklineOptions`
Remove 54 exported types:
`AutoPageBreaks`, `BaseColWidth`, `BlackAndWhite`, `CodeName`, `CustomHeight`, `Date1904`, `DefaultColWidth`, `DefaultGridColor`, `DefaultRowHeight`, `EnableFormatConditionsCalculation`, `FilterPrivacy`, `FirstPageNumber`, `FitToHeight`, `FitToPage`, `FitToWidth`, `OutlineSummaryBelow`, `PageLayoutOption`, `PageLayoutOptionPtr`, `PageLayoutOrientation`, `PageLayoutPaperSize`, `PageLayoutScale`, `PageMarginBottom`, `PageMarginFooter`, `PageMarginHeader`, `PageMarginLeft`, `PageMarginRight`, `PageMarginsOptions`, `PageMarginsOptionsPtr`, `PageMarginTop`, `Published`, `RightToLeft`, `SheetFormatPrOptions`, `SheetFormatPrOptionsPtr`, `SheetPrOption`, `SheetPrOptionPtr`, `SheetViewOption`, `SheetViewOptionPtr`, `ShowFormulas`, `ShowGridLines`, `ShowRowColHeaders`, `ShowRuler`, `ShowZeros`, `TabColorIndexed`, `TabColorRGB`, `TabColorTheme`, `TabColorTint`, `ThickBottom`, `ThickTop`, `TopLeftCell`, `View`, `WorkbookPrOption`, `WorkbookPrOptionPtr`, `ZeroHeight` and `ZoomScale`
Remove 2 exported constants:
`OrientationPortrait` and `OrientationLandscape`
Change 8 functions:
- Change the `func (f *File) SetPageLayout(sheet string, opts ...PageLayoutOption) error` to `func (f *File) SetPageLayout(sheet string, opts *PageLayoutOptions) error`
- Change the `func (f *File) GetPageLayout(sheet string, opts ...PageLayoutOptionPtr) error` to `func (f *File) GetPageLayout(sheet string) (PageLayoutOptions, error)`
- Change the `func (f *File) SetPageMargins(sheet string, opts ...PageMarginsOptions) error` to `func (f *File) SetPageMargins(sheet string, opts *PageLayoutMarginsOptions) error`
- Change the `func (f *File) GetPageMargins(sheet string, opts ...PageMarginsOptionsPtr) error` to `func (f *File) GetPageMargins(sheet string) (PageLayoutMarginsOptions, error)`
- Change the `func (f *File) SetSheetViewOptions(sheet string, viewIndex int, opts ...SheetViewOption) error` to `func (f *File) SetSheetView(sheet string, viewIndex int, opts *ViewOptions) error`
- Change the `func (f *File) GetSheetViewOptions(sheet string, viewIndex int, opts ...SheetViewOptionPtr) error` to `func (f *File) GetSheetView(sheet string, viewIndex int) (ViewOptions, error)`
- Change the `func (f *File) SetWorkbookPrOptions(opts ...WorkbookPrOption) error` to `func (f *File) SetWorkbookProps(opts *WorkbookPropsOptions) error`
- Change the `func (f *File) GetWorkbookPrOptions(opts ...WorkbookPrOptionPtr) error` to `func (f *File) GetWorkbookProps() (WorkbookPropsOptions, error)`
Introduce new function to instead of existing functions:
- New function `func (f *File) SetSheetProps(sheet string, opts *SheetPropsOptions) error` instead of `func (f *File) SetSheetPrOptions(sheet string, opts ...SheetPrOption) error` and `func (f *File) SetSheetFormatPr(sheet string, opts ...SheetFormatPrOption
2022-09-29 22:00:21 +08:00
|
|
|
// lineOptions directly maps the line settings of the shape.
|
|
|
|
type lineOptions struct {
|
2021-09-08 22:05:42 +08:00
|
|
|
Width float64 `json:"width"`
|
|
|
|
}
|