Monkeybread Xojo plugin - CDXYChartMBS methods

CDXYChartMBS.addBoxWhiskerLayer2(boxTop() as Double, boxBottom() as Double, maxData() as Double, minData() as Double) as CDBoxWhiskerLayerMBS

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

Adds a multi-color box-whisker layer to the XYChart, and specify the data sets to use for drawing the layer.

This method is similar to XYChart.addBoxWhiskerLayer, except that the layer will be added in multi-color mode. Please refer to XYChart.addBoxWhiskerLayer on basic information of what is a box-whisker layer.

In multi-color mode, the boxes of a BoxWhiskerLayer can have different fill colors. For the whisker, instead of specifying a single whisker color for all boxes, ChartDirector computes the whisker colors by darkening or brightening the corresponding fill colors using a configurable brightness factor.

Parameter Default Description

boxTop (Mandatory) An array of numbers representing the top edge of the box.

boxBottom (Mandatory) An array of numbers representing the bottom edge of the box.

maxData [Empty_Array] An array of numbers representing the maximum value mark lines.

minData [Empty_Array] An array of numbers representing the minimum value mark lines.

midData [Empty_Array] An array of numbers representing the middle value mark lines.

fillColors [Empty_Array] An array of colors to be used as the fill color of the boxes. If there are insufficient colors in the array for the boxes, the remaining boxes will have their colors automatically selected from the palette.

whiskerBrightness 0.5 The brightness factor for whisker color. A value less than 1 means darkening. A value larger than 1 means brightening. A zero value means black.

names [Empty_Array] An array of names for the boxes to be used in the legend box, if one is configured for the chart.

Return Value
A BoxWhiskerLayer object representing the box-whisker layer created.

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

Adds a multi-color box-whisker layer to the XYChart, and specify the data sets to use for drawing the layer.

This method is similar to XYChart.addBoxWhiskerLayer, except that the layer will be added in multi-color mode. Please refer to XYChart.addBoxWhiskerLayer on basic information of what is a box-whisker layer.

In multi-color mode, the boxes of a BoxWhiskerLayer can have different fill colors. For the whisker, instead of specifying a single whisker color for all boxes, ChartDirector computes the whisker colors by darkening or brightening the corresponding fill colors using a configurable brightness factor.

Parameter Default Description

boxTop (Mandatory) An array of numbers representing the top edge of the box.

boxBottom (Mandatory) An array of numbers representing the bottom edge of the box.

maxData [Empty_Array] An array of numbers representing the maximum value mark lines.

minData [Empty_Array] An array of numbers representing the minimum value mark lines.

midData [Empty_Array] An array of numbers representing the middle value mark lines.

fillColors [Empty_Array] An array of colors to be used as the fill color of the boxes. If there are insufficient colors in the array for the boxes, the remaining boxes will have their colors automatically selected from the palette.

whiskerBrightness 0.5 The brightness factor for whisker color. A value less than 1 means darkening. A value larger than 1 means brightening. A zero value means black.

names [Empty_Array] An array of names for the boxes to be used in the legend box, if one is configured for the chart.

Return Value
A BoxWhiskerLayer object representing the box-whisker layer created.

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

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

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

Adds a multi-color box-whisker layer to the XYChart, and specify the data sets to use for drawing the layer.

This method is similar to XYChart.addBoxWhiskerLayer, except that the layer will be added in multi-color mode. Please refer to XYChart.addBoxWhiskerLayer on basic information of what is a box-whisker layer.

In multi-color mode, the boxes of a BoxWhiskerLayer can have different fill colors. For the whisker, instead of specifying a single whisker color for all boxes, ChartDirector computes the whisker colors by darkening or brightening the corresponding fill colors using a configurable brightness factor.

Parameter Default Description

boxTop (Mandatory) An array of numbers representing the top edge of the box.

boxBottom (Mandatory) An array of numbers representing the bottom edge of the box.

maxData [Empty_Array] An array of numbers representing the maximum value mark lines.

minData [Empty_Array] An array of numbers representing the minimum value mark lines.

