Documentation

Chart extends AbstractGraphic
in package
implements ComparableInterface

Chart element.

Table of Contents

Interfaces

ComparableInterface
PhpOffice\PhpPresentation\ComparableInterface.

Constants

BLANKAS_GAP  = 'gap'
BLANKAS_SPAN  = 'span'
BLANKAS_ZERO  = 'zero'

Properties

$relationId  : string
Slide relation ID (should not be used by user code!).
$container  : null|ShapeContainerInterface
Container.
$description  : string
Description.
$height  : int
Height.
$hyperlink  : null|Hyperlink
$name  : string
Name.
$offsetX  : int
Offset X.
$offsetY  : int
Offset Y.
$placeholder  : null|Placeholder
$resizeProportional  : bool
Proportional resize.
$rotation  : int
Rotation.
$shadow  : null|Shadow
Shadow.
$width  : int
Width.
$border  : Border
Border.
$displayBlankAs  : string
How to display blank (missing) values? Not set by default.
$fill  : null|Fill
$hashIndex  : int
Hash index.
$imageCounter  : int
Image counter.
$imageIndex  : int
Image index.
$includeSpreadsheet  : bool
Is the spreadsheet included for editing data ?
$legend  : Legend
Legend.
$plotArea  : PlotArea
Plot area.
$title  : Title
Title.
$view3D  : View3D
View 3D.

Methods

__clone()  : mixed
Magic Method : clone.
__construct()  : mixed
Create a new Chart.
getBorder()  : Border
getContainer()  : ShapeContainerInterface|null
Get Container, Slide or Group.
getDescription()  : string
Get Description.
getDisplayBlankAs()  : string
How missing/blank values are displayed on chart (dispBlanksAs property).
getFill()  : Fill|null
getHashCode()  : string
Get hash code.
getHashIndex()  : null|int
Get hash index.
getHeight()  : int
Get Height.
getHyperlink()  : Hyperlink
Get Hyperlink.
getImageIndex()  : int
Get image index.
getIndexedFilename()  : string
Get indexed filename (using image index).
getLegend()  : Legend
Get Legend.
getName()  : string
Get Name.
getOffsetX()  : int
Get OffsetX.
getOffsetY()  : int
Get OffsetY.
getPlaceholder()  : Placeholder|null
getPlotArea()  : PlotArea
Get PlotArea.
getRotation()  : int
Get Rotation.
getShadow()  : Shadow|null
getTitle()  : Title
Get Title.
getView3D()  : View3D
Get View3D.
getWidth()  : int
Get Width.
hasHyperlink()  : bool
Has Hyperlink?
hasIncludedSpreadsheet()  : bool
Is the spreadsheet included for editing data ?
isPlaceholder()  : bool
isResizeProportional()  : bool
Get ResizeProportional.
setContainer()  : $this
Set Container, Slide or Group.
setDescription()  : $this
Set Description.
setDisplayBlankAs()  : self
Define a way to display missing/blank values (dispBlanksAs property).
setFill()  : self
setHashIndex()  : $this
Set hash index.
setHeight()  : $this
Set Height.
setHyperlink()  : self
Set Hyperlink.
setIncludeSpreadsheet()  : self
Is the spreadsheet included for editing data ?
setName()  : static
Set Name.
setOffsetX()  : $this
Set OffsetX.
setOffsetY()  : $this
Set OffsetY.
setPlaceHolder()  : self
setResizeProportional()  : self
Set ResizeProportional.
setRotation()  : $this
Set Rotation.
setShadow()  : $this
setWidth()  : $this
Set Width.
setWidthAndHeight()  : self
Set width and height with proportional resize.

Constants

BLANKAS_GAP

public mixed BLANKAS_GAP = 'gap'

BLANKAS_SPAN

public mixed BLANKAS_SPAN = 'span'

BLANKAS_ZERO

public mixed BLANKAS_ZERO = 'zero'

Properties

$relationId

Slide relation ID (should not be used by user code!).

public string $relationId

$resizeProportional

Proportional resize.

protected bool $resizeProportional

$displayBlankAs

How to display blank (missing) values? Not set by default.

private string $displayBlankAs = self::BLANKAS_ZERO

$includeSpreadsheet

Is the spreadsheet included for editing data ?

private bool $includeSpreadsheet = false

Methods

__clone()

Magic Method : clone.

public __clone() : mixed

__construct()

Create a new Chart.

