Xojo Developer Conference
25/27th April 2018 in Denver.
MBS Xojo Conference
6/7th September 2018 in Munich, Germany.

Platforms to show: All Mac Windows Linux Cross-Platform

Next items

CDLayerMBS.addCustomAggregateLabel(dataItem as Integer, label as string, font as string = "", fontSize as Double = 8, fontColor as Integer = &hffff0002, fontAngle as Double = 0) as CDTextBoxMBS
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method ChartDirector MBS ChartDirector Plugin 8.2 Yes Yes Yes Yes No
Function: Adds a custom aggregate label to an aggregated object.
Notes:
Aggregate data labels applies to layer types that contains "aggregated data", such as stacked bar layer and stacked area layer. In these layer types, data labels (see Layer.setDataLabelStyle) represents a single data item, while aggregate labels represents the stacked object.

See Font Specification for details on various font attributes.
ArgumentDefaultDescription
dataItem(Mandatory)The index of the aggregated object. The first aggregated object is 0, while the nth aggregated object is (n - 1).
label(Mandatory)A text string representing the custom aggregate label. Parameter Substitution and Formatting is supported.
font""The font used to draw the labels.
fontSize8The font size used to draw the labels.
fontColorTextColorThe color used to draw the labels.
fontAngle0The rotation angle of the labels.
Return Value
A TextBox object representing the prototype of the obj. This may be used to fine-tune the appearance of the obj.

See font specification here:
http://www.monkeybreadsoftware.net/faq-chartdirectorfontspecification.shtml

See also:

Feedback, Comments & Corrections

CDLayerMBS.addCustomAggregateLabel(dataItem as Integer, label as string, font as string, fontSize as Double, fontColor as color, fontAngle as Double = 0) as CDTextBoxMBS
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method ChartDirector MBS ChartDirector Plugin 11.1 Yes Yes Yes Yes No
Function: Same as the other addCustomAggregateLabel method, but uses color instead of integer data type for passing color values.

See also:

Feedback, Comments & Corrections

CDLayerMBS.addCustomDataLabel(dataSet as Integer, dataItem as Integer, label as string, font as string = "", fontSize as Double = 8, fontColor as Integer = &hffff0002, fontAngle as Double = 0) as CDTextBoxMBS
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method ChartDirector MBS ChartDirector Plugin 8.2 Yes Yes Yes Yes No
Function: Adds a custom data label to a data point.
Notes:
Data labels are text used label data points in the layer. Please refer to Layer.setDataLabelStyle for a more detail description.

See Font Specification for details on various font attributes.
ArgumentDefaultDescription
dataSet(Mandatory)The data set number for the data point. The first data set is 0, while the nth data set is (n - 1).
dataItem(Mandatory)The data point number for the data point within the data set. The first data point is 0, while the nth data point is (n - 1).
label(Mandatory)A text string representing the data label. Parameter Substitution and Formatting is supported.
font""The font used to draw the label.
fontSize8The font size used to draw the label.
fontColorTextColorThe color used to draw the label.
fontAngle0The rotation angle of the label.
Return Value
A TextBox object representing the prototype of the obj. This may be used to fine-tune the appearance of the obj.

See font specification here:
http://www.monkeybreadsoftware.net/faq-chartdirectorfontspecification.shtml

See also:

Feedback, Comments & Corrections

CDLayerMBS.addCustomDataLabel(dataSet as Integer, dataItem as Integer, label as string, font as string, fontSize as Double, fontColor as color, fontAngle as Double = 0) as CDTextBoxMBS
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method ChartDirector MBS ChartDirector Plugin 11.1 Yes Yes Yes Yes No
Function: Same as the other addCustomDataLabel method, but uses color instead of integer data type for passing color values.

See also:

Feedback, Comments & Corrections

CDLayerMBS.addCustomGroupLabel(dataGroup as Integer, dataItem as Integer, label as string, font as string ="", fontSize as Double = 8, fontColor as Integer = &hffff0002, fontAngle as Double = 0) as CDTextBoxMBS
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method ChartDirector MBS ChartDirector Plugin 8.2 Yes Yes Yes Yes No
Function: Adds a custom data group label to object representing the group.
Notes:
Data group label applies to layer types that may represent data groups. See Layer.addDataGroup on how data groups are created and the layer types that support data groups.

