Documentation

Drawing extends WriterPart
in package

Table of Contents

Methods

__construct()  : mixed
Set parent Xlsx object.
allDrawings()  : array<string|int, BaseDrawing>
Get an array of all drawings.
getParentWriter()  : Xlsx
Get parent Xlsx object.
writeChart()  : void
Write drawings to XML format.
writeDrawing()  : void
Write drawings to XML format.
writeDrawings()  : string
Write drawings to XML format.
writeVMLHeaderFooterImages()  : string
Write VML header/footer images to XML format.
getPassThroughDrawingXml()  : string|null
Get pass-through drawing XML if available.
stringEmu()  : string
writeAttributeIf()  : void
writeHyperLinkDrawing()  : void
writeVMLHeaderFooterImage()  : void
Write VML comment to XML format.

Methods

__construct()

Set parent Xlsx object.

public __construct(Xlsx $writer) : mixed
Parameters
$writer : Xlsx

getParentWriter()

Get parent Xlsx object.

public getParentWriter() : Xlsx
Return values
Xlsx

writeChart()

Write drawings to XML format.

public writeChart(XMLWriter $objWriter, Chart $chart[, int $relationId = -1 ]) : void
Parameters
$objWriter : XMLWriter
$chart : Chart
$relationId : int = -1

writeDrawing()

Write drawings to XML format.

public writeDrawing(XMLWriter $objWriter, BaseDrawing $drawing[, int $relationId = -1 ][, int|null $hlinkClickId = null ]) : void
Parameters
$objWriter : XMLWriter
$drawing : BaseDrawing
$relationId : int = -1
$hlinkClickId : int|null = null

writeDrawings()

Write drawings to XML format.

public writeDrawings(Worksheet $worksheet[, bool $includeCharts = false ]) : string
Parameters
$worksheet : Worksheet
$includeCharts : bool = false

Flag indicating if we should include drawing details for charts

Return values
string —

XML Output

writeVMLHeaderFooterImages()

Write VML header/footer images to XML format.

public writeVMLHeaderFooterImages(Worksheet $worksheet) : string
Parameters
$worksheet : Worksheet
Return values
string —

XML Output

getPassThroughDrawingXml()

Get pass-through drawing XML if available.

private getPassThroughDrawingXml(Worksheet $worksheet) : string|null

Returns the original drawing XML stored during load (when Reader pass-through was enabled). This preserves unsupported drawing elements (shapes, textboxes) that PhpSpreadsheet cannot parse.

Parameters
$worksheet : Worksheet
Return values
string|null —

The pass-through XML, or null if not available or should not be used

stringEmu()

private static stringEmu(int $pixelValue) : string
Parameters
$pixelValue : int
Return values
string

writeAttributeIf()

private static writeAttributeIf(XMLWriter $objWriter, bool|null $condition, string $attr, string $val) : void
Parameters
$objWriter : XMLWriter
$condition : bool|null
$attr : string
$val : string

writeHyperLinkDrawing()

private writeHyperLinkDrawing(XMLWriter $objWriter, int|null $hlinkClickId) : void
Parameters
$objWriter : XMLWriter
$hlinkClickId : int|null 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results