499 lines
16 KiB
Go
499 lines
16 KiB
Go
// Copyright 2016 - 2024 The excelize Authors. All rights reserved. Use of
|
|
// 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 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.18 or later.
|
|
|
|
package excelize
|
|
|
|
import (
|
|
"strconv"
|
|
"strings"
|
|
)
|
|
|
|
// parseShapeOptions provides a function to parse the format settings of the
|
|
// shape with default value.
|
|
func parseShapeOptions(opts *Shape) (*Shape, error) {
|
|
if opts == nil {
|
|
return nil, ErrParameterInvalid
|
|
}
|
|
if opts.Type == "" {
|
|
return nil, ErrParameterInvalid
|
|
}
|
|
if opts.Width == 0 {
|
|
opts.Width = defaultShapeSize
|
|
}
|
|
if opts.Height == 0 {
|
|
opts.Height = defaultShapeSize
|
|
}
|
|
if opts.Format.PrintObject == nil {
|
|
opts.Format.PrintObject = boolPtr(true)
|
|
}
|
|
if opts.Format.Locked == nil {
|
|
opts.Format.Locked = boolPtr(false)
|
|
}
|
|
if opts.Format.ScaleX == 0 {
|
|
opts.Format.ScaleX = defaultDrawingScale
|
|
}
|
|
if opts.Format.ScaleY == 0 {
|
|
opts.Format.ScaleY = defaultDrawingScale
|
|
}
|
|
if opts.Line.Width == nil {
|
|
opts.Line.Width = float64Ptr(defaultShapeLineWidth)
|
|
}
|
|
return opts, nil
|
|
}
|
|
|
|
// AddShape provides the method to add shape in a sheet by given worksheet
|
|
// name and shape format set (such as offset, scale, aspect ratio setting and
|
|
// print settings). For example, add text box (rect shape) in Sheet1:
|
|
//
|
|
// lineWidth := 1.2
|
|
// err := f.AddShape("Sheet1",
|
|
// &excelize.Shape{
|
|
// Cell: "G6",
|
|
// Type: "rect",
|
|
// Line: excelize.ShapeLine{Color: "4286F4", Width: &lineWidth},
|
|
// Fill: excelize.Fill{Color: []string{"8EB9FF"}, Pattern: 1},
|
|
// Paragraph: []excelize.RichTextRun{
|
|
// {
|
|
// Text: "Rectangle Shape",
|
|
// Font: &excelize.Font{
|
|
// Bold: true,
|
|
// Italic: true,
|
|
// Family: "Times New Roman",
|
|
// Size: 18,
|
|
// Color: "777777",
|
|
// Underline: "sng",
|
|
// },
|
|
// },
|
|
// },
|
|
// Width: 180,
|
|
// Height: 40,
|
|
// },
|
|
// )
|
|
//
|
|
// The following shows the type of shape supported by excelize:
|
|
//
|
|
// accentBorderCallout1 (Callout 1 with Border and Accent Shape)
|
|
// accentBorderCallout2 (Callout 2 with Border and Accent Shape)
|
|
// accentBorderCallout3 (Callout 3 with Border and Accent Shape)
|
|
// accentCallout1 (Callout 1 Shape)
|
|
// accentCallout2 (Callout 2 Shape)
|
|
// accentCallout3 (Callout 3 Shape)
|
|
// actionButtonBackPrevious (Back or Previous Button Shape)
|
|
// actionButtonBeginning (Beginning Button Shape)
|
|
// actionButtonBlank (Blank Button Shape)
|
|
// actionButtonDocument (Document Button Shape)
|
|
// actionButtonEnd (End Button Shape)
|
|
// actionButtonForwardNext (Forward or Next Button Shape)
|
|
// actionButtonHelp (Help Button Shape)
|
|
// actionButtonHome (Home Button Shape)
|
|
// actionButtonInformation (Information Button Shape)
|
|
// actionButtonMovie (Movie Button Shape)
|
|
// actionButtonReturn (Return Button Shape)
|
|
// actionButtonSound (Sound Button Shape)
|
|
// arc (Curved Arc Shape)
|
|
// bentArrow (Bent Arrow Shape)
|
|
// bentConnector2 (Bent Connector 2 Shape)
|
|
// bentConnector3 (Bent Connector 3 Shape)
|
|
// bentConnector4 (Bent Connector 4 Shape)
|
|
// bentConnector5 (Bent Connector 5 Shape)
|
|
// bentUpArrow (Bent Up Arrow Shape)
|
|
// bevel (Bevel Shape)
|
|
// blockArc (Block Arc Shape)
|
|
// borderCallout1 (Callout 1 with Border Shape)
|
|
// borderCallout2 (Callout 2 with Border Shape)
|
|
// borderCallout3 (Callout 3 with Border Shape)
|
|
// bracePair (Brace Pair Shape)
|
|
// bracketPair (Bracket Pair Shape)
|
|
// callout1 (Callout 1 Shape)
|
|
// callout2 (Callout 2 Shape)
|
|
// callout3 (Callout 3 Shape)
|
|
// can (Can Shape)
|
|
// chartPlus (Chart Plus Shape)
|
|
// chartStar (Chart Star Shape)
|
|
// chartX (Chart X Shape)
|
|
// chevron (Chevron Shape)
|
|
// chord (Chord Shape)
|
|
// circularArrow (Circular Arrow Shape)
|
|
// cloud (Cloud Shape)
|
|
// cloudCallout (Callout Cloud Shape)
|
|
// corner (Corner Shape)
|
|
// cornerTabs (Corner Tabs Shape)
|
|
// cube (Cube Shape)
|
|
// curvedConnector2 (Curved Connector 2 Shape)
|
|
// curvedConnector3 (Curved Connector 3 Shape)
|
|
// curvedConnector4 (Curved Connector 4 Shape)
|
|
// curvedConnector5 (Curved Connector 5 Shape)
|
|
// curvedDownArrow (Curved Down Arrow Shape)
|
|
// curvedLeftArrow (Curved Left Arrow Shape)
|
|
// curvedRightArrow (Curved Right Arrow Shape)
|
|
// curvedUpArrow (Curved Up Arrow Shape)
|
|
// decagon (Decagon Shape)
|
|
// diagStripe (Diagonal Stripe Shape)
|
|
// diamond (Diamond Shape)
|
|
// dodecagon (Dodecagon Shape)
|
|
// donut (Donut Shape)
|
|
// doubleWave (Double Wave Shape)
|
|
// downArrow (Down Arrow Shape)
|
|
// downArrowCallout (Callout Down Arrow Shape)
|
|
// ellipse (Ellipse Shape)
|
|
// ellipseRibbon (Ellipse Ribbon Shape)
|
|
// ellipseRibbon2 (Ellipse Ribbon 2 Shape)
|
|
// flowChartAlternateProcess (Alternate Process Flow Shape)
|
|
// flowChartCollate (Collate Flow Shape)
|
|
// flowChartConnector (Connector Flow Shape)
|
|
// flowChartDecision (Decision Flow Shape)
|
|
// flowChartDelay (Delay Flow Shape)
|
|
// flowChartDisplay (Display Flow Shape)
|
|
// flowChartDocument (Document Flow Shape)
|
|
// flowChartExtract (Extract Flow Shape)
|
|
// flowChartInputOutput (Input Output Flow Shape)
|
|
// flowChartInternalStorage (Internal Storage Flow Shape)
|
|
// flowChartMagneticDisk (Magnetic Disk Flow Shape)
|
|
// flowChartMagneticDrum (Magnetic Drum Flow Shape)
|
|
// flowChartMagneticTape (Magnetic Tape Flow Shape)
|
|
// flowChartManualInput (Manual Input Flow Shape)
|
|
// flowChartManualOperation (Manual Operation Flow Shape)
|
|
// flowChartMerge (Merge Flow Shape)
|
|
// flowChartMultidocument (Multi-Document Flow Shape)
|
|
// flowChartOfflineStorage (Offline Storage Flow Shape)
|
|
// flowChartOffpageConnector (Off-Page Connector Flow Shape)
|
|
// flowChartOnlineStorage (Online Storage Flow Shape)
|
|
// flowChartOr (Or Flow Shape)
|
|
// flowChartPredefinedProcess (Predefined Process Flow Shape)
|
|
// flowChartPreparation (Preparation Flow Shape)
|
|
// flowChartProcess (Process Flow Shape)
|
|
// flowChartPunchedCard (Punched Card Flow Shape)
|
|
// flowChartPunchedTape (Punched Tape Flow Shape)
|
|
// flowChartSort (Sort Flow Shape)
|
|
// flowChartSummingJunction (Summing Junction Flow Shape)
|
|
// flowChartTerminator (Terminator Flow Shape)
|
|
// foldedCorner (Folded Corner Shape)
|
|
// frame (Frame Shape)
|
|
// funnel (Funnel Shape)
|
|
// gear6 (Gear 6 Shape)
|
|
// gear9 (Gear 9 Shape)
|
|
// halfFrame (Half Frame Shape)
|
|
// heart (Heart Shape)
|
|
// heptagon (Heptagon Shape)
|
|
// hexagon (Hexagon Shape)
|
|
// homePlate (Home Plate Shape)
|
|
// horizontalScroll (Horizontal Scroll Shape)
|
|
// irregularSeal1 (Irregular Seal 1 Shape)
|
|
// irregularSeal2 (Irregular Seal 2 Shape)
|
|
// leftArrow (Left Arrow Shape)
|
|
// leftArrowCallout (Callout Left Arrow Shape)
|
|
// leftBrace (Left Brace Shape)
|
|
// leftBracket (Left Bracket Shape)
|
|
// leftCircularArrow (Left Circular Arrow Shape)
|
|
// leftRightArrow (Left Right Arrow Shape)
|
|
// leftRightArrowCallout (Callout Left Right Arrow Shape)
|
|
// leftRightCircularArrow (Left Right Circular Arrow Shape)
|
|
// leftRightRibbon (Left Right Ribbon Shape)
|
|
// leftRightUpArrow (Left Right Up Arrow Shape)
|
|
// leftUpArrow (Left Up Arrow Shape)
|
|
// lightningBolt (Lightning Bolt Shape)
|
|
// line (Line Shape)
|
|
// lineInv (Line Inverse Shape)
|
|
// mathDivide (Divide Math Shape)
|
|
// mathEqual (Equal Math Shape)
|
|
// mathMinus (Minus Math Shape)
|
|
// mathMultiply (Multiply Math Shape)
|
|
// mathNotEqual (Not Equal Math Shape)
|
|
// mathPlus (Plus Math Shape)
|
|
// moon (Moon Shape)
|
|
// nonIsoscelesTrapezoid (Non-Isosceles Trapezoid Shape)
|
|
// noSmoking (No Smoking Shape)
|
|
// notchedRightArrow (Notched Right Arrow Shape)
|
|
// octagon (Octagon Shape)
|
|
// parallelogram (Parallelogram Shape)
|
|
// pentagon (Pentagon Shape)
|
|
// pie (Pie Shape)
|
|
// pieWedge (Pie Wedge Shape)
|
|
// plaque (Plaque Shape)
|
|
// plaqueTabs (Plaque Tabs Shape)
|
|
// plus (Plus Shape)
|
|
// quadArrow (Quad-Arrow Shape)
|
|
// quadArrowCallout (Callout Quad-Arrow Shape)
|
|
// rect (Rectangle Shape)
|
|
// ribbon (Ribbon Shape)
|
|
// ribbon2 (Ribbon 2 Shape)
|
|
// rightArrow (Right Arrow Shape)
|
|
// rightArrowCallout (Callout Right Arrow Shape)
|
|
// rightBrace (Right Brace Shape)
|
|
// rightBracket (Right Bracket Shape)
|
|
// round1Rect (One Round Corner Rectangle Shape)
|
|
// round2DiagRect (Two Diagonal Round Corner Rectangle Shape)
|
|
// round2SameRect (Two Same-side Round Corner Rectangle Shape)
|
|
// roundRect (Round Corner Rectangle Shape)
|
|
// rtTriangle (Right Triangle Shape)
|
|
// smileyFace (Smiley Face Shape)
|
|
// snip1Rect (One Snip Corner Rectangle Shape)
|
|
// snip2DiagRect (Two Diagonal Snip Corner Rectangle Shape)
|
|
// snip2SameRect (Two Same-side Snip Corner Rectangle Shape)
|
|
// snipRoundRect (One Snip One Round Corner Rectangle Shape)
|
|
// squareTabs (Square Tabs Shape)
|
|
// star10 (Ten Pointed Star Shape)
|
|
// star12 (Twelve Pointed Star Shape)
|
|
// star16 (Sixteen Pointed Star Shape)
|
|
// star24 (Twenty Four Pointed Star Shape)
|
|
// star32 (Thirty Two Pointed Star Shape)
|
|
// star4 (Four Pointed Star Shape)
|
|
// star5 (Five Pointed Star Shape)
|
|
// star6 (Six Pointed Star Shape)
|
|
// star7 (Seven Pointed Star Shape)
|
|
// star8 (Eight Pointed Star Shape)
|
|
// straightConnector1 (Straight Connector 1 Shape)
|
|
// stripedRightArrow (Striped Right Arrow Shape)
|
|
// sun (Sun Shape)
|
|
// swooshArrow (Swoosh Arrow Shape)
|
|
// teardrop (Teardrop Shape)
|
|
// trapezoid (Trapezoid Shape)
|
|
// triangle (Triangle Shape)
|
|
// upArrow (Up Arrow Shape)
|
|
// upArrowCallout (Callout Up Arrow Shape)
|
|
// upDownArrow (Up Down Arrow Shape)
|
|
// upDownArrowCallout (Callout Up Down Arrow Shape)
|
|
// uturnArrow (U-Turn Arrow Shape)
|
|
// verticalScroll (Vertical Scroll Shape)
|
|
// wave (Wave Shape)
|
|
// wedgeEllipseCallout (Callout Wedge Ellipse Shape)
|
|
// wedgeRectCallout (Callout Wedge Rectangle Shape)
|
|
// wedgeRoundRectCallout (Callout Wedge Round Rectangle Shape)
|
|
//
|
|
// The following shows the type of text underline supported by excelize:
|
|
//
|
|
// none
|
|
// words
|
|
// sng
|
|
// dbl
|
|
// heavy
|
|
// dotted
|
|
// dottedHeavy
|
|
// dash
|
|
// dashHeavy
|
|
// dashLong
|
|
// dashLongHeavy
|
|
// dotDash
|
|
// dotDashHeavy
|
|
// dotDotDash
|
|
// dotDotDashHeavy
|
|
// wavy
|
|
// wavyHeavy
|
|
// wavyDbl
|
|
func (f *File) AddShape(sheet string, opts *Shape) error {
|
|
options, err := parseShapeOptions(opts)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
// Read sheet data
|
|
ws, err := f.workSheetReader(sheet)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
// Add first shape for given sheet, create xl/drawings/ and xl/drawings/_rels/ folder.
|
|
drawingID := f.countDrawings() + 1
|
|
drawingXML := "xl/drawings/drawing" + strconv.Itoa(drawingID) + ".xml"
|
|
sheetRelationshipsDrawingXML := "../drawings/drawing" + strconv.Itoa(drawingID) + ".xml"
|
|
|
|
if ws.Drawing != nil {
|
|
// The worksheet already has a shape or chart relationships, use the relationships drawing ../drawings/drawing%d.xml.
|
|
sheetRelationshipsDrawingXML = f.getSheetRelationshipsTargetByID(sheet, ws.Drawing.RID)
|
|
drawingID, _ = strconv.Atoi(strings.TrimSuffix(strings.TrimPrefix(sheetRelationshipsDrawingXML, "../drawings/drawing"), ".xml"))
|
|
drawingXML = strings.ReplaceAll(sheetRelationshipsDrawingXML, "..", "xl")
|
|
} else {
|
|
// Add first shape for given sheet.
|
|
sheetXMLPath, _ := f.getSheetXMLPath(sheet)
|
|
sheetRels := "xl/worksheets/_rels/" + strings.TrimPrefix(sheetXMLPath, "xl/worksheets/") + ".rels"
|
|
rID := f.addRels(sheetRels, SourceRelationshipDrawingML, sheetRelationshipsDrawingXML, "")
|
|
f.addSheetDrawing(sheet, rID)
|
|
f.addSheetNameSpace(sheet, SourceRelationship)
|
|
}
|
|
if err = f.addDrawingShape(sheet, drawingXML, opts.Cell, options); err != nil {
|
|
return err
|
|
}
|
|
return f.addContentTypePart(drawingID, "drawings")
|
|
}
|
|
|
|
// twoCellAnchorShape create a two cell anchor shape size placeholder for a
|
|
// group, a shape, or a drawing element.
|
|
func (f *File) twoCellAnchorShape(sheet, drawingXML, cell string, width, height uint, format GraphicOptions) (*xlsxWsDr, *xdrCellAnchor, int, error) {
|
|
fromCol, fromRow, err := CellNameToCoordinates(cell)
|
|
if err != nil {
|
|
return nil, nil, 0, err
|
|
}
|
|
w := int(float64(width) * format.ScaleX)
|
|
h := int(float64(height) * format.ScaleY)
|
|
colStart, rowStart, colEnd, rowEnd, x2, y2 := f.positionObjectPixels(sheet, fromCol, fromRow, format.OffsetX, format.OffsetY, w, h)
|
|
content, cNvPrID, err := f.drawingParser(drawingXML)
|
|
if err != nil {
|
|
return content, nil, cNvPrID, err
|
|
}
|
|
twoCellAnchor := xdrCellAnchor{}
|
|
twoCellAnchor.EditAs = format.Positioning
|
|
from := xlsxFrom{}
|
|
from.Col = colStart
|
|
from.ColOff = format.OffsetX * EMU
|
|
from.Row = rowStart
|
|
from.RowOff = format.OffsetY * EMU
|
|
to := xlsxTo{}
|
|
to.Col = colEnd
|
|
to.ColOff = x2 * EMU
|
|
to.Row = rowEnd
|
|
to.RowOff = y2 * EMU
|
|
twoCellAnchor.From = &from
|
|
twoCellAnchor.To = &to
|
|
return content, &twoCellAnchor, cNvPrID, err
|
|
}
|
|
|
|
// addDrawingShape provides a function to add preset geometry by given sheet,
|
|
// drawingXML and format sets.
|
|
func (f *File) addDrawingShape(sheet, drawingXML, cell string, opts *Shape) error {
|
|
content, twoCellAnchor, cNvPrID, err := f.twoCellAnchorShape(
|
|
sheet, drawingXML, cell, opts.Width, opts.Height, opts.Format)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
var solidColor string
|
|
if len(opts.Fill.Color) == 1 {
|
|
solidColor = opts.Fill.Color[0]
|
|
}
|
|
shape := xdrSp{
|
|
Macro: opts.Macro,
|
|
NvSpPr: &xdrNvSpPr{
|
|
CNvPr: &xlsxCNvPr{
|
|
ID: cNvPrID,
|
|
Name: "Shape " + strconv.Itoa(cNvPrID),
|
|
},
|
|
CNvSpPr: &xdrCNvSpPr{
|
|
TxBox: true,
|
|
},
|
|
},
|
|
SpPr: &xlsxSpPr{
|
|
PrstGeom: xlsxPrstGeom{
|
|
Prst: opts.Type,
|
|
},
|
|
},
|
|
Style: &xdrStyle{
|
|
LnRef: setShapeRef(opts.Line.Color, 2),
|
|
FillRef: setShapeRef(solidColor, 1),
|
|
EffectRef: setShapeRef("", 0),
|
|
FontRef: &aFontRef{
|
|
Idx: "minor",
|
|
SchemeClr: &attrValString{
|
|
Val: stringPtr("tx1"),
|
|
},
|
|
},
|
|
},
|
|
TxBody: &xdrTxBody{
|
|
BodyPr: &aBodyPr{
|
|
VertOverflow: "clip",
|
|
HorzOverflow: "clip",
|
|
Wrap: "none",
|
|
RtlCol: false,
|
|
Anchor: "t",
|
|
},
|
|
},
|
|
}
|
|
if *opts.Line.Width != 1 {
|
|
shape.SpPr.Ln = xlsxLineProperties{
|
|
W: f.ptToEMUs(*opts.Line.Width),
|
|
}
|
|
}
|
|
defaultFont, err := f.GetDefaultFont()
|
|
if err != nil {
|
|
return err
|
|
}
|
|
if len(opts.Paragraph) < 1 {
|
|
opts.Paragraph = []RichTextRun{
|
|
{
|
|
Font: &Font{
|
|
Bold: false,
|
|
Italic: false,
|
|
Underline: "none",
|
|
Family: defaultFont,
|
|
Size: 11,
|
|
Color: "000000",
|
|
},
|
|
Text: " ",
|
|
},
|
|
}
|
|
}
|
|
for _, p := range opts.Paragraph {
|
|
u := "none"
|
|
font := &Font{}
|
|
if p.Font != nil {
|
|
font = p.Font
|
|
}
|
|
if idx := inStrSlice(supportedDrawingUnderlineTypes, font.Underline, true); idx != -1 {
|
|
u = supportedDrawingUnderlineTypes[idx]
|
|
}
|
|
text := p.Text
|
|
if text == "" {
|
|
text = " "
|
|
}
|
|
paragraph := &aP{
|
|
R: &aR{
|
|
RPr: aRPr{
|
|
I: font.Italic,
|
|
B: font.Bold,
|
|
Lang: "en-US",
|
|
AltLang: "en-US",
|
|
U: u,
|
|
Sz: font.Size * 100,
|
|
Latin: &xlsxCTTextFont{Typeface: font.Family},
|
|
},
|
|
T: text,
|
|
},
|
|
EndParaRPr: &aEndParaRPr{
|
|
Lang: "en-US",
|
|
},
|
|
}
|
|
srgbClr := strings.ReplaceAll(strings.ToUpper(font.Color), "#", "")
|
|
if len(srgbClr) == 6 {
|
|
paragraph.R.RPr.SolidFill = &aSolidFill{
|
|
SrgbClr: &attrValString{
|
|
Val: stringPtr(srgbClr),
|
|
},
|
|
}
|
|
}
|
|
shape.TxBody.P = append(shape.TxBody.P, paragraph)
|
|
}
|
|
twoCellAnchor.Sp = &shape
|
|
twoCellAnchor.ClientData = &xdrClientData{
|
|
FLocksWithSheet: *opts.Format.Locked,
|
|
FPrintsWithSheet: *opts.Format.PrintObject,
|
|
}
|
|
content.TwoCellAnchor = append(content.TwoCellAnchor, twoCellAnchor)
|
|
f.Drawings.Store(drawingXML, content)
|
|
return err
|
|
}
|
|
|
|
// setShapeRef provides a function to set color with hex model by given actual
|
|
// color value.
|
|
func setShapeRef(color string, i int) *aRef {
|
|
if color == "" {
|
|
return &aRef{
|
|
Idx: 0,
|
|
ScrgbClr: &aScrgbClr{
|
|
R: 0,
|
|
G: 0,
|
|
B: 0,
|
|
},
|
|
}
|
|
}
|
|
return &aRef{
|
|
Idx: i,
|
|
SrgbClr: &attrValString{
|
|
Val: stringPtr(strings.ReplaceAll(strings.ToUpper(color), "#", "")),
|
|
},
|
|
}
|
|
}
|