Class HeaderProperty

(Defined in: jpgraph_gantt.php : 1781)

HeaderProperty

SetBackgroundColor()
SetFont()
SetFontColor()
SetFormatString()
SetFrameColor()
SetFrameWeight()
SetInterval()
SetIntervall()
SetLabelFormatString()
SetStyle()
SetSundayFontColor()
SetTitleVertMargin()
SetWeekendColor()

Class usage and Overview

Data encapsulating class to hold properties for each type of the scale headers of the Gantt chart. It is instantiated in (and accessible through)


$ganttgraph->scale->min
$ganttgraph->scale->hour
$ganttgraph->scale->day
$ganttgraph->scale->week
$ganttgraph->scale->month
$ganttgraph->scale->year

You use the methods on these object to specify how you want the scale to be displayed. For example specifying if the week view will show start date or week number.

Class Methods

HeaderProperty ::
SetBackgroundColor($aColor)

Specify background color in scale

Argument Default Description

$aColor Color

Argument	Default	Description
$aColor		Color

Description:

Specify background color in scale

Example:

$ganttgraph->scale->week->SetBackgroundColor('lightblue');

HeaderProperty ::
SetFont($aFFamily, $aFStyle, $aFSize)

Specify font for scale

Argument Default Description

$aFFamily Font family

$aFStyle FS_NORMAL Font style

$aFSize 10 Font size

Argument	Default	Description
$aFFamily		Font family
$aFStyle	FS_NORMAL	Font style
$aFSize	10	Font size

Description:

Specify font for scale

Example:

$ganttgraph->scale->week->SetFont(FF_FONT0);

HeaderProperty ::
SetFontColor($aColor)

Specify font (text) color

Argument Default Description

$aColor Color

Argument	Default	Description
$aColor		Color

Description:

Specify font (text) color

Example:

$ganttgraph->scale->week->SetFontColor('darkred');

HeaderProperty ::
SetFormatString($aStr)

Specify format string for scales

Argument Default Description

$aStr Format string

Argument	Default	Description
$aStr		Format string

Description:

Specify printf() style format string for scales

HeaderProperty ::
SetFrameColor($aColor)

Set color of frame around scale

Argument Default Description

$aColor Color

Argument	Default	Description
$aColor		Color

Description:

Set color of frame around scale

Example:

$ganttgraph->scale->year->SetFrameCOlor('darkblue');

HeaderProperty ::
SetFrameWeight($aWeight)

Specify width of frame around scale

Argument Default Description

$aWeight Width in pixels

Argument	Default	Description
$aWeight		Width in pixels

Description:

Specify width of frame around scale

Example:

$ganttgraph->scale->year->SetFrameWeight(2);

HeaderProperty ::
SetInterval($aInt)

Argument Default Description

$aInt No description available

Argument	Default	Description
$aInt		No description available

Description:

No description available.

HeaderProperty ::
SetIntervall($aInt)

Set scale interval

Argument Default Description

$aInt Integer intervall

Argument	Default	Description
$aInt		Integer intervall

Description:

Set scale interval. The exact behaviour depends on if this is evoked on a day, hour or minute scale.

For example if the scale is an hour scale then SetIntervall() will give number of hours between each scale interball.

Example:

// Setup minute format

$graph->scale->minute->SetIntervall(30);

$graph->scale->minute->SetBackgroundColor('lightyellow:1.5');

$graph->scale->minute->SetFont(FF_FONT0);

$graph->scale->minute->SetStyle(MINUTESTYLE_MM);

$graph->scale->minute->grid->SetColor('lightgray');

HeaderProperty ::
SetLabelFormatString($aStr)

Specify format string for use in scale

Argument Default Description

$aStr printf() style format string

Argument	Default	Description
$aStr		printf() style format string

Description:

Specify format string for use in scale.

Example:

$ganttgraph->scale->week->SetLabelFormatString('week %d');

HeaderProperty ::
SetStyle($aStyle)

Specify style of scale.

Argument Default Description

$aStyle Scale style

Argument	Default	Description
$aStyle		Scale style

Description:

Specifies how the week, month, day, hour and minute scale should appear. For year scale this method has no meaning. For week scale:

WEEKSTYLE_WNBR, Show the numeric week number
WEEKSTYLE_FIRSTDAY, Show the date for the first day in the week. e.g. 24/05 (Meaning 24:th of May)
WEEKSTYLE_FIRSTDAY2, Show the date for the first day in the week but with month as text, e.g. 24 May
WEEKSTYLE_FIRSTDAYWNBR, Same as Firstday above but also adds the week number, e.g. 24/05, w34
WEEKSTYLE_FIRSTDAY2WNBR, Same as Firstday2 above but also adds the week number, e.g. 24 May, w34

For month scale:

MONTHSTYLE_SHORTNAME, Use short form of month name
MONTHSTYLE_LONGNAME, Use long form of month name
MONTHSTYLE_LONGNAMEYEAR2, Show long month nmame with a 2 digit year
MONTHSTYLE_SHORTNAMEYEAR2, Show short month nmame with a 2 digit year
MONTHSTYLE_LONGNAMEYEAR4, Show long month nmame with a 4 digit year
MONTHSTYLE_SHORTNAMEYEAR4, Show short month nmame with a 4 digit year

For Day style

"DAYSTYLE_ONELETTER"
"DAYSTYLE_LONG"
"DAYSTYLE_LONGDAYDATE1"
"DAYSTYLE_LONGDAYDATE2"
"DAYSTYLE_SHORT"
"DAYSTYLE_SHORTDAYDATE1"
"DAYSTYLE_SHORTDAYDATE2"
"DAYSTYLE_SHORTDAYDATE3"
"DAYSTYLE_SHORTDATE1"
"DAYSTYLE_SHORTDATE2"
"DAYSTYLE_SHORTDATE3"
"DAYSTYLE_CUSTOM"

For hour style

"HOURSTYLE_HM24"
"HOURSTYLE_HMAMPM"
"HOURSTYLE_H24"
"HOURSTYLE_HAMPM"
"HOURSTYLE_CUSTOM"

Minute style

"MINUTESTYLE_MM"
"MINUTESTYLE_CUSTOM"

Example:

$graph->scale->month->SetStyle(MONTHSTYLE_SHORTNAMEYEAR4);

HeaderProperty ::
SetSundayFontColor($aColor)

Only used by day scale. Specify font color for sunday.

Argument Default Description

$aColor Color

Argument	Default	Description
$aColor		Color

Description:

Only used by day scale. Specify font color for sunday. The default is toi display Sundays in red color as per convention.