midData [Empty_Array] An array of numbers representing the middle value mark lines.

fillColors [Empty_Array] An array of colors to be used as the fill color of the boxes. If there are insufficient colors in the array for the boxes, the remaining boxes will have their colors automatically selected from the palette.

whiskerBrightness 0.5 The brightness factor for whisker color. A value less than 1 means darkening. A value larger than 1 means brightening. A zero value means black.

names [Empty_Array] An array of names for the boxes to be used in the legend box, if one is configured for the chart.

Return Value
A BoxWhiskerLayer object representing the box-whisker layer created.

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

Adds a multi-color box-whisker layer to the XYChart, and specify the data sets to use for drawing the layer.

This method is similar to XYChart.addBoxWhiskerLayer, except that the layer will be added in multi-color mode. Please refer to XYChart.addBoxWhiskerLayer on basic information of what is a box-whisker layer.

In multi-color mode, the boxes of a BoxWhiskerLayer can have different fill colors. For the whisker, instead of specifying a single whisker color for all boxes, ChartDirector computes the whisker colors by darkening or brightening the corresponding fill colors using a configurable brightness factor.

Parameter Default Description

boxTop (Mandatory) An array of numbers representing the top edge of the box.

boxBottom (Mandatory) An array of numbers representing the bottom edge of the box.

maxData [Empty_Array] An array of numbers representing the maximum value mark lines.

minData [Empty_Array] An array of numbers representing the minimum value mark lines.

midData [Empty_Array] An array of numbers representing the middle value mark lines.

fillColors [Empty_Array] An array of colors to be used as the fill color of the boxes. If there are insufficient colors in the array for the boxes, the remaining boxes will have their colors automatically selected from the palette.

whiskerBrightness 0.5 The brightness factor for whisker color. A value less than 1 means darkening. A value larger than 1 means brightening. A zero value means black.

names [Empty_Array] An array of names for the boxes to be used in the legend box, if one is configured for the chart.

Return Value
A BoxWhiskerLayer object representing the box-whisker layer created.

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

See also:

addCandleStickLayer(highData() as Double, lowData() as Double, openData() as Double, closeData() as Double, riseColor as Integer = -1, fallColor as Integer = 0, edgeColor as Integer = &hffff0001) as CDCandleStickLayerMBS

Some examples using this method:

/ChartDirector/candlestick

CDXYChartMBS.addCandleStickLayer(highData() as Double, lowData() as Double, openData() as Double, closeData() as Double, riseColor as Integer = -1, fallColor as Integer = 0, edgeColor as Integer = &hffff0001) as CDCandleStickLayerMBS

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

Adds a candlestick layer to the XYChart, and specify the data sets to use for drawing the layer.

By default, the candlestick symbol will be drawn using the colors specified in the riseColor, fallColor and edgeColor argument. The riseColor and fallColor are used to fill the candle depending on whether the opening value or closing value is larger. The edgeColor is used to the center line and the border of the candle.

Internally, ChartDirector maps the colors of different parts of the candlestick symbol to data set colors as shown in the following table. You may control the colors of the candlestick symbol in more details by setting the data set colors directly. The data set objects can be obtained using Layer.getDataSet, and the colors can be changed using DataSet.setDataColor.

Candlestick Symbol Color Data Set Color

Fill color for "up" candlesticks Data Color for the first data set (index = 0).

Fill color for "down" candlesticks Data Color for the second data set (index = 1).

Border color Edge Color for the first data set (index = 0).

Center line color Edge Color for the second data set (index = 1).

Parameter Default Description

highData (Mandatory) An array of numbers representing the high values.

lowData (Mandatory) An array of numbers representing the low values.

openData (Mandatory) An array of numbers representing the opening values.

closeData (Mandatory) An array of numbers representing the closing values.

riseColor FFFFFF The color used to fill the candle if the closing value is higher than the opening value.

fallColor 000000 The color used to fill the candle if the opening value is higher than the closing value.

edgeColor LineColor The color used to draw the center line and the border of the candle.

Return Value
A CandleStickLayer object representing the candlestick layer created.

See also:

