173 lines
15 KiB
HTML
173 lines
15 KiB
HTML
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"><HTML><HEAD><style type="text/css">
|
||
|
|
<!--
|
||
|
|
A:link {font-family: helvetica, arial, geneva, sans-serif; font-size: small; text-decoration: none; color: #000000}
|
||
|
|
A:visited {font-family: helvetica, arial, geneva, sans-serif; font-size: small; text-decoration: none; color: #000000}
|
||
|
|
A:hover {font-family: helvetica, arial, geneva, sans-serif; font-size: small; text-decoration: underline; color: #FF0000}
|
||
|
|
A.no:link {font-family:inherit; font-size: inhreit;text-decoration: none; color: #000000}
|
||
|
|
A.no:visited {font-family:inherit; font-size: inherit;text-decoration: none; color: #000000}
|
||
|
|
A.no:hover {font-family:inherit; font-size: inherit;text-decoration: none; color: #000000}
|
||
|
|
th {font-family: helvetica, arial; color : black; font-size:90%; background : #b7c8b7; border-right:black solid 1pt; border-bottom:black solid 1pt;}
|
||
|
|
td {font-family: helvetica, arial; color : black; font-size:90%; background : white; border-right:black solid 1pt; border-bottom:black solid 1pt;}
|
||
|
|
|
||
|
|
//-->
|
||
|
|
</style></HEAD><hr><div style="padding-left:4px;border-left:solid black 1px;border-top:solid black 1px;border-bottom:solid black 2px;border-right:solid black 2px;background-color:#deaa87;font-family:courier new;font-size:16pt;">Class <a class="no" name="_C_GANTTSCALE"><b>GanttScale</b></a></div>
|
||
|
|
<i>(Defined in: jpgraph_gantt.php : 1890)</i><br> <br><table cellspaceing=0 cellpadding=4 style="border:solid #303030 1px;"><tr><td align="center" style="background:lightgray;" > <a href="GanttScale.html" style="font-family:arial;font-weight:bold;color:darkblue;">GanttScale</a> </td></tr><tr><td valign=top> <a href="GanttScale.html#_GANTTSCALE_SETDATELOCALE">SetDateLocale()</a> <br>
|
||
|
|
<a href="GanttScale.html#_GANTTSCALE_SETRANGE">SetRange()</a> <br>
|
||
|
|
<a href="GanttScale.html#_GANTTSCALE_SETTABLETITLEBACKGROUND">SetTableTitleBackground()</a> <br>
|
||
|
|
<a href="GanttScale.html#_GANTTSCALE_SETVERTLAYOUT">SetVertLayout()</a> <br>
|
||
|
|
<a href="GanttScale.html#_GANTTSCALE_SETWEEKSTART">SetWeekStart()</a> <br>
|
||
|
|
<a href="GanttScale.html#_GANTTSCALE_USEWEEKENDBACKGROUND">UseWeekendBackground()</a> <br>
|
||
|
|
</td></tr></table> <p><div style="font-weight:bold;font-family:arial;font-size:100%;">Class usage and Overview</div>Internal class to represent the scale used for Gantt graphs.
|
||
|
|
|
||
|
|
The scale is accessible as GanttGraph::scale
|
||
|
|
|
||
|
|
The following public available subobjects are available
|
||
|
|
|
||
|
|
<ul>
|
||
|
|
<li> tableTitle (Instance of class TextProperty)
|
||
|
|
<li> divider (Instance of class LineProperty)
|
||
|
|
<li> actinfo (Instance of class GanttActivityInfo)
|
||
|
|
<li> year (Instance of HeaderProperty)
|
||
|
|
<li> month (Instance of HeaderProperty)
|
||
|
|
<li> week (Instance of HeaderProperty)
|
||
|
|
<li> day (Instance of HeaderProperty)
|
||
|
|
<li> hour (Instance of HeaderProperty)
|
||
|
|
<li> minute (Instance of HeaderProperty)
|
||
|
|
</ul> <p>
|
||
|
|
<div style="font-weight:bold;font-family:arial;font-size:85%;">See also related classes:</div><a href="GanttGraph.html">GanttGraph</a>, <a href="HeaderProperty.html">HeaderProperty</a>, <a href="GanttActivityInfo.html">GanttActivityInfo</a> and <a href="TextProperty.html">TextProperty</a> <p> <hr><span style="font-family:arial;font-size:120%;font-weight:bold;">Class Methods</span><hr><p>
|
||
|
|
<p> <div style='font-family: helvetica, arial, geneva, sans-serif;margin-bottom:4px;border-left:solid black 1px;border-top:solid black 1px;border-bottom:solid black 2px;border-right:solid black 2px;font-size:120%;background:#dde9af;padding:4px;'><a class="no" name="_GANTTSCALE_SETDATELOCALE"><span style="color:#555555;">GanttScale ::</span><br><b>SetDateLocale</b>($aLocale)</a></div>
|
||
|
|
|
||
|
|
<span style='font-family:arial;font-size:95%;'><i>Specify locale to use for scale.</i></span><p>
|
||
|
|
|
||
|
|
<table cellspacing=0 style='border:black solid 1pt;' width=100%>
|
||
|
|
<tr><th width=25%>Argument</th><th width=15%>Default</th><th width=60%>Description</th></tr>
|
||
|
|
<tr><td style='border-right:black solid 1pt;font-family:courier;font-size:100%;font-weight:bold;'><span style="color: #000000">
|
||
|
|
<span style="color: #0000BB">$aLocale</span>
|
||
|
|
</span>
|
||
|
|
|
||
|
|
</td><td style='border-right:black solid 1pt;font-family:courier;font-size:100%;font-weight:bold;'> </td><td>String to specify locale</td></tr>
|
||
|
|
</table>
|
||
|
|
|
||
|
|
<div style="font-weight:bold;font-family:arial;font-size:90%;">Description:</div>Specify locale to use for scale. If no locale is specified then the default locale for the installed system will be used. <br>
|
||
|
|
<div style="font-weight:bold;font-family:arial;font-size:90%;">See also:</div><ul><li><a href="DateLocale.html#_DATELOCALE___CONSTRUCT">DateLocale::__construct()</a></ul>
|
||
|
|
<div style="font-weight:bold;font-family:arial;font-size:90%;"><p>Example:</div><div style="padding:5px;border:dashed gray 1px;background-color:#f3f3f3;font-family:courier new;font-size:90%;font-weight:bold;"><b><span style="color: #000000">
|
||
|
|
<span style="color: #0000BB">$ganttgraph</span><span style="color: #007700">-></span><span style="color: #0000BB">scale</span><span style="color: #007700">-></span><span style="color: #0000BB">SetDateLocale</span><span style="color: #007700">(</span><span style="color: #DD0000">'US_en'</span><span style="color: #007700">);</span><span style="color: #0000BB"></span>
|
||
|
|
</span>
|
||
|
|
</b></div><br>
|
||
|
|
<p>
|
||
|
|
<p> <div style='font-family: helvetica, arial, geneva, sans-serif;margin-bottom:4px;border-left:solid black 1px;border-top:solid black 1px;border-bottom:solid black 2px;border-right:solid black 2px;font-size:120%;background:#dde9af;padding:4px;'><a class="no" name="_GANTTSCALE_SETRANGE"><span style="color:#555555;">GanttScale ::</span><br><b>SetRange</b>($aMin, $aMax)</a></div>
|
||
|
|
|
||
|
|
<span style='font-family:arial;font-size:95%;'><i>Specify date range for scale.</i></span><p>
|
||
|
|
|
||
|
|
<table cellspacing=0 style='border:black solid 1pt;' width=100%>
|
||
|
|
<tr><th width=25%>Argument</th><th width=15%>Default</th><th width=60%>Description</th></tr>
|
||
|
|
<tr><td style='border-right:black solid 1pt;font-family:courier;font-size:100%;font-weight:bold;'><span style="color: #000000">
|
||
|
|
<span style="color: #0000BB">$aMin</span>
|
||
|
|
</span>
|
||
|
|
|
||
|
|
</td><td style='border-right:black solid 1pt;font-family:courier;font-size:100%;font-weight:bold;'> </td><td>Min date</td></tr>
|
||
|
|
|
||
|
|
<tr><td style='border-right:black solid 1pt;font-family:courier;font-size:100%;font-weight:bold;'><span style="color: #000000">
|
||
|
|
<span style="color: #0000BB">$aMax</span>
|
||
|
|
</span>
|
||
|
|
|
||
|
|
</td><td style='border-right:black solid 1pt;font-family:courier;font-size:100%;font-weight:bold;'> </td><td>Max date</td></tr>
|
||
|
|
</table>
|
||
|
|
|
||
|
|
<div style="font-weight:bold;font-family:arial;font-size:90%;">Description:</div>Specify scale min and max date either as timestamp or as date strings. Always round to the nearest week boundary <br>
|
||
|
|
|
||
|
|
<div style="font-weight:bold;font-family:arial;font-size:90%;"><p>Example:</div><div style="padding:5px;border:dashed gray 1px;background-color:#f3f3f3;font-family:courier new;font-size:90%;font-weight:bold;"><b><span style="color: #000000">
|
||
|
|
<span style="color: #0000BB">$ganttgraph</span><span style="color: #007700">-></span><span style="color: #0000BB">scale</span><span style="color: #007700">-></span><span style="color: #0000BB">SetRange</span><span style="color: #007700">(</span><span style="color: #DD0000">"2002-11-23"</span><span style="color: #007700">, </span><span style="color: #DD0000">"2003-03-31"</span><span style="color: #007700">);
<br /></span><span style="color: #0000BB"></span>
|
||
|
|
</span>
|
||
|
|
</b></div><br>
|
||
|
|
<p>
|
||
|
|
<p> <div style='font-family: helvetica, arial, geneva, sans-serif;margin-bottom:4px;border-left:solid black 1px;border-top:solid black 1px;border-bottom:solid black 2px;border-right:solid black 2px;font-size:120%;background:#dde9af;padding:4px;'><a class="no" name="_GANTTSCALE_SETTABLETITLEBACKGROUND"><span style="color:#555555;">GanttScale ::</span><br><b>SetTableTitleBackground</b>($aColor)</a></div>
|
||
|
|
|
||
|
|
<span style='font-family:arial;font-size:95%;'><i>Specify background for the table title area.</i></span><p>
|
||
|
|
|
||
|
|
<table cellspacing=0 style='border:black solid 1pt;' width=100%>
|
||
|
|
<tr><th width=25%>Argument</th><th width=15%>Default</th><th width=60%>Description</th></tr>
|
||
|
|
<tr><td style='border-right:black solid 1pt;font-family:courier;font-size:100%;font-weight:bold;'><span style="color: #000000">
|
||
|
|
<span style="color: #0000BB">$aColor</span>
|
||
|
|
</span>
|
||
|
|
|
||
|
|
</td><td style='border-right:black solid 1pt;font-family:courier;font-size:100%;font-weight:bold;'> </td><td>Color</td></tr>
|
||
|
|
</table>
|
||
|
|
|
||
|
|
<div style="font-weight:bold;font-family:arial;font-size:90%;">Description:</div>Specify background for the table title area (upper left corner of the table). <br>
|
||
|
|
|
||
|
|
<div style="font-weight:bold;font-family:arial;font-size:90%;"><p>Example:</div><div style="padding:5px;border:dashed gray 1px;background-color:#f3f3f3;font-family:courier new;font-size:90%;font-weight:bold;"><b><span style="color: #000000">
|
||
|
|
<span style="color: #0000BB">$ganttgraph</span><span style="color: #007700">-></span><span style="color: #0000BB">scale</span><span style="color: #007700">-></span><span style="color: #0000BB">SetTableTitleBackground</span><span style="color: #007700">(</span><span style="color: #DD0000">'lightblue'</span><span style="color: #007700">);</span><span style="color: #0000BB"></span>
|
||
|
|
</span>
|
||
|
|
</b></div><br>
|
||
|
|
<p>
|
||
|
|
<p> <div style='font-family: helvetica, arial, geneva, sans-serif;margin-bottom:4px;border-left:solid black 1px;border-top:solid black 1px;border-bottom:solid black 2px;border-right:solid black 2px;font-size:120%;background:#dde9af;padding:4px;'><a class="no" name="_GANTTSCALE_SETVERTLAYOUT"><span style="color:#555555;">GanttScale ::</span><br><b>SetVertLayout</b>($aLayout)</a></div>
|
||
|
|
|
||
|
|
<span style='font-family:arial;font-size:95%;'><i>Specify the vertical layout fro rows.</i></span><p>
|
||
|
|
|
||
|
|
<table cellspacing=0 style='border:black solid 1pt;' width=100%>
|
||
|
|
<tr><th width=25%>Argument</th><th width=15%>Default</th><th width=60%>Description</th></tr>
|
||
|
|
<tr><td style='border-right:black solid 1pt;font-family:courier;font-size:100%;font-weight:bold;'><span style="color: #000000">
|
||
|
|
<span style="color: #0000BB">$aLayout</span>
|
||
|
|
</span>
|
||
|
|
|
||
|
|
</td><td style='border-right:black solid 1pt;font-family:courier;font-size:100%;font-weight:bold;'> </td><td>Vertical layout parameter</td></tr>
|
||
|
|
</table>
|
||
|
|
|
||
|
|
<div style="font-weight:bold;font-family:arial;font-size:90%;">Description:</div>Should the layout be from top or even. Valid parameters are
|
||
|
|
<ul>
|
||
|
|
<li> GANTT_EVEN, Spread out the rows even over the whole height of the plot.
|
||
|
|
<li> GANTT_FROMTOP, Use the minimum height required for the rows starting from top.
|
||
|
|
</ul>
|
||
|
|
|
||
|
|
Note that if you use auto-sizing of the Gantt chart these parameters have little effect since the total height of the image will always be so that all rows fit exactly.
|
||
|
|
<br>
|
||
|
|
|
||
|
|
<div style="font-weight:bold;font-family:arial;font-size:90%;"><p>Example:</div><div style="padding:5px;border:dashed gray 1px;background-color:#f3f3f3;font-family:courier new;font-size:90%;font-weight:bold;"><b><span style="color: #000000">
|
||
|
|
<span style="color: #0000BB">$granntgraph</span><span style="color: #007700">-></span><span style="color: #0000BB">scale</span><span style="color: #007700">-></span><span style="color: #0000BB">SetVertLayout</span><span style="color: #007700">(</span><span style="color: #0000BB">GANTT_FROMTOP</span><span style="color: #007700">);</span><span style="color: #0000BB"></span>
|
||
|
|
</span>
|
||
|
|
</b></div><br>
|
||
|
|
<p>
|
||
|
|
<p> <div style='font-family: helvetica, arial, geneva, sans-serif;margin-bottom:4px;border-left:solid black 1px;border-top:solid black 1px;border-bottom:solid black 2px;border-right:solid black 2px;font-size:120%;background:#dde9af;padding:4px;'><a class="no" name="_GANTTSCALE_SETWEEKSTART"><span style="color:#555555;">GanttScale ::</span><br><b>SetWeekStart</b>($aStartDay)</a></div>
|
||
|
|
|
||
|
|
<span style='font-family:arial;font-size:95%;'><i>Specify which weekday should start the week</i></span><p>
|
||
|
|
|
||
|
|
<table cellspacing=0 style='border:black solid 1pt;' width=100%>
|
||
|
|
<tr><th width=25%>Argument</th><th width=15%>Default</th><th width=60%>Description</th></tr>
|
||
|
|
<tr><td style='border-right:black solid 1pt;font-family:courier;font-size:100%;font-weight:bold;'><span style="color: #000000">
|
||
|
|
<span style="color: #0000BB">$aStartDay</span>
|
||
|
|
</span>
|
||
|
|
|
||
|
|
</td><td style='border-right:black solid 1pt;font-family:courier;font-size:100%;font-weight:bold;'> </td><td>Weekday, (0-6)</td></tr>
|
||
|
|
</table>
|
||
|
|
|
||
|
|
<div style="font-weight:bold;font-family:arial;font-size:90%;">Description:</div>Which day should the week start?
|
||
|
|
0==Sun, 1==Monday, 2==Tuesday etc
|
||
|
|
|
||
|
|
By default weeks start on Mondays. <br>
|
||
|
|
<div style="font-weight:bold;font-family:arial;font-size:90%;">See also:</div><ul><li><a href="GanttScale.html#_GANTTSCALE_SETRANGE">GanttScale::SetRange()</a></ul>
|
||
|
|
<div style="font-weight:bold;font-family:arial;font-size:90%;"><p>Example:</div><div style="padding:5px;border:dashed gray 1px;background-color:#f3f3f3;font-family:courier new;font-size:90%;font-weight:bold;"><b><span style="color: #000000">
|
||
|
|
<span style="color: #0000BB">$granttgraph</span><span style="color: #007700">-></span><span style="color: #0000BB">SetWeekStart</span><span style="color: #007700">(</span><span style="color: #0000BB">1</span><span style="color: #007700">);</span><span style="color: #0000BB"></span>
|
||
|
|
</span>
|
||
|
|
</b></div><br>
|
||
|
|
<p>
|
||
|
|
<p> <div style='font-family: helvetica, arial, geneva, sans-serif;margin-bottom:4px;border-left:solid black 1px;border-top:solid black 1px;border-bottom:solid black 2px;border-right:solid black 2px;font-size:120%;background:#dde9af;padding:4px;'><a class="no" name="_GANTTSCALE_USEWEEKENDBACKGROUND"><span style="color:#555555;">GanttScale ::</span><br><b>UseWeekendBackground</b>($aShow)</a></div>
|
||
|
|
|
||
|
|
<span style='font-family:arial;font-size:95%;'><i>Determine if the background color for weekends in the scale should extend down in the plot area.</i></span><p>
|
||
|
|
|
||
|
|
<table cellspacing=0 style='border:black solid 1pt;' width=100%>
|
||
|
|
<tr><th width=25%>Argument</th><th width=15%>Default</th><th width=60%>Description</th></tr>
|
||
|
|
<tr><td style='border-right:black solid 1pt;font-family:courier;font-size:100%;font-weight:bold;'><span style="color: #000000">
|
||
|
|
<span style="color: #0000BB">$aShow</span>
|
||
|
|
</span>
|
||
|
|
|
||
|
|
</td><td style='border-right:black solid 1pt;font-family:courier;font-size:100%;font-weight:bold;'> </td><td>True=Use the weekend background color in the ganttgraph</td></tr>
|
||
|
|
</table>
|
||
|
|
|
||
|
|
<div style="font-weight:bold;font-family:arial;font-size:90%;">Description:</div>Determine if the background color for weekends in the scale should extend down in the plot area. <br>
|
||
|
|
|
||
|
|
<div style="font-weight:bold;font-family:arial;font-size:90%;"><p>Example:</div><div style="padding:5px;border:dashed gray 1px;background-color:#f3f3f3;font-family:courier new;font-size:90%;font-weight:bold;"><b><span style="color: #000000">
|
||
|
|
<span style="color: #0000BB">$ganttgraph</span><span style="color: #007700">-></span><span style="color: #0000BB">scale</span><span style="color: #007700">-></span><span style="color: #0000BB">USeWeekendBackground</span><span style="color: #007700">();
<br /></span><span style="color: #0000BB"></span>
|
||
|
|
</span>
|
||
|
|
</b></div><br>
|
||
|
|
<p> <hr> <p></html>
|