PageRenderTime 51ms CodeModel.GetById 25ms RepoModel.GetById 0ms app.codeStats 0ms

/external/jpgraph/docs/html/14CodedefinesinJpGraph.html

https://github.com/wally/hamsterpaj4
HTML | 174 lines | 163 code | 0 blank | 11 comment | 0 complexity | 2147998d3e5a5538595d627096106a36 MD5 | raw file
    

  1. <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN" "http://www.w3.org/TR/REC-html40/loose.dtd">
    2. 

  2. <HTML>
    3. 

  3. <HEAD>
    4. 

  4. <META HTTP-EQUIV="Content-Type" CONTENT="text/html; CHARSET=iso-iso-8859-1">
    5. 

  5. <LINK REL="Start" HREF="index.html">
    6. 

  6. <LINK REL="Contents" HREF="toc.html">
    7. 

  7. <LINK REL="Prev" HREF="132ImprovingtheLEDswithsupersampling.html">
    8. 

  8. <STYLE TYPE="text/css"><!--
    9. 

  9. BODY { font-family: serif }
    10. 

  10. H1 { font-family: sans-serif }
    11. 

  11. H2 { font-family: sans-serif }
    12. 

  12. H3 { font-family: sans-serif }
    13. 

  13. H4 { font-family: sans-serif }
    14. 

  14. H5 { font-family: sans-serif }
    15. 

  15. H6 { font-family: sans-serif }
    16. 

  16. SUB { font-size: smaller }
    17. 

  17. SUP { font-size: smaller }
    18. 

  18. PRE { font-family: monospace }
    19. 

  19. A { text-decoration: none }
    20. 

  20. --></STYLE>
    21. 

  21. </HEAD>
    22. 

  22. <BODY>
    23. 

  23. <A HREF="toc.html">Contents</A>
    24. 

  24. <A HREF="132ImprovingtheLEDswithsupersampling.html">Previous</A>
    25. 

  25. <HR NOSHADE>
    26. 

  26. <H1><A NAME="14">14 Code defines in JpGraph</A></H1>
    27. 

  27. <P> Various settings in JpGraph are controlled by overall DEFINEs in the
    28. 

  28.  configuration file &quot;jpg-config.inc.php&quot;. Most of these defines have
    29. 

  29.  default values that should be valid for most usage.</P>
    30. 

  30. <P> In the rest of this chapter all constants are described with default
    31. 

  31.  value and usage.</P>
    32. 

  32. <P></P>
    33. 

  33. <TABLE cellpadding="3" cellspacing="0" class="codedefines">
    34. 

  34. <TR><TH>Define, default value</TH><TH>Comment</TH></TR>
    35. 

  35. <TR><TD valign="top">&quot;CACHE_DIR&quot;, &quot;/tmp/jpgraph_cache/&quot;</TD><TD>The full
    36. 

  36.  absolute name of directory to be used as a cache. This directory<STRONG>
    37. 

  37.  must</STRONG> be readable and writable for PHP. Must end with '/'</TD></TR>
    38. 

  38. <TR><TD valign="top">&quot;TTF_DIR&quot;, &quot;/usr/local/fonts/ttf/&quot;</TD><TD>
    39. 

  39. Directory for JpGraph TTF fonts. Must end with '/' The fonts must follow
    40. 

  40.  the naming conventions as used by the supplied TTF fonts in JpGraph.</TD>
    41. 

  41. </TR>
    42. 

  42. <TR><TD valign="top">&quot;CSIMCACHE_DIR&quot;, &quot;csimcache/&quot;</TD><TD>Directory for
    43. 

  43.  cache directory for CSIM graphs. Must end with '/' Cache directory
    44. 

  44.  specification for use with CSIM graphs that are using the cache. The
    45. 

  45.  directory must be the filesystem name as seen by PHP and the 'http'
    46. 

  46.  version must be the same directory but as seen by the HTTP server
    47. 

  47.  relative to the 'htdocs' directory. If a relative path is specified it
    48. 

  48.  is taken to be relative from where the image script is executed. Note:
    49. 

  49.  The default setting is to create a subdirectory in the directory from
    50. 

  50.  where the image script is executed and store all files there. As usual
    51. 

  51.  this directory must be writable by the PHP process.</TD></TR>
    52. 

  52. <TR><TD valign="top">&quot;CSIMCACHE_HTTP_DIR&quot;, &quot;csimcache&quot;</TD><TD>Directory
    53. 

  53.  for JpGraph TTF fonts. Must end with '/' Cache directory specification
    54. 

  54.  for use with CSIM graphs that are using the cache. The directory must
    55. 

  55.  be the filesystem name as seen by PHP and the 'http' version must be
    56. 

  56.  the same directory but as seen by the HTTP server relative to the
    57. 

  57.  'htdocs' directory. If a relative path is specified it is taken to be
    58. 

  58.  relative from where the image script is executed. Note: The default
    59. 

  59.  setting is to create a subdirectory in the directory from where the
    60. 

  60.  image script is executed and store all files there. As usual this
    61. 

  61.  directory must be writable by the PHP process.</TD></TR>
    62. 

  62. <TR><TD valign="top">&quot;CHINESE_TTF_FONT&quot;, &quot;bkai00mp.ttf&quot;</TD><TD> Actual
    63. 

  63.  name of the TTF file used together with FF_CHINESE aka FF_BIG5 This is
    64. 

  64.  the TTF file being used when the font family is specified as either
    65. 

  65.  FF_CHINESE or FF_BIG5</TD></TR>
    66. 

  66. <TR><TD valign="top">&quot;LANGUAGE_CYRILLIC&quot;, false</TD><TD> Special unicode
    67. 

  67.  Cyrillic language support.</TD></TR>
    68. 

  68. <TR><TD valign="top">&quot;CYRILLIC_FROM_WINDOWS&quot;, false</TD><TD> If you are
    69. 

  69.  setting this config to true the conversion will assume that the input
    70. 

  70.  text is windows 1251, if false it will assume koi8-r</TD></TR>
    71. 

  71. <TR><TD valign="top">'MINCHO_TTF_FONT', 'ipam.ttf'</TD><TD> Japanese
    72. 

  72.  TrueType font used with FF_MINCHO</TD></TR>
    73. 

  73. <TR><TD valign="top">'PMINCHO_TTF_FONT', 'ipamp.ttf'</TD><TD> Japanese
    74. 

  74.  TrueType font used with FF_PMINCHO</TD></TR>
    75. 

  75. <TR><TD valign="top">'GOTHIC_TTF_FONT', 'ipag.ttf'</TD><TD> Japanese
    76. 

  76.  TrueType font used with FF_GOTHIC</TD></TR>
    77. 

  77. <TR><TD valign="top">'PGOTHIC_TTF_FONT', 'ipagp.ttf'</TD><TD> Japanese
    78. 

  78.  TrueType font used with FF_PGOTHIC</TD></TR>
    79. 

  79. <TR><TD valign="top">&quot;INSTALL_PHP_ERR_HANDLER&quot;, false</TD><TD> Determine
    80. 

  80.  if the library should also setup the default PHP error handler to
    81. 

  81.  generate a graphic error message. This is useful during development to
    82. 

  82.  be able to see the error message as an image instead as a &quot;red-cross&quot;
    83. 

  83.  in a page where an image is expected.</TD></TR>
    84. 

  84. <TR><TD valign="top">&quot;CATCH_PHPERRMSG&quot;, true</TD><TD> Should the library
    85. 

  85.  examine the global php_errmsg string and convert any error in it to a
    86. 

  86.  graphical representation. This is handy for the occasions when, for
    87. 

  87.  example, header files cannot be found and this results in the graph not
    88. 

  88.  being created and just a &quot;red-cross&quot; image would be seen. This should
    89. 

  89.  be turned off for a production site.</TD></TR>
    90. 

  90. <TR><TD valign="top">&quot;USE_LIBRARY_GD2&quot;,false</TD><TD>Specify if we
    91. 

  91.  should use GD 2.x or GD 1.x If you have GD 2.x installed it is
    92. 

  92.  recommended that you use it since it will give a slightly, slightly
    93. 

  93.  better visual appearance for arcs. If you don't have GD2 installed this
    94. 

  94.  must be set to false!</TD></TR>
    95. 

  95. <TR><TD valign="top">'USE_TRUECOLOR',true</TD><TD>Should the image be a
    96. 

  96.  truecolor image? Note 1: Can only be used with GD 2.0.2 and above. Note
    97. 

  97.  2: GD 2.0.1 + PHP 4.0.6 on Win32 crashes when trying to use truecolor.
    98. 

  98.  Truecolor support is to be considered alpha since GD 2.x is still not
    99. 

  99.  considered stable (especially on Win32). Note 3: MUST be enabled to get
    100. 

  100.  background images working with GD2 Note 4: If enabled then truetype
    101. 

  101.  fonts will look very ugly =&gt; You can't have both background images and
    102. 

  102.  truetype fonts in the same image until these bugs has been fixed in GD
    103. 

  103.  2.01</TD></TR>
    104. 

  104. <TR><TD valign="top">&quot;USE_CACHE&quot;,false</TD><TD>Should the cache be used
    105. 

  105.  at all? By setting this to false no files will be generated in the
    106. 

  106.  cache directory. The difference from READ_CACHE being that setting
    107. 

  107.  READ_CACHE to false will still create the image in the cache directory
    108. 

  108.  just not use it. By setting USE_CACHE=false no files will even be
    109. 

  109.  generated in the cache directory.</TD></TR>
    110. 

  110. <TR><TD valign="top">&quot;READ_CACHE&quot;,true</TD><TD>Should we try to find an
    111. 

  111.  image in the cache before generating it? Set this define to false to
    112. 

  112.  bypass the reading of the cache and always regenerate the image. Note
    113. 

  113.  that even if reading the cache is disabled the cached will still be
    114. 

  114.  updated with the newly generated image. Set also &quot;USE_CACHE&quot; below.</TD>
    115. 

  115. </TR>
    116. 

  116. <TR><TD valign="top">&quot;DEFAULT_GFORMAT&quot;,&quot;auto&quot;</TD><TD>Default graphic
    117. 

  117.  format set to &quot;auto&quot; which will automatically choose the best available
    118. 

  118.  format in the order png,gif,jpg (The supported format depends on what
    119. 

  119.  your PHP installation supports)</TD></TR>
    120. 

  120. <TR><TD valign="top">&quot;USE_IMAGE_ERROR_HANDLER&quot;,true</TD><TD> Determine
    121. 

  121.  if the error handler should be image based or purely text based. Image
    122. 

  122.  based makes it easier since the script will always return an image even
    123. 

  123.  in case of errors.</TD></TR>
    124. 

  124. <TR><TD valign="top">&quot;USE_APPROX_COLORS&quot;,true</TD><TD>If the color
    125. 

  125.  palette is full should JpGraph try to allocate the closest match? If
    126. 

  126.  you plan on using background image or gradient fills it might be a good
    127. 

  127.  idea to enable this. If not you will otherwise get an error saying that
    128. 

  128.  the color palette is exhausted. The drawback of using approximations is
    129. 

  129.  that the colors might not be exactly what you specified. Note1: This
    130. 

  130.  does only apply to a palette image, not true color images since they
    131. 

  131.  don't have the limitations of maximum number of colors.</TD></TR>
    132. 

  132. <TR><TD valign="top">&quot;ERR_DEPRECATED&quot;,false</TD><TD>Should usage of
    133. 

  133.  deprecated functions and parameters give a fatal error? (Useful to
    134. 

  134.  check if code is future proof.)</TD></TR>
    135. 

  135. <TR><TD valign="top">&quot;BRAND_TIMING&quot;,false</TD><TD>Should the time taken
    136. 

  136.  to generate each picture be branded to the lower left in corner in each
    137. 

  137.  generated image? Useful for performance measurements generating graphs</TD>
    138. 

  138. </TR>
    139. 

  139. <TR><TD valign="top">&quot;BRAND_TIME_FORMAT&quot;,&quot;Generated in: %01.3fs&quot;</TD><TD>
    140. 

  140. What format should be used for the timing string?</TD></TR>
    141. 

  141. </TABLE>
    142. 

  142. <P> The following defines should very rarely need to be changed</P>
    143. 

  143. <P></P>
    144. 

  144. <TABLE cellpadding="3" cellspacing="0" class="codedefines">
    145. 

  145. <TR><TH>Define, default value</TH><TH>Comment</TH></TR>
    146. 

  146. <TR><TD valign="top">&quot;CACHE_FILE_GROUP&quot;,&quot;wwwadmin&quot;</TD><TD>What group
    147. 

  147.  should the cached file belong to (Set to &quot;&quot; will give the default group
    148. 

  148.  for the &quot;PHP-user&quot;) Please note that the Apache user must be a member
    149. 

  149.  of the specified group since otherwise it is impossible for Apache to
    150. 

  150.  set the specified group.</TD></TR>
    151. 

  151. <TR><TD valign="top">&quot;CACHE_FILE_MOD&quot;,0664</TD><TD>What permissions
    152. 

  152.  should the cached file have (Set to &quot;&quot; will give the default
    153. 

  153.  permissions for the &quot;PHP-user&quot;)</TD></TR>
    154. 

  154. <TR><TD valign="top">&quot;USE_BRESENHAM&quot;,false</TD><TD>Decide if we should
    155. 

  155.  use the Bresenham circle algorithm or the built in Arc(). Bresenham
    156. 

  156.  gives better visual appearance of circles but is more CPU intensive and
    157. 

  157.  slower then the built in Arc() function in GD. Turned off by default
    158. 

  158.  for speed</TD></TR>
    159. 

  159. <TR><TD valign="top">&quot;_CSIM_SPECIALFILE&quot;,&quot;_csim_special_&quot;</TD><TD>
    160. 

  160. Special file name to indicate that we only want to calc the image map in
    161. 

  161.  the call to Graph::Stroke() used internally from the GetHTMLCSIM()
    162. 

  162.  method.</TD></TR>
    163. 

  163. <TR><TD valign="top">&quot;_CSIM_DISPLAY&quot;,&quot;_jpg_csimd&quot;</TD><TD>HTTP GET
    164. 

  164.  argument that is used with image map to indicate to the script to just
    165. 

  165.  generate the image and not the full CSIM HTML page.</TD></TR>
    166. 

  166. </TABLE>
    167. 

  167.  &nbsp;
    168. 

  168. <P>&nbsp;</P>
    169. 

  169. <P>&amp;nbsp</P>
    170. 

  170. </DIV><HR NOSHADE>
    171. 

  171. <A HREF="toc.html">Contents</A>
    172. 

  172. <A HREF="132ImprovingtheLEDswithsupersampling.html">Previous</A>
    173. 

  173. </BODY>
    174. 

  174. </HTML>
    175. 

  175.