\PHPExcel_Style_Fill

PHPExcel_Style_Fill

Copyright (c) 2006 - 2015 PHPExcel

This library is free software; you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation; either version 2.1 of the License, or (at your option) any later version.

This library is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.

You should have received a copy of the GNU Lesser General Public License along with this library; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA

Summary

Methods
Properties
Constants
__construct()
bindParent()
getIsSupervisor()
getActiveSheet()
getSelectedCells()
getActiveCell()
__clone()
getSharedComponent()
getStyleArray()
applyFromArray()
getFillType()
setFillType()
getRotation()
setRotation()
getStartColor()
setStartColor()
getEndColor()
setEndColor()
getHashCode()
No public properties found
FILL_NONE
FILL_SOLID
FILL_GRADIENT_LINEAR
FILL_GRADIENT_PATH
FILL_PATTERN_DARKDOWN
FILL_PATTERN_DARKGRAY
FILL_PATTERN_DARKGRID
FILL_PATTERN_DARKHORIZONTAL
FILL_PATTERN_DARKTRELLIS
FILL_PATTERN_DARKUP
FILL_PATTERN_DARKVERTICAL
FILL_PATTERN_GRAY0625
FILL_PATTERN_GRAY125
FILL_PATTERN_LIGHTDOWN
FILL_PATTERN_LIGHTGRAY
FILL_PATTERN_LIGHTGRID
FILL_PATTERN_LIGHTHORIZONTAL
FILL_PATTERN_LIGHTTRELLIS
FILL_PATTERN_LIGHTUP
FILL_PATTERN_LIGHTVERTICAL
FILL_PATTERN_MEDIUMGRAY
No protected methods found
$isSupervisor
$parent
$fillType
$rotation
$startColor
$endColor
N/A
No private methods found
No private properties found
N/A

Constants

FILL_NONE

FILL_NONE = 'none'

FILL_SOLID

FILL_SOLID = 'solid'

FILL_GRADIENT_LINEAR

FILL_GRADIENT_LINEAR = 'linear'

FILL_GRADIENT_PATH

FILL_GRADIENT_PATH = 'path'

FILL_PATTERN_DARKDOWN

FILL_PATTERN_DARKDOWN = 'darkDown'

FILL_PATTERN_DARKGRAY

FILL_PATTERN_DARKGRAY = 'darkGray'

FILL_PATTERN_DARKGRID

FILL_PATTERN_DARKGRID = 'darkGrid'

FILL_PATTERN_DARKHORIZONTAL

FILL_PATTERN_DARKHORIZONTAL = 'darkHorizontal'

FILL_PATTERN_DARKTRELLIS

FILL_PATTERN_DARKTRELLIS = 'darkTrellis'

FILL_PATTERN_DARKUP

FILL_PATTERN_DARKUP = 'darkUp'

FILL_PATTERN_DARKVERTICAL

FILL_PATTERN_DARKVERTICAL = 'darkVertical'

FILL_PATTERN_GRAY0625

FILL_PATTERN_GRAY0625 = 'gray0625'

FILL_PATTERN_GRAY125

FILL_PATTERN_GRAY125 = 'gray125'

FILL_PATTERN_LIGHTDOWN

FILL_PATTERN_LIGHTDOWN = 'lightDown'

FILL_PATTERN_LIGHTGRAY

FILL_PATTERN_LIGHTGRAY = 'lightGray'

FILL_PATTERN_LIGHTGRID

FILL_PATTERN_LIGHTGRID = 'lightGrid'

FILL_PATTERN_LIGHTHORIZONTAL

FILL_PATTERN_LIGHTHORIZONTAL = 'lightHorizontal'

FILL_PATTERN_LIGHTTRELLIS

FILL_PATTERN_LIGHTTRELLIS = 'lightTrellis'

FILL_PATTERN_LIGHTUP

FILL_PATTERN_LIGHTUP = 'lightUp'

