Xojo Conferences
MBSOct2019CologneDE

Platforms to show: All Mac Windows Linux Cross-Platform

Next items

CDXYChartMBS.addAreaLayer(data() as Double, colorvalue as Integer = -1, name as string = "", depth as Integer = 0) as CDAreaLayerMBS
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 area chart layer to the XYChart, and specify the data set to use for drawing the area.
Notes:
ParameterDefaultDescription
data(Mandatory)An array of numbers representing the data set.
color-1The color to draw the area. -1 means that the color is automatically selected from the color 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.
depth0The 3D depth of the area layer.

Return Value
An AreaLayer object representing the area layer created.

See also:

Feedback, Comments & Corrections

CDXYChartMBS.addAreaLayer(dataCombineMethod as Integer = 1, depth as Integer = 0) as CDAreaLayerMBS
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 empty area chart layer to the XYChart.
Notes:
This method is typically used to add multiple data sets to a single bar layer. First an empty area chart layer is created, then the data sets can be added using Layer.addDataSet.

The dataCombineMethod parameter specifies how to combine the data sets together in the area layer. The followings methods are supported:

ConstantValueDescription
Stack1The data sets are combined by stacking up the areas.
Percentage4The data sets are combined similar to stacked area, except that the data are scaled so that the area always stacked up to 100. An area strip within the stacked area therefore represents the percentage of the data item relative to sum of all the data items in the stacked area.

ParameterDefaultDescription
dataCombineMethodStackThe method to combine the data sets together in the area layer.
depth0The 3D depth of the area layer.

Return Value
An AreaLayer object representing the area layer created.

See also:

Feedback, Comments & Corrections

CDXYChartMBS.addAreaLayer(dates() as date, colorvalue as Integer = -1, name as string = "", depth as Integer = 0) as CDAreaLayerMBS
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method ChartDirector MBS ChartDirector Plugin 9.6 Yes Yes Yes Yes No
Function: Adds an area chart layer to the XYChart, and specify the data set to use for drawing the area.
Notes:
ParameterDefaultDescription
data(Mandatory)An array of numbers representing the data set.
color-1The color to draw the area. -1 means that the color is automatically selected from the color 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.
depth0The 3D depth of the area layer.

Return Value
An AreaLayer object representing the area layer created.

See also:

Feedback, Comments & Corrections

CDXYChartMBS.addAxis(align as Integer, offset as Integer) 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: Adds an additional axis to the chart.
Notes:
By default, ChartDirector XY charts have 2 x-axes and 2 y-axes at the 4 borders of the plot area. The addAxis method can be used to create additional axis.

The new axis will be put at one of the 4 borders of the plot area. To avoid overlapping with existing axis, the new axis will not be put exactly as the plot area border, but at an offset from it.

ParameterDefaultDescription
align(Mandatory)Specifies which side of the plot area is the primary side of the axis. Must be one of the constants Left, Right, Top and Bottom for the 4 sides of the plot area.
offset(Mandatory)An offset in pixels to move the axis away from the plot area. If a negative value is used, it will mean to move the axis into the plot area.

Feedback, Comments & Corrections

CDXYChartMBS.addBarLayer(data() as Double, colors() as Integer, depth as Integer = 0) as CDBarLayerMBS
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 empty bar layer to the XYChart.
Example:
// Create a XYChart object of size 250 x 250 pixels
dim c as new CDXYChartMBS(250, 250)

// Add a bar chart layer using the given data
dim t as CDTextBoxMBS = c.addBarLayer(data)
t.setPos(0, -10) // move 10 up
Notes:
This method is typically used to add multiple data sets to a single bar layer. First an empty bar layer is created, then the data sets can be added using Layer.addDataSet.

The dataCombineMethod parameter specifies how to combine the data sets together in the bar layer. The followings methods are supported:

ConstantValueDescription
Side3The data sets are combined by plotting the bars side by side.
Stack1The data sets are combined by stacking up the bar segments.
Overlay0The data sets are combined similar to stacked bars. However, in Overlay, one data set is assumed to already include the other data set. For example, if the data sets are "average" and "peak", the "peak" cannot be stacked on top of "average", because the "peak" already contains "average". In the Overlay style, only "peak - average" is stacked on top of "average", and so the total bar length will be "peak".
Percentage4The data sets are combined similar to stacked bars, except that the data in a bar are scaled so that they summed to 100. In other words, all stacked bars will be of the same length. A bar segment within a bar represents the percentage of the data item relative to sum of all the data items in the stacked bar.

