Drawing extends WriterPart
Table of Contents
- $parentWriter : Xlsx
- Parent Xlsx object.
- __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.
- stringEmu() : string
- writeHyperLinkDrawing() : void
- writeVMLHeaderFooterImage() : void
- Write VML comment to XML format.
Properties
$parentWriter
Parent Xlsx object.
private
Xlsx
$parentWriter
Methods
__construct()
Set parent Xlsx object.
public
__construct(Xlsx $writer) : mixed
Parameters
- $writer : Xlsx
Return values
mixed —allDrawings()
Get an array of all drawings.
public
allDrawings(Spreadsheet $spreadsheet) : array<string|int, BaseDrawing>
Parameters
- $spreadsheet : Spreadsheet
Return values
array<string|int, BaseDrawing> —All drawings in PhpSpreadsheet
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
Return values
void —writeDrawing()
Write drawings to XML format.
public
writeDrawing(XMLWriter $objWriter, BaseDrawing $drawing[, int $relationId = -1 ][, null|int $hlinkClickId = null ]) : void
Parameters
- $objWriter : XMLWriter
- $drawing : BaseDrawing
- $relationId : int = -1
- $hlinkClickId : null|int = null
Return values
void —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
stringEmu()
private
static stringEmu(int $pixelValue) : string
Parameters
- $pixelValue : int
Return values
string —writeHyperLinkDrawing()
private
writeHyperLinkDrawing(XMLWriter $objWriter, null|int $hlinkClickId) : void
Parameters
- $objWriter : XMLWriter
- $hlinkClickId : null|int
Return values
void —writeVMLHeaderFooterImage()
Write VML comment to XML format.
private
writeVMLHeaderFooterImage(XMLWriter $objWriter, string $reference, HeaderFooterDrawing $image) : void
Parameters
- $objWriter : XMLWriter
- $reference : string
-
Reference
- $image : HeaderFooterDrawing