See Font Specification for details on various font attributes.
ArgumentDefaultDescription
dataGroup(Mandatory)The data group number for the data point. The first data group is 0, while the nth data group is (n - 1).
dataItem(Mandatory)The data point number for the data point within the data group. The first data point is 0, while the nth data point is (n - 1).
label(Mandatory)A text string representing the data label. Parameter Substitution and Formatting is supported.
font""The font used to draw the label.
fontSize8The font size used to draw the label.
fontColorTextColorThe color used to draw the label.
fontAngle0The rotation angle of the label.
Return Value
A TextBox object representing the prototype of the obj. This may be used to fine-tune the appearance of the obj.

See font specification here:
http://www.monkeybreadsoftware.net/faq-chartdirectorfontspecification.shtml

See also:

Feedback, Comments & Corrections

CDLayerMBS.addCustomGroupLabel(dataGroup as Integer, dataItem as Integer, label as string, font as string, fontSize as Double, fontColor as color, fontAngle as Double = 0) as CDTextBoxMBS
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method ChartDirector MBS ChartDirector Plugin 11.1 Yes Yes Yes Yes No
Function: Same as the other addCustomGroupLabel method, but uses color instead of integer data type for passing color values.

See also:

Feedback, Comments & Corrections

CDLayerMBS.addDataGroup(name as string)
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method ChartDirector MBS ChartDirector Plugin 8.2 Yes Yes Yes Yes No
Function: Open a new data group.
Notes:
Currently, only stacked bar layers support data groups for creating "multi-stacked" bars.

In a normal stacked bar layer, all data sets are stacked on top of one another, creating one stacked bar per x-axis position. If data grouping is used, data sets within the same data group with be stacked up. So there may be multiple stacked bars in each x-axis position. These stacked bars are drawn side by side.

When you add a data set using Layer.addDataSet, the data set will belong to the current data group. The addDataGroup method can be used to open a new data group, so that subsequent data sets will belong to that new group.

You may associate a name with a data group. The name can then be used in data labels or image maps to identify the data group.
ArgumentDefaultDescription
name""Name of the data group.

Feedback, Comments & Corrections

CDLayerMBS.addDataSet(data as CDArrayMBS, colorvalue as color, name as string = "") as CDDataSetMBS
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method ChartDirector MBS ChartDirector Plugin 11.1 Yes Yes Yes Yes No
Function: Same as the other addDataSet method, but uses color instead of integer data type for passing color values.

See also:

Feedback, Comments & Corrections

CDLayerMBS.addDataSet(data as CDArrayMBS, colorvalue as Integer = -1, name as string = "") as CDDataSetMBS
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method ChartDirector MBS ChartDirector Plugin 8.2 Yes Yes Yes Yes No
Function: Adds a data set to the chart layer.
Notes:
ArgumentDefaultDescription
data(Mandatory)An array of numbers representing the data set.
color-1The color to draw the data item. -1 means that the color is automatically selected from the palette.
name""The name of the data set. The name will be used in the legend box, if one is available. An empty string means the data set has no name.
Return Value
A DataSet object representing the data set added. You may use the methods of this object to fine-tune how the data set is drawn on the chart.

See also:

Feedback, Comments & Corrections

CDLayerMBS.addDataSet(data() as Double, colorvalue as color, name as string = "") as CDDataSetMBS
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method ChartDirector MBS ChartDirector Plugin 11.1 Yes Yes Yes Yes No
Function: Same as the other addDataSet method, but uses color instead of integer data type for passing color values.

See also:

Feedback, Comments & Corrections

CDLayerMBS.addDataSet(data() as Double, colorvalue as Integer = -1, name as string = "") as CDDataSetMBS
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method ChartDirector MBS ChartDirector Plugin 8.2 Yes Yes Yes Yes No
Function: Adds a data set to the chart layer.
Notes:
ArgumentDefaultDescription
data(Mandatory)An array of numbers representing the data set.
color-1The color to draw the data item. -1 means that the color is automatically selected from the palette.
name""The name of the data set. The name will be used in the legend box, if one is available. An empty string means the data set has no name.
Return Value
A DataSet object representing the data set added. You may use the methods of this object to fine-tune how the data set is drawn on the chart.

See also:

Feedback, Comments & Corrections

CDLayerMBS.addExtraField(numbers() as Double)
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method ChartDirector MBS ChartDirector Plugin 8.2 Yes Yes Yes Yes No
Function: Adds an array of numbers/dates to be used as an extra field in various places.
Notes:
This method merely stores the data inside the layer object. The Parameter Substitution and Formatting mechanism will determine how the data are to be used.

A common use for extra fields is to specify extra information (such as a custom serial number for the data points) to be displayed on data labels or on tool tips, or to supply extra query parameters in clickable charts. All these are achieved by specifying the extra field on the data label template or image map templates during parameter substitution.
ArgumentDefaultDescription
numbers(Mandatory)An array of numbers/dates to be stored inside the layer object.