addCandleStickLayer(highData() as Double, lowData() as Double, openData() as Double, closeData() as Double, riseColor as color, fallColor as color, edgeColor as color) as CDCandleStickLayerMBS

CDXYChartMBS.addContourLayer(xData() as Double, yData() as Double, zData() as Double) as CDContourLayerMBS

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

Adds a contour layer to the XYChart, and specify the data sets to use for drawing the layer.

ChartDirector supports both gridded and scattered data. If the data points are on a rectangular grid will no missing points, they will be handled as gridded data. Otherwise, they will be handled as scattered data.
For gridded data, you may provide the x and y values of the grid, and the z values of the data points. For a 10 x 15 grid, that means the x data series should have 10 values, the y data series should have 15 values, and the z data series should have 150 values. The x and y data series should be strictly monotonic (either strictly increasing or strictly decreasing).
For both gridded and scattered data, you may also provide the (x, y, z) values of the data points. For example, for 150 data points, the x, y and z data series should each have 150 values. ChartDirector will automatically detect if the data points are gridded or scattered.

Arguments:

Argument Default Description

xData (Mandatory) An array of numbers representing the x data series.

yData (Mandatory) An array of numbers representing the y data series.

zData (Mandatory) An array of numbers representing the z data series.

Return Value:
A ContourLayer object representing the contour layer created.

Some examples using this method:

CDXYChartMBS.addDiscreteHeatMapLayer(xGrid() as double, yGrid() as Double, zData() as Double) as CDDiscreteHeatMapLayerMBS

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

Adds a discrete heat map layer to the XYChart by specifying the cell values and positions.

The cells are assumed to be arranged as a regular grid. The xGrid and yGrid arrays can be the center coordinates of the cells or the boundary coordinates of the cells.

Suppose there are 9 cells (the zData array contains 9 values). If the xGrid and yGrid arrays each contains 3 values, the cells will be assumed to be arranged as a 3 x 3 grid, and the xGrid and yGrid will be assumed to be the center coordinates of the cells.

If the xGrid array and yGrid array each contains 4 values instead, they will be assumed to be the boundaries of the cells. The first column of cells will occupy the space between xGrid[0] and xGrid[1], the second column between xGrid[1] and xGrid[2], and the third column between xGrid[2] and xGrid[3]. The same applies to the yGrid.

In general, if xGrid and yGrid contains enough values to be used as the boundary coordinates, they will be assumed to be the boundary coordinates. Otherwise they will be assumed to be the center coordinates.

Argument Default Description

xGrid (Mandatory) An array containing the x coordinates of the centers or boundaries of the cells.

yGrid (Mandatory) An array containing the y coordinates of the centers or boundaries of the cells.

zData (Mandatory) An array containing the data values of the cells.

Returns a DiscreteHeatMapLayer object representing the discrete heat map layer created.

See also:

addDiscreteHeatMapLayer(zData() as Double, xCount as Integer) as CDDiscreteHeatMapLayerMBS

Some examples using this method:

CDXYChartMBS.addDiscreteHeatMapLayer(zData() as Double, xCount as Integer) as CDDiscreteHeatMapLayerMBS

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

Adds a discrete heat map layer to the XYChart by specifying the cell values and the cell count in the x direction.

The zData array contains the cell values. xCount is the cell count in the x direction. The cell count in the y direction will be computed as the total cell count (the size of the zData array) divided by xCount.

The boundary of the cells will be at integer axis coordinates 0, 1, 2, ..... In the x direction, the first column of cells will occupy the space between x = 0 and x = 1, the second column between x = 1 and x = 2, and so on. The same applies to the y direction. The first row of cells will be between y = 0 and y = 1, the second row between y = 1 and y = 2, and so on.

This method is often used with Axis.setLabels and Axis.setLabelOffset for axis labelling. The Axis.setLabels put labels at coordinates 0, 1, 2, ... along the axis. The Axis.setLabelOffset can offset the labels by 0.5 units, so the labels will be at 0.5, 1.5, 2.5 ... which corresponds to the center of the cells.

