Xojo Conferences
XDCMay2019MiamiUSA

Platforms to show: All Mac Windows Linux Cross-Platform

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 Console & Web iOS
method ChartDirector MBS ChartDirector Plugin 8.2 Yes Yes Yes Yes No
Function: Adds a custom data label to a data point.
Notes:
See Font Specification for details on various font attributes.
ArgumentDefaultDescription
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.
fontSize8The font size used to draw the label.
fontColorTextColorThe color used to draw the label.
fontAngle0The rotation angle of the label.
Return Value
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:

Feedback, Comments & Corrections

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 Console & Web iOS
method ChartDirector MBS ChartDirector Plugin 11.1 Yes Yes Yes Yes No
Function: Same as the other addCustomDataLabel method, but uses color instead of integer data type for passing color values.

See also:

Feedback, Comments & Corrections

CDPolarLayerMBS.Constructor
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method ChartDirector MBS ChartDirector Plugin 15.2 Yes Yes Yes Yes No
Function: The private constructor.

Feedback, Comments & Corrections

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 Console & Web iOS
method ChartDirector MBS ChartDirector Plugin 8.2 Yes Yes Yes Yes No
Function: Generates an HTML image map for all data points on the layer.
Notes:
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.
ArgumentDefaultDescription
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.

The special keyword "{default}" represents the default query parameters. This is useful for specifying appending to the default.

Note that an empty string means to use the default query query parameters. To specify no query parameter, use a space character.
extraAttr""A text string to specify additional attributes to add to the <area> tag. Parameter Substitution and Formatting is supported.
offsetX0An 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.
offsetY0An offset to be added to all y coordinates in the image map. See offsetX above for description.
Return Value
A text string containing the image map generated.

Feedback, Comments & Corrections

CDPolarLayerMBS.getImageCoor(dataItem as Integer, offsetX as Integer = 0, offsetY as Integer = 0) as string
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method ChartDirector MBS ChartDirector Plugin 8.2 Yes Yes Yes Yes No
Function: Gets the image map coordinates of a data point.
Notes:
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.
ArgumentDefaultDescription
dataItem(Mandatory)The data point number for the data point. The first data point is 0, while the nth data point is (n - 1).
offsetX0An 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.
offsetY0An offset to be added to all y coordinates in the image map. See offsetX above for description.
Return Value
A text string representing the image map coordinates of the data points as HTML image map attributes.

Feedback, Comments & Corrections

CDPolarLayerMBS.setAngles(data() as Double)
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method ChartDirector MBS ChartDirector Plugin 8.2 Yes Yes Yes Yes No
Function: Sets the angular coordinates of the data points.
Notes:
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).
ArgumentDefaultDescription
angles(Mandatory)An array of numbers representing the angular coordinates of the data points.

Feedback, Comments & Corrections

CDPolarLayerMBS.setBorderColor(edgeColor as color)
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 setBorderColor method, but uses color instead of integer data type for passing color values.

See also:

Feedback, Comments & Corrections

CDPolarLayerMBS.setBorderColor(edgeColor as Integer)
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method ChartDirector MBS ChartDirector Plugin 8.2 Yes Yes Yes Yes No
Function: Sets the border color for drawing the data on the layer.
Notes:
This method only applies to layers that represents data with elements that have borders (e.g. polar area layer and polar spline area layer).
ArgumentDefaultDescription
edgeColor(Mandatory)The border color.

See also:

Feedback, Comments & Corrections

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

See also:

Feedback, Comments & Corrections

CDPolarLayerMBS.setData(data() as Double, colorvalue as Integer = -1, name as string = "")
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method ChartDirector MBS ChartDirector Plugin 8.2 Yes Yes Yes Yes No
Function: Sets the values of the data points.

See also:

Feedback, Comments & Corrections

CDPolarLayerMBS.setDataLabelFormat(formatString as string)
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method ChartDirector MBS ChartDirector Plugin 8.2 Yes Yes Yes Yes No
Function: Sets the data label format.
Notes:
By default, the data label format is "{value}". Please refer to Parameter Substitution and Formatting on available parameters and how to format them.
ArgumentDefaultDescription
formatString(Mandatory)The format string.

Feedback, Comments & Corrections

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 Console & Web iOS
method ChartDirector MBS ChartDirector Plugin 8.2 Yes Yes Yes Yes No
Function: Enables data labels and sets their styles.
Notes:
ArgumentDefaultDescription
font""The font used to draw the labels.
fontSize8The font size used to draw the labels.
fontColorTextColorThe color used to draw the labels.
fontAngle0The rotation angle of the labels.
Return Value
A TextBox object representing the prototype of the obj. This may be used to fine-tune the appearance of the obj.

See also:

Feedback, Comments & Corrections

CDPolarLayerMBS.setDataLabelStyle(font as string, fontsize as Double, fontcolor as color, fontangle as Double = 0) as CDTextBoxMBS
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 setDataLabelStyle method, but uses color instead of integer data type for passing color values.

See also:

Feedback, Comments & Corrections

