ChartDirector 7.0 (PHP Edition)

BaseBoxLayer


The BaseBoxLayer class is the base class for layers that uses isolated symbols to represent multiple data sets. These include BoxWhiskerLayer, HLOCLayer and CandleStickLayer. BaseBoxLayer is a subclass of Layer.

MethodInheritedDescription
setDataGap(Self)Sets the symbol width by specifying the gap ratio between adjacent symbols.
setDataWidth(Self)Sets the symbol width by specifying the pixel width of the symbols.
setRoundedCorners(Self)Configures rounded corners for the boxes. This method currently is only supported by the BoxWhiskerLayer.
setMinImageMapSize(Self)Sets the minimum height (or width if the x-axis and y-axis are swapped with XYChart.swapXY) of the hot spots defined by the image map.
set3DLayerSets the 3D depth of the layer, and the 3D gap between the current layer and the next layer.
setLineWidthLayerSets the default line width of lines when drawing data sets on the layer.
setBorderColorLayerSets the default border color and lighting effect for the data representation.
setLegendOrderLayerSets the order of the data set names as appeared in the legend box.
setLegendLayerSets the order of the data set names as appeared in the legend box.
getLegendIconLayerGets the CDML representation of the legend icon for a data set.
setDataCombineMethodLayerSets the method used to combine multiple data sets in a layer.
addDataSetLayerAdds a data set to the chart layer.
getDataSetLayerGets a DataSet object based on the order in which it is being added to the chart.
getDataSetByZLayerGets a DataSet object based on the order in which it is being drawn.
getDataSetCountLayerGets the number of data sets in the layer.
addDataGroupLayerOpen a new data group.
addExtraFieldLayerAdds an array of text to be used as an extra field in various places.
addExtraField2LayerAdds an array of numbers/dates to be used as an extra field in various places.
setUseYAxisLayerDetermine the y-axis to use when drawing the data sets.
setUseYAxis2LayerDetermine if the primary or secondary y-axis should be used when drawing the data sets.
setXDataLayerSets the x values of the data points in the data sets.
setXData2LayerSets the x values of the data points in the data sets as evenly distributed in a range.
setBaseLineLayerSets the baseline for the data representation.
alignLayerLayerAligns the layer with a data set of another bar chart layer in Side layout.
getXCoorLayerGets the x pixel coordinate given the x data value.
getYCoorLayerGets the y pixel coordinate given the y data value.
getNearestXValueLayerGets the x data value that is nearest to the specified x pixel coordinate.
getXIndexOfLayerGets the data point index at the specified x data value.
getXPositionLayerGets the x positional value of a data point, as measured on the primary x-axis.
xZoneColorLayerCreates an x-zone color. An x-zone color will change from one color to another depending on a threshold value on the x-axis.
yZoneColorLayerCreates a y-zone color. A y-zone color will change from one color to another depending on a threshold value on the y-axis.
setDataLabelStyleLayerEnables data labels and sets their styles.
setDataLabelFormatLayerSets the data label format.
addCustomDataLabelLayerAdds a custom data label to a data point.
setAggregateLabelStyleLayerEnables aggregate labels and sets their styles.
setAggregateLabelFormatLayerSets the aggregate label format.
addCustomAggregateLabelLayerAdds a custom aggregate label to an aggregated object.
addCustomGroupLabelLayerAdds a custom data group label to object representing the group.
moveFrontLayerMoves the layer in front of another layer.
moveBackLayerMoves the layer behind another layer.
getImageCoorLayerGets the image map coordinates of a data point as represented in the layer as HTML image map attributes.
getImageCoor2LayerGets the image map coordinates of a region containing all data points at the given x-position as HTML image map attributes.
getHTMLImageMapLayerGenerates an HTML image map for all data points as represented on the layer.
setHTMLImageMapLayerOverride the default arguments used when generating HTML image map for the layer.