FILL_PATTERN_LIGHTVERTICAL

FILL_PATTERN_LIGHTVERTICAL = 'lightVertical'

FILL_PATTERN_MEDIUMGRAY

FILL_PATTERN_MEDIUMGRAY = 'mediumGray'

Properties

$isSupervisor

$isSupervisor : boolean

Supervisor?

Type

boolean

$parent

$parent : \PHPExcel_Style

Parent. Only used for supervisor

Type

\PHPExcel_Style

$fillType

$fillType : string

Fill type

Type

string

$rotation

$rotation : double

Rotation

Type

double

Methods

__construct()

__construct(boolean  $isSupervisor = false, boolean  $isConditional = false) 

Create a new PHPExcel_Style_Fill

Parameters

boolean $isSupervisor

Flag indicating if this is a supervisor or not Leave this value at default unless you understand exactly what its ramifications are

boolean $isConditional

Flag indicating if this is a conditional style or not Leave this value at default unless you understand exactly what its ramifications are

bindParent()

bindParent(\PHPExcel  $parent,   $parentPropertyName = null) : \PHPExcel_Style_Supervisor

Bind parent. Only used for supervisor

Parameters

\PHPExcel $parent
$parentPropertyName

Returns

\PHPExcel_Style_Supervisor

getIsSupervisor()

getIsSupervisor() : boolean

Is this a supervisor or a cell style component?

Returns

boolean

getActiveSheet()

getActiveSheet() : \PHPExcel_Worksheet

Get the currently active sheet. Only used for supervisor

Returns

\PHPExcel_Worksheet

getSelectedCells()

getSelectedCells() : string

Get the currently active cell coordinate in currently active sheet.

Only used for supervisor

Returns

string —

E.g. 'A1'

getActiveCell()

getActiveCell() : string

Get the currently active cell coordinate in currently active sheet.

Only used for supervisor

Returns

string —

E.g. 'A1'

__clone()

__clone() 

Implement PHP __clone to create a deep clone, not just a shallow copy.

getSharedComponent()

getSharedComponent() : \PHPExcel_Style_Fill

Get the shared style component for the currently active cell in currently active sheet.

Only used for style supervisor

Returns

\PHPExcel_Style_Fill

getStyleArray()

getStyleArray(array  $array) : array

Build style array from subcomponents

Parameters

array $array

Returns

array

applyFromArray()

applyFromArray(array  $pStyles = null) : \PHPExcel_Style_Fill

Apply styles from array

$objPHPExcel->getActiveSheet()->getStyle('B2')->getFill()->applyFromArray( array( 'type' => PHPExcel_Style_Fill::FILL_GRADIENT_LINEAR, 'rotation' => 0, 'startcolor' => array( 'rgb' => '000000' ), 'endcolor' => array( 'argb' => 'FFFFFFFF' ) ) );

Parameters

array $pStyles

Array containing style information

Throws

\PHPExcel_Exception

Returns

\PHPExcel_Style_Fill

getFillType()

getFillType() : string

Get Fill Type

Returns

string

setFillType()

setFillType(string  $pValue = \PHPExcel_Style_Fill::FILL_NONE) : \PHPExcel_Style_Fill

Set Fill Type

Parameters

string $pValue

PHPExcel_Style_Fill fill type

Returns

\PHPExcel_Style_Fill

getRotation()

getRotation() : double

Get Rotation

Returns

double

setRotation()

setRotation(double  $pValue) : \PHPExcel_Style_Fill

Set Rotation

Parameters

double $pValue

Returns

\PHPExcel_Style_Fill

setStartColor()

setStartColor(\PHPExcel_Style_Color  $pValue = null) : \PHPExcel_Style_Fill

Set Start Color

Parameters

\PHPExcel_Style_Color $pValue

Throws

\PHPExcel_Exception

Returns

\PHPExcel_Style_Fill

getHashCode()

getHashCode() : string

Get hash code

Returns

string —

Hash code