CDPolarLayerMBS.setDataSymbol(image as folderitem)
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method ChartDirector MBS ChartDirector Plugin 8.2 Yes Yes Yes Yes No
Function: Load an image from a file and use it as the graphics symbol to plot the data points.
Notes:
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.
ArgumentDefaultDescription
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:

Feedback, Comments & Corrections

CDPolarLayerMBS.setDataSymbol(polygon() as Integer, size as Integer = 11, fillcolor as Integer = -1, edgecolor as Integer = -1)
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method ChartDirector MBS ChartDirector Plugin 8.2 Yes Yes Yes Yes No
Function: Uses a custom polygon as the graphics symbol to plot the data points.
Notes:
ArgumentDefaultDescription
polygon(Mandatory)An array of integers representing the coordinates the polygon vertices. See Shape Specification on how the custom shape is defined.
size11The nominal width and height of the symbol in pixels.
fillColor-1The color used to fill the symbol. -1 means the color of the data set will be used.
edgeColor-1The edge color used to draw the edge of the symbol. -1 means the edge color of the data set will be used.

See also:

Feedback, Comments & Corrections

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 Console & Web iOS
method ChartDirector MBS ChartDirector Plugin 8.2 Yes Yes Yes Yes No
Function: Uses one of the built-in symbols as the graphics symbol to plot the data points.
Notes:
ArgumentDefaultDescription
symbol(Mandatory)One of the predefined shape constants representing the symbol shape. See Shape Specification for the available built-in shapes.
size7The width and height of the symbol in pixels.
fillColor-1The color used to fill the symbol. -1 means the color of the data set will be used.
edgeColor-1The edge color used to draw the edge of the symbol. -1 means the edge color of the data set will be used.
lineWidth1The line width used for drawing the symbols.

See also:

Feedback, Comments & Corrections

CDPolarLayerMBS.setHTMLImageMap(url as string, queryFormat as string = "", extraAttr as string = "")
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method ChartDirector MBS ChartDirector Plugin 8.2 Yes Yes Yes Yes No
Function: Override the default arguments used when generating HTML image map for the layer.
Notes:
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.
ArgumentDefaultDescription
url(Mandatory)The URL to be used in the "href" attribute of the image map. Parameter Substitution and Formatting is supported.

The special keyword "{default}" represents the global URL as specified in BaseChart.getHTMLImageMap. This field is useful for specifying appending to the global URL.

Note that an empty string also means to use the global URL. To specify no URL, use the special keyword "{none}".

To disable the entire image map, use the special keyword "{disable}".
queryFormat""A text string representing the template of the query parameters to be appended to the URL. Parameter Substitution and Formatting is supported.

The special keyword "{default}" represents the global query parameters as specified in BaseChart.getHTMLImageMap. This field is useful for specifying appending to the global query parameters.

Note that an empty string also means to use the global query parameters. To specify no query parameters, use the special keyword "{none}".
extraAttr""A text string to specify additional attributes to add to the <area> tag. Parameter Substitution and Formatting is supported.

The special keyword "{default}" represents the global additional attributes as specified in BaseChart.getHTMLImageMap. This field is useful for specifying appending to the global additional attributes.

Note that an empty string also means to use the global additional attributes. To specify no additional attributes, use the special keyword "{none}".

Feedback, Comments & Corrections

CDPolarLayerMBS.setImageMapWidth(width as Integer)
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method ChartDirector MBS ChartDirector Plugin 8.2 Yes Yes Yes Yes No
Function: Sets the effective size of a data point for producing image maps.
Notes:
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.
ArgumentDefaultDescription
width(Mandatory)The effective width and height of the data point for the purpose of producing image maps.

Feedback, Comments & Corrections

CDPolarLayerMBS.setLineWidth(w as Integer)
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method ChartDirector MBS ChartDirector Plugin 8.2 Yes Yes Yes Yes No
Function: Sets the line width of lines when drawing the data on the layer.
Notes:
ArgumentDefaultDescription
w(Mandatory)The width of the line in pixels.

Feedback, Comments & Corrections

CDPolarLayerMBS.setSymbolOffset(offsetX as Integer, offsetY as Integer)
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method ChartDirector MBS ChartDirector Plugin 15.1 Yes Yes Yes Yes No
Function: Offset the symbols in the x and y directions in pixel unit.
Notes:
ArgumentDefaultDescription
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.

Feedback, Comments & Corrections

CDPolarLayerMBS.setSymbolScale(data() as Double, scaleType as Integer = 0)
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method ChartDirector MBS ChartDirector Plugin 8.2 Yes Yes Yes Yes No
Function: Sets the size of the symbol for each data point (for creating bubble charts).
Notes:
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
PixelScale0The unit is measured in pixels.
RadialAxisScale2 The unit is measured in the radial axis scale.

ArgumentDefaultDescription
zData(Mandatory)The sizes of the symbols, expressed using the unit defined by the scaleType argument.
scaleTypePixelScaleThe unit for zData, which must be one of the predefined constants in the table above.

Feedback, Comments & Corrections

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




Links
MBS Xojo Plugins