class Chart (View source)

Methods

__construct(mixed $name, Title $title = null, Legend $legend = null, PlotArea $plotArea = null, mixed $plotVisibleOnly = true, mixed $displayBlanksAs = '0', Title $xAxisLabel = null, Title $yAxisLabel = null, Axis $xAxis = null, Axis $yAxis = null, GridLines $majorGridlines = null, GridLines $minorGridlines = null)

Create a new Chart.

string
getName()

Get Name.

getWorksheet()

Get Worksheet.

setWorksheet(Worksheet $pValue = null)

Set Worksheet.

getTitle()

Get Title.

setTitle(Title $title)

Set Title.

getLegend()

Get Legend.

setLegend(Legend $legend)

Set Legend.

getXAxisLabel()

Get X-Axis Label.

setXAxisLabel(Title $label)

Set X-Axis Label.

getYAxisLabel()

Get Y-Axis Label.

setYAxisLabel(Title $label)

Set Y-Axis Label.

getPlotArea()

Get Plot Area.

bool
getPlotVisibleOnly()

Get Plot Visible Only.

setPlotVisibleOnly(bool $plotVisibleOnly)

Set Plot Visible Only.

string
getDisplayBlanksAs()

Get Display Blanks as.

setDisplayBlanksAs(string $displayBlanksAs)

Set Display Blanks as.

getChartAxisY()

Get yAxis.

getChartAxisX()

Get xAxis.

getMajorGridlines()

Get Major Gridlines.

getMinorGridlines()

Get Minor Gridlines.

setTopLeftPosition(string $cell, int $xOffset = null, int $yOffset = null)

Set the Top Left position for the chart.

array
getTopLeftPosition()

Get the top left position of the chart.

string
getTopLeftCell()

Get the cell address where the top left of the chart is fixed.

setTopLeftCell(string $cell)

Set the Top Left cell position for the chart.

setTopLeftOffset(int $xOffset, int $yOffset)

Set the offset position within the Top Left cell for the chart.

int[]
getTopLeftOffset()

Get the offset position within the Top Left cell for the chart.

setTopLeftXOffset($xOffset)

No description

getTopLeftXOffset()

No description

setTopLeftYOffset($yOffset)

No description

getTopLeftYOffset()

No description

setBottomRightPosition(string $cell, int $xOffset = null, int $yOffset = null)

Set the Bottom Right position of the chart.

array
getBottomRightPosition()

Get the bottom right position of the chart.

setBottomRightCell($cell)

No description

string
getBottomRightCell()

Get the cell address where the bottom right of the chart is fixed.

setBottomRightOffset(int $xOffset, int $yOffset)

Set the offset position within the Bottom Right cell for the chart.

int[]
getBottomRightOffset()

Get the offset position within the Bottom Right cell for the chart.

setBottomRightXOffset($xOffset)

No description

getBottomRightXOffset()

No description

setBottomRightYOffset($yOffset)

No description

getBottomRightYOffset()

No description

refresh()

No description

bool
render(string $outputDestination = null)

Render the chart to given file (or stream).

Details

__construct(mixed $name, Title $title = null, Legend $legend = null, PlotArea $plotArea = null, mixed $plotVisibleOnly = true, mixed $displayBlanksAs = '0', Title $xAxisLabel = null, Title $yAxisLabel = null, Axis $xAxis = null, Axis $yAxis = null, GridLines $majorGridlines = null, GridLines $minorGridlines = null)

Create a new Chart.

Parameters

mixed $name
Title $title
Legend $legend
PlotArea $plotArea
mixed $plotVisibleOnly
mixed $displayBlanksAs
Title $xAxisLabel
Title $yAxisLabel
Axis $xAxis
Axis $yAxis
GridLines $majorGridlines
GridLines $minorGridlines

string getName()

Get Name.

Return Value

string

Worksheet getWorksheet()

Get Worksheet.

Return Value

Worksheet

Chart setWorksheet(Worksheet $pValue = null)

Set Worksheet.

Parameters