See also:

Feedback, Comments & Corrections

CDLayerMBS.addExtraField(texts() as string)
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method ChartDirector MBS ChartDirector Plugin 8.2 Yes Yes Yes Yes No
Function: Adds an array of text to be used as an extra field in various places.
Notes:
This method merely stores the data inside the layer object. The Parameter Substitution and Formatting mechanism will determine how the data are to be used.

A common use for extra fields is to specify extra information (such as a custom serial number for the data points) to be displayed on data labels or on tool tips, or to supply extra query parameters in clickable charts. All these are achieved by specifying the extra field on the data label template or image map templates during parameter substitution.
ArgumentDefaultDescription
texts(Mandatory)An array of text to be stored inside the layer object.

See also:

Feedback, Comments & Corrections

CDLayerMBS.alignLayer(layer as CDLayerMBS, dataSet as Integer)
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method ChartDirector MBS ChartDirector Plugin 8.2 Yes Yes Yes Yes No
Function: Aligns the layer with a data set of another bar chart layer in Side layout.
Notes:
The Side layout is a layout method specific to the bar chart layer. In this layout method, multiple bars belonging to the same x-position are laid out side by side. Thus the bars are not centered exactly on the x-position, but are shifted. The shift amount depends on the data set numbers of the bars.

In some cases, it may be necessary to overlay another layer (eg. a line chart layer, or a box-whisker chart layer) on top of the bars. The alignLayer method ensures the data points are shifted by the same amount as a given data set on a given BarLayer.
ArgumentDefaultDescription
layer(Mandatory)The BarLayer which contains the bars to synchronize with.
dataSet(Mandatory)The data set of the bars to synchronize with.

Feedback, Comments & Corrections

CDLayerMBS.Constructor
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method ChartDirector MBS ChartDirector Plugin 15.2 Yes Yes Yes Yes No
Function: The private constructor.

Feedback, Comments & Corrections

CDLayerMBS.getDataSet(dataSet as Integer) as CDDataSetMBS
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method ChartDirector MBS ChartDirector Plugin 8.2 Yes Yes Yes Yes No
Function: Gets the requested DataSet object.
Notes:
ArgumentDefaultDescription
dataSet(Mandatory)A data set number, starting from 0. The first data set object is 0, and the nth data set is (n-1).
Return Value
The requested DataSet object.

Feedback, Comments & Corrections

CDLayerMBS.getDataSetByZ(z as Integer) as CDDataSetMBS
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method ChartDirector MBS ChartDirector Plugin 12.3 Yes Yes Yes Yes No
Function: Gets a DataSet object based on the order in which it is being drawn.
Notes:
In certain layer types, the data sets are drawn in a certain order. For example, in a line layer, the data sets represent lines and they are drawn one by one. In contrast, for a candlestick layer, the high, low, open and close data sets are combined into candlestick symbols, and there is no specific order on which data sets are drawn.

This method can be used to get the data set based on the order it is being drawn. If the data sets are not drawn in any specific order, this method will return the data sets in the reverse order to which it is added to the layer.

ArgumentDefaultDescription
zIndex(Mandatory)The z-index of the required data set. The z-index of the first data set drawn is 0. The z-index for the Nth data set drawn is N - 1.

Returns the DataSet object at the specified z-order.

Feedback, Comments & Corrections

CDLayerMBS.getDataSetCount as Integer
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method ChartDirector MBS ChartDirector Plugin 12.3 Yes Yes Yes Yes No
Function: Gets the number of data sets in the layer.
Notes: Returns the number of data sets in the layer.

Feedback, Comments & Corrections

CDLayerMBS.getHTMLImageMap(url as string, queryFormat as string = "", extraAttr as string = "", offsetX as Integer = 0, offsetY as Integer = 0) as string
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method ChartDirector MBS ChartDirector Plugin 8.2 Yes Yes Yes Yes No
Function: Generates an HTML image map for all data points as represented on the layer.
Notes:
Please refer to BaseChart.getHTMLImageMap for the detail description of this method.

This method should be called only after creating the chart image (eg. using BaseChart.makeChart, BaseChart.makeChart2 or BaseChart.makeChart3). The image map cannot be determined without creating the chart image first.
ArgumentDefaultDescription
url(Mandatory)The URL to be used in the "href" attribute of the image map. Parameter Substitution and Formatting is supported. Use an empty string if no href attribute is needed.
queryFormat""A text string representing the template of the query parameters to be appended to the URL. Parameter Substitution and Formatting is supported.

The special keyword "{default}" represents the default query parameters. This is useful for specifying appending to the default.

