ChartDirector 5.1 (PHP Edition)

Layer


The Layer class is the base class for all XYChart layer classes.

MethodInheritedDescription
set3D(Self)Sets the 3D depth of the layer, and the 3D gap between the current layer and the next layer.
setLineWidth(Self)Sets the default line width of lines when drawing data sets on the layer.
setBorderColor(Self)Sets the default border color and lighting effect for the data representation.
setLegendOrder(Self)Sets the order of the data set names as appeared in the legend box.
setLegend(Self)Sets the order of the data set names as appeared in the legend box.
getLegendIcon(Self)Gets the CDML representation of the legend icon for a data set.
setDataCombineMethod(Self)Sets the method used to combine multiple data sets in a layer.
addDataSet(Self)Adds a data set to the chart layer.
getDataSet(Self)Gets a DataSet object based on the order in which it is being added to the chart.
getDataSetByZ(Self)Gets a DataSet object based on the order in which it is being drawn.
getDataSetCount(Self)Gets the number of data sets in the layer.
addDataGroup(Self)Open a new data group.
addExtraField(Self)Adds an array of text to be used as an extra field in various places.
addExtraField2(Self)Adds an array of numbers/dates to be used as an extra field in various places.
setUseYAxis(Self)Determine the y-axis to use when drawing the data sets.
setUseYAxis2(Self)Determine if the primary or secondary y-axis should be used when drawing the data sets.
setXData(Self)Sets the x values of the data points in the data sets.
setXData2(Self)Sets the x values of the data points in the data sets as evenly distributed in a range.
setBaseLine(Self)Sets the baseline for the data representation.
alignLayer(Self)Aligns the layer with a data set of another bar chart layer in Side layout.
getXCoor(Self)Gets the x pixel coordinate given the x data value.
getYCoor(Self)Gets the y pixel coordinate given the y data value.
getNearestXValue(Self)Gets the x data value that is nearest to the specified x pixel coordinate.
getXIndexOf(Self)Gets the data point index at the specified x data value.
getXPosition(Self)Gets the x positional value of a data point, as measured on the primary x-axis.
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.
setDataLabelStyle(Self)Enables data labels and sets their styles.
setDataLabelFormat(Self)Sets the data label format.
addCustomDataLabel(Self)Adds a custom data label to a data point.
setAggregateLabelStyle(Self)Enables aggregate labels and sets their styles.
setAggregateLabelFormat(Self)Sets the aggregate label format.
addCustomAggregateLabel(Self)Adds a custom aggregate label to an aggregated object.
addCustomGroupLabel(Self)Adds a custom data group label to object representing the group.
moveFront(Self)Moves the layer in front of another layer.
moveBack(Self)Moves the layer behind another layer.
getImageCoor(Self)Gets the image map coordinates of a data point as represented in the layer as HTML image map attributes.
getImageCoor2(Self)Gets the image map coordinates of a region containing all data points at the given x-position as HTML image map attributes.
getHTMLImageMap(Self)Generates an HTML image map for all data points as represented on the layer.
setHTMLImageMap(Self)Override the default arguments used when generating HTML image map for the layer.