CDDataSetMBS.Constructor   Private

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
method	ChartDirector	MBS ChartDirector Plugin	15.2	✅ Yes	✅ Yes	✅ Yes	✅ Yes	All

The private constructor.

CDDataSetMBS.getDataColor as Integer

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
method	ChartDirector	MBS ChartDirector Plugin	12.3	✅ Yes	✅ Yes	✅ Yes	✅ Yes	All

Gets the main color used to draw the data set.

Returns the main color used to draw the data set.

Some examples using this method:

• /ChartDirector/RealTime ViewPort
• /ChartDirector/Track Line Web
• /ChartDirector/Track Line with Data Labels Retina
• /ChartDirector/Track Line with Legend Retina
• /ChartDirector/Tracking Cursor/Finance Chart Track Line
• /ChartDirector/Tracking Cursor/Track Box with Legend
• /ChartDirector/Tracking Cursor/Track Line with Axis Labels
• /ChartDirector/Tracking Cursor/Track Line with Data Labels
• /ChartDirector/Tracking Cursor/Track Line with Legend
• /ChartDirector/Tracking Cursor/Track Line with Legend Retina

CDDataSetMBS.getDataName as string

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
method	ChartDirector	MBS ChartDirector Plugin	12.3	✅ Yes	✅ Yes	✅ Yes	✅ Yes	All

Gets the name of the data set.

Return the name of the data set.

Some examples using this method:

• /ChartDirector/Finance Chart Track Line Retina
• /ChartDirector/Track Line Web
• /ChartDirector/Track Line with Data Labels Retina
• /ChartDirector/Track Line with Legend Retina
• /ChartDirector/Tracking Cursor/Finance Chart Track Line
• /ChartDirector/Tracking Cursor/Track Box with Legend
• /ChartDirector/Tracking Cursor/Track Line Web
• /ChartDirector/Tracking Cursor/Track Line with Data Labels
• /ChartDirector/Tracking Cursor/Track Line with Data Labels Retina
• /ChartDirector/Tracking Cursor/Track Line with Legend

CDDataSetMBS.getLegendIcon as string

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
method	ChartDirector	MBS ChartDirector Plugin	12.3	✅ Yes	✅ Yes	✅ Yes	✅ Yes	All

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

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.

CDDataSetMBS.getPosition(i as Integer) as Double

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
method	ChartDirector	MBS ChartDirector Plugin	12.3	✅ Yes	✅ Yes	✅ Yes	✅ Yes	All

Gets the positional value of a data point.

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.

Argument	Default	Description
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.

CDDataSetMBS.getUseYAxis as CDAxisMBS

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
method	ChartDirector	MBS ChartDirector Plugin	12.3	✅ Yes	✅ Yes	✅ Yes	✅ Yes	All

Gets the y-axis to use when drawing the data set.

Returns an Axis object representing the y-axis to use when drawing the data set.

Some examples using this method:

• /ChartDirector/RealTime ViewPort
• /ChartDirector/Track Line Web
• /ChartDirector/Track Line with Data Labels Retina
• /ChartDirector/Track Line with Legend Retina
• /ChartDirector/Tracking Cursor/Track Line Web
• /ChartDirector/Tracking Cursor/Track Line with Axis Labels
• /ChartDirector/Tracking Cursor/Track Line with Data Labels
• /ChartDirector/Tracking Cursor/Track Line with Data Labels Retina
• /ChartDirector/Tracking Cursor/Track Line with Legend
• /ChartDirector/Tracking Cursor/Track Line with Legend Retina

CDDataSetMBS.getValue(i as Integer) as Double

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
method	ChartDirector	MBS ChartDirector Plugin	12.3	✅ Yes	✅ Yes	✅ Yes	✅ Yes	All

Gets the value of a data point.

Argument	Default	Description
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.

CDDataSetMBS.setData(data() as Double)

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
method	ChartDirector	MBS ChartDirector Plugin	8.2	✅ Yes	✅ Yes	✅ Yes	✅ Yes	All

Sets the data for this dataset.

CDDataSetMBS.setDataColor(dataColor as color, edgeColor as color, shadowColor as color, shadowEdgeColor as color)

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
method	ChartDirector	MBS ChartDirector Plugin	11.1	✅ Yes	✅ Yes	✅ Yes	✅ Yes	All

Same as the other setDataColor method, but uses color instead of integer data type for passing color values.

