ChartDirector 5.1 (PHP Edition)

XYChart


The XYChart class represents XY charts. The XYChart class is a subclass of BaseChart.

MethodInheritedDescription
XYChart(Self)Creates a new XYChart object.
yAxis(Self)Retrieves the Axis object representing the primary y-axis of the XYChart.
yAxis2(Self)Retrieves the Axis object representing the secondary y-axis of the XYChart.
syncYAxis(Self)Sets a linear formula to synchronize the secondary y-axis scale to the primary y-axis scale.
setYAxisOnRight(Self)Interchange the position of the primary y-axis and the secondary y-axis.
xAxis(Self)Retrieves the Axis object representing the primary x-axis of the XYChart.
xAxis2(Self)Retrieves the Axis object representing the secondary x-axis of the XYChart.
setXAxisOnTop(Self)Interchange the position of the primary x-axis and the secondary x-axis.
setAxisAtOrigin(Self)Sets the chart into 4 quadrant mode. The axes may intersect at origin inside the plot area (as opposed to at the border of the plot area).
addAxis(Self)Adds an additional axis to the chart.
swapXY(Self)Swap the position of the x and y axes, so the x-axes will become vertical, and the y-axes will become horizontal.
setPlotArea(Self)Sets the position, size, background colors, edge color and grid colors of the plot area.
getPlotArea(Self)Gets the PlotArea object representing the plot area.
packPlotArea(Self)Adjusts the plot area size and position to fit the plot area and the axis labels in a bounding box.
setClipping(Self)Enables clipping on the plot area.
setTrimData(Self)Uses only a subset of the data series to draw charts.
addBarLayer(Self)Adds a bar layer to the XYChart, and specify the data set to use for drawing the bars.
addBarLayer2(Self)Adds an empty bar layer to the XYChart.
addBarLayer3(Self)Adds a multi-color bar layer to the XYChart, and specify the data set to use for drawing the bars.
addLineLayer(Self)Adds a line layer to the XYChart, and specify the data set to use for drawing the line.
addLineLayer2(Self)Adds an empty line layer to the XYChart.
addSplineLayer(Self)Adds a spline layer to the XYChart.
addStepLineLayer(Self)Adds a step line chart layer to the XYChart.
addTrendLayer(Self)Adds a trend chart layer to the XYChart, and specify the data set to use for drawing the trend line.
addTrendLayer2(Self)Adds a trend chart layer to the XYChart, and specify the x and y values for drawing the trend line.
addInterLineLayer(Self)Adds an inter-line layer the XYChart. An inter-line layer is used to fill the region between any two lines (straight lines, spline curves, step lines, etc).
addScatterLayer(Self)Adds a scatter chart layer to the XYChart.
addAreaLayer(Self)Adds an area chart layer to the XYChart, and specify the data set to use for drawing the area.
addAreaLayer2(Self)Adds an empty area chart layer to the XYChart.
addBoxWhiskerLayer(Self)Adds a box-whisker layer to the XYChart, and specify the data sets to use for drawing the layer.
addBoxWhiskerLayer2(Self)Adds a multi-color box-whisker layer to the XYChart, and specify the data sets to use for drawing the layer.
addBoxLayer(Self)Adds a floating box layer to the XYChart, and specify the data sets to use for drawing the layer.
addVectorLayer(Self)Adds a vector layer to the chart.
addHLOCLayer(Self)Adds a high-low-open-close (HLOC) layer to the XYChart, and specify the data sets to use for drawing the layer.
addHLOCLayer2(Self)Adds an empty high-low-open-close (HLOC) layer to the XYChart.
addHLOCLayer3(Self)Adds a multi-color high-low-open-close (HLOC) layer to the XYChart, and specify the data sets to use for drawing the layer.
addCandleStickLayer(Self)Adds a candlestick layer to the XYChart, and specify the data sets to use for drawing the layer.
addContourLayer(Self)Adds a contour layer to the XYChart, and specify the data sets to use for drawing the layer.
getLayer(Self)Gets a Layer object based on the order in which it is being added to the chart.
getLayerByZ(Self)Gets a Layer object based on the order in which it is being drawn.
getLayerCount(Self)Gets the number of layers in the chart.
layoutAxes(Self)Performs axis auto-scaling and sets the axis positions and lengths.
getXCoor(Self)Gets the x pixel coordinate given the x data value.
getYCoor(Self)Gets the y pixel coordinate given the y data value.
getXValue(Self)Gets the x data value given the x pixel coordinate.
getYValue(Self)Gets the y data value given the y pixel coordinate.
getNearestXValue(Self)Gets the x data value that is nearest to the specified x pixel coordinate.
xZoneColor(Self)Creates an x-zone color. An x-zone will change from one color to another depending on a threshold value on the x-axis.
yZoneColor(Self)Creates a y-zone color. A y-zone will change from one color to another depending on a threshold value on the y-axis.
setSizeBaseChartSets the size of the chart, exclusive of the drop shadow (if any).
getWidthBaseChartGets the width of the chart.
getHeightBaseChartGets the height of the chart.
getAbsOffsetXBaseChartGets the x offset of the chart relative to the outermost MultiChart container.
getAbsOffsetYBaseChartGets the y offset of the chart relative to the outermost MultiChart container.
setBackgroundBaseChartSets the background color, border color and 3D border effect of the chart.
setRoundedFrameBaseChartSets the border style of the chart to rounded corners.
setDropShadowBaseChartAdds a drop shadow to the chart.
setBorderBaseChartSets the border color of the chart.
setWallpaperBaseChartUses the image from the specified file as the wallpaper to repetitively fill the background of the chart.
setBgImageBaseChartUses the image from the specified file as the background image of the chart.
setSearchPathBaseChartSets the file system search path for loading image files.
setTransparentColorBaseChartSpecifies a certain color to mean transparent when creating a raster image output, or to include alpha transparency channel in the output.
setAntiAliasBaseChartControls whether anti-alias is used when drawing lines, shapes and text.
addTitleBaseChartAdds a title at the top center of the chart.
addTitle2BaseChartAdds a title to the chart.
addLegendBaseChartAdds a legend box to the chart.
addLegend2BaseChartAdds a legend box to the chart with grid layout.
getLegendBaseChartGets the LegendBox object representing the legend box in the chart.
layoutLegendBaseChartLays out and gets the LegendBox object representing the legend box in the chart.
getDrawAreaBaseChartRetrieves the internal DrawArea object that is used to draw the chart.
addTextBaseChartAdds a text box to the chart.
addTableBaseChartAdds a CDML table to the chart.
addLineBaseChartAdds a line to the chart.
addExtraFieldBaseChartAdds an array of text to be used as an extra field in various places.
addExtraField2BaseChartAdds an array of numbers/dates to be used as an extra field in various places.
setColorBaseChartChange the color at the specified position in the palette.
setColorsBaseChartChange the colors in the palette.
setColors2BaseChartChange the colors in the palette, starting from the specified position in the palette.
getColorBaseChartGets the color at the specified position of the palette.
adjustBrightnessBaseChartCreates a color that is a darkened or brightened version of the given color.
halfColorBaseChartCreates a color that is half the intensity of the given color.
dashLineColorBaseChartCreates a dash line color.
patternColorBaseChartCreates a pattern color using an array of colors as the bitmap pattern.
patternColor2BaseChartCreates a pattern color by loading the pattern from an image file.
linearGradientColorBaseChartCreates a two-point linear gradient color.
linearGradientColor2BaseChartCreates a multi-point linear gradient color.
radialGradientColorBaseChartCreates a two-point radial gradient color.
radialGradientColor2BaseChartCreates a multi-point radial gradient color.
gradientColorBaseChartCreates a two-point linear gradient color.
gradientColor2BaseChartCreates a multi-point linear gradient color.
setDefaultFontsBaseChartSets the defaults for normal, bold, italic and bold-italic fonts.
setFontTableBaseChartSets an entry in the font table to the specified font name.
formatValueBaseChartFormats a number/date using the ChartDirector formatting syntax as is in Parameter Substitution and Formatting.
setNumberFormatBaseChartSets the characters used for thousand separator, decimal point, and negative sign.
setMonthNamesBaseChartSets the names of the months for date/time formatting purposes.
setWeekDayNamesBaseChartSets the names of the week days for date/time formatting purposes.
setAMPMBaseChartSets the names to be used to denote morning and afternoon.
layoutBaseChartPerform auto-scaling of the axes (if any) and compute the positions of the various objects in the chart.
enableVectorOutputBaseChartEnables true vector graphics output.
makeChartBaseChartGenerates the chart image and save it into a file.
makeChart2BaseChartGenerates the chart as an image in memory.
makeChart3BaseChartGenerates the chart in internal format and return a DrawArea object to allow adding custom drawings on top of the chart.
makeSessionBaseChartGenerates the chart as an image and save it to a session variable.
initDynamicLayerBaseChartInitializes a dynamic layer for drawing text and shapes.
removeDynamicLayerBaseChartRemoves the dynamic layer if any.
getHTMLImageMapBaseChartGenerates an HTML image map for the chart.
getJsChartModelBaseChartGets the Javascript Chart Model for passing to WebChartViewer.setChartModel for the purpose of supporting track cursors in a web application.
getChartMetricsBaseChartGets the chart metrics for passing to WebChartViewer.setChartMetrics to support view ports for web applications.