A similar method XYChart.addDiscreteHeatMapLayer2 allows you to specify the exact x and y coordinates for the cells.

Argument Default Description

zData (Mandatory) An array containing the data values of the cells.

xCount (Mandatory) The number of cells in the x direction. The number of cells in the y direction will be computed as the total number of cells (the size of the zData array) divided by xCount.

See also:

addDiscreteHeatMapLayer(xGrid() as double, yGrid() as Double, zData() as Double) as CDDiscreteHeatMapLayerMBS

CDXYChartMBS.addHLOCLayer as CDHLOCLayerMBS

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

Adds an empty high-low-open-close (HLOC) layer to the XYChart.

Return Value
A HLOCLayer object representing the HLOC layer created.

See also:

Some examples using this method:

/ChartDirector/hloc

CDXYChartMBS.addHLOCLayer(highData() as Double, lowData() as Double) as CDHLOCLayerMBS

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

Adds a high-low-open-close (HLOC) layer to the XYChart, and specify the data sets to use for drawing the layer.

In this method, all HLOC symbols will be drawn using the color specified in the color argument. Use XYChart.addHLOCLayer for multi-color HLOC layers.

Internally, ChartDirector maps the colors of different parts of the HLOC symbol to data set colors as shown in the following table. You may control the colors of the HLOC symbol in more details by setting the data set colors directly. The data set objects can be obtained using Layer.getDataSet, and the colors can be changed using DataSet.setDataColor.

HLOC Symbol Color Data Set Color

Central Line Data Color for the first data set (index = 0)

Open Mark Line Data Color for the third data set (index = 2)

Close Mark Line Data Color for the fourth data set (index = 3)

Parameter Default Description

highData (Mandatory) An array of numbers representing the high values. An empty array means there is no high value data available.

lowData (Mandatory) An array of numbers representing the low values. An empty array means there is no low value data available.

openData [Empty_Array] An array of numbers representing the opening values. An empty array means there is no opening value data available.

closeData [Empty_Array] An array of numbers representing the closing values. An empty array means there is no closing value data available.

color -1 The color to draw the HLOC symbol. -1 means that the color is automatically selected from the palette.

Return Value
A HLOCLayer object representing the HLOC layer created.

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

Adds a high-low-open-close (HLOC) layer to the XYChart, and specify the data sets to use for drawing the layer.

In this method, all HLOC symbols will be drawn using the color specified in the color argument. Use XYChart.addHLOCLayer for multi-color HLOC layers.

Internally, ChartDirector maps the colors of different parts of the HLOC symbol to data set colors as shown in the following table. You may control the colors of the HLOC symbol in more details by setting the data set colors directly. The data set objects can be obtained using Layer.getDataSet, and the colors can be changed using DataSet.setDataColor.

HLOC Symbol Color Data Set Color

Central Line Data Color for the first data set (index = 0)

Open Mark Line Data Color for the third data set (index = 2)

Close Mark Line Data Color for the fourth data set (index = 3)

Parameter Default Description

highData (Mandatory) An array of numbers representing the high values. An empty array means there is no high value data available.

lowData (Mandatory) An array of numbers representing the low values. An empty array means there is no low value data available.

openData [Empty_Array] An array of numbers representing the opening values. An empty array means there is no opening value data available.

closeData [Empty_Array] An array of numbers representing the closing values. An empty array means there is no closing value data available.

color -1 The color to draw the HLOC symbol. -1 means that the color is automatically selected from the palette.

Return Value
A HLOCLayer object representing the HLOC layer created.

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

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

Adds a high-low-open-close (HLOC) layer to the XYChart, and specify the data sets to use for drawing the layer.

In this method, all HLOC symbols will be drawn using the color specified in the color argument. Use XYChart.addHLOCLayer for multi-color HLOC layers.

Internally, ChartDirector maps the colors of different parts of the HLOC symbol to data set colors as shown in the following table. You may control the colors of the HLOC symbol in more details by setting the data set colors directly. The data set objects can be obtained using Layer.getDataSet, and the colors can be changed using DataSet.setDataColor.

