Online Documentation - Statistics - FAQ - Plugin Parts (All, Dependencies) - Class hierarchy
New in Version 22.2 22.3 22.4 22.5 23.0 23.1 23.2 23.3 23.4 23.5 24.0 24.1
The list of the topics, classes, interfaces, controls, modules, global methods by category, global methods by name, screenshots, licenses and examples.
Platforms to show: All Mac Windows Linux Cross-Platform
Back to CDPolarLayerMBS class.
CDPolarLayerMBS.addCustomDataLabel(i 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 |
See Font Specification for details on various font attributes.
Argument | Default | Description |
i | (Mandatory) | The data point number for the data point. 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. |
See also:
CDPolarLayerMBS.addCustomDataLabel(i 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:
CDPolarLayerMBS.Constructor Private
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | ChartDirector | MBS ChartDirector Plugin | 15.2 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
CDPolarLayerMBS.getHTMLImageMap(url as string, queryFormat as string = "", extraAttr as string = "", offsetX as Integer = 0, offsetY as Integer = 0) 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 should be called only after creating the chart image (eg. using BaseChart.makeChart, BaseChart.makeChart2 or BaseChart.makeChart3). The image map cannot be determined without creating the chart image first.
Argument | Default | Description |
url | (Mandatory) | The URL to be used in the "href" attribute of the image map. Parameter Substitution and Formatting is supported. Use an empty string if no href attribute is needed. |
queryFormat | "" | A text string representing the template of the query parameters to be appended to the URL. Parameter Substitution and Formatting is supported. |
extraAttr | "" | A text string to specify additional attributes to add to the <area> tag. Parameter Substitution and Formatting is supported. |
offsetX | 0 | An offset to be added to all x coordinates in the image map. This is useful if the current image will be shifted and inserted into another image. In this case, the image map will need to be shifted by the same offset. |
offsetY | 0 | An offset to be added to all y coordinates in the image map. See offsetX above for description. |
CDPolarLayerMBS.getImageCoor(dataItem as Integer, offsetX as Integer = 0, offsetY as Integer = 0) as string
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | ChartDirector | MBS ChartDirector Plugin | 8.2 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
The image map coordinates will be in the following format:
shape="rect" cords="[x1],[y1],[x2],[y2]"
This format is specially designed so that it can easily be included into HTML image maps.
This method should be called only after creating the chart image (eg. using BaseChart.makeChart, BaseChart.makeChart2 or BaseChart.makeChart3). The image map cannot be determined without creating the chart image first.
Argument | Default | Description |
dataItem | (Mandatory) | The data point number for the data point. The first data point is 0, while the nth data point is (n - 1). |
offsetX | 0 | An offset to be added to all x coordinates in the image map. This is useful if the current image will be shifted and inserted into another image. In this case, the image map will need to be shifted by the same offset. |
offsetY | 0 | An offset to be added to all y coordinates in the image map. See offsetX above for description. |
CDPolarLayerMBS.setAngles(data() as Double)
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | ChartDirector | MBS ChartDirector Plugin | 8.2 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
Note that the angular coordinates are measured using the scale of the angular axis, which may not be in degrees or radians. See AngularAxis.setLabels and AngularAxis.setLinearScale on how the angular axis scale is defined.
If this method is not called, the first data point is assumed to have an angular coordinate of 0, and the nth data point is assumed to have an angular coordinate of (n - 1). This is common for radar charts, in which enumerated scale is used for the angular axis (see AngularAxis.setLabels).
Argument | Default | Description |
angles | (Mandatory) | An array of numbers representing the angular coordinates of the data points. |
CDPolarLayerMBS.setBorderColor(edgeColor as color)
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | ChartDirector | MBS ChartDirector Plugin | 11.1 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
See also:
CDPolarLayerMBS.setBorderColor(edgeColor as Integer)
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | ChartDirector | MBS ChartDirector Plugin | 8.2 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
This method only applies to layers that represents data with elements that have borders (e.g. polar area layer and polar spline area layer).
Argument | Default | Description |
edgeColor | (Mandatory) | The border color. |
See also:
CDPolarLayerMBS.setData(data() as Double, colorvalue as color, name as string = "")
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | ChartDirector | MBS ChartDirector Plugin | 11.1 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
See also:
CDPolarLayerMBS.setData(data() as Double, colorvalue as Integer = -1, name as string = "")
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | ChartDirector | MBS ChartDirector Plugin | 8.2 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
See also:
CDPolarLayerMBS.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 |
By default, the data label format is "{value}". Please refer to Parameter Substitution and Formatting on available parameters and how to format them.
Argument | Default | Description |
formatString | (Mandatory) | The format string. |
CDPolarLayerMBS.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 |
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. |
See also:
CDPolarLayerMBS.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 |
See also:
CDPolarLayerMBS.setDataSymbol(area as CDDrawAreaMBS)
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | ChartDirector | MBS ChartDirector Plugin | 8.2 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
Argument | Default | Description |
obj | (Mandatory) | A DrawArea object to be used as the symbol. |
See also:
CDPolarLayerMBS.setDataSymbol(image as folderitem)
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | ChartDirector | MBS ChartDirector Plugin | 8.2 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
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.
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:
CDPolarLayerMBS.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 |
Argument | Default | Description |
obj | (Mandatory) | A picture object to be used as the symbol. |
See also:
CDPolarLayerMBS.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 |
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:
CDPolarLayerMBS.setDataSymbol(polygon() as Integer, size as Integer, fillcolor as color, edgecolor as Integer = -1)
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | ChartDirector | MBS ChartDirector Plugin | 11.1 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
See also:
CDPolarLayerMBS.setDataSymbol(symbol as Integer, size as Integer = 7, 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 |
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 | 7 | 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:
CDPolarLayerMBS.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 |
See also:
CDPolarLayerMBS.setHTMLImageMap(url as string, queryFormat as string = "", extraAttr as string = "")
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | ChartDirector | MBS ChartDirector Plugin | 8.2 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
BaseChart.getHTMLImageMap can be used to generate HTML image map for the whole chart. When BaseChart.getHTMLImageMap is used, the image map for all layers will be generated based on the arguments supplied to BaseChart.getHTMLImageMap.
The setHTMLImageMap method can be used to override those arguments for a chart layer, so the image map for that layer can be different.
For a detail description of image maps, please refer to BaseChart.getHTMLImageMap.
Argument | Default | Description |
url | (Mandatory) | The URL to be used in the "href" attribute of the image map. Parameter Substitution and Formatting is supported. |
queryFormat | "" | A text string representing the template of the query parameters to be appended to the URL. Parameter Substitution and Formatting is supported. |
extraAttr | "" | A text string to specify additional attributes to add to the <area> tag. Parameter Substitution and Formatting is supported. |
CDPolarLayerMBS.setImageMapWidth(width as Integer)
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | ChartDirector | MBS ChartDirector Plugin | 8.2 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
For the purpose of producing image maps for the data points, the sizes of the data points are assumed to be the size of the data symbols. If no data symbol is used, an effective size is assumed. The default is 10 pixels in width and height.
Argument | Default | Description |
width | (Mandatory) | The effective width and height of the data point for the purpose of producing image maps. |
CDPolarLayerMBS.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 |
Argument | Default | Description |
w | (Mandatory) | The width of the line in pixels. |
CDPolarLayerMBS.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 |
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. |
CDPolarLayerMBS.setSymbolScale(data() as Double, scaleType as Integer = 0)
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | ChartDirector | MBS ChartDirector Plugin | 8.2 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
One common usage for this method is to draw circle symbols of different sizes at each data points, creating a bubble chart.
This method supports any valid data symbols. You can create bubble charts with square bubbles, or even custom data symbols.
ChartDirector supports specifying sizes as pixels or in axis scale. The unit is specified by using the following predefined constants.
ConstantValueDescription
PixelScale | 0 | The unit is measured in pixels. |
RadialAxisScale | 2 | The unit is measured in the radial axis scale. |
Argument | Default | Description |
zData | (Mandatory) | The sizes of the symbols, expressed using the unit defined by the scaleType argument. |
scaleType | PixelScale | The unit for zData, which must be one of the predefined constants in the table above. |
The items on this page are in the following plugins: MBS ChartDirector Plugin.