ParameterDefaultDescription
dataCombineMethodSideThe method to combine the data sets together in the bar layer.
depth0The 3D depth of the bar layer.

Return Value
A BarLayer object representing the bar layer created.

To set some more options like transparent border of the bar, please use the methods in CDBarLayerMBS class. e.g. setBorderColor(CDXYChartMBS.kTransparent) will make them transparent.

See also:

Feedback, Comments & Corrections

CDXYChartMBS.addBarLayer(data() as Double, colors() as Integer, names() as string, depth as Integer = 0) as CDBarLayerMBS
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 multi-color bar layer to the XYChart, and specify the data set to use for drawing the bars.
Notes:
A multi-color bar layer is a bar layer in which each bar has a different color. In a normal bar layer, each data set has a different color, but the bars in the same data set have the same color.

ParameterDefaultDescription
data(Mandatory)An array of numbers representing the data set.
colors(Mandatory)An array of colors to draw the bars. An empty array means the colors are automatically selected from the palette.
names[Empty_Array]An array of text strings as the names of the bars. The names will be used in the legend box, if one is available. An empty array means that bars have no name.
depth0The 3D depth of the bar layer.

Return Value
A BarLayer object representing the bar layer created.

To set some more options like transparent border of the bar, please use the methods in CDBarLayerMBS class. e.g. setBorderColor(CDXYChartMBS.kTransparent) will make them transparent.

See also:

Feedback, Comments & Corrections

CDXYChartMBS.addBarLayer(data() as Double, colorvalue as Integer = -1, name as string = "", depth as Integer = 0) as CDBarLayerMBS
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 bar layer to the XYChart, and specify the data set to use for drawing the bars.
Notes:
ParameterDefaultDescription
data(Mandatory)An array of numbers representing the data set.
color-1The color to draw the bars. -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.
depth0The 3D depth of the bar layer.

Return Value
A BarLayer object representing the bar layer created.

To set some more options like transparent border of the bar, please use the methods in CDBarLayerMBS class. e.g. setBorderColor(CDXYChartMBS.kTransparent) will make them transparent.

See also:

Feedback, Comments & Corrections

CDXYChartMBS.addBarLayer(dataCombineMethod as Integer = 3, depth as Integer = 0) as CDBarLayerMBS
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 empty bar layer to the XYChart.
Notes:
This method is typically used to add multiple data sets to a single bar layer. First an empty bar layer is created, then the data sets can be added using
Layer.addDataSet.

The dataCombineMethod parameter specifies how to combine the data sets together in the bar layer. The followings methods are supported:

ConstantValueDescription
Side3The data sets are combined by plotting the bars side by side.
Stack1The data sets are combined by stacking up the bar segments.
Overlay0The data sets are combined similar to stacked bars. However, in Overlay, one data set is assumed to already include the other data set. For example, if the data sets are "average" and "peak", the "peak" cannot be stacked on top of "average", because the "peak" already contains "average". In the Overlay style, only "peak - average" is stacked on top of "average", and so the total bar length will be "peak".
Percentage4The data sets are combined similar to stacked bars, except that the data in a bar are scaled so that they summed to 100. In other words, all stacked bars will be of the same length. A bar segment within a bar represents the percentage of the data item relative to sum of all the data items in the stacked bar.

ParameterDefaultDescription
dataCombineMethodSideThe method to combine the data sets together in the bar layer.
depth0The 3D depth of the bar layer.

Return Value
A BarLayer object representing the bar layer created.

To set some more options like transparent border of the bar, please use the methods in CDBarLayerMBS class. e.g. setBorderColor(CDXYChartMBS.kTransparent) will make them transparent.

See also:

Feedback, Comments & Corrections

CDXYChartMBS.addBoxLayer(boxTop() as Double, boxBottom() as Double, colorvalue as color, name as string = "") as CDBoxWhiskerLayerMBS
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 addBoxLayer method, but uses color instead of integer data type for passing color values.