HLOC Symbol Color Data Set Color

Central Line Data Color for the first data set (index = 0)

Open Mark Line Data Color for the third data set (index = 2)

Close Mark Line Data Color for the fourth data set (index = 3)

Parameter Default Description

highData (Mandatory) An array of numbers representing the high values. An empty array means there is no high value data available.

lowData (Mandatory) An array of numbers representing the low values. An empty array means there is no low value data available.

openData [Empty_Array] An array of numbers representing the opening values. An empty array means there is no opening value data available.

closeData [Empty_Array] An array of numbers representing the closing values. An empty array means there is no closing value data available.

color -1 The color to draw the HLOC symbol. -1 means that the color is automatically selected from the palette.

Return Value
A HLOCLayer object representing the HLOC layer created.

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

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

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

Adds a multi-color high-low-open-close (HLOC) layer to the XYChart, and specify the data sets to use for drawing the layer.

ChartDirector supports drawing the HLOC symbol using different colors depending on whether the data represents an "up" day or "down" day. ChartDirector supports different definitions of what is an "up" day and "down" day, denoted using the following constants.

Constant Value Description

HLOCDefault 0 Do not distinguish between "up" and "down" days and use the same color for all HLOC symbols.

HLOCOpenClose 1 An up day is a day of which the closing value is on or above the opening value. This is the same definition commonly used in candlestick charts.

HLOCUpDown 2 An up day is a day of which the closing value is on or above the closing value of the previous day.

Parameter Default Description

highData (Mandatory) An array of numbers representing the high values. An empty array means there is no high value data available.

lowData (Mandatory) An array of numbers representing the low values. An empty array means there is no low value data available.

openData (Mandatory) An array of numbers representing the opening values. An empty array means there is no opening value data available.

closeData (Mandatory) An array of numbers representing the closing values. An empty array means there is no closing value data available.

upColor (Mandatory) The color to be used on an "up" day.

downColor (Mandatory) The color to be used on a "down" day.

colorMode -1 The method used to determine if a day is an "up" or "down". Must be one of the constants in the above table. The default value of -1 means the colorMode is automatically determine to be either HLOCDefault or HLOCUpDown, depending on whether upColor and downColor are the same or different.

leadValue [-Infinity] The lead value to act as the closing pricing before the first day, so as to determine if the first day is an "up" or "down" day.

Return Value
A HLOCLayer object representing the HLOC layer created.

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

Adds a multi-color high-low-open-close (HLOC) layer to the XYChart, and specify the data sets to use for drawing the layer.

ChartDirector supports drawing the HLOC symbol using different colors depending on whether the data represents an "up" day or "down" day. ChartDirector supports different definitions of what is an "up" day and "down" day, denoted using the following constants.

Constant Value Description

HLOCDefault 0 Do not distinguish between "up" and "down" days and use the same color for all HLOC symbols.

HLOCOpenClose 1 An up day is a day of which the closing value is on or above the opening value. This is the same definition commonly used in candlestick charts.

HLOCUpDown 2 An up day is a day of which the closing value is on or above the closing value of the previous day.

Parameter Default Description

highData (Mandatory) An array of numbers representing the high values. An empty array means there is no high value data available.

lowData (Mandatory) An array of numbers representing the low values. An empty array means there is no low value data available.

openData (Mandatory) An array of numbers representing the opening values. An empty array means there is no opening value data available.

closeData (Mandatory) An array of numbers representing the closing values. An empty array means there is no closing value data available.

upColor (Mandatory) The color to be used on an "up" day.

downColor (Mandatory) The color to be used on a "down" day.

colorMode -1 The method used to determine if a day is an "up" or "down". Must be one of the constants in the above table. The default value of -1 means the colorMode is automatically determine to be either HLOCDefault or HLOCUpDown, depending on whether upColor and downColor are the same or different.

leadValue [-Infinity] The lead value to act as the closing pricing before the first day, so as to determine if the first day is an "up" or "down" day.

Return Value
A HLOCLayer object representing the HLOC layer created.

See also:

