| 1 |
lars |
1 |
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN" "http://www.w3.org/TR/REC-html40/loose.dtd">
|
|
|
2 |
<HTML>
|
|
|
3 |
<HEAD>
|
|
|
4 |
<META HTTP-EQUIV="Content-Type" CONTENT="text/html; CHARSET=iso-iso-8859-1">
|
|
|
5 |
<LINK REL="Start" HREF="index.html">
|
|
|
6 |
<LINK REL="Contents" HREF="toc.html">
|
|
|
7 |
<LINK REL="Prev" HREF="132ImprovingtheLEDswithsupersampling.html">
|
|
|
8 |
<STYLE TYPE="text/css"><!--
|
|
|
9 |
BODY { font-family: serif }
|
|
|
10 |
H1 { font-family: sans-serif }
|
|
|
11 |
H2 { font-family: sans-serif }
|
|
|
12 |
H3 { font-family: sans-serif }
|
|
|
13 |
H4 { font-family: sans-serif }
|
|
|
14 |
H5 { font-family: sans-serif }
|
|
|
15 |
H6 { font-family: sans-serif }
|
|
|
16 |
SUB { font-size: smaller }
|
|
|
17 |
SUP { font-size: smaller }
|
|
|
18 |
PRE { font-family: monospace }
|
|
|
19 |
A { text-decoration: none }
|
|
|
20 |
--></STYLE>
|
|
|
21 |
</HEAD>
|
|
|
22 |
<BODY>
|
|
|
23 |
<A HREF="toc.html">Contents</A>
|
|
|
24 |
<A HREF="132ImprovingtheLEDswithsupersampling.html">Previous</A>
|
|
|
25 |
<HR NOSHADE>
|
|
|
26 |
<H1><A NAME="14">14 Code defines in JpGraph</A></H1>
|
|
|
27 |
<P> Various settings in JpGraph are controlled by overall DEFINEs in the
|
|
|
28 |
configuration file "jpg-config.inc.php". Most of these defines have
|
|
|
29 |
default values that should be valid for most usage.</P>
|
|
|
30 |
<P> In the rest of this chapter all constants are described with default
|
|
|
31 |
value and usage.</P>
|
|
|
32 |
<P></P>
|
|
|
33 |
<TABLE cellpadding="3" cellspacing="0" class="codedefines">
|
|
|
34 |
<TR><TH>Define, default value</TH><TH>Comment</TH></TR>
|
|
|
35 |
<TR><TD valign="top">"CACHE_DIR", "/tmp/jpgraph_cache/"</TD><TD>The full
|
|
|
36 |
absolute name of directory to be used as a cache. This directory<STRONG>
|
|
|
37 |
must</STRONG> be readable and writable for PHP. Must end with '/'</TD></TR>
|
|
|
38 |
<TR><TD valign="top">"TTF_DIR", "/usr/local/fonts/ttf/"</TD><TD>
|
|
|
39 |
Directory for JpGraph TTF fonts. Must end with '/' The fonts must follow
|
|
|
40 |
the naming conventions as used by the supplied TTF fonts in JpGraph.</TD>
|
|
|
41 |
</TR>
|
|
|
42 |
<TR><TD valign="top">"CSIMCACHE_DIR", "csimcache/"</TD><TD>Directory for
|
|
|
43 |
cache directory for CSIM graphs. Must end with '/' Cache directory
|
|
|
44 |
specification for use with CSIM graphs that are using the cache. The
|
|
|
45 |
directory must be the filesystem name as seen by PHP and the 'http'
|
|
|
46 |
version must be the same directory but as seen by the HTTP server
|
|
|
47 |
relative to the 'htdocs' directory. If a relative path is specified it
|
|
|
48 |
is taken to be relative from where the image script is executed. Note:
|
|
|
49 |
The default setting is to create a subdirectory in the directory from
|
|
|
50 |
where the image script is executed and store all files there. As usual
|
|
|
51 |
this directory must be writable by the PHP process.</TD></TR>
|
|
|
52 |
<TR><TD valign="top">"CSIMCACHE_HTTP_DIR", "csimcache"</TD><TD>Directory
|
|
|
53 |
for JpGraph TTF fonts. Must end with '/' Cache directory specification
|
|
|
54 |
for use with CSIM graphs that are using the cache. The directory must
|
|
|
55 |
be the filesystem name as seen by PHP and the 'http' version must be
|
|
|
56 |
the same directory but as seen by the HTTP server relative to the
|
|
|
57 |
'htdocs' directory. If a relative path is specified it is taken to be
|
|
|
58 |
relative from where the image script is executed. Note: The default
|
|
|
59 |
setting is to create a subdirectory in the directory from where the
|
|
|
60 |
image script is executed and store all files there. As usual this
|
|
|
61 |
directory must be writable by the PHP process.</TD></TR>
|
|
|
62 |
<TR><TD valign="top">"CHINESE_TTF_FONT", "bkai00mp.ttf"</TD><TD> Actual
|
|
|
63 |
name of the TTF file used together with FF_CHINESE aka FF_BIG5 This is
|
|
|
64 |
the TTF file being used when the font family is specified as either
|
|
|
65 |
FF_CHINESE or FF_BIG5</TD></TR>
|
|
|
66 |
<TR><TD valign="top">"LANGUAGE_CYRILLIC", false</TD><TD> Special unicode
|
|
|
67 |
Cyrillic language support.</TD></TR>
|
|
|
68 |
<TR><TD valign="top">"CYRILLIC_FROM_WINDOWS", false</TD><TD> If you are
|
|
|
69 |
setting this config to true the conversion will assume that the input
|
|
|
70 |
text is windows 1251, if false it will assume koi8-r</TD></TR>
|
|
|
71 |
<TR><TD valign="top">'MINCHO_TTF_FONT', 'ipam.ttf'</TD><TD> Japanese
|
|
|
72 |
TrueType font used with FF_MINCHO</TD></TR>
|
|
|
73 |
<TR><TD valign="top">'PMINCHO_TTF_FONT', 'ipamp.ttf'</TD><TD> Japanese
|
|
|
74 |
TrueType font used with FF_PMINCHO</TD></TR>
|
|
|
75 |
<TR><TD valign="top">'GOTHIC_TTF_FONT', 'ipag.ttf'</TD><TD> Japanese
|
|
|
76 |
TrueType font used with FF_GOTHIC</TD></TR>
|
|
|
77 |
<TR><TD valign="top">'PGOTHIC_TTF_FONT', 'ipagp.ttf'</TD><TD> Japanese
|
|
|
78 |
TrueType font used with FF_PGOTHIC</TD></TR>
|
|
|
79 |
<TR><TD valign="top">"INSTALL_PHP_ERR_HANDLER", false</TD><TD> Determine
|
|
|
80 |
if the library should also setup the default PHP error handler to
|
|
|
81 |
generate a graphic error message. This is useful during development to
|
|
|
82 |
be able to see the error message as an image instead as a "red-cross"
|
|
|
83 |
in a page where an image is expected.</TD></TR>
|
|
|
84 |
<TR><TD valign="top">"CATCH_PHPERRMSG", true</TD><TD> Should the library
|
|
|
85 |
examine the global php_errmsg string and convert any error in it to a
|
|
|
86 |
graphical representation. This is handy for the occasions when, for
|
|
|
87 |
example, header files cannot be found and this results in the graph not
|
|
|
88 |
being created and just a "red-cross" image would be seen. This should
|
|
|
89 |
be turned off for a production site.</TD></TR>
|
|
|
90 |
<TR><TD valign="top">"USE_LIBRARY_GD2",false</TD><TD>Specify if we
|
|
|
91 |
should use GD 2.x or GD 1.x If you have GD 2.x installed it is
|
|
|
92 |
recommended that you use it since it will give a slightly, slightly
|
|
|
93 |
better visual appearance for arcs. If you don't have GD2 installed this
|
|
|
94 |
must be set to false!</TD></TR>
|
|
|
95 |
<TR><TD valign="top">'USE_TRUECOLOR',true</TD><TD>Should the image be a
|
|
|
96 |
truecolor image? Note 1: Can only be used with GD 2.0.2 and above. Note
|
|
|
97 |
2: GD 2.0.1 + PHP 4.0.6 on Win32 crashes when trying to use truecolor.
|
|
|
98 |
Truecolor support is to be considered alpha since GD 2.x is still not
|
|
|
99 |
considered stable (especially on Win32). Note 3: MUST be enabled to get
|
|
|
100 |
background images working with GD2 Note 4: If enabled then truetype
|
|
|
101 |
fonts will look very ugly => You can't have both background images and
|
|
|
102 |
truetype fonts in the same image until these bugs has been fixed in GD
|
|
|
103 |
2.01</TD></TR>
|
|
|
104 |
<TR><TD valign="top">"USE_CACHE",false</TD><TD>Should the cache be used
|
|
|
105 |
at all? By setting this to false no files will be generated in the
|
|
|
106 |
cache directory. The difference from READ_CACHE being that setting
|
|
|
107 |
READ_CACHE to false will still create the image in the cache directory
|
|
|
108 |
just not use it. By setting USE_CACHE=false no files will even be
|
|
|
109 |
generated in the cache directory.</TD></TR>
|
|
|
110 |
<TR><TD valign="top">"READ_CACHE",true</TD><TD>Should we try to find an
|
|
|
111 |
image in the cache before generating it? Set this define to false to
|
|
|
112 |
bypass the reading of the cache and always regenerate the image. Note
|
|
|
113 |
that even if reading the cache is disabled the cached will still be
|
|
|
114 |
updated with the newly generated image. Set also "USE_CACHE" below.</TD>
|
|
|
115 |
</TR>
|
|
|
116 |
<TR><TD valign="top">"DEFAULT_GFORMAT","auto"</TD><TD>Default graphic
|
|
|
117 |
format set to "auto" which will automatically choose the best available
|
|
|
118 |
format in the order png,gif,jpg (The supported format depends on what
|
|
|
119 |
your PHP installation supports)</TD></TR>
|
|
|
120 |
<TR><TD valign="top">"USE_IMAGE_ERROR_HANDLER",true</TD><TD> Determine
|
|
|
121 |
if the error handler should be image based or purely text based. Image
|
|
|
122 |
based makes it easier since the script will always return an image even
|
|
|
123 |
in case of errors.</TD></TR>
|
|
|
124 |
<TR><TD valign="top">"USE_APPROX_COLORS",true</TD><TD>If the color
|
|
|
125 |
palette is full should JpGraph try to allocate the closest match? If
|
|
|
126 |
you plan on using background image or gradient fills it might be a good
|
|
|
127 |
idea to enable this. If not you will otherwise get an error saying that
|
|
|
128 |
the color palette is exhausted. The drawback of using approximations is
|
|
|
129 |
that the colors might not be exactly what you specified. Note1: This
|
|
|
130 |
does only apply to a palette image, not true color images since they
|
|
|
131 |
don't have the limitations of maximum number of colors.</TD></TR>
|
|
|
132 |
<TR><TD valign="top">"ERR_DEPRECATED",false</TD><TD>Should usage of
|
|
|
133 |
deprecated functions and parameters give a fatal error? (Useful to
|
|
|
134 |
check if code is future proof.)</TD></TR>
|
|
|
135 |
<TR><TD valign="top">"BRAND_TIMING",false</TD><TD>Should the time taken
|
|
|
136 |
to generate each picture be branded to the lower left in corner in each
|
|
|
137 |
generated image? Useful for performance measurements generating graphs</TD>
|
|
|
138 |
</TR>
|
|
|
139 |
<TR><TD valign="top">"BRAND_TIME_FORMAT","Generated in: %01.3fs"</TD><TD>
|
|
|
140 |
What format should be used for the timing string?</TD></TR>
|
|
|
141 |
</TABLE>
|
|
|
142 |
<P> The following defines should very rarely need to be changed</P>
|
|
|
143 |
<P></P>
|
|
|
144 |
<TABLE cellpadding="3" cellspacing="0" class="codedefines">
|
|
|
145 |
<TR><TH>Define, default value</TH><TH>Comment</TH></TR>
|
|
|
146 |
<TR><TD valign="top">"CACHE_FILE_GROUP","wwwadmin"</TD><TD>What group
|
|
|
147 |
should the cached file belong to (Set to "" will give the default group
|
|
|
148 |
for the "PHP-user") Please note that the Apache user must be a member
|
|
|
149 |
of the specified group since otherwise it is impossible for Apache to
|
|
|
150 |
set the specified group.</TD></TR>
|
|
|
151 |
<TR><TD valign="top">"CACHE_FILE_MOD",0664</TD><TD>What permissions
|
|
|
152 |
should the cached file have (Set to "" will give the default
|
|
|
153 |
permissions for the "PHP-user")</TD></TR>
|
|
|
154 |
<TR><TD valign="top">"USE_BRESENHAM",false</TD><TD>Decide if we should
|
|
|
155 |
use the Bresenham circle algorithm or the built in Arc(). Bresenham
|
|
|
156 |
gives better visual appearance of circles but is more CPU intensive and
|
|
|
157 |
slower then the built in Arc() function in GD. Turned off by default
|
|
|
158 |
for speed</TD></TR>
|
|
|
159 |
<TR><TD valign="top">"_CSIM_SPECIALFILE","_csim_special_"</TD><TD>
|
|
|
160 |
Special file name to indicate that we only want to calc the image map in
|
|
|
161 |
the call to Graph::Stroke() used internally from the GetHTMLCSIM()
|
|
|
162 |
method.</TD></TR>
|
|
|
163 |
<TR><TD valign="top">"_CSIM_DISPLAY","_jpg_csimd"</TD><TD>HTTP GET
|
|
|
164 |
argument that is used with image map to indicate to the script to just
|
|
|
165 |
generate the image and not the full CSIM HTML page.</TD></TR>
|
|
|
166 |
</TABLE>
|
|
|
167 |
|
|
|
168 |
<P> </P>
|
|
|
169 |
<P>&nbsp</P>
|
|
|
170 |
</DIV><HR NOSHADE>
|
|
|
171 |
<A HREF="toc.html">Contents</A>
|
|
|
172 |
<A HREF="132ImprovingtheLEDswithsupersampling.html">Previous</A>
|
|
|
173 |
</BODY>
|
|
|
174 |
</HTML>
|