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

CDDataSetMBS.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

CDDataSetMBS.getDataColor 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 main color used to draw the data set.
Notes: Returns the main color used to draw the data set.

Feedback, Comments & Corrections

CDDataSetMBS.getDataName as string
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 name of the data set.
Notes: Return the name of the data set.

Feedback, Comments & Corrections

CDDataSetMBS.getLegendIcon as string
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 CDML representation of the legend icon for the data set.
Notes:
The CDML representation can be used in any ChartDirector API that supports CDML. Note that the CDML representation is only valid in the BaseChart object that contains the data set. It is not allowed to use the CDML representation obtained from one chart in a different chart.

The legend icon is the same icon that would appear in the LegendBox. If you modify the icon using methods of the LegendBox object (such as using LegendBox.setKeyBorder to set the legend icon border), the modification will also apply to the icon returned by this method.

Returns the CDML representation of the legend icon for the data set.

Feedback, Comments & Corrections

CDDataSetMBS.getPosition(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 positional value of a data point.
Notes:
The positional value is the value used to position the data point. Usually, the positional value is equal to the data value. However, for chart types in which the data sets are combined using the Stack or Percentage method, the positional value can be different from the data value. For example, for stacked charts, the positional value of a data point is equal to the accumulative value of the corresponding data points from data sets added before the target data set.

ArgumentDefaultDescription
i(Mandatory)The data point index of the data point. The first data point is 0; the nth data point is (n - 1).

Returns the positional value of the data point.

Feedback, Comments & Corrections

CDDataSetMBS.getUseYAxis as CDAxisMBS
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 y-axis to use when drawing the data set.
Notes: Returns an Axis object representing the y-axis to use when drawing the data set.

Feedback, Comments & Corrections

CDDataSetMBS.getValue(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 value of a data point.
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).

Returns the value of the data point.

Feedback, Comments & Corrections

CDDataSetMBS.setData(data() 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: Sets the data for this dataset.

Feedback, Comments & Corrections

CDDataSetMBS.setDataColor(dataColor as color, edgeColor as color, shadowColor as color, shadowEdgeColor as color)
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 setDataColor method, but uses color instead of integer data type for passing color values.

See also:

Feedback, Comments & Corrections

CDDataSetMBS.setDataColor(dataColor as Integer, edgeColor as Integer = -1, shadowColor as Integer = -1, shadowEdgeColor as Integer = -1)
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method ChartDirector MBS ChartDirector Plugin 8.2 Yes Yes Yes Yes No
Function: Sets the colors used to draw the data set.
Notes:
The usage of the colors depend on the layer type. For example, in a bar layer, the dataColor and edgeColor are used as the fill and border color of the bar. In a line layer, the dataColor is used as the color of the line, while the edgeColor is used as the border of the line for 3D lines, and is ignored for 2D lines..
ArgumentDefaultDescription
dataColor(Mandatory)The main color used to draw the data set.
edgeColor-1The color used to draw the edges or borders of the data set, if any. -1 means that the edges are drawn using the default border color of the layer (defined using Layer.setBorderColor).
shadowColor-1The color to use to draw 3D shadows of the data set, if any. -1 means the shadow color will be a "darker" version of the dataColor, created by reducing the RGB intensities of the dataColor in half.
shadowEdgeColor-1The color to use to draw edges of the 3D shadows of the data set, if any. -1 means the shadow color will be a "darker" version of the edgeColor, created by by reducing the RGB intensities of the edgeColor in half.

See also:

Feedback, Comments & Corrections

CDDataSetMBS.setDataLabelFormat(formatString 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: Sets the data label format for the data set.
Notes:
To set the label format for all data sets in a layer, use Layer.setDataLabelFormat.

For details description of data label format, please refer to Layer.setDataLabelFormat.
ArgumentDefaultDescription
formatString(Mandatory)The format string.

Feedback, Comments & Corrections

CDDataSetMBS.setDataLabelStyle(font as string = "", fontsize as Double = 8, fontcolor as Integer = 0, 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: Enables data labels and sets their styles.
Notes:
To set the data label styles for all data sets in a layer, use Layer.setDataLabelStyle.

For details description of data labels, please refer to :Layer.setDataLabelStyle.
ArgumentDefaultDescription
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 also:

Feedback, Comments & Corrections

CDDataSetMBS.setDataLabelStyle(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 setDataLabelStyle method, but uses color instead of integer data type for passing color values.

See also:

Feedback, Comments & Corrections

CDDataSetMBS.setDataName(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: Sets the name of the data set.
Notes:
The name will be used in the legend box, if one is available for the chart.
ArgumentDefaultDescription
name(Mandatory)The name of the data set.

Feedback, Comments & Corrections

CDDataSetMBS.setDataSymbol(drawobj as CDDrawAreaMBS)
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method ChartDirector MBS ChartDirector Plugin 8.2 Yes Yes Yes Yes No
Function: Uses a DrawArea object as the graphics symbol to plot the data points.
Notes:
In the current version of ChartDirector, data symbols are supported only in LineLayer, SplineLayer, StepLineLayer and ScatterLayer. To use data symbols in other layer types, add a ScatterLayer on top of that layer.
ArgumentDefaultDescription
obj(Mandatory)A DrawArea object to be used as the symbol.

See also:

Feedback, Comments & Corrections

CDDataSetMBS.setDataSymbol(file as folderitem)
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method ChartDirector MBS ChartDirector Plugin 8.2 Yes Yes Yes Yes No
Function: Load an image from a file and use it as the graphics symbol to plot the data points.
Notes:
ChartDirector will automatically detect the image file format using the file extension, which must either png, jpg, jpeg, gif, wbmp or wmp (case insensitive).

Please refer to BaseChart.setSearchPath on the directory that ChartDirector will search for the file.

In the current version of ChartDirector, data symbols are supported only in LineLayer, SplineLayer, StepLineLayer and ScatterLayer. To use data symbols in other layer types, add a ScatterLayer on top of that layer.
ArgumentDefaultDescription
image(Mandatory)The filename of the image file. The image type is determined based on file extension, which must be png, jpg/jpeg, gif or wbmp/wmp.

See also:

Feedback, Comments & Corrections

CDDataSetMBS.setDataSymbol(ImageFilePath as string)
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method ChartDirector MBS ChartDirector Plugin 12.4 Yes Yes Yes Yes No
Function: Load an image from a file and use it as the graphics symbol to plot the data points.
Notes:
ChartDirector will automatically detect the image file format using the file extension, which must either png, jpg, jpeg, gif, wbmp or wmp (case insensitive).

Please refer to BaseChart.setSearchPath on the directory that ChartDirector will search for the file.

In the current version of ChartDirector, data symbols are supported only in LineLayer, SplineLayer, StepLineLayer and ScatterLayer. To use data symbols in other layer types, add a ScatterLayer on top of that layer.
ArgumentDefaultDescription
image(Mandatory)The filename of the image file. The image type is determined based on file extension, which must be png, jpg/jpeg, gif or wbmp/wmp.

See also:

Feedback, Comments & Corrections

CDDataSetMBS.setDataSymbol(pic as Picture)
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method ChartDirector MBS ChartDirector Plugin 12.4 Yes Yes Yes Yes No
Function: Uses a picture object as the graphics symbol to plot the data points.
Notes:
In the current version of ChartDirector, data symbols are supported only in LineLayer, SplineLayer, StepLineLayer and ScatterLayer. To use data symbols in other layer types, add a ScatterLayer on top of that layer.
ArgumentDefaultDescription
obj(Mandatory)A picture object to be used as the symbol.

See also:

Feedback, Comments & Corrections

CDDataSetMBS.setDataSymbol(polygon() as Integer, size as Integer = 11, fillcolor as Integer = -1, edgeColor as Integer = -1)
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method ChartDirector MBS ChartDirector Plugin 8.2 Yes Yes Yes Yes No
Function: Uses a custom polygon as the graphics symbol to plot the data points.
Notes:
In the current version of ChartDirector, data symbols are supported only in LineLayer, SplineLayer, StepLineLayer and ScatterLayer. To use data symbols in other layer types, add a ScatterLayer on top of that layer.
ArgumentDefaultDescription
polygon(Mandatory)An array of integers representing the coordinates the polygon vertices. See Shape Specification on how the custom shape is defined.
size11The nominal width and height of the symbol in pixels.
fillColor-1The color used to fill the symbol. -1 means the color of the data set will be used.
edgeColor-1The edge color used to draw the edge of the symbol. -1 means the edge color of the data set will be used.

See also:

Feedback, Comments & Corrections

CDDataSetMBS.setDataSymbol(symbol as Integer, size as Integer = 5, fillColor as Integer = -1, edgeColor as Integer = -1, lineWidth as Integer = 1)
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method ChartDirector MBS ChartDirector Plugin 8.2 Yes Yes Yes Yes No
Function: Uses one of the built-in symbols as the graphics symbol to plot the data points.
Notes:
In the current version of ChartDirector, data symbols are supported only in LineLayer, SplineLayer, StepLineLayer and ScatterLayer. To use data symbols in other layer types, add a ScatterLayer on top of that layer.
ArgumentDefaultDescription
symbol(Mandatory)One of the predefined shape constants representing the symbol shape. See Shape Specification for the available built-in shapes.
size5The width and height of the symbol in pixels.
fillColor-1The color used to fill the symbol. -1 means the color of the data set will be used.
edgeColor-1The edge color used to draw the edge of the symbol. -1 means the edge color of the data set will be used.
lineWidth1The line width used for drawing the symbols.

See also:

Feedback, Comments & Corrections

CDDataSetMBS.setLineWidth(w 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: Sets the line width of lines when drawing the data set.
Notes:
This method only applies to layers that employ lines to represent data (e.g. line layer).

If this method is not called, the default line width for the layer will be used (set using Layer.setLineWidth).
ArgumentDefaultDescription
w(Mandatory)The width of the line in pixels.

Feedback, Comments & Corrections

CDDataSetMBS.setSymbolOffset(offsetX as Integer, offsetY as Integer)
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method ChartDirector MBS ChartDirector Plugin 15.1 Yes Yes Yes Yes No
Function: Offset the symbols in the x and y directions in pixel unit.
Notes:
ArgumentDefaultDescription
xOffset(Mandatory)The x offset in pixels. A positive value mean shifting to the right.
yOffset(Mandatory)The y offset in pixels. A positive value mean shifting to the bottom.

Feedback, Comments & Corrections

CDDataSetMBS.setUseYAxis(axis as CDAxisMBS)
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method ChartDirector MBS ChartDirector Plugin 8.2 Yes Yes Yes Yes No
Function: Determine if the primary or secondary y-axis should be used when drawing the data set.
Notes:
To set the y-axis to use for all data sets within a layer, use Layer.setUseYAxis2.

Note: DataSet.setUseYAxis is a more general method that can support more than 2 y-axes.
ArgumentDefaultDescription
btrueA true value means the secondary y-axis will be used. A false value means the primary y-axis will be used.

See also:

Feedback, Comments & Corrections

CDDataSetMBS.setUseYAxis(b as boolean=true)
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method ChartDirector MBS ChartDirector Plugin 8.2 Yes Yes Yes Yes No
Function: Determine the y-axis to use when drawing the data set.
Notes:
To set the y-axis to use for all data sets within a layer, use Layer.setUseYAxis.
ArgumentDefaultDescription
a(Mandatory)The y-axis to use when drawing the data set.

See also:

Feedback, Comments & Corrections

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




Links
MBS Xojo Chart Plugins