CDXYChartMBS.addInterLineLayer(line1 as CDLineObjMBS, line2 as CDLineObjMBS, color12 as color, color21 as color) as CDInterLineLayerMBS

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

See also:

addInterLineLayer(line1 as CDLineObjMBS, line2 as CDLineObjMBS, color12 as Integer, color21 as Integer = -1) as CDInterLineLayerMBS

Some examples using this method:

CDXYChartMBS.addInterLineLayer(line1 as CDLineObjMBS, line2 as CDLineObjMBS, color12 as Integer, color21 as Integer = -1) as CDInterLineLayerMBS

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

Adds an inter-line layer the XYChart. An inter-line layer is used to fill the region between any two lines (straight lines, spline curves, step lines, etc).

This method expects two "line" objects representing the two lines. The line objects can be obtained using LineLayer.getLine (inherited by SplineLayer and StepLineLayer), TrendLayer.getLine, and Mark.getLine.

Parameter Default Description

line1 (Mandatory) An opaque line object representing the first line.

line2 (Mandatory) An opaque line object representing the second line.

color12 (Mandatory) The color used to fill the region of the lines when line1 > line2.

color21 -1 The color used to fill the region of the lines when line2 > line1. -1 means this color is the same as color12.

Return Value
An InterLineLayer object representing the inter-line layer created.

See also:

addInterLineLayer(line1 as CDLineObjMBS, line2 as CDLineObjMBS, color12 as color, color21 as color) as CDInterLineLayerMBS

CDXYChartMBS.addLineLayer(data as CDArrayMBS, colorvalue as color, name as string = "", depth as Integer = 0) as CDLineLayerMBS

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

See also:

CDXYChartMBS.addLineLayer(data as CDArrayMBS, colorvalue as Integer = -1, name as string = "", depth as Integer = 0) as CDLineLayerMBS

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

Adds a line layer to the XYChart, and specify the data set to use for drawing the line.

Parameter Default Description

data (Mandatory) An array of numbers representing the data set.

color -1 The color to draw the line. -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.

depth 0 The 3D depth of the line layer.

Return Value
A LineLayer object representing the line layer created.

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

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

Adds a line layer to the XYChart, and specify the data set to use for drawing the line.

Parameter Default Description

data (Mandatory) An array of numbers representing the data set.

color -1 The color to draw the line. -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.

depth 0 The 3D depth of the line layer.

Return Value
A LineLayer object representing the line layer created.

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

Adds an empty line layer to the XYChart.

This method is typically used to add multiple data sets to a single line layer. First an empty line layer is created, then the data sets can be added using Layer.addDataSet.

Parameter Default Description

dataCombineMethod Overlay In this version of ChartDirector, this parameter is ignored.

depth 0 The 3D depth of the line layer.

Return Value
A LineLayer object representing the line layer created.

See also:

CDXYChartMBS.addLineLayer(fastDB as CDDataAcceleratorMBS, seriesId as string, color as integer = -1, name as string = "") as CDLineLayerMBS

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

Adds a line layer using data from a DataAccelerator.

The LineLayer created using this method will use only the data series provided by the DataAccelerator. It does not support adding more data sets, that is, Layer.addDataSet or Layer.setXData should not be used. Additional LineLayer objects should be used to plot other data series.

Argument Default Description

fastDB (Mandatory) The CDDataAcceleratorMBS object that provides the x and y data values.

seriesId (Mandatory) The id of the data series. The DataAccelerator will provide the x data series and the y data series with the specified id to the LineLayer.

color -1 The color to draw the line. -1 means that the color is automatically selected from the palette.

name "" The name of the data series. The name will be used in the legend box, if one is available. An empty string means the data set has no name.

Returns a CDLineLayerMBS object representing the line layer created.

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

Adds a scatter chart layer to the XYChart.

A scatter chart can be considered as a special configuration of a line chart, in the data symbols are enabled and the line width is set to zero. Therefore only the data symbols are visible and the chart appears as scattered.

Parameter Default Description

xData (Mandatory) An array of numbers representing the x values of the data points. If no explicit x coordinates are used in the chart (eg. using an enumerated x-axis), an empty array may be used for this argument.

