[Sommaire] [Imprimer]

   1  <style type="text/css">
   2          <!--
   3          A:link        {font-family: helvetica, arial, geneva, sans-serif; font-size: x-small; text-decoration: none; color: #0000ff}
   4          A:visited     {font-family: helvetica, arial, geneva, sans-serif; font-size: x-small; text-decoration: none; color: #0000ff}
   5          A:hover       {font-family: helvetica, arial, geneva, sans-serif; font-size: x-small; text-decoration: underline; color: #FF0000}
   6          th            {font-family: helvetica, arial; color : blue; font-size:85%; background : lightgrey; border-right:black solid 1pt; border-bottom:black solid 1pt;}
   7          //-->
   8          </style><hr><a name="_C_GANTTSCALE"><div style="background-color:yellow;font-family:courier new;"></a>CLASS <b>GanttScale</b></div>
   9  <i>(Defined in: jpgraph_gantt.php : 1834)</i><table border=1><tr><td>&nbsp;<a href="GanttScale.html" style="font-family:arial;font-weight:bold;color:darkblue;">GanttScale</a>&nbsp;</td></tr><tr><td valign=top>&nbsp;<a href="GanttScale.html#_GANTTSCALE_SETDATELOCALE">SetDateLocale()</a>&nbsp;<br>
  10  &nbsp;<a href="GanttScale.html#_GANTTSCALE_SETRANGE">SetRange()</a>&nbsp;<br>
  11  &nbsp;<a href="GanttScale.html#_GANTTSCALE_SETTABLETITLEBACKGROUND">SetTableTitleBackground()</a>&nbsp;<br>
  12  &nbsp;<a href="GanttScale.html#_GANTTSCALE_SETVERTLAYOUT">SetVertLayout()</a>&nbsp;<br>
  13  &nbsp;<a href="GanttScale.html#_GANTTSCALE_SETWEEKSTART">SetWeekStart()</a>&nbsp;<br>
  14  &nbsp;<a href="GanttScale.html#_GANTTSCALE_USEWEEKENDBACKGROUND">UseWeekendBackground()</a>&nbsp;<br>
  15  </td></tr></table>&nbsp;<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.
  16  
  17  The scale is accessible as GanttGraph::scale
  18  
  19  The following public available subobjects are available
  20  
  21  <ul>
  22  <li> tableTitle (Instance of class TextProperty)
  23  <li> divider (Instance of class LineProperty)
  24  <li> actinfo (Instance of class GanttActivityInfo)
  25  <li> year (Instance of HeaderProperty)
  26  <li> month (Instance of HeaderProperty)
  27  <li> week (Instance of HeaderProperty)
  28  <li> day (Instance of HeaderProperty)
  29  <li> hour (Instance of HeaderProperty)
  30  <li> minute (Instance of HeaderProperty)
  31  </ul> <p> &nbsp;
  32  <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> &nbsp;<hr><span style="font-family:arial;font-size:120%;font-weight:bold;">Class Methods</span><hr><p>
  33  <p>&nbsp; <p> &nbsp; <span style='font-size:110%;'><a name="_GANTTSCALE_SETDATELOCALE"><div style="border-top:solid black 2pt;background-color:lightblue;font-family:courier new;font-size:90%;font-weight:bold;"><b><font color="#000000">
  34  function&nbsp;SetDateLocale($aLocale)</font>
  35  </b></div></a></span>
  36  
  37  <span style='font-family:arial;font-size:90%;'><i>Specify locale to use for scale.</i></span><p>
  38  
  39  <table cellspacing=0 style='border:black solid 1pt;' width=100%>
  40  <tr><th width=25%>Argument</th><th width=15%>Default</th><th width=60%>Description</th></tr>
  41  <tr><td style='border-right:black solid 1pt;font-family:courier;font-size:90%;font-weight:bold;'><font color="#000000">
  42  $aLocale</font>
  43  
  44  </td><td style='border-right:black solid 1pt;font-family:courier;font-size:90%;font-weight:bold;'>&nbsp;</td><td>String to specify locale</td></tr>
  45  </table>
  46  
  47  <div style="font-weight:bold;font-family:arial;font-size:85%;">Description</div>Specify locale to use for scale. If no locale is specified then the default locale for the installed system will be used.&nbsp;<br>
  48   &nbsp; <div style="font-weight:bold;font-family:arial;font-size:85%;">See also</div><a href="DateLocale.html#_DATELOCALE_DATELOCALE">DateLocale::DateLocale</a>
  49  <div style="font-weight:bold;font-family:arial;font-size:85%;"><p>Example</div><span style="font-family:courier;font-size:85%;"><font color="#000000">
  50  $ganttgraph-&gt;scale-&gt;SetDateLocale('US_en');</font>
  51  </span><br>
  52  <p>
  53  <p>&nbsp; <p> &nbsp; <span style='font-size:110%;'><a name="_GANTTSCALE_SETRANGE"><div style="border-top:solid black 2pt;background-color:lightblue;font-family:courier new;font-size:90%;font-weight:bold;"><b><font color="#000000">
  54  function&nbsp;SetRange($aMin,$aMax)</font>
  55  </b></div></a></span>
  56  
  57  <span style='font-family:arial;font-size:90%;'><i>Specify date range for scale.</i></span><p>
  58  
  59  <table cellspacing=0 style='border:black solid 1pt;' width=100%>
  60  <tr><th width=25%>Argument</th><th width=15%>Default</th><th width=60%>Description</th></tr>
  61  <tr><td style='border-right:black solid 1pt;font-family:courier;font-size:90%;font-weight:bold;'><font color="#000000">
  62  $aMin</font>
  63  
  64  </td><td style='border-right:black solid 1pt;font-family:courier;font-size:90%;font-weight:bold;'>&nbsp;</td><td>Min date</td></tr>
  65  
  66  <tr><td style='border-right:black solid 1pt;font-family:courier;font-size:90%;font-weight:bold;'><font color="#000000">
  67  $aMax</font>
  68  
  69  </td><td style='border-right:black solid 1pt;font-family:courier;font-size:90%;font-weight:bold;'>&nbsp;</td><td>Max date</td></tr>
  70  </table>
  71  
  72  <div style="font-weight:bold;font-family:arial;font-size:85%;">Description</div>Specify scale min and max date either as timestamp or as date strings. Always round to the nearest week boundary&nbsp;<br>
  73  
  74  <div style="font-weight:bold;font-family:arial;font-size:85%;"><p>Example</div><span style="font-family:courier;font-size:85%;"><font color="#000000">
  75  $ganttgraph-&gt;scale-&gt;SetRange("2002-11-23",&nbsp;"2003-03-31");
<br /></font>
  76  </span><br>
  77  <p>
  78  <p>&nbsp; <p> &nbsp; <span style='font-size:110%;'><a name="_GANTTSCALE_SETTABLETITLEBACKGROUND"><div style="border-top:solid black 2pt;background-color:lightblue;font-family:courier new;font-size:90%;font-weight:bold;"><b><font color="#000000">
  79  function&nbsp;SetTableTitleBackground($aColor)</font>
  80  </b></div></a></span>
  81  
  82  <span style='font-family:arial;font-size:90%;'><i>Specify background for the table title area.</i></span><p>
  83  
  84  <table cellspacing=0 style='border:black solid 1pt;' width=100%>
  85  <tr><th width=25%>Argument</th><th width=15%>Default</th><th width=60%>Description</th></tr>
  86  <tr><td style='border-right:black solid 1pt;font-family:courier;font-size:90%;font-weight:bold;'><font color="#000000">
  87  $aColor</font>
  88  
  89  </td><td style='border-right:black solid 1pt;font-family:courier;font-size:90%;font-weight:bold;'>&nbsp;</td><td>Color</td></tr>
  90  </table>
  91  
  92  <div style="font-weight:bold;font-family:arial;font-size:85%;">Description</div>Specify background for the table title area (upper left corner of the table).&nbsp;<br>
  93  
  94  <div style="font-weight:bold;font-family:arial;font-size:85%;"><p>Example</div><span style="font-family:courier;font-size:85%;"><font color="#000000">
  95  $ganttgraph-&gt;scale-&gt;SetTableTitleBackground('lightblue');</font>
  96  </span><br>
  97  <p>
  98  <p>&nbsp; <p> &nbsp; <span style='font-size:110%;'><a name="_GANTTSCALE_SETVERTLAYOUT"><div style="border-top:solid black 2pt;background-color:lightblue;font-family:courier new;font-size:90%;font-weight:bold;"><b><font color="#000000">
  99  function&nbsp;SetVertLayout($aLayout)</font>
 100  </b></div></a></span>
 101  
 102  <span style='font-family:arial;font-size:90%;'><i>Specify the vertical layout fro rows.</i></span><p>
 103  
 104  <table cellspacing=0 style='border:black solid 1pt;' width=100%>
 105  <tr><th width=25%>Argument</th><th width=15%>Default</th><th width=60%>Description</th></tr>
 106  <tr><td style='border-right:black solid 1pt;font-family:courier;font-size:90%;font-weight:bold;'><font color="#000000">
 107  $aLayout</font>
 108  
 109  </td><td style='border-right:black solid 1pt;font-family:courier;font-size:90%;font-weight:bold;'>&nbsp;</td><td>Vertical layout parameter</td></tr>
 110  </table>
 111  
 112  <div style="font-weight:bold;font-family:arial;font-size:85%;">Description</div>Should the layout be from top or even. Valid parameters are
 113  <ul>
 114  <li> GANTT_EVEN, Spread out the rows even over the whole height of the plot.
 115  <li> GANTT_FROMTOP, Use the minimum height required for the rows starting from top.
 116  </ul>
 117  
 118  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.
 119  &nbsp;<br>
 120  
 121  <div style="font-weight:bold;font-family:arial;font-size:85%;"><p>Example</div><span style="font-family:courier;font-size:85%;"><font color="#000000">
 122  $granntgraph-&gt;scale-&gt;SetVertLayout(GANTT_FROMTOP);</font>
 123  </span><br>
 124  <p>
 125  <p>&nbsp; <p> &nbsp; <span style='font-size:110%;'><a name="_GANTTSCALE_SETWEEKSTART"><div style="border-top:solid black 2pt;background-color:lightblue;font-family:courier new;font-size:90%;font-weight:bold;"><b><font color="#000000">
 126  function&nbsp;SetWeekStart($aStartDay)</font>
 127  </b></div></a></span>
 128  
 129  <span style='font-family:arial;font-size:90%;'><i>Specify which weekday should start the week</i></span><p>
 130  
 131  <table cellspacing=0 style='border:black solid 1pt;' width=100%>
 132  <tr><th width=25%>Argument</th><th width=15%>Default</th><th width=60%>Description</th></tr>
 133  <tr><td style='border-right:black solid 1pt;font-family:courier;font-size:90%;font-weight:bold;'><font color="#000000">
 134  $aStartDay</font>
 135  
 136  </td><td style='border-right:black solid 1pt;font-family:courier;font-size:90%;font-weight:bold;'>&nbsp;</td><td>Weekday, (0-6)</td></tr>
 137  </table>
 138  
 139  <div style="font-weight:bold;font-family:arial;font-size:85%;">Description</div>Which day should the week start?
 140  0==Sun, 1==Monday, 2==Tuesday etc
 141  
 142  By default weeks start on Mondays.&nbsp;<br>
 143   &nbsp; <div style="font-weight:bold;font-family:arial;font-size:85%;">See also</div><a href="GanttScale.html#_GANTTSCALE_SETRANGE">GanttScale::SetRange</a>
 144  <div style="font-weight:bold;font-family:arial;font-size:85%;"><p>Example</div><span style="font-family:courier;font-size:85%;"><font color="#000000">
 145  $granttgraph-&gt;SetWeekStart(1);</font>
 146  </span><br>
 147  <p>
 148  <p>&nbsp; <p> &nbsp; <span style='font-size:110%;'><a name="_GANTTSCALE_USEWEEKENDBACKGROUND"><div style="border-top:solid black 2pt;background-color:lightblue;font-family:courier new;font-size:90%;font-weight:bold;"><b><font color="#000000">
 149  function&nbsp;UseWeekendBackground($aShow)</font>
 150  </b></div></a></span>
 151  
 152  <span style='font-family:arial;font-size:90%;'><i>Determine if the background color for weekends in the scale should extend down in the plot area.</i></span><p>
 153  
 154  <table cellspacing=0 style='border:black solid 1pt;' width=100%>
 155  <tr><th width=25%>Argument</th><th width=15%>Default</th><th width=60%>Description</th></tr>
 156  <tr><td style='border-right:black solid 1pt;font-family:courier;font-size:90%;font-weight:bold;'><font color="#000000">
 157  $aShow</font>
 158  
 159  </td><td style='border-right:black solid 1pt;font-family:courier;font-size:90%;font-weight:bold;'>&nbsp;</td><td>True=Use the weekend background color in the ganttgraph</td></tr>
 160  </table>
 161  
 162  <div style="font-weight:bold;font-family:arial;font-size:85%;">Description</div>Determine if the background color for weekends in the scale should extend down in the plot area.&nbsp;<br>
 163  
 164  <div style="font-weight:bold;font-family:arial;font-size:85%;"><p>Example</div><span style="font-family:courier;font-size:85%;"><font color="#000000">
 165  $ganttgraph-&gt;scale-&gt;USeWeekendBackground();
<br /></font>
 166  </span><br>
 167  <p> <hr> <p>