See also:

• setDataColor(dataColor as Integer, edgeColor as Integer = -1, shadowColor as Integer = -1, shadowEdgeColor as Integer = -1)

CDDataSetMBS.setDataColor(dataColor as Integer, edgeColor as Integer = -1, shadowColor as Integer = -1, shadowEdgeColor as Integer = -1)

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
method	ChartDirector	MBS ChartDirector Plugin	8.2	✅ Yes	✅ Yes	✅ Yes	✅ Yes	All

Sets the colors used to draw the data set.

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

Argument	Default	Description
dataColor	(Mandatory)	The main color used to draw the data set.
edgeColor	-1	The 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	-1	The 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	-1	The 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:

• setDataColor(dataColor as color, edgeColor as color, shadowColor as color, shadowEdgeColor as color)

CDDataSetMBS.setDataLabelFormat(formatString as string)

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
method	ChartDirector	MBS ChartDirector Plugin	8.2	✅ Yes	✅ Yes	✅ Yes	✅ Yes	All

Sets the data label format for the data set.

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.

Argument	Default	Description
formatString	(Mandatory)	The format string.

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	iOS	Targets
method	ChartDirector	MBS ChartDirector Plugin	8.2	✅ Yes	✅ Yes	✅ Yes	✅ Yes	All

Enables data labels and sets their styles.

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.

Argument	Default	Description
font	""	The font used to draw the labels.
fontSize	8	The font size used to draw the labels.
fontColor	TextColor	The color used to draw the labels.
fontAngle	0	The 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:

• setDataLabelStyle(font as string, fontsize as Double, fontcolor as color, fontangle as Double = 0) as CDTextBoxMBS

CDDataSetMBS.setDataLabelStyle(font as string, fontsize as Double, fontcolor as color, fontangle as Double = 0) as CDTextBoxMBS

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
method	ChartDirector	MBS ChartDirector Plugin	11.1	✅ Yes	✅ Yes	✅ Yes	✅ Yes	All

Same as the other setDataLabelStyle method, but uses color instead of integer data type for passing color values.

See also:

• setDataLabelStyle(font as string = "", fontsize as Double = 8, fontcolor as Integer = 0, fontangle as Double = 0) as CDTextBoxMBS

CDDataSetMBS.setDataName(name as string)

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
method	ChartDirector	MBS ChartDirector Plugin	8.2	✅ Yes	✅ Yes	✅ Yes	✅ Yes	All

Sets the name of the data set.

The name will be used in the legend box, if one is available for the chart.

Argument	Default	Description
name	(Mandatory)	The name of the data set.

CDDataSetMBS.setDataSymbol(drawobj as CDDrawAreaMBS)

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
method	ChartDirector	MBS ChartDirector Plugin	8.2	✅ Yes	✅ Yes	✅ Yes	✅ Yes	All

Uses a DrawArea object as the graphics symbol to plot the data points.

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.

Argument	Default	Description
obj	(Mandatory)	A DrawArea object to be used as the symbol.

See also:

• setDataSymbol(file as folderitem)
• setDataSymbol(ImageFilePath as string)
• setDataSymbol(pic as Picture)
• setDataSymbol(polygon() as Integer, size as Integer = 11, fillcolor as Integer = -1, edgeColor as Integer = -1)
• setDataSymbol(polygon() as Integer, size as Integer, fillcolor as color, edgeColor as color)
• setDataSymbol(symbol as Integer, size as Integer = 5, fillColor as Integer = -1, edgeColor as Integer = -1, lineWidth as Integer = 1)
• setDataSymbol(symbol as Integer, size as Integer, fillColor as color, edgeColor as color, lineWidth as Integer = 1)

CDDataSetMBS.setDataSymbol(file as folderitem)

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
method	ChartDirector	MBS ChartDirector Plugin	8.2	✅ Yes	✅ Yes	✅ Yes	✅ Yes	All

Load an image from a file and use it as the graphics symbol to plot the data points.

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.

Argument	Default	Description
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:

• setDataSymbol(drawobj as CDDrawAreaMBS)
• setDataSymbol(ImageFilePath as string)
• setDataSymbol(pic as Picture)
• setDataSymbol(polygon() as Integer, size as Integer = 11, fillcolor as Integer = -1, edgeColor as Integer = -1)
• setDataSymbol(polygon() as Integer, size as Integer, fillcolor as color, edgeColor as color)
• setDataSymbol(symbol as Integer, size as Integer = 5, fillColor as Integer = -1, edgeColor as Integer = -1, lineWidth as Integer = 1)
• setDataSymbol(symbol as Integer, size as Integer, fillColor as color, edgeColor as color, lineWidth as Integer = 1)

