previousWorkbook::setVersion (Previous) (Next) Workbook::worksheetsnext

View this page in Last updated: Sun, 18 Oct 2009
English | Brazilian Portuguese | Chinese | Dutch | French | German | Hungarian | Japanese | Polish | Russian | Spanish | Turkish

Workbook::setCustomColor

Workbook::setCustomColor – Change the RGB components of the elements in the colour palette.

Synopsis

require_once "Spreadsheet/Excel/Writer.php";

integer Workbook::setCustomColor ( integer $index , integer $red , integer $green , integer $blue )

Description

Change the RGB components of the elements in the colour palette. The new color, defined by the given RGB components, will "overwrite" the color previously defined for the given index.

Parameter

  • integer $index - colour index

  • integer $red - red RGB value [0-255]

  • integer $green - green RGB value [0-255]

  • integer $blue - blue RGB value [0-255]

Return value

integer - The palette index for the custom color

Note

This function can not be called statically.

Example

Using setCustomColor()

<?php
require_once 'Spreadsheet/Excel/Writer.php';

$workbook = new Spreadsheet_Excel_Writer();
$worksheet =& $workbook->addWorksheet();

// "regular" green
$format_regular_green =& $workbook->addFormat();
$format_regular_green->setFgColor('green');

// "special" green
$format_special_green =& $workbook->addFormat();
$format_special_green->setFgColor(11);

// our green (overwriting color on index 12)
$workbook->setCustomColor(121020010);
$format_our_green =& $workbook->addFormat();
$format_our_green->setFgColor(12);

$worksheet->setColumn(0030);

$worksheet->write(00"Regular green"$format_regular_green);
$worksheet->write(10"Special green (index 11)"$format_special_green);
$worksheet->write(20"Our green"$format_our_green);

$workbook->send('greens.xls');
$workbook->close();
?>
previousWorkbook::setVersion (Previous) (Next) Workbook::worksheetsnext

Download Documentation Last updated: Sun, 18 Oct 2009
Do you think that something on this page is wrong? Please file a bug report or add a note.
User Notes:
Note by: gwinkless
BEWARE OF BUG 12062 - http://pear.php.net/bugs/bug.php?id=12062 - the excel-writer object maps colors 0-7 to colors 8-15, so with the default 0.9.1beta DO NOT map colors 8-15, custom colors should only start at 16.