Skip to content

Add new function GetShapes #2408

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wangyica879112 wants to merge 3 commits into
base: master
Choose a base branch
from
Open

Add new function GetShapes #2408

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
0fa78be
Add new function GetShapes
wangyica879112 Sep 20, 2026
d54ce71
Merge remote-tracking branch 'upstream/master' into shapes
wangyica879112 Oct 10, 2026
438fd77
Implement GetShapes function
wangyica879112 Oct 10, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
282 changes: 282 additions & 0 deletions shape.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -426,6 +426,9 @@ func (f *File) addDrawingShape(sheet, drawingXML, cell string, opts *Shape) erro
shape.NvSpPr.CNvPr.Name = opts.Format.Name
}
shape.SpPr.Ln = opts.Line.drawChartLn()
if shape.SpPr.Ln == nil && opts.Line.Width != defaultLineWidth {

@peng peng Oct 10, 2026

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The cyclomatic complexity of the addDrawingShape function is 16, we need keep cyclomatic complexity less than 16.

shape.SpPr.Ln = &aLn{W: ptToEMUs(opts.Line.Width)}
}
if opts.Fill.Transparency > 0 {
val := (100 - opts.Fill.Transparency) * 1000
shape.SpPr.SolidFill = &aSolidFill{SrgbClr: &aSrgbClr{
Expand Down Expand Up @@ -528,3 +531,282 @@ func setShapeRef(color string, i int) *aRef {
},
}
}

// GetShapes provides the method to get all shapes in a sheet by given worksheet
// name.
func (f *File) GetShapes(sheet string) ([]Shape, error) {
var (
cells []string
shapes []Shape
wsDr *xlsxWsDr
)
ws, err := f.workSheetReader(sheet)
if err != nil {
return shapes, err
}
if ws.Drawing == nil {
return shapes, nil
}
target := f.getSheetRelationshipsTargetByID(sheet, ws.Drawing.RID)
drawingXML := strings.TrimPrefix(strings.ReplaceAll(target, "..", "xl"), "/")
if wsDr, _, err = f.drawingParser(drawingXML); err != nil {
return shapes, err
}
for _, anchor := range wsDr.OneCellAnchor {
f.extractCellAnchorShape(sheet, anchor, &cells, &shapes)
}
for _, anchor := range wsDr.TwoCellAnchor {
f.extractCellAnchorShape(sheet, anchor, &cells, &shapes)
}
return shapes, err
}

// extractCellAnchorShape extracts shape from a cell anchor and appends it to
// shapes if valid and not duplicate.
func (f *File) extractCellAnchorShape(sheet string, anchor *xdrCellAnchor, cells *[]string, shapes *[]Shape) {
if anchor.GraphicFrame == "" {
if shape := f.extractShapeFromAnchor(sheet, anchor); shape != nil && inStrSlice(*cells, shape.Cell, true) == -1 {
*cells = append(*cells, shape.Cell)
*shapes = append(*shapes, *shape)
return
}
}
if shape := f.extractShapeFromDecodeAnchor(sheet, anchor.GraphicFrame); shape != nil && inStrSlice(*cells, shape.Cell, true) == -1 {
*cells = append(*cells, shape.Cell)
*shapes = append(*shapes, *shape)
}
}

// extractShapeFromAnchor extracts shape data from a cell anchor.
func (f *File) extractShapeFromAnchor(sheet string, anchor *xdrCellAnchor) *Shape {
var (
cell string
err error
shape *Shape
)
if anchor.From == nil || anchor.Sp == nil {
return shape
}
if cell, err = CoordinatesToCellName(anchor.From.Col+1, anchor.From.Row+1); err != nil {
return shape
}
shape = &Shape{
Cell: cell,
Type: anchor.Sp.SpPr.PrstGeom.Prst,
Macro: anchor.Sp.Macro,
Format: GraphicOptions{
Name: anchor.Sp.NvSpPr.CNvPr.Name,
AltText: anchor.Sp.NvSpPr.CNvPr.Descr,
ScaleX: defaultDrawingScale,
ScaleY: defaultDrawingScale,
},
Line: LineOptions{Width: defaultLineWidth},
}
if anchor.To != nil {
width, height := f.getCellAnchorShapeSize(sheet, anchor)
shape.Width, shape.Height, shape.Format.ScaleX, shape.Format.ScaleY = f.getShapeSizeAndScale(width, height, anchor.Sp.SpPr.Xfrm.Ext.Cx, anchor.Sp.SpPr.Xfrm.Ext.Cy)
} else {
shape.Format.Positioning = "oneCell"
if anchor.Ext != nil {
width, height := anchor.Ext.Cx/EMU, anchor.Ext.Cy/EMU
shape.Width, shape.Height, shape.Format.ScaleX, shape.Format.ScaleY = f.getShapeSizeAndScale(width, height, anchor.Sp.SpPr.Xfrm.Ext.Cx, anchor.Sp.SpPr.Xfrm.Ext.Cy)
}
}
if anchor.ClientData != nil {
shape.Format.PrintObject = boolPtr(anchor.ClientData.FPrintsWithSheet)
shape.Format.Locked = boolPtr(anchor.ClientData.FLocksWithSheet)
}
anchor.Sp.extractShapeFill(shape)
shape.Paragraph = anchor.Sp.TxBody.extractRichTextRun()
return shape
}

// extractShapeFromDecodeAnchor extracts shape data from a decoded cell anchor.
func (f *File) extractShapeFromDecodeAnchor(sheet, graphicFrame string) *Shape {
var (
cell string
err error
shape *Shape
deCellAnchor = new(decodeCellAnchor)
)
_ = f.xmlNewDecoder(strings.NewReader("<decodeCellAnchor>" + graphicFrame + "</decodeCellAnchor>")).Decode(&deCellAnchor)
if deCellAnchor.From == nil || deCellAnchor.Sp == nil {
return shape
}
if cell, err = CoordinatesToCellName(deCellAnchor.From.Col+1, deCellAnchor.From.Row+1); err != nil {
return shape
}
shape = &Shape{
Cell: cell,
Type: deCellAnchor.Sp.SpPr.PrstGeom.Prst,
Macro: deCellAnchor.Sp.Macro,
Format: GraphicOptions{
Name: deCellAnchor.Sp.NvSpPr.CNvPr.Name,
AltText: deCellAnchor.Sp.NvSpPr.CNvPr.Descr,
ScaleX: defaultDrawingScale,
ScaleY: defaultDrawingScale,
},
Line: LineOptions{Width: defaultLineWidth},
}
if deCellAnchor.To != nil {
width, height := f.getDecodeCellAnchorShapeSize(sheet, deCellAnchor)
shape.Width, shape.Height, shape.Format.ScaleX, shape.Format.ScaleY = f.getShapeSizeAndScale(width, height, deCellAnchor.Sp.SpPr.Xfrm.Ext.Cx, deCellAnchor.Sp.SpPr.Xfrm.Ext.Cy)
} else {
shape.Format.Positioning = "oneCell"
if deCellAnchor.Ext != nil {
width, height := deCellAnchor.Ext.Cx/EMU, deCellAnchor.Ext.Cy/EMU
shape.Width, shape.Height, shape.Format.ScaleX, shape.Format.ScaleY = f.getShapeSizeAndScale(width, height, deCellAnchor.Sp.SpPr.Xfrm.Ext.Cx, deCellAnchor.Sp.SpPr.Xfrm.Ext.Cy)
}
}
if deCellAnchor.ClientData != nil {
shape.Format.PrintObject = boolPtr(deCellAnchor.ClientData.FPrintsWithSheet)
shape.Format.Locked = boolPtr(deCellAnchor.ClientData.FLocksWithSheet)
}
deCellAnchor.Sp.extractShapeFill(shape)
shape.Paragraph = deCellAnchor.Sp.TxBody.extractRichTextRun()
return shape
}

// extractShapeFill extracts shape fill properties.
func (sp *xdrSp) extractShapeFill(shape *Shape) {
if sp.SpPr != nil {
if sp.SpPr.SolidFill != nil && sp.SpPr.SolidFill.SrgbClr != nil {
if sp.SpPr.SolidFill.SrgbClr.Val != nil {
shape.Fill.Color = []string{*sp.SpPr.SolidFill.SrgbClr.Val}
}
if sp.SpPr.SolidFill.SrgbClr.Alpha != nil && sp.SpPr.SolidFill.SrgbClr.Alpha.Val != nil {
shape.Fill.Transparency = 100 - (*sp.SpPr.SolidFill.SrgbClr.Alpha.Val / 1000)
}
}
if sp.SpPr.Ln != nil && sp.SpPr.Ln.W != 0 {
shape.Line.Width = float64(sp.SpPr.Ln.W) / 12700
}
}
if sp.Style != nil && sp.Style.LnRef != nil && sp.Style.LnRef.SrgbClr != nil && sp.Style.LnRef.SrgbClr.Val != nil {
shape.Line.Fill = Fill{Type: "pattern", Pattern: 1, Color: []string{*sp.Style.LnRef.SrgbClr.Val}}
}
}

// extractShapeFill extracts shape fill properties.
func (sp *decodeSp) extractShapeFill(shape *Shape) {
if sp.SpPr != nil {
if sp.SpPr.SolidFill != nil && sp.SpPr.SolidFill.SrgbClr != nil {
if sp.SpPr.SolidFill.SrgbClr.Val != nil {
shape.Fill.Color = []string{*sp.SpPr.SolidFill.SrgbClr.Val}
}
if sp.SpPr.SolidFill.SrgbClr.Alpha != nil && sp.SpPr.SolidFill.SrgbClr.Alpha.Val != nil {
shape.Fill.Transparency = 100 - (*sp.SpPr.SolidFill.SrgbClr.Alpha.Val / 1000)
}
}
if sp.SpPr.Ln.W != 0 {
shape.Line.Width = float64(sp.SpPr.Ln.W) / 12700
}
}
if sp.Style != nil && sp.Style.LnRef != nil && sp.Style.LnRef.SrgbClr != nil && sp.Style.LnRef.SrgbClr.Val != nil {
shape.Line.Fill = Fill{Type: "pattern", Pattern: 1, Color: []string{*sp.Style.LnRef.SrgbClr.Val}}
}
}

// extractRichTextRun extracts rich text runs from the text body.
func (tb *xdrTxBody) extractRichTextRun() []RichTextRun {
var paragraphs []RichTextRun
for _, p := range tb.P {
run := RichTextRun{}
if p.R != nil {
run.Text = p.R.T
run.Font = &Font{
Bold: p.R.RPr.B,
Italic: p.R.RPr.I,
Underline: p.R.RPr.U,
}
if p.R.RPr.Sz > 0 {
run.Font.Size = p.R.RPr.Sz / 100
}
if p.R.RPr.Latin != nil {
run.Font.Family = p.R.RPr.Latin.Typeface
}
if p.R.RPr.SolidFill != nil && p.R.RPr.SolidFill.SrgbClr != nil && p.R.RPr.SolidFill.SrgbClr.Val != nil {
run.Font.Color = *p.R.RPr.SolidFill.SrgbClr.Val
}
}
paragraphs = append(paragraphs, run)
}
return paragraphs
}

// extractRichTextRun extracts rich text runs from decoded text body.
func (tb *decodeTxBody) extractRichTextRun() []RichTextRun {
var paragraphs []RichTextRun
for _, p := range tb.P {
run := RichTextRun{}
if p.R != nil {
run.Text = p.R.T
run.Font = &Font{
Bold: p.R.RPr.B,
Italic: p.R.RPr.I,
Underline: p.R.RPr.U,
}
if p.R.RPr.Sz > 0 {
run.Font.Size = p.R.RPr.Sz / 100
}
if p.R.RPr.Latin != nil {
run.Font.Family = p.R.RPr.Latin.Typeface
}
if p.R.RPr.SolidFill != nil && p.R.RPr.SolidFill.SrgbClr != nil && p.R.RPr.SolidFill.SrgbClr.Val != nil {
run.Font.Color = *p.R.RPr.SolidFill.SrgbClr.Val
}
}
paragraphs = append(paragraphs, run)
}
return paragraphs
}

// getCellAnchorShapeSize calculates the shape size in pixels by given cell
// anchor.
func (f *File) getCellAnchorShapeSize(sheet string, cellAnchor *xdrCellAnchor) (int, int) {
var width, height int
for col := cellAnchor.From.Col; col < cellAnchor.To.Col; col++ {
width += f.getColWidth(sheet, col+1)
}
width += cellAnchor.To.ColOff/EMU - cellAnchor.From.ColOff/EMU
for row := cellAnchor.From.Row; row < cellAnchor.To.Row; row++ {
height += f.getRowHeight(sheet, row+1)
}
height += cellAnchor.To.RowOff/EMU - cellAnchor.From.RowOff/EMU
return width, height
}

// getDecodeCellAnchorShapeSize calculates the shape size in pixels by given
// decode cell anchor.
func (f *File) getDecodeCellAnchorShapeSize(sheet string, deCellAnchor *decodeCellAnchor) (int, int) {
var width, height int
for col := deCellAnchor.From.Col; col < deCellAnchor.To.Col; col++ {
width += f.getColWidth(sheet, col+1)
}
width += deCellAnchor.To.ColOff/EMU - deCellAnchor.From.ColOff/EMU
for row := deCellAnchor.From.Row; row < deCellAnchor.To.Row; row++ {
height += f.getRowHeight(sheet, row+1)
}
height += deCellAnchor.To.RowOff/EMU - deCellAnchor.From.RowOff/EMU
return width, height
}

// getShapeSizeAndScale calculates the shape size and scale by given actual
// width and height in pixels, and the original cx and cy in EMU.
func (f *File) getShapeSizeAndScale(w, h, cx, cy int) (uint, uint, float64, float64) {
var (
width, height uint
scaleX, scaleY float64 = defaultDrawingScale, defaultDrawingScale
)
if cx > 0 && cy > 0 {
width = uint(cx / EMU)
height = uint(cy / EMU)
if width > 0 {
scaleX = float64(w) / float64(width)
}
if height > 0 {
scaleY = float64(h) / float64(height)
}
}
return width, height, scaleX, scaleY
}
45 changes: 44 additions & 1 deletion shape_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,8 +21,12 @@ func TestAddShape(t *testing.T) {
},
}))
assert.NoError(t, f.AddShape("Sheet1", &Shape{Cell: "B30", Type: "rect", Paragraph: []RichTextRun{{Text: "Rectangle"}, {}}}))
shape1 := Shape{Cell: "C30", Type: "rect", Width: 160, Height: 160}
shape1 := Shape{Cell: "C30", Type: "rect", Width: 160, Height: 160, Format: GraphicOptions{Name: "Shape 8"}}
assert.NoError(t, f.AddShape("Sheet1", &shape1))
shapes, err := f.GetShapes("Sheet1")
assert.NoError(t, err)
assert.Len(t, shapes, 3)
assert.Equal(t, shape1, shapes[2])
// Test add shape with invalid positioning types
assert.Equal(t, newInvalidOptionalValue("Positioning", "x", supportedPositioning), f.AddShape("Sheet1", &Shape{Cell: "C30", Type: "rect", Format: GraphicOptions{Positioning: "x"}}))
assert.EqualError(t, f.AddShape("Sheet3", &Shape{Cell: "C30", Type: "rect"}), "sheet Sheet3 does not exist")
Expand Down Expand Up @@ -76,6 +80,10 @@ func TestAddShape(t *testing.T) {
Height: 90,
}
assert.NoError(t, f.AddShape("Sheet1", &shape2))
shapes, err = f.GetShapes("Sheet1")
assert.NoError(t, err)
assert.Len(t, shapes, 1)
assert.Equal(t, shape2, shapes[0])
assert.NoError(t, f.SaveAs(filepath.Join("test", "TestAddShape2.xlsx")))
// Test add shape with invalid sheet name
assert.Equal(t, ErrSheetNameInvalid, f.AddShape("Sheet:1", &Shape{
Expand All @@ -97,6 +105,41 @@ func TestAddShape(t *testing.T) {
f.ContentTypes = nil
f.Pkg.Store(defaultXMLPathContentTypes, MacintoshCyrillicCharset)
assert.EqualError(t, f.AddShape("Sheet1", &Shape{Cell: "B30", Type: "rect", Paragraph: []RichTextRun{{Text: "Rectangle"}, {}}}), "XML syntax error on line 1: invalid UTF-8")

// Test get shapes after from a worksheet which contains existing shapes
f, err = OpenFile(filepath.Join("test", "TestAddShape1.xlsx"))
assert.NoError(t, err)
shapes, err = f.GetShapes("Sheet1")
assert.NoError(t, err)
assert.Len(t, shapes, 3)
assert.Equal(t, shape1, shapes[2])
// Test get shapes from a worksheet without shapes
shapes, err = f.GetShapes("Sheet2")
assert.NoError(t, err)
assert.Empty(t, shapes)
// Test get shapes after from a worksheet which contains existing shapes
f, err = OpenFile(filepath.Join("test", "TestAddShape2.xlsx"))
assert.NoError(t, err)
shapes, err = f.GetShapes("Sheet1")
assert.NoError(t, err)
assert.Len(t, shapes, 1)
assert.Equal(t, shape2, shapes[0])
// Test get shapes with unsupported charset
path := "xl/drawings/drawing1.xml"
f.Drawings.Delete(path)
f.Pkg.Store(path, MacintoshCyrillicCharset)
_, err = f.GetShapes("Sheet1")
assert.EqualError(t, err, "XML syntax error on line 1: invalid UTF-8")
// Test get shapes from a sheet without shapes
f = NewFile()
shapes, err = f.GetShapes("Sheet1")
assert.NoError(t, err)
assert.Empty(t, shapes)
// Test get shapes on not exists worksheet
_, err = f.GetShapes("SheetN")
assert.EqualError(t, err, "sheet SheetN does not exist")
assert.Nil(t, f.extractShapeFromAnchor("Sheet1", &xdrCellAnchor{Sp: &xdrSp{}, From: &xlsxFrom{Col: -1, Row: 0}}))
assert.Nil(t, f.extractShapeFromDecodeAnchor("Sheet1", "<from><col>-1</col><row>0</row></from><sp/>"))
}

func TestAddDrawingShape(t *testing.T) {
Expand Down
Loading