ChartDirector Ver 5.0 (PHP Edition)

phpchartdir

phpchartdir is the PHP module for interface with ChartDirector. It includes all ChartDirector classes, general informational functions and predefined constants.
ChartDirector constants are implemented as true PHP constants. For example, the NoValue constant is just `NoValue`, not `$NoValue`. The `'$'` character is not needed.
The exceptions are constants that represent arrays, like whiteOnBlackPalette. PHP does not support true constants for arrays. As a result, they can only be implemented as variables, and so require leading `'$'` characters (eg. `$whiteOnBlackPalette`).
True PHP constants have global scope by default, which means they are automatically visible inside function definitions. On the other hand, PHP variables has local scope by default. If used inside function definitions, an explicit PHP "global" statement is needed.
Constants

Name | Description
--- | ---
NoValue | A constant equals to 1.7E+308 to represent missing values in ChartDirector.
BottomLeft | A constant equals to 1 to represent the bottom left position.
BottomLeft2 | A constant equals to 12 to represent the alternative exterior bottom left position.
BottomCenter | A constant equals to 2 to represent the bottom center position.
BottomRight | A constant equals to 3 to represent the bottom right position.
BottomRight2 | A constant equals to 13 to represent the alternative exterior bottom right position.
Left | A constant equals to 4 to represent the left position.
Center | A constant equals to 5 to represent the center position.
Right | A constant equals to 6 to represent the right position.
TopLeft | A constant equals to 7 to represent the top left position.
TopLeft2 | A constant equals to 10 to represent the alternative exterior top left position.
TopCenter | A constant equals to 8 to represent the top center position.
TopRight | A constant equals to 9 to represent the top right position.
TopRight2 | A constant equals to 11 to represent the alternative exterior top right position.
Bottom | A constant equals to 2 to represent the bottom position.
Top | A constant equals to 8 to represent the top position.
Transparent | A constant equals to FF000000 (in hex) to represent the transparent color.
BackgroundColor | A constant equals to FFFF0000 (in hex) to represent the background color.
LineColor | A constant equals to FFFF0001 (in hex) to represent the default line color.
TextColor | A constant equals to FFFF0002 (in hex) to represent the default text color.
SameAsMainColor | A constant equals to FFFF0007 (in hex) to represent the current main color.
Palette | A constant equals to FFFF0000 (in hex) to represent the starting index of the color palette.
DataColor | A constant equals to FFFF0008 (in hex) to represent the starting index of automatic data color.
defaultPalette | A constant array of integers to represent the default palette.
whiteOnBlackPalette | A constant array of integers to represent the white on black palette.
transparentPalette | A constant array of integers to represent the semi-transparent palette.
NormalGlare | A constant equals to 3 to represent using normal glare strength in glassEffect shading style.
ReducedGlare | A constant equals to 2 to represent using reduced glare strength in glassEffect shading style.
NoGlare | A constant equals to 1 to represent disabling the glare in glassEffect shading style.
DashLine | A constant equals to 0505 (in hex) to represent a dash line pattern for use in dash colors.
DotLine | A constant equals to 0202 (in hex) to represent a dotted line pattern for use in dash colors.
DotDashLine | A constant equals to 05050205 (in hex) to represent a dot-dash line pattern for use in dash colors.
AltDashLine | A constant equals to 0A050505 (in hex) to represent a alternating long/short dash line pattern for use in dash colors.
goldGradient | A constant array of integers to represent a gradient that looks like a golden color.
silverGradient | A constant array of integers to represent a gradient that looks like a silver color.
redMetalGradient | A constant array of integers to represent a gradient that looks like a red metallic color.
blueMetalGradient | A constant array of integers to represent a gradient that looks like a blue metallic color.
greenMetalGradient | A constant array of integers to represent a gradient that looks like a green metallic color.
SquareShape | A constant equals to 1 to represent a square.
DiamondShape | A constant equals to 2 to represent a diamond shape.
TriangleShape | A constant equals to 3 to represent a triangle pointing upwards.
RightTriangleShape | A constant equals to 4 to represent a triangle pointing rightwards.
LeftTriangleShape | A constant equals to 5 to represent a triangle pointing leftwards.
InvertedTriangleShape | A constant equals to 6 to represent a triangle pointing downwards.
CircleShape | A constant equals to 7 to represent a circle.
GlassSphereShape | A constant equals to 15 to represent a glass sphere.
GlassSphere2Shape | A constant equals to 16 to represent a bright glass sphere.
SolidSphereShape | A constant equals to 17 to represent a solid sphere.
DefaultShading | A constant equals to 0 to represent default sector shading style.
FlatShading | A constant equals to 1 to represent flat sector shading style.
LocalGradientShading | A constant equals to 2 to represent local gradient sector shading style.
GlobalGradientShading | A constant equals to 3 to represent global gradient sector shading style.
ConcaveShading | A constant equals to 4 to represent concave sector shading style.
RoundedEdgeShading | A constant equals to 6 to represent rounded edge sector shading style.
RadialShading | A constant equals to 7 to represent radial sector shading style.
RingShading | A constant equals to 8 to represent ring sector shading style.
SmoothShading | A constant equals to 0 to represent smooth surface shading style.
TriangularShading | A constant equals to 1 to represent triangular surface shading style.
RectangularShading | A constant equals to 2 to represent rectangular surface shading style.
TriangularFrame | A constant equals to 3 to represent triangular frame only surface shading style.
RectangularFrame | A constant equals to 4 to represent rectangular frame only surface shading style.
DiamondPointer | A constant equals to 0 to represent the diamond style meter pointer.
TriangularPointer | A constant equals to 1 to represent the triangular style meter pointer.
ArrowPointer | A constant equals to 2 to represent the arrow style meter pointer.
ArrowPointer2 | A constant equals to 3 to represent the alternative arrow style meter pointer.
LinePointer | A constant equals to 4 to represent the line style meter pointer.
PencilPointer | A constant equals to 5 to represent the pencil style meter pointer.
PNG | A constant equals to 0 to represent the PNG image format.
GIF | A constant equals to 1 to represent the GIF image format.
JPG | A constant equals to 2 to represent the JPG image format.
BMP | A constant equals to 4 to represent the BMP image format.
WMP | A constant equals to 3 to represent the WAP bitmap image format.
SVG | A constant equals to 5 to represent the SVG image format.
SVGZ | A constant equals to 5 to represent the compressed SVG image format.
NoAntiAlias | A constant equals to 0 to represent that text should be drawn without using anti-alias.
AntiAlias | A constant equals to 1 to represent that text should be drawn with anti-alias.
AutoAntiAlias | A constant equals to 2 to represent that text should be drawn with anti-alias if necessary based on font attributes.
TryPalette | A constant equals to 0 to represent that palette based image format should be used if the image contains 256 colors or less.
ForcePalette | A constant equals to 1 to represent that palette based image format should always be used (dither the image if necessary).
NoPalette | A constant equals to 2 to represent that true color image format should always be used.
Quantize | A constant equals to 0 to represent that the quantize dithering method should be used if dithering is required.
OrderedDither | A constant equals to 1 to represent that the ordered dithering method should be used if dithering is required.
ErrorDiffusion | A constant equals to 2 to represent that the error diffusion dithering method should be used if dithering is required.
SideLayout | A constant equals to 0 to represent the side label layout method for pie/donut charts.
CircleLayout | A constant equals to 1 to represent the circular label layout method for pie/donut charts.
Side | A constant equals to 3 to represent the "Side" data representation method for multiple data sets.
Stack | A constant equals to 1 to represent the "Stack" data representation method for multiple data sets.
Overlay | A constant equals to 0 to represent the "Overlay" data representation method for multiple data sets.
Percentage | A constant equals to 4 to represent the "Percentage" data representation method for multiple data sets.
MonotonicNone | A constant equals to 0 to represent that a spline curve is not constraint to flow in any direction.
MonotonicX | A constant equals to 1 to represent that a spline curve is constrained to not overshooting or undershooting in the x-axis direction.
MonotonicY | A constant equals to 2 to represent that a spline curve is constrained to not overshooting or undershooting in the y-axis direction.
MonotonicXY | A constant equals to 3 to represent that a spline curve is constrained to not overshooting or undershooting in both the x-axis direction and the y-axis direction.
MonotonicAuto | A constant equals to 3 to represent that the system will automatically determine whether to constrained a spline curve to not overshooting or undershooting in the x-axis direction and/or the y-axis direction.
LinearRegression | A constant equals to 1 to represent that linear regression be used to draw a trend line.
ConstrainedLinearRegression | A constant equals to 0 to represent that constrained linear regression be used to draw a trend line.
ExponentialRegression | A constant equals to -1 to represent that exponential regression be used to draw a trend line.
LogarithmicRegression | A constant equals to -2 to represent that logarithmic regression be used to draw a trend line.
LogTick | A constant equals to +1.6e308 to represent that the ticks in a log scale axis should be 1 - 2 - 5 - 10 style increments.
LinearTick | A constant equals to +1.5E+308 to represent that the ticks in a log scale axis should be 1 - 2 - 3 - 4 - 5 - 6 - 7 - 8 - 9 - 10 style increments.
TickInc | A constant equals to +1E+200 to represent the distance between major ticks.
MinorTickOnly | A constant equals to -1.7e308 to represent that the label position should contain a minor tick only.
MicroTickOnly | A constant equals to -1.6e308 to represent that the label position should contain a micro tick only.
PixelScale | A constant equals to 0 to represent that the size is measured in pixels.
XAxisScale | A constant equals to 1 to represent that the size is measured using the x-axis scale.
YAxisScale | A constant equals to 2 to represent that the size is measured using y-axis scale.
AngularAxisScale | A constant equals to 1 to represent that the size is measured using the angular-axis scale.
RadialAxisScale | A constant equals to 2 to represent that the size is measured using the radial-axis scale.
EndPoints | A constant equals to 3 to represent that the vector lengths and directions are measured by specifying the end points.
XAxisAtOrigin | A constant equals to 1 to represent that the x-axis should intersect with the zero point of the y-axis if it exists on the chart.
YAxisAtOrigin | A constant equals to 2 to represent that the y-axis should intersect with the zero point of the x-axis if it exists on the chart.
XYAxisAtOrigin | A constant equals to 3 to represent that the x-axis and y-axis should intersect at the origin if it exists on the chart.
XAxisSymmetric | A constant equals to 1 to represent that the x-axis should be symmetrical about the origin.
XAxisSymmetricIfNeeded | A constant equals to 2 to represent that the x-axis should be symmetrical about the origin if the data contain both positive and negative values.
YAxisSymmetric | A constant equals to 4 to represent that the y-axis should be symmetrical about the origin.
YAxisSymmetricIfNeeded | A constant equals to 8 to represent that the y-axis should be symmetrical about the origin if the data contain both positive and negative values.
XYAxisSymmetric | A constant equals to 16 to represent that the the x-axis and y-axis should be symmetrical about the origin.
XYAxisSymmetricIfNeeded | A constant equals to 32 to represent that the x-axis and y-axis should be symmetrical about the origin if the data contain both positive and negative values.
NormalLegend | A constant equals to 0 to represent that the legend keys order should follow the creation order of the data sets.
ReverseLegend | A constant equals to 1 to represent that the legend keys order is the reverse of the creation order of the data sets.
NoLegend | A constant equals to 2 to represent that no legend keys should be added to the legend box.
AutoGrid | A constant equals to -2 to represent that the number of columns in the legend box with grid layout is automatically determine.
ChartBackZ | A constant equals to 100 (in hex) to represent the z-order of the back surface of the chart.
ChartFrontZ | A constant equals to ffff (in hex) to represent the z-order of the front surface of the chart.
PlotAreaZ | A constant equals to 1000 (in hex) to represent the z-order of the plot area back surface of the chart.
GridLinesZ | A constant equals to 2000 (in hex) to represent the z-order of the grid lines of the chart.
TouchBar | A constant equals to -1.7e-100 to represent that the bars in a bar layer should touch each others with no gap in between.
HLOCDefault | A constant equals to 0 to represent that the HLOC symbols should be drawn using the same color.
HLOCOpenClose | A constant equals to 1 to represent that the HLOC symbols should be drawn using two alternative colors based on whether the closing price is higher than the opening price.
HLOCUpDown | A constant equals to 2 to represent that the HLOC symbols should be drawn using two alternative colors based on whether the closing price is higher than the previous closing price.
AggregateSum | A constant equals to 0 to represent using the sum as the aggregated value in ArrayMath.aggregate.
AggregateAvg | A constant equals to 1 to represent using the average as the aggregated value in ArrayMath.aggregate.
AggregateStdDev | A constant equals to 2 to represent using the standard deviation as the aggregated value in ArrayMath.aggregate.
AggregateMin | A constant equals to 3 to represent using the minimum value as the aggregated value in ArrayMath.aggregate.
AggregateMed | A constant equals to 4 to represent using the median value as the aggregated value in ArrayMath.aggregate.
AggregateMax | A constant equals to 5 to represent using the maximum value as the aggregated value in ArrayMath.aggregate.
AggregatePercentile | A constant equals to 6 to represent using the percentile value as the aggregated value in ArrayMath.aggregate.
AggregateFirst | A constant equals to 7 to represent using the first value as the aggregated value in ArrayMath.aggregate.
AggregateLast | A constant equals to 8 to represent using the last value as the aggregated value in ArrayMath.aggregate.
AggregateCount | A constant equals to 9 to represent using the item count as the aggregated value in ArrayMath.aggregate.
BoxFilter | A constant equals to 0 to represent a Box graphical re-sampling filter.
LinearFilter | A constant equals to 1 to represent a Linear graphical re-sampling filter.
QuadraticFilter | A constant equals to 2 to represent a Quadratic graphical re-sampling filter.
BSplineFilter | A constant equals to 3 to represent a B-spline graphical re-sampling filter.
HermiteFilter | A constant equals to 4 to represent a Hermite graphical re-sampling filter.
CatromFilter | A constant equals to 5 to represent a Catrom graphical re-sampling filter.
MitchellFilter | A constant equals to 6 to represent a Mitchell graphical re-sampling filter.
SincFilter | A constant equals to 7 to represent a Sinc graphical re-sampling filter.
LanczosFilter | A constant equals to 8 to represent a Lanczos graphical re-sampling filter.
GaussianFilter | A constant equals to 9 to represent a Gaussian graphical re-sampling filter.
HanningFilter | A constant equals to 10 to represent a Hanning graphical re-sampling filter.
HammingFilter | A constant equals to 11 to represent a Hamming graphical re-sampling filter.
BlackmanFilter | A constant equals to 12 to represent a Blackman graphical re-sampling filter.
BesselFilter | A constant equals to 13 to represent a Bessel graphical re-sampling filter.
MouseUsageDefault | A constant equals to 0 to represent using the default mouse behaviour.
MouseUsageScroll | A constant equals to 2 to represent using the mouse for drag scrolling.
MouseUsageZoomIn | A constant equals to 3 to represent using the mouse for zoom in actions.
MouseUsageZoomOut | A constant equals to 4 to represent using the mouse for zoom out actions.
DirectionHorizontal | A constant equals to 0 to represent that the zoom and/or scroll orientation is horizontal.
DirectionVertical | A constant equals to 1 to represent that the zoom and/or scroll orientation is vertical.
DirectionHorizontalVertical | A constant equals to 2 to represent that the zoom and/or scroll orientation can be both horizontal and vertical.