See also:

Feedback, Comments & Corrections

CDXYChartMBS.addBoxLayer(boxTop() as Double, boxBottom() as Double, colorvalue as Integer = -1, name as string = "") as CDBoxWhiskerLayerMBS
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 floating box layer to the XYChart, and specify the data sets to use for drawing the layer.
Notes:
This method is a simplification of XYChart.addBoxWhiskerLayer. Instead of adding a full box-whisker layer, only the box part is used, resulting in a chart layer displaying floating boxes.

ParameterDefaultDescription
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.
color-1The color to draw the area. -1 means that the color is automatically selected from the color 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 BoxWhiskerLayer object representing the box-whisker layer created.

See also:

Feedback, Comments & Corrections

CDXYChartMBS.addBoxWhiskerLayer(boxTop() as Double, boxBottom() as Double) as CDBoxWhiskerLayerMBS
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 box-whisker layer to the XYChart, and specify the data sets to use for drawing the layer.
Notes:
Traditionally, each box-whisker symbol represents 5 values, which are the as maximum, 3rd quartile, median, 1st quartile and minimum of some data samples.

A vertical box-whisker symbol (on a non-swapped XY chart) consists of a vertical line joining the maximum and minimum points, a box extending from the 1st quartile point to the 3rd quartile point, and 3 horizontal mark lines at the maximum, median and minimum points.

In practice, the box-whisker symbol is not limited to representing the maximum, 3rd quartile, median, 1st quartile and minimum values. It can be used to represent any ordered values.

The boxTop and boxBottom data sets specifies the top and bottom edges of the box. The maxData, minData and midData specifies the top, bottom and middle mark lines.

You can use empty arrays to disable showing some parts of the box-whisker symbol.

For example, if you just want to show a floating box, you can use only boxTop and boxBottom and set the maxData, minData and midData to empty arrays.

Similarly, if the boxTop, boxBottom and midData are set to empty arrays, only the top and bottom mark lines and the joining center line are visible. This style is most often used as "error bands" together with line charts.

In addition to maxData, minData and midData, you can add additional mark lines to the box-whisker element by adding more data sets using Layer.addDataSet.

By default, the box-whisker symbol will be drawn using the colors specified in the fillColor, whiskerColor and edgeColor argument. The fillColor and edgeColor are used as the fill and border colors of the box, while the whiskerColor is used as the color of the center line and the mark lines.

Internally, ChartDirector maps the colors of different parts of the box-whisker symbol to data set colors as shown in the following table. You may control the colors of the box-whisker 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.

Box-Whisker Symbol ColorData Set Color
Fill color of the boxData Color for the first data set (index = 0)
Border color of the boxEdge Color for the first data set (index = 0)
Center line colorData Color for the second data set (index = 1)
Maximum value mark line colorData Color for the third data set (index = 2)
Minimum value mark line colorData Color for the fourth data set (index = 3)
Middle value mark line colorData Color for the fifth data set (index = 4)
Mark line color for additional mark linesData Color for the data set representing the additional mark line

ParameterDefaultDescription
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.
fillColor-1The color used to fill the box. -1 means that the color is automatically selected from the palette.
whiskerColorLineColorThe color used to draw the central line and mark lines.
edgeColorLineColorThe color used to draw the border of the box.

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

See also:

Feedback, Comments & Corrections

CDXYChartMBS.addBoxWhiskerLayer(boxTop() as Double, boxBottom() as Double, maxData() as Double) as CDBoxWhiskerLayerMBS
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 box-whisker layer to the XYChart, and specify the data sets to use for drawing the layer.
Notes:
Traditionally, each box-whisker symbol represents 5 values, which are the as maximum, 3rd quartile, median, 1st quartile and minimum of some data samples.

A vertical box-whisker symbol (on a non-swapped XY chart) consists of a vertical line joining the maximum and minimum points, a box extending from the 1st quartile point to the 3rd quartile point, and 3 horizontal mark lines at the maximum, median and minimum points.

In practice, the box-whisker symbol is not limited to representing the maximum, 3rd quartile, median, 1st quartile and minimum values. It can be used to represent any ordered values.

The boxTop and boxBottom data sets specifies the top and bottom edges of the box. The maxData, minData and midData specifies the top, bottom and middle mark lines.