Worksheet $pValue

Return Value

Chart

Title getTitle()

Get Title.

Return Value

Title

Chart setTitle(Title $title)

Set Title.

Parameters

Title $title

Return Value

Chart

Legend getLegend()

Get Legend.

Return Value

Legend

Chart setLegend(Legend $legend)

Set Legend.

Parameters

Legend $legend

Return Value

Chart

Title getXAxisLabel()

Get X-Axis Label.

Return Value

Title

Chart setXAxisLabel(Title $label)

Set X-Axis Label.

Parameters

Title $label

Return Value

Chart

Title getYAxisLabel()

Get Y-Axis Label.

Return Value

Title

Chart setYAxisLabel(Title $label)

Set Y-Axis Label.

Parameters

Title $label

Return Value

Chart

PlotArea getPlotArea()

Get Plot Area.

Return Value

PlotArea

bool getPlotVisibleOnly()

Get Plot Visible Only.

Return Value

bool

Chart setPlotVisibleOnly(bool $plotVisibleOnly)

Set Plot Visible Only.

Parameters

bool $plotVisibleOnly

Return Value

Chart

string getDisplayBlanksAs()

Get Display Blanks as.

Return Value

string

Chart setDisplayBlanksAs(string $displayBlanksAs)

Set Display Blanks as.

Parameters

string $displayBlanksAs

Return Value

Chart

Axis getChartAxisY()

Get yAxis.

Return Value

Axis

Axis getChartAxisX()

Get xAxis.

Return Value

Axis

GridLines getMajorGridlines()

Get Major Gridlines.

Return Value

GridLines

GridLines getMinorGridlines()

Get Minor Gridlines.

Return Value

GridLines

Chart setTopLeftPosition(string $cell, int $xOffset = null, int $yOffset = null)

Set the Top Left position for the chart.

Parameters

string $cell
int $xOffset
int $yOffset

Return Value

Chart

array getTopLeftPosition()

Get the top left position of the chart.

Return Value

array an associative array containing the cell address, X-Offset and Y-Offset from the top left of that cell

string getTopLeftCell()

Get the cell address where the top left of the chart is fixed.

Return Value

string

Chart setTopLeftCell(string $cell)

Set the Top Left cell position for the chart.

Parameters

string $cell

Return Value

Chart

Chart setTopLeftOffset(int $xOffset, int $yOffset)

Set the offset position within the Top Left cell for the chart.

Parameters

int $xOffset
int $yOffset

Return Value

Chart

int[] getTopLeftOffset()

Get the offset position within the Top Left cell for the chart.

Return Value

int[]

setTopLeftXOffset($xOffset)

Parameters

$xOffset

getTopLeftXOffset()

setTopLeftYOffset($yOffset)

Parameters

$yOffset

getTopLeftYOffset()

Chart setBottomRightPosition(string $cell, int $xOffset = null, int $yOffset = null)

Set the Bottom Right position of the chart.

Parameters

string $cell
int $xOffset
int $yOffset

Return Value

Chart

array getBottomRightPosition()

Get the bottom right position of the chart.

Return Value

array an associative array containing the cell address, X-Offset and Y-Offset from the top left of that cell

setBottomRightCell($cell)

Parameters

$cell

string getBottomRightCell()

Get the cell address where the bottom right of the chart is fixed.

Return Value

string

Chart setBottomRightOffset(int $xOffset, int $yOffset)

Set the offset position within the Bottom Right cell for the chart.

Parameters

int $xOffset
int $yOffset

Return Value

Chart

int[] getBottomRightOffset()

Get the offset position within the Bottom Right cell for the chart.

Return Value

int[]

setBottomRightXOffset($xOffset)

Parameters

$xOffset

getBottomRightXOffset()

setBottomRightYOffset($yOffset)

Parameters

$yOffset

getBottomRightYOffset()

refresh()

bool render(string $outputDestination = null)

Render the chart to given file (or stream).

Parameters

string $outputDestination Name of the file render to

Return Value

bool true on success