Note that an empty string means to use the default query query parameters. To specify no query parameter, use a space character.
extraAttr""A text string to specify additional attributes to add to the <area> tag. Parameter Substitution and Formatting is supported.
offsetX0An offset to be added to all x coordinates in the image map. This is useful if the current image will be shifted and inserted into another image. In this case, the image map will need to be shifted by the same offset.
offsetY0An offset to be added to all y coordinates in the image map. See offsetX above for description.
Return Value
A text string containing the image map generated.

Feedback, Comments & Corrections

CDLayerMBS.getImageCoor(dataSet as Integer, dataItem as Integer = &h80000001, offsetX as Integer = 0, offsetY as Integer = 0) as string
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method ChartDirector MBS ChartDirector Plugin 8.2 Yes Yes Yes Yes No
Function: Gets the image map coordinates of a data point as represented in the layer as HTML image map attributes.
Notes:
The image map coordinates will be in the following format:

shape="[shape]" cords="[x1],[y1],[x2],[y2] ..."
This format is specially designed so that it can easily be incorporated into HTML image maps.

This method should be called only after creating the chart image (eg. using BaseChart.makeChart, BaseChart.makeChart2 or BaseChart.makeChart3). The image map cannot be determined without creating the chart image first.
ArgumentDefaultDescription
dataSet(Mandatory)The data set number for the data point. The first data set is 0, while the nth data set is (n-1).
dataItem(Mandatory)The index of the data point within the data set. The first data point is 0, while the nth data point is (n-1).
offsetX0An offset to be added to all x coordinates in the image map. This is useful if the current image will be shifted and inserted into another image. In this case, the image map will need to be shifted by the same offset.
offsetY0An offset to be added to all y coordinates in the image map. See offsetX above for description.
Return Value
A text string representing the coordinates of the data point as represented in the layer in HTML image map attribute format.

Feedback, Comments & Corrections

CDLayerMBS.getImageCoor2(dataItem as Integer, offsetX as Integer = 0, offsetY as Integer = 0) as string
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method ChartDirector MBS ChartDirector Plugin 8.2 Yes Yes Yes Yes No
Function: Gets the image map coordinates of a region containing all data points at the given x-position as HTML image map attributes.
Notes:
For example, in a stacked bar chart, this method will obtain the image map coordinates of the whole stacked bar, which contains multiple data points at the same x-position.

The image map coordinates will be in the following format:

shape="" cords="[x1],[y1],[x2],[y2] ..."
This format is specially designed so that it can easily be included into HTML image maps.

This method should be called only after creating the chart image (eg. using BaseChart.makeChart, BaseChart.makeChart2 or BaseChart.makeChart3). The image map cannot be determined without creating the chart image first.
ArgumentDefaultDescription
dataItem(Mandatory)The x-position of the data points.
offsetX0An offset to be added to all x coordinates in the image map. This is useful if the current image will be shifted and inserted into another image. In this case, the image map will need to be shifted by the same offset.
offsetY0An offset to be added to all y coordinates in the image map. See offsetX above for description.
Return Value
A text string representing the image map coordinates of a region containing all data points at the given x-position as HTML image map attributes.

Feedback, Comments & Corrections

CDLayerMBS.getLegendIcon(dataSetNo as Integer) as string
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method ChartDirector MBS ChartDirector Plugin 9.2 Yes Yes Yes Yes No
Function: Gets the textual representation of the legend icon for a data set.
Notes:
The textual representation can be used in any ChartDirector API that supports the ChartDirector Mark Up Language. A common usage is to insert the icon to a cell in a CDMLTable to label the data series in the table, or to create a custom legend table.

The legend icon is the same legend icon that would be used in the CDLegendBoxMBS. If you modify the icon appearance using the methods of the CDLegendBoxMBS object (such as using CDLegendBoxMBS.setKeyBorder to configure the legend key border), the modification will also apply to the icon returned this method.

Arguments:
ArgumentDefaultDescription
dataSetNo(Mandatory)The data set for which the legend icon represents.

Return Value
The textual representation of the legend icon for the data set.

Feedback, Comments & Corrections

CDLayerMBS.getNearestXValue(target as Double) as Double
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method ChartDirector MBS ChartDirector Plugin 12.3 Yes Yes Yes Yes No
Function: Gets the x data value that is nearest to the specified x pixel coordinate.
Notes:
This method will search all x data values in the Layer to look for the x data value that is nearest to the given x coordinate. If there are two x data values equally near to the specified x pixel coordinate, this method will arbitrarily return one of the values.

ArgumentDefaultDescription
xCoor(Mandatory)The x pixel coordinate to search for.

