Platforms to show: All Mac Windows Linux Cross-Platform
Back to CDLayerMBS class.
CDLayerMBS.addCustomAggregateLabel(dataItem as Integer, label as string, font as string = "", fontSize as Double = 8, fontColor as Integer = &hffff0002, fontAngle as Double = 0) as CDTextBoxMBS
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| method | ChartDirector | MBS ChartDirector Plugin | 8.2 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
Aggregate data labels applies to layer types that contains "aggregated data", such as stacked bar layer and stacked area layer. In these layer types, data labels (see Layer.setDataLabelStyle) represents a single data item, while aggregate labels represents the stacked object.
See Font Specification for details on various font attributes.
| Argument | Default | Description |
|---|---|---|
| dataItem | (Mandatory) | The index of the aggregated object. The first aggregated object is 0, while the nth aggregated object is (n - 1). |
| label | (Mandatory) | A text string representing the custom aggregate label. Parameter Substitution and Formatting is supported. |
| font | "" | The font used to draw the labels. |
| 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. |
A TextBox object representing the prototype of the obj. This may be used to fine-tune the appearance of the obj.
See font specification here:
http://www.monkeybreadsoftware.net/faq-chartdirectorfontspecification.shtml
See also:
CDLayerMBS.addCustomAggregateLabel(dataItem as Integer, label as string, font as string, fontSize as Double, fontColor as color, fontAngle as Double = 0) as CDTextBoxMBS
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| method | ChartDirector | MBS ChartDirector Plugin | 11.1 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
See also:
CDLayerMBS.addCustomDataLabel(dataSet as Integer, dataItem as Integer, label as string, font as string = "", fontSize as Double = 8, fontColor as Integer = &hffff0002, fontAngle as Double = 0) as CDTextBoxMBS
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| method | ChartDirector | MBS ChartDirector Plugin | 8.2 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
Data labels are text used label data points in the layer. Please refer to Layer.setDataLabelStyle for a more detail description.
See Font Specification for details on various font attributes.
| Argument | Default | Description |
|---|---|---|
| dataSet | (Mandatory) | The data set number for the data point. The first data set is 0, while the nth data set is (n - 1). |
| dataItem | (Mandatory) | The data point number for the data point within the data set. The first data point is 0, while the nth data point is (n - 1). |
| label | (Mandatory) | A text string representing the data label. Parameter Substitution and Formatting is supported. |
| font | "" | The font used to draw the label. |
| fontSize | 8 | The font size used to draw the label. |
| fontColor | TextColor | The color used to draw the label. |
| fontAngle | 0 | The rotation angle of the label. |
A TextBox object representing the prototype of the obj. This may be used to fine-tune the appearance of the obj.
See font specification here:
http://www.monkeybreadsoftware.net/faq-chartdirectorfontspecification.shtml
See also:
CDLayerMBS.addCustomDataLabel(dataSet as Integer, dataItem as Integer, label as string, font as string, fontSize as Double, fontColor as color, fontAngle as Double = 0) as CDTextBoxMBS
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| method | ChartDirector | MBS ChartDirector Plugin | 11.1 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
See also:
CDLayerMBS.addCustomGroupLabel(dataGroup as Integer, dataItem as Integer, label as string, font as string ="", fontSize as Double = 8, fontColor as Integer = &hffff0002, fontAngle as Double = 0) as CDTextBoxMBS
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| method | ChartDirector | MBS ChartDirector Plugin | 8.2 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
Data group label applies to layer types that may represent data groups. See Layer.addDataGroup on how data groups are created and the layer types that support data groups.
See Font Specification for details on various font attributes.
| Argument | Default | Description |
|---|---|---|
| dataGroup | (Mandatory) | The data group number for the data point. The first data group is 0, while the nth data group is (n - 1). |
| dataItem | (Mandatory) | The data point number for the data point within the data group. The first data point is 0, while the nth data point is (n - 1). |
| label | (Mandatory) | A text string representing the data label. Parameter Substitution and Formatting is supported. |
| font | "" | The font used to draw the label. |
| fontSize | 8 | The font size used to draw the label. |
| fontColor | TextColor | The color used to draw the label. |
| fontAngle | 0 | The rotation angle of the label. |
A TextBox object representing the prototype of the obj. This may be used to fine-tune the appearance of the obj.
See font specification here:
http://www.monkeybreadsoftware.net/faq-chartdirectorfontspecification.shtml
See also:
CDLayerMBS.addCustomGroupLabel(dataGroup as Integer, dataItem as Integer, label as string, font as string, fontSize as Double, fontColor as color, fontAngle as Double = 0) as CDTextBoxMBS
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| method | ChartDirector | MBS ChartDirector Plugin | 11.1 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
See also:
CDLayerMBS.addDataGroup(name as string)
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| method | ChartDirector | MBS ChartDirector Plugin | 8.2 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
Currently, only stacked bar layers support data groups for creating "multi-stacked" bars.
In a normal stacked bar layer, all data sets are stacked on top of one another, creating one stacked bar per x-axis position. If data grouping is used, data sets within the same data group with be stacked up. So there may be multiple stacked bars in each x-axis position. These stacked bars are drawn side by side.
When you add a data set using Layer.addDataSet, the data set will belong to the current data group. The addDataGroup method can be used to open a new data group, so that subsequent data sets will belong to that new group.
You may associate a name with a data group. The name can then be used in data labels or image maps to identify the data group.
| Argument | Default | Description |
|---|---|---|
| name | "" | Name of the data group. |
CDLayerMBS.addDataSet(data as CDArrayMBS, colorvalue as color, name as string = "") as CDDataSetMBS
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| method | ChartDirector | MBS ChartDirector Plugin | 11.1 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
See also:
- addDataSet(data as CDArrayMBS, colorvalue as Integer = -1, name as string = "") as CDDataSetMBS
- addDataSet(data() as Double, colorvalue as color, name as string = "") as CDDataSetMBS
- addDataSet(data() as Double, colorvalue as Integer = -1, name as string = "") as CDDataSetMBS
Some examples using this method:
- /ChartDirector/RealTime ViewPort
- /ChartDirector/Tracking Cursor/Track Box with Legend
- /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 Legend
CDLayerMBS.addDataSet(data as CDArrayMBS, colorvalue as Integer = -1, name as string = "") as CDDataSetMBS
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| method | ChartDirector | MBS ChartDirector Plugin | 8.2 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
| Argument | Default | Description |
|---|---|---|
| data | (Mandatory) | An array of numbers representing the data set. |
| color | -1 | The color to draw the data item. -1 means that the color is automatically selected from the palette. |
| name | "" | The name of the data set. The name will be used in the legend box, if one is available. An empty string means the data set has no name. |
A DataSet object representing the data set added. You may use the methods of this object to fine-tune how the data set is drawn on the chart.
See also:
CDLayerMBS.addDataSet(data() as Double, colorvalue as color, name as string = "") as CDDataSetMBS
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| method | ChartDirector | MBS ChartDirector Plugin | 11.1 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
See also:
CDLayerMBS.addDataSet(data() as Double, colorvalue as Integer = -1, name as string = "") as CDDataSetMBS
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| method | ChartDirector | MBS ChartDirector Plugin | 8.2 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
| Argument | Default | Description |
|---|---|---|
| data | (Mandatory) | An array of numbers representing the data set. |
| color | -1 | The color to draw the data item. -1 means that the color is automatically selected from the palette. |
| name | "" | The name of the data set. The name will be used in the legend box, if one is available. An empty string means the data set has no name. |
A DataSet object representing the data set added. You may use the methods of this object to fine-tune how the data set is drawn on the chart.
See also:
CDLayerMBS.addExtraField(numbers() as Double)
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| method | ChartDirector | MBS ChartDirector Plugin | 8.2 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
This method merely stores the data inside the layer object. The Parameter Substitution and Formatting mechanism will determine how the data are to be used.
A common use for extra fields is to specify extra information (such as a custom serial number for the data points) to be displayed on data labels or on tool tips, or to supply extra query parameters in clickable charts. All these are achieved by specifying the extra field on the data label template or image map templates during parameter substitution.
| Argument | Default | Description |
|---|---|---|
| numbers | (Mandatory) | An array of numbers/dates to be stored inside the layer object. |
See also:
CDLayerMBS.addExtraField(texts() as string)
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| method | ChartDirector | MBS ChartDirector Plugin | 8.2 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
This method merely stores the data inside the layer object. The Parameter Substitution and Formatting mechanism will determine how the data are to be used.
A common use for extra fields is to specify extra information (such as a custom serial number for the data points) to be displayed on data labels or on tool tips, or to supply extra query parameters in clickable charts. All these are achieved by specifying the extra field on the data label template or image map templates during parameter substitution.
| Argument | Default | Description |
|---|---|---|
| texts | (Mandatory) | An array of text to be stored inside the layer object. |
See also:
CDLayerMBS.alignLayer(layer as CDLayerMBS, dataSet as Integer)
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| method | ChartDirector | MBS ChartDirector Plugin | 8.2 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
The Side layout is a layout method specific to the bar chart layer. In this layout method, multiple bars belonging to the same x-position are laid out side by side. Thus the bars are not centered exactly on the x-position, but are shifted. The shift amount depends on the data set numbers of the bars.
In some cases, it may be necessary to overlay another layer (eg. a line chart layer, or a box-whisker chart layer) on top of the bars. The alignLayer method ensures the data points are shifted by the same amount as a given data set on a given BarLayer.
| Argument | Default | Description |
|---|---|---|
| layer | (Mandatory) | The BarLayer which contains the bars to synchronize with. |
| dataSet | (Mandatory) | The data set of the bars to synchronize with. |
The items on this page are in the following plugins: MBS ChartDirector Plugin.