You can use empty arrays to disable showing some parts of the box-whisker symbol.

For example, if you just want to show a floating box, you can use only boxTop and boxBottom and set the maxData, minData and midData to empty arrays.

Similarly, if the boxTop, boxBottom and midData are set to empty arrays, only the top and bottom mark lines and the joining center line are visible. This style is most often used as "error bands" together with line charts.

In addition to maxData, minData and midData, you can add additional mark lines to the box-whisker element by adding more data sets using Layer.addDataSet.

By default, the box-whisker symbol will be drawn using the colors specified in the fillColor, whiskerColor and edgeColor argument. The fillColor and edgeColor are used as the fill and border colors of the box, while the whiskerColor is used as the color of the center line and the mark lines.

Internally, ChartDirector maps the colors of different parts of the box-whisker symbol to data set colors as shown in the following table. You may control the colors of the box-whisker 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.

Box-Whisker Symbol ColorData Set Color
Fill color of the boxData Color for the first data set (index = 0)
Border color of the boxEdge Color for the first data set (index = 0)
Center line colorData Color for the second data set (index = 1)
Maximum value mark line colorData Color for the third data set (index = 2)
Minimum value mark line colorData Color for the fourth data set (index = 3)
Middle value mark line colorData Color for the fifth data set (index = 4)
Mark line color for additional mark linesData Color for the data set representing the additional mark line

ParameterDefaultDescription
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.
fillColor-1The color used to fill the box. -1 means that the color is automatically selected from the palette.
whiskerColorLineColorThe color used to draw the central line and mark lines.
edgeColorLineColorThe color used to draw the border of the box.

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

See also:

Feedback, Comments & Corrections

CDXYChartMBS.addBoxWhiskerLayer(boxTop() as Double, boxBottom() as Double, maxData() as Double, minData() as Double) as CDBoxWhiskerLayerMBS
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 box-whisker layer to the XYChart, and specify the data sets to use for drawing the layer.
Notes:
Traditionally, each box-whisker symbol represents 5 values, which are the as maximum, 3rd quartile, median, 1st quartile and minimum of some data samples.

A vertical box-whisker symbol (on a non-swapped XY chart) consists of a vertical line joining the maximum and minimum points, a box extending from the 1st quartile point to the 3rd quartile point, and 3 horizontal mark lines at the maximum, median and minimum points.

In practice, the box-whisker symbol is not limited to representing the maximum, 3rd quartile, median, 1st quartile and minimum values. It can be used to represent any ordered values.

The boxTop and boxBottom data sets specifies the top and bottom edges of the box. The maxData, minData and midData specifies the top, bottom and middle mark lines.

You can use empty arrays to disable showing some parts of the box-whisker symbol.

For example, if you just want to show a floating box, you can use only boxTop and boxBottom and set the maxData, minData and midData to empty arrays.

Similarly, if the boxTop, boxBottom and midData are set to empty arrays, only the top and bottom mark lines and the joining center line are visible. This style is most often used as "error bands" together with line charts.

In addition to maxData, minData and midData, you can add additional mark lines to the box-whisker element by adding more data sets using Layer.addDataSet.

By default, the box-whisker symbol will be drawn using the colors specified in the fillColor, whiskerColor and edgeColor argument. The fillColor and edgeColor are used as the fill and border colors of the box, while the whiskerColor is used as the color of the center line and the mark lines.

Internally, ChartDirector maps the colors of different parts of the box-whisker symbol to data set colors as shown in the following table. You may control the colors of the box-whisker 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.

Box-Whisker Symbol ColorData Set Color
Fill color of the boxData Color for the first data set (index = 0)
Border color of the boxEdge Color for the first data set (index = 0)
Center line colorData Color for the second data set (index = 1)
Maximum value mark line colorData Color for the third data set (index = 2)
Minimum value mark line colorData Color for the fourth data set (index = 3)
Middle value mark line colorData Color for the fifth data set (index = 4)
Mark line color for additional mark linesData Color for the data set representing the additional mark line

ParameterDefaultDescription
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.
fillColor-1The color used to fill the box. -1 means that the color is automatically selected from the palette.
whiskerColorLineColorThe color used to draw the central line and mark lines.
edgeColorLineColorThe color used to draw the border of the box.

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