Returns the x data value that is nearest to the specified x coordinate.

Feedback, Comments & Corrections

CDLayerMBS.getXCoor(value as Double) as Integer
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method ChartDirector MBS ChartDirector Plugin 8.2 Yes Yes Yes Yes No
Function: Gets the x pixel coordinate of a point given the x data value.
Notes:
Note: You must call BaseChart.layout first before calling this method. It is because ChartDirector needs to perform auto-scaling and determine the axis scale first before it can compute the coordinates.
ArgumentDefaultDescription
v(Mandatory)The x data value.
Return Value
The x coordinate of the x data value.

Feedback, Comments & Corrections

CDLayerMBS.getXIndexOf(xValue as Double, tolerance as Double = 0) as Integer
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method ChartDirector MBS ChartDirector Plugin 12.3 Yes Yes Yes Yes No
Function: Gets the data point index at the specified x data value.
Notes:
The index can be used in DataSet.getValue and DataSet.getPosition to obtain the y values and positions of the data points for all data sets in the layer.

The tolerance argument is to allow this method to consider data points that are not exactly at xValue, but are within tolerance from it.

If multiple data points at within tolerance, this method will return the index of the data point nearest to xValue. If multiple data points are equally near to xValue, this method will choose one arbitrarily and return its data point index. If no data points are found, this method will return -1.

ArgumentDefaultDescription
xValue(Mandatory)The x data value used to look for the data points in order to get the data point index of the nearest data point.
tolerance0The tolerance allowed for for data points that are not exactly at the specified xValue.

Returns the data point index of the data point nearest to the specified x data value up to the specified tolerance, or -1 if no data points are found.

Feedback, Comments & Corrections

CDLayerMBS.getXPosition(i as Integer) as Double
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method ChartDirector MBS ChartDirector Plugin 12.3 Yes Yes Yes Yes No
Function: Gets the x positional value of a data point, as measured on the primary x-axis.
Notes:
ArgumentDefaultDescription
i(Mandatory)The data point index of the data point. The first data point is 0; the nth data point is (n - 1).

Feedback, Comments & Corrections

CDLayerMBS.getYCoor(value as Double, axis as boolean=true) as Integer
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method ChartDirector MBS ChartDirector Plugin 8.2 Yes Yes Yes Yes No
Function: Gets the y pixel coordinate of a point given the y data value.
Notes:
Note: You must call BaseChart.layout first before calling this method. It is because ChartDirector needs to perform auto-scaling and determine the axis scale first before it can compute the coordinates.
ArgumentDefaultDescription
v(Mandatory)The y data value.
yAxis[Null]The y-axis to use to determine the pixel coordinates of data values. The y-axis may be obtained using XYChart.yAxis, XYChart.yAxis2 or XYChart.addAxis. The default is to use the primary y-axis.

For backward compatibility, the axis argument can also be a boolean value. A true value means the primary y-axis. A false value means the secondary y-axis.
Return Value
The y coordinate of the y data value.

See also:

Feedback, Comments & Corrections

CDLayerMBS.getYCoor(value as Double, axis as CDAxisMBS) as Integer
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method ChartDirector MBS ChartDirector Plugin 8.2 Yes Yes Yes Yes No
Function: Gets the y pixel coordinate of a point given the y data value.
Notes:
Note: You must call BaseChart.layout first before calling this method. It is because ChartDirector needs to perform auto-scaling and determine the axis scale first before it can compute the coordinates.
ArgumentDefaultDescription
v(Mandatory)The y data value.
yAxis[Null]The y-axis to use to determine the pixel coordinates of data values. The y-axis may be obtained using XYChart.yAxis, XYChart.yAxis2 or XYChart.addAxis. The default is to use the primary y-axis.

For backward compatibility, the axis argument can also be a boolean value. A true value means the primary y-axis. A false value means the secondary y-axis.
Return Value
The y coordinate of the y data value.

See also:

Feedback, Comments & Corrections

CDLayerMBS.moveBack(layer as CDLayerMBS=nil)
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method ChartDirector MBS ChartDirector Plugin 9.2 Yes Yes Yes Yes No
Function: Moves the layer in front of another layer.
Notes:
By default, the front to back ordering of the Layer objects are the same as the order in which they are added to the chart. For example, a layer added first will be in front of a layer added last.

This method can be used to move the layer behind another layer.

Arguments:
ArgumentDefaultDescription
layernilThe Layer for this layer to move behind. A nil object means the layer will be moved behind all current layers.

Feedback, Comments & Corrections

Next items

The items on this page are in the following plugins: MBS ChartDirector Plugin.




Links
MBS FileMaker Plugins