Xojo Developer Conference
25/27th April 2018 in Denver.
MBS Xojo Conference
6/7th September 2018 in Munich, Germany.

Platforms to show: All Mac Windows Linux Cross-Platform

CDAngularAxisMBS.addLabel(pos as Double, label 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: Adds an extra label on the axis.
Notes:
ParameterDefaultDescription
pos(Mandatory)The position on the axis to add the label.
label(Mandatory)The text label to add.

Feedback, Comments & Corrections

CDAngularAxisMBS.addZone(startValue as Double, endValue as Double, fillColor as color, 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 addZone method, but uses color instead of integer data type for passing color values.

See also:

Feedback, Comments & Corrections

CDAngularAxisMBS.addZone(startValue as Double, endValue as Double, fillColor as Integer, 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: Adds an angular zone to the polar chart.
Notes:
This method is just a short cut to AngularAxis.addZone, in which the starting radius is always 0, and ending radius is the radius of the polar plot region. In other words, the angular zone is a sector on the polar chart.

Parameters:
startValue(Mandatory)The data value that marks the start angular position of the zone.
endValue(Mandatory)The data value that marks the end angular position of the zone.
fillColor(Mandatory)The fill color of the zone.
edgeColor-1The edge color of the zone. The default is the same as the fill color.

See also:

Feedback, Comments & Corrections

CDAngularAxisMBS.addZone(startValue as Double, endValue as Double, startRadius as Double, endRadius as Double, fillColor as color, 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 addZone method, but uses color instead of integer data type for passing color values.

See also:

Feedback, Comments & Corrections

CDAngularAxisMBS.addZone(startValue as Double, endValue as Double, startRadius as Double, endRadius as Double, fillColor as Integer, 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: Adds an angular zone to the polar chart.
Notes:
An angular zone marks an angular region that spans from a start angle to an end angle, where the angles are specified as data values on the angular axis scale. The addZone method allows you to specify a starting and ending radius in pixels for drawing the zone.

ParameterDefaultDescription
startValue(Mandatory)The data value that marks the start angular position of the zone.
endValue(Mandatory)The data value that marks the end angular position of the zone.
startRadius(Mandatory)The starting radius of the zone in pixels.
endRadius(Mandatory)The ending radius of the zone in pixels.
fillColor(Mandatory)The fill color of the zone.
edgeColor-1The edge color of the zone. The default is the same as the fill color.

See also:

Feedback, Comments & Corrections

CDAngularAxisMBS.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

CDAngularAxisMBS.getAxisImageMap(noOfSegments as Integer, mapWidth as Integer, 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 the axis itself.
Notes:
This method is similar to AngularAxis.getHTMLImageMap. The difference is instead of generating an image map for the labels, it generates an image map for the axis itself. The axis will be divided into a number of segments, with an image map entry created for each segment.

noOfSegments(Mandatory)The number of segments to divide the axis into.
mapWidth(Mandatory)The width of the axis used for the purpose of generating the image map.
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

CDAngularAxisMBS.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 the axis labels.
Notes:
This method should be called only after creating the chart image (eg. using BaseChart.makeChart). The image map cannot be determined without creating the chart image first.
This method accepts a URL as its argument. When generating an image map, it appends query parameters to the URL to indicate which legend entry the user has clicked.

The following is an example image map generated for an axis with 3 labels.

<area shape="rect" coords="30,220,70,239" href="handler.asp?value=0&label=John">
<area shape="rect" coords="70,220,110,239" href="handler.asp?value=1&label=Mary">
<area shape="rect" coords="110,220,150,239" href="handler.asp?value=2&label=Peter">

The image map consists of multiple <area> tags, one for each label. In the "href" attributes, query parameters are appended to the URL to provide information on the label clicked.
The image map produces by ChartDirector does not include the <map> and </map> tag. This is intentional so that you can add additional custom <area> tags to the image map, or append multiple image maps together.
The format of the appended URL parameters is determined using the queryFormat argument, which by default is:

value={value}&label={label}

The texts in curly brackets (i.e. {value}, {label}) will be replaced by the actual values when generating the image map. For example, {label} will be replaced by the label text.
Please refer to Parameter Substitution and Formatting on all available parameters and how to format them.
In addition to customizing the query parameters, ChartDirector supports additional HTML attributes in the <area> tags using the extraAttr argument.
For example, the following extraAttr will add a "title" HTML attribute to every <area> tag. The "title" attribute will be displayed as "tool tip" when the mouse moves over the image map.

title='Click me for details on {label}'

Another common usage of the extraAttr argument is to add "onmouseover" and "onmouseout" HTML attributes to handle user interaction using Javascript on the browser.


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

CDAngularAxisMBS.setLabelGap(d 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 distance between the axis labels and the axis.
Notes:
Parameters:
d(Mandatory)The distance between the axis label and axis in pixels.

Feedback, Comments & Corrections

CDAngularAxisMBS.setLabels(labels() as Double, formatString as string = "") 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: Sets the numeric labels to be used on the axis.
Notes:
This method is typically used to set the angular axis to enumerated scale. For more details on what is enumerated axis scale, please refer to AngularAxis.setLabels. In some cases, it may be desirable to skip some labels. If you want to leave a label position empty, use kNoValue as the axis label.

ParameterDefaultDescription
labels(Mandatory)An array of numbers to be used as the axis labels.
formatString""A format string to specified how to format the labels into human readable form. Please refer to Axis.setLabelFormatfor the syntax of the format string. An empty string means the format will be automatically determined.

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

CDAngularAxisMBS.setLabels(labels() as string) 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: Sets the text labels to be used on the axis.
Notes:
ParameterDefaultDescription
lowerLimit(Mandatory)The lower bound of the axis.
upperLimit(Mandatory)The upper bound of the axis.
labels(Mandatory)An array of text strings to be used as the labels on the axis. ChartDirector will distribute the labels evenly on the axis.

This method is typically used in radar charts to set the angular axis to enumerated scale.
In enumerated scale, the labels are laid out evenly on the perimeter of the polar plot area. It is like the labels are at on the vertices of an n-side polygon, where n is the number of labels. Radial grid lines are drawn from the center to the vertices.
The angular coordinates of the data points are determined based on their position in the data array. The first data point will be at the same angular coordinate as the first vertex, the second data point at the second vertex, and so on.
Internally, ChartDirector will assign a value of 0 to the first axis label, 1 to the second axis label, and so on. These values are not visible. Only the axis labels are visible. However, these values may be useful for some ChartDirector features that need to reference the axis position by value, such as adding extra labels using AngularAxis.addLabel.

ParameterDefaultDescription
text(Mandatory)An array of strings containing the text 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

CDAngularAxisMBS.setLabelStyle(font as string = "bold", 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: Sets the font style used to for the axis labels.
Notes:
See Font Specification for details on various font attributes.

ParameterDefaultDescription
font"bold"The font used to draw the labels.
fontSize10The font size used to draw the labels in points.
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 font specification here:
http://www.monkeybreadsoftware.net/faq-chartdirectorfontspecification.shtml

Feedback, Comments & Corrections

CDAngularAxisMBS.setLinearScale(lowerLimit as Double, upperLimit as Double, labels() 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 axis to use the given linear scale and the given labels.
Notes:
ParameterDefaultDescription
lowerLimit(Mandatory)The lower bound of the axis.
upperLimit(Mandatory)The upper bound of the axis.
labels(Mandatory)An array of text strings to be used as the labels on the axis. ChartDirector will distribute the labels evenly on the axis.

See also:

Feedback, Comments & Corrections

CDAngularAxisMBS.setLinearScale(lowerLimit as Double, upperLimit as Double, majorTickInc as Double = 0, minorTickInc as Double = 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 axis to use the given linear scale.
Notes:
ParameterDefaultDescription
lowerLimit(Mandatory)The lower bound of the axis.
upperLimit(Mandatory)The upper bound of the axis.
majorTickInc0Adds major ticks to the axis, where the major ticks are separated by majorTickInc in value. Each major tick will have an associated text label for the value if the axis at the tick. The default value of 0 means no major tick is used.
minorTickInc0Adds minor ticks to the axis, where the minor ticks are separated by minorTickInc in value. The default value of 0 means no minor tick is used.

See also:

Feedback, Comments & Corrections

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




Links
MBS Xojo Plugins