See also:

Feedback, Comments & Corrections

CDXYChartMBS.addBoxWhiskerLayer(boxTop() as Double, boxBottom() as Double, maxData() as Double, minData() as Double, midData() as Double, fillColor as Integer = -1, whiskerColor as Integer = &hffff0001, edgeColor as Integer = -1) as CDBoxWhiskerLayerMBS
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 box-whisker layer to the XYChart, and specify the data sets to use for drawing the layer.
Notes:
Traditionally, each box-whisker symbol represents 5 values, which are the as maximum, 3rd quartile, median, 1st quartile and minimum of some data samples.

A vertical box-whisker symbol (on a non-swapped XY chart) consists of a vertical line joining the maximum and minimum points, a box extending from the 1st quartile point to the 3rd quartile point, and 3 horizontal mark lines at the maximum, median and minimum points.

In practice, the box-whisker symbol is not limited to representing the maximum, 3rd quartile, median, 1st quartile and minimum values. It can be used to represent any ordered values.

The boxTop and boxBottom data sets specifies the top and bottom edges of the box. The maxData, minData and midData specifies the top, bottom and middle mark lines.

You can use empty arrays to disable showing some parts of the box-whisker symbol.

For example, if you just want to show a floating box, you can use only boxTop and boxBottom and set the maxData, minData and midData to empty arrays.

Similarly, if the boxTop, boxBottom and midData are set to empty arrays, only the top and bottom mark lines and the joining center line are visible. This style is most often used as "error bands" together with line charts.

In addition to maxData, minData and midData, you can add additional mark lines to the box-whisker element by adding more data sets using Layer.addDataSet.

By default, the box-whisker symbol will be drawn using the colors specified in the fillColor, whiskerColor and edgeColor argument. The fillColor and edgeColor are used as the fill and border colors of the box, while the whiskerColor is used as the color of the center line and the mark lines.

Internally, ChartDirector maps the colors of different parts of the box-whisker symbol to data set colors as shown in the following table. You may control the colors of the box-whisker 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.

Box-Whisker Symbol ColorData Set Color
Fill color of the boxData Color for the first data set (index = 0)
Border color of the boxEdge Color for the first data set (index = 0)
Center line colorData Color for the second data set (index = 1)
Maximum value mark line colorData Color for the third data set (index = 2)
Minimum value mark line colorData Color for the fourth data set (index = 3)
Middle value mark line colorData Color for the fifth data set (index = 4)
Mark line color for additional mark linesData Color for the data set representing the additional mark line

ParameterDefaultDescription
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.
fillColor-1The color used to fill the box. -1 means that the color is automatically selected from the palette.
whiskerColorLineColorThe color used to draw the central line and mark lines.
edgeColorLineColorThe color used to draw the border of the box.

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

See also:

Feedback, Comments & Corrections

CDXYChartMBS.addBoxWhiskerLayer2(boxTop() as Double, boxBottom() as Double) as CDBoxWhiskerLayerMBS
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 multi-color box-whisker layer to the XYChart, and specify the data sets to use for drawing the layer.
Notes:
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.

ParameterDefaultDescription
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.
whiskerBrightness0.5The 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.

See also:

Feedback, Comments & Corrections

CDXYChartMBS.addBoxWhiskerLayer2(boxTop() as Double, boxBottom() as Double, maxData() as Double) as CDBoxWhiskerLayerMBS
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 multi-color box-whisker layer to the XYChart, and specify the data sets to use for drawing the layer.
Notes:
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.

ParameterDefaultDescription
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.
whiskerBrightness0.5The 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.

See also:

Feedback, Comments & Corrections

CDXYChartMBS.addBoxWhiskerLayer2(boxTop() as Double, boxBottom() as Double, maxData() as Double, minData() as Double) as CDBoxWhiskerLayerMBS
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 multi-color box-whisker layer to the XYChart, and specify the data sets to use for drawing the layer.
Notes:
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.

ParameterDefaultDescription
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.
whiskerBrightness0.5The 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.

See also:

Feedback, Comments & Corrections

Next items

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

The biggest plugin in space...




Links
MBS Xojo PDF Plugins