Methods

Name | Description
--- | ---
setLicenseCode | Sets the license code into ChartDirector.
getVersion | Gets ChartDirector version information.
getBootLog | A diagnostic function to obtain the ChartDirector boot log.
testFont | A diagnostic function to perform a font loading test.
chartTime | Obtain the second elapsed since 01-01-0001 00:00:00 to the given time, which is the date/time format used by ChartDirector.
chartTime2 | Converts a UNIX time (seconds elapsed since 01-01-1970 00:00:00 GMT) to the date/time format used by ChartDirector.
getChartYMD | Gets the year, month and day represented by a ChartDirector date/time.
getChartWeekDay | Gets the weekday represented by a ChartDirector date/time.
goldColor | Creates a golden color, most commonly used as a background color.
silverColor | Creates a silver color, most commonly used as a background color.
metalColor | Creates a color by modulates the brightness of another color to create metallic shiny effects.
brushedGoldColor | Creates a brushed golden color, most commonly used as a background color.
brushedSilverColor | Creates a brushed silver color, most commonly used as a background color.
brushedMetalColor | Creates a color by modulates the brightness of another color to create brushed metallic shiny effects.
glassEffect | A complex shading effect that emulates tinted glass or semi-transparent plastic material.
softLighting | A special shading effect that looks like gradient coloring.
barLighting | A special shading effect for rectangular and polygonal bars on a BarLayer. It shades all surfaces of a 2D or 3D bar with gradient colors.
cylinderEffect | A special shading effect that emulates the lighting of a cylinder surface.
PolygonShape | Gets the shape id that represents a polygon.
Polygon2Shape | Gets the shape id that represents a polygon in an alternative orientation.
StarShape | Gets the shape id that represents a star shape.
CrossShape | Gets the shape id that represents a '+' shape.
Cross2Shape | Gets the shape id that represents a 'X' shape.
PolynomialRegression | Sets the degree of the polynomial regression to be used in a trend layer.
StartOfHourFilter | Creates a data filter that matches date/times that represent the start of a new hour in a date/time series.
StartOfDayFilter | Creates a data filter that matches date/times that represent the start of a new day in a date/time series.
StartOfWeekFilter | Creates a data filter that matches date/times that represent the start of a new week in a date/time series.
StartOfMonthFilter | Creates a data filter that matches date/times that represent the start of a new month in a date/time series.
StartOfYearFilter | Creates a data filter that matches date/times that represent the start of a new year in a date/time series.
RegularSpacingFilter | Creates a data filter that matches 1 out of every N elements.
AllPassFilter | Creates a data filter that matches every element.
NonePassFilter | Creates a data filter that matches no element.
SelectItemFilter | Creates a data filter that matches the specified item.

© 2009 Advanced Software Engineering Limited. All rights reserved.