public __construct() : mixed

getDescription()

Get Description.

public getDescription() : string
Return values
string

getDisplayBlankAs()

How missing/blank values are displayed on chart (dispBlanksAs property).

public getDisplayBlankAs() : string
Return values
string

getHashCode()

Get hash code.

public getHashCode() : string
Return values
string —

Hash code

getHashIndex()

Get hash index.

public getHashIndex() : null|int

Note that this index may vary during script execution! Only reliable moment is while doing a write of a workbook and when changes are not allowed.

Return values
null|int —

Hash index

getHeight()

Get Height.

public getHeight() : int
Return values
int

getImageIndex()

Get image index.

public getImageIndex() : int
Return values
int

getIndexedFilename()

Get indexed filename (using image index).

public getIndexedFilename() : string
Return values
string

getName()

Get Name.

public getName() : string
Return values
string

getOffsetX()

Get OffsetX.

public getOffsetX() : int
Return values
int

getOffsetY()

Get OffsetY.

public getOffsetY() : int
Return values
int

getRotation()

Get Rotation.

public getRotation() : int
Return values
int

getWidth()

Get Width.

public getWidth() : int
Return values
int

hasHyperlink()

Has Hyperlink?

public hasHyperlink() : bool
Return values
bool

hasIncludedSpreadsheet()

Is the spreadsheet included for editing data ?

public hasIncludedSpreadsheet() : bool
Return values
bool

isPlaceholder()

public isPlaceholder() : bool
Return values
bool

isResizeProportional()

Get ResizeProportional.

public isResizeProportional() : bool
Return values
bool

setContainer()

Set Container, Slide or Group.

public setContainer([ShapeContainerInterface|null $pValue = null ][, bool $pOverrideOld = false ]) : $this
Parameters
$pValue : ShapeContainerInterface|null = null
$pOverrideOld : bool = false

If a Slide has already been assigned, overwrite it and remove image from old Slide?

Return values
$this

setDescription()

Set Description.

public setDescription([string $pValue = '' ]) : $this
Parameters
$pValue : string = ''
Return values
$this

setDisplayBlankAs()

Define a way to display missing/blank values (dispBlanksAs property).

public setDisplayBlankAs(string $value) : self
Parameters
$value : string
Return values
self

setFill()

public setFill([Fill|null $pValue = null ]) : self
Parameters
$pValue : Fill|null = null
Return values
self

setHashIndex()

Set hash index.

public setHashIndex(int $value) : $this

Note that this index may vary during script execution! Only reliable moment is while doing a write of a workbook and when changes are not allowed.

Parameters
$value : int

Hash index

Return values
$this

setHeight()

Set Height.

public setHeight([int $pValue = 0 ]) : $this
Parameters
$pValue : int = 0
Return values
$this

setHyperlink()

Set Hyperlink.

public setHyperlink([Hyperlink|null $pHyperlink = null ]) : self
Parameters
$pHyperlink : Hyperlink|null = null
Return values
self

setIncludeSpreadsheet()

Is the spreadsheet included for editing data ?

public setIncludeSpreadsheet([bool $value = false ]) : self
Parameters
$value : bool = false
Return values
self

setName()

Set Name.

public setName([string $pValue = '' ]) : static
Parameters
$pValue : string = ''
Return values
static

setOffsetX()

Set OffsetX.

public setOffsetX([int $pValue = 0 ]) : $this
Parameters
$pValue : int = 0
Return values
$this

setOffsetY()

Set OffsetY.

public setOffsetY([int $pValue = 0 ]) : $this
Parameters
$pValue : int = 0
Return values
$this

setResizeProportional()

Set ResizeProportional.

public setResizeProportional([bool $pValue = true ]) : self
Parameters
$pValue : bool = true
Return values
self

setRotation()

Set Rotation.

public setRotation([int $pValue = 0 ]) : $this
Parameters
$pValue : int = 0
Return values
$this

setShadow()

public setShadow([Shadow|null $pValue = null ]) : $this
Parameters
$pValue : Shadow|null = null
Return values
$this

setWidth()

Set Width.

public setWidth([int $pValue = 0 ]) : $this
Parameters
$pValue : int = 0
Return values
$this

setWidthAndHeight()

Set width and height with proportional resize.

public setWidthAndHeight([int $width = 0 ][, int $height = 0 ]) : self
Parameters
$width : int = 0
$height : int = 0
Return values
self 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results