yData (Mandatory) An array of numbers representing the y values of the data points.

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.

symbol SquareShape One of the predefined symbol constants to specify the symbol to use. (See Shape Specification for available built-in shapes.)

symbolSize 5 The width and height of the symbol in pixels.

fillColor -1 The color used to fill the symbol. -1 means that the color is automatically selected from the palette.

edgeColor -1 The edge color used to draw the edge of the symbol. The default value of -1 means using LineColor as the edge color.

Return Value
A ScatterLayer object representing the scatter layer created.

See also:

Some examples using this method:

CDXYChartMBS.addScatterLayer(xData() as Double, yData() as Double, name as string, symbol as Integer, symbolSize as Integer, fillColor as color, edgeColor as color) as CDScatterLayerMBS

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

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
method	ChartDirector	MBS ChartDirector Plugin	9.6	✅ Yes	✅ Yes	✅ Yes	❌ No	Desktop, Console & Web

Adds a scatter chart layer to the XYChart.

A scatter chart can be considered as a special configuration of a line chart, in the data symbols are enabled and the line width is set to zero. Therefore only the data symbols are visible and the chart appears as scattered.

Parameter Default Description

xData (Mandatory) An array of numbers representing the x values of the data points. If no explicit x coordinates are used in the chart (eg. using an enumerated x-axis), an empty array may be used for this argument.

yData (Mandatory) An array of numbers representing the y values of the data points.

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.

symbol SquareShape One of the predefined symbol constants to specify the symbol to use. (See Shape Specification for available built-in shapes.)

symbolSize 5 The width and height of the symbol in pixels.

fillColor -1 The color used to fill the symbol. -1 means that the color is automatically selected from the palette.

edgeColor -1 The edge color used to draw the edge of the symbol. The default value of -1 means using LineColor as the edge color.

Return Value
A ScatterLayer object representing the scatter layer created.

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
method	ChartDirector	MBS ChartDirector Plugin	11.1	✅ Yes	✅ Yes	✅ Yes	❌ No	Desktop, Console & Web

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

See also:

Parameter	Default	Description
boxTop	(Mandatory)	An array of numbers representing the top edge of the box.
boxBottom	(Mandatory)	An array of numbers representing the bottom edge of the box.
maxData	[Empty_Array]	An array of numbers representing the maximum value mark lines.
minData	[Empty_Array]	An array of numbers representing the minimum value mark lines.
midData	[Empty_Array]	An array of numbers representing the middle value mark lines.
fillColors	[Empty_Array]	An array of colors to be used as the fill color of the boxes. If there are insufficient colors in the array for the boxes, the remaining boxes will have their colors automatically selected from the palette.
whiskerBrightness	0.5	The brightness factor for whisker color. A value less than 1 means darkening. A value larger than 1 means brightening. A zero value means black.
names	[Empty_Array]	An array of names for the boxes to be used in the legend box, if one is configured for the chart.

Candlestick Symbol Color	Data Set Color
Fill color for "up" candlesticks	Data Color for the first data set (index = 0).
Fill color for "down" candlesticks	Data Color for the second data set (index = 1).
Border color	Edge Color for the first data set (index = 0).
Center line color	Edge Color for the second data set (index = 1).

Argument	Default	Description
xData	(Mandatory)	An array of numbers representing the x data series.
yData	(Mandatory)	An array of numbers representing the y data series.
zData	(Mandatory)	An array of numbers representing the z data series.

HLOC Symbol Color	Data Set Color
Central Line	Data Color for the first data set (index = 0)
Open Mark Line	Data Color for the third data set (index = 2)
Close Mark Line	Data Color for the fourth data set (index = 3)

Constant	Value	Description
HLOCDefault	0	Do not distinguish between "up" and "down" days and use the same color for all HLOC symbols.
HLOCOpenClose	1	An up day is a day of which the closing value is on or above the opening value. This is the same definition commonly used in candlestick charts.
HLOCUpDown	2	An up day is a day of which the closing value is on or above the closing value of the previous day.