CDDataSetMBS.setDataSymbol(ImageFilePath as string)

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
method	ChartDirector	MBS ChartDirector Plugin	12.4	✅ Yes	✅ Yes	✅ Yes	✅ Yes	All

Load an image from a file and use it as the graphics symbol to plot the data points.

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.

Argument	Default	Description
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:

• setDataSymbol(drawobj as CDDrawAreaMBS)
• setDataSymbol(file as folderitem)
• setDataSymbol(pic as Picture)
• setDataSymbol(polygon() as Integer, size as Integer = 11, fillcolor as Integer = -1, edgeColor as Integer = -1)
• setDataSymbol(polygon() as Integer, size as Integer, fillcolor as color, edgeColor as color)
• setDataSymbol(symbol as Integer, size as Integer = 5, fillColor as Integer = -1, edgeColor as Integer = -1, lineWidth as Integer = 1)
• setDataSymbol(symbol as Integer, size as Integer, fillColor as color, edgeColor as color, lineWidth as Integer = 1)

CDDataSetMBS.setDataSymbol(pic as Picture)

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
method	ChartDirector	MBS ChartDirector Plugin	12.4	✅ Yes	✅ Yes	✅ Yes	✅ Yes	All

Uses a picture object as the graphics symbol to plot the data points.

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.

Argument	Default	Description
obj	(Mandatory)	A picture object to be used as the symbol.

See also:

• setDataSymbol(drawobj as CDDrawAreaMBS)
• setDataSymbol(file as folderitem)
• setDataSymbol(ImageFilePath as string)
• setDataSymbol(polygon() as Integer, size as Integer = 11, fillcolor as Integer = -1, edgeColor as Integer = -1)
• setDataSymbol(polygon() as Integer, size as Integer, fillcolor as color, edgeColor as color)
• setDataSymbol(symbol as Integer, size as Integer = 5, fillColor as Integer = -1, edgeColor as Integer = -1, lineWidth as Integer = 1)
• setDataSymbol(symbol as Integer, size as Integer, fillColor as color, edgeColor as color, lineWidth as Integer = 1)

CDDataSetMBS.setDataSymbol(polygon() as Integer, size as Integer = 11, fillcolor as Integer = -1, edgeColor as Integer = -1)

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
method	ChartDirector	MBS ChartDirector Plugin	8.2	✅ Yes	✅ Yes	✅ Yes	✅ Yes	All

Uses a custom polygon as the graphics symbol to plot the data points.

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.

Argument	Default	Description
polygon	(Mandatory)	An array of integers representing the coordinates the polygon vertices. See Shape Specification on how the custom shape is defined.
size	11	The nominal width and height of the symbol in pixels.
fillColor	-1	The color used to fill the symbol. -1 means the color of the data set will be used.
edgeColor	-1	The edge color used to draw the edge of the symbol. -1 means the edge color of the data set will be used.

See also:

• setDataSymbol(drawobj as CDDrawAreaMBS)
• setDataSymbol(file as folderitem)
• setDataSymbol(ImageFilePath as string)
• setDataSymbol(pic as Picture)
• setDataSymbol(polygon() as Integer, size as Integer, fillcolor as color, edgeColor as color)
• setDataSymbol(symbol as Integer, size as Integer = 5, fillColor as Integer = -1, edgeColor as Integer = -1, lineWidth as Integer = 1)
• setDataSymbol(symbol as Integer, size as Integer, fillColor as color, edgeColor as color, lineWidth as Integer = 1)

CDDataSetMBS.setDataSymbol(polygon() as Integer, size as Integer, fillcolor as color, edgeColor as color)

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
method	ChartDirector	MBS ChartDirector Plugin	11.1	✅ Yes	✅ Yes	✅ Yes	✅ Yes	All

Same as the other setDataSymbol method, but uses color instead of integer data type for passing color values.

See also:

