ChartDirector Ver 3.1 (PHP Edition Edition)

BaseChart.setSearchPath


Usage

setSearchPath(path)

Description

Set the file system search path for loading image files.

Several ChartDirector operations involve loading image files. Examples are wallpapers (BaseChart.setWallpaper), background images (BaseChart.setBgImage and PlotArea.setBackground2), user-defined symbols (DataSet.setDataSymbol2) or for embedding images in text using ChartDirector Mark Up Language.

By default, if a relative path name or just a file name is used for an image file, ChartDirector will assume the path is relative to the "current directory". The setSearchPath method allows you to specify the directory ChartDirector used to search for the file. You may specify more than one directory by separating the directories with semi-colons.

If you are using ChartDirector in a web server, note that the "current directory" may not be the same as the script directory. It depends on the web server. For example, for the Microsoft IIS, the "current directory" is the directory of the web server executable, which is usually inside [system32].

To ensure you are loading images from the script directory, you may use setSearchPath to specify the script directory. For example:

$c->setSearchPath(dirname(__FILE__));

Another thing to note is that setSearchPath expects a file system path, not a URL path. For example, the root of the path is the file system root, not the web server document root. If you are using a URL path, please map it to a file system path first before calling setSearchPath.

Arguments

ArgumentDefaultDescription
path(Mandatory)A list of directories, separated with the path separator of your operating system (";" for Windows, ":" for Linux/UNIX).

Return Value

None


>

Arguments

ArgumentDefaultDescription
name(Mandatory)The name of the session variable used to store the chart image. If there are multiple chart images in the same web page, each image must use a different name.
imageFormatPNGA constant representing the format of the image. Must be one of the pre-defined constants PNG, JPG, GIF, BMP or WMP.

Return Value

A string representing the query parameters for retrieving the image using the myimage.php utility.


Chart.gradientColor.htm">gradientColor(Self)Create a two-point gradient color.gradientColor2(Self)Create a multi-point gradient color.setDefaultFonts(Self)Set the defaults for normal, bold, italic and bold-italic fonts.setFontTable(Self)Set an entry in the font table to the specified font name.setNumberFormat(Self)Set the characters used for thousand separator, decimal point, and negative sign.setMonthNames(Self)Set the names of the months for date/time formatting purposes.setWeekDayNames(Self)Set the names of the week days for date/time formatting purposes.setAMPM(Self)Set the names to be used to denote morning and afternoon.layout(Self)Perform auto-scaling of the axis and compute the positions of the various objects in the chart.makeChart(Self)Generate the chart image and save it into a file.makeChart2(Self)Generate the chart as an image in memory.makeChart3(Self)Generate the chart in internal format and return a DrawArea object to allow adding custom drawings on top of the chart.makeSession(Self)Generate the chart as an image and save it to a session variable.getHTMLImageMap(Self)Generate an HTML image map for the chart.
">© 2004 Advanced Software Engineering Limited. All rights reserved. d>lowess(Self)Fit a curve through the data points in the ArrayMath object using the LOWESS algorithm.lowess2(Self)Fit a curve through the data points in the ArrayMath object using the LOWESS algorithm, where the spacing of the data points is supplied by the given array.result(Self)Get the content of the ArrayMath object as a normal array to be used in other ChartDirector API.max(Self)Get the maximum value of the elements of the ArrayMath object.min(Self)Get the minimum value of the elements of the ArrayMath object.avg(Self)Get the average value of the elements of the ArrayMath object.sum(Self)Get the total value of the elements of the ArrayMath object.med(Self)Get the median value of the elements of the ArrayMath object.percentile(Self)Get the required percentile value of the elements of the ArrayMath object.maxIndex(Self)Get the index of the maximum value element of the ArrayMath object.minIndex(Self)Get the index of the minimum value element of the ArrayMath object.
(1059, '1999-03-01', '371', '635', '722');