• setDataSymbol(drawobj as CDDrawAreaMBS)
• setDataSymbol(file as folderitem)
• setDataSymbol(ImageFilePath as string)
• setDataSymbol(pic as Picture)
• setDataSymbol(polygon() as Integer, size as Integer = 11, fillcolor as Integer = -1, edgeColor as Integer = -1)
• setDataSymbol(symbol as Integer, size as Integer = 5, fillColor as Integer = -1, edgeColor as Integer = -1, lineWidth as Integer = 1)
• setDataSymbol(symbol as Integer, size as Integer, fillColor as color, edgeColor as color, lineWidth as Integer = 1)

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	iOS	Targets
method	ChartDirector	MBS ChartDirector Plugin	8.2	✅ Yes	✅ Yes	✅ Yes	✅ Yes	All

Uses one of the built-in symbols as the graphics symbol to plot the data points.

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.

Argument	Default	Description
symbol	(Mandatory)	One of the predefined shape constants representing the symbol shape. See Shape Specification for the available built-in shapes.
size	5	The width and height of the symbol in pixels.
fillColor	-1	The color used to fill the symbol. -1 means the color of the data set will be used.
edgeColor	-1	The edge color used to draw the edge of the symbol. -1 means the edge color of the data set will be used.
lineWidth	1	The line width used for drawing the symbols.

See also:

• setDataSymbol(drawobj as CDDrawAreaMBS)
• setDataSymbol(file as folderitem)
• setDataSymbol(ImageFilePath as string)
• setDataSymbol(pic as Picture)
• setDataSymbol(polygon() as Integer, size as Integer = 11, fillcolor as Integer = -1, edgeColor as Integer = -1)
• setDataSymbol(polygon() as Integer, size as Integer, fillcolor as color, edgeColor as color)
• setDataSymbol(symbol as Integer, size as Integer, fillColor as color, edgeColor as color, lineWidth as Integer = 1)

CDDataSetMBS.setDataSymbol(symbol as Integer, size as Integer, fillColor as color, edgeColor as color, lineWidth as Integer = 1)

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
method	ChartDirector	MBS ChartDirector Plugin	11.1	✅ Yes	✅ Yes	✅ Yes	✅ Yes	All

Same as the other setDataSymbol method, but uses color instead of integer data type for passing color values.

See also:

• setDataSymbol(drawobj as CDDrawAreaMBS)
• setDataSymbol(file as folderitem)
• setDataSymbol(ImageFilePath as string)
• setDataSymbol(pic as Picture)
• setDataSymbol(polygon() as Integer, size as Integer = 11, fillcolor as Integer = -1, edgeColor as Integer = -1)
• setDataSymbol(polygon() as Integer, size as Integer, fillcolor as color, edgeColor as color)
• setDataSymbol(symbol as Integer, size as Integer = 5, fillColor as Integer = -1, edgeColor as Integer = -1, lineWidth as Integer = 1)

CDDataSetMBS.setLineWidth(w as Integer)

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
method	ChartDirector	MBS ChartDirector Plugin	8.2	✅ Yes	✅ Yes	✅ Yes	✅ Yes	All

Sets the line width of lines when drawing the data set.

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

Argument	Default	Description
w	(Mandatory)	The width of the line in pixels.

CDDataSetMBS.setSymbolOffset(offsetX as Integer, offsetY as Integer)

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
method	ChartDirector	MBS ChartDirector Plugin	15.1	✅ Yes	✅ Yes	✅ Yes	✅ Yes	All

Offset the symbols in the x and y directions in pixel unit.

Argument	Default	Description
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.

CDDataSetMBS.setUseYAxis(axis as CDAxisMBS)

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
method	ChartDirector	MBS ChartDirector Plugin	8.2	✅ Yes	✅ Yes	✅ Yes	✅ Yes	All

Determine if the primary or secondary y-axis should be used when drawing the data set.

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.

Argument	Default	Description
b	true	A true value means the secondary y-axis will be used. A false value means the primary y-axis will be used.

See also:

• setUseYAxis(b as boolean=true)

CDDataSetMBS.setUseYAxis(b as boolean=true)

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
method	ChartDirector	MBS ChartDirector Plugin	8.2	✅ Yes	✅ Yes	✅ Yes	✅ Yes	All

Determine the y-axis to use when drawing the data set.

To set the y-axis to use for all data sets within a layer, use Layer.setUseYAxis.

Argument	Default	Description
a	(Mandatory)	The y-axis to use when drawing the data set.

See also:

• setUseYAxis(axis as CDAxisMBS)