Platforms to show: All Mac Windows Linux Cross-Platform

Back to CDPolarChartMBS class.

CDPolarChartMBS.addAreaLayer(data() as Double, colorvalue as Integer = -1, name as string = "") as CDPolarAreaLayerMBS

Type Topic Plugin Version macOS Windows Linux iOS Targets
method ChartDirector MBS ChartDirector Plugin 8.2 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Adds a polar area layer to the polar chart.

ArgumentDefaultDescription
data(Mandatory)An array of numbers representing the data points in the layer.
color-1The color to draw the area. -1 means that the color is automatically selected from the palette.
name""The name of the layer. The name will be used in the legend box, if one is available. An empty string means the layer has no name.
Return Value
A PolarAreaLayer object representing the chart layer created.

See also:

CDPolarChartMBS.addAreaLayer(dates() as date, colorvalue as Integer = -1, name as string = "") as CDPolarAreaLayerMBS

Type Topic Plugin Version macOS Windows Linux iOS Targets
method ChartDirector MBS ChartDirector Plugin 9.6 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop, Console & Web
Adds a polar area layer to the polar chart.

ArgumentDefaultDescription
data(Mandatory)An array of numbers representing the data points in the layer.
color-1The color to draw the area. -1 means that the color is automatically selected from the palette.
name""The name of the layer. The name will be used in the legend box, if one is available. An empty string means the layer has no name.
Return Value
A PolarAreaLayer object representing the chart layer created.

See also:

CDPolarChartMBS.addLineLayer(data() as Double, colorvalue as Integer = -1, name as string = "") as CDPolarLineLayerMBS

Type Topic Plugin Version macOS Windows Linux iOS Targets
method ChartDirector MBS ChartDirector Plugin 8.2 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Adds a polar line layer to the polar chart.

ArgumentDefaultDescription
data(Mandatory)An array of numbers representing the data points in the layer.
color-1The color to draw the line. -1 means that the color is automatically selected from the palette.
name""The name of the layer. The name will be used in the legend box, if one is available. An empty string means the layer has no name.
Return Value
A PolarLineLayer object representing the chart layer created.

See also:

CDPolarChartMBS.addLineLayer(dates() as date, colorvalue as Integer = -1, name as string = "") as CDPolarLineLayerMBS

Type Topic Plugin Version macOS Windows Linux iOS Targets
method ChartDirector MBS ChartDirector Plugin 9.6 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop, Console & Web
Adds a polar line layer to the polar chart.

ArgumentDefaultDescription
data(Mandatory)An array of numbers representing the data points in the layer.
color-1The color to draw the line. -1 means that the color is automatically selected from the palette.
name""The name of the layer. The name will be used in the legend box, if one is available. An empty string means the layer has no name.
Return Value
A PolarLineLayer object representing the chart layer created.

See also:

CDPolarChartMBS.addSplineAreaLayer(data() as Double, colorvalue as Integer = -1, name as string = "") as CDPolarSplineAreaLayerMBS

Type Topic Plugin Version macOS Windows Linux iOS Targets
method ChartDirector MBS ChartDirector Plugin 8.2 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Adds a polar spline area layer to the polar chart.

ArgumentDefaultDescription
data(Mandatory)An array of numbers representing the data points in the layer.
color-1The color to draw the spline area. -1 means that the color is automatically selected from the palette.
name""The name of the layer. The name will be used in the legend box, if one is available. An empty string means the layer has no name.
Return Value
A PolarSplineAreaLayer object representing the chart layer created.

See also:

CDPolarChartMBS.addSplineAreaLayer(dates() as date, colorvalue as Integer = -1, name as string = "") as CDPolarSplineAreaLayerMBS

Type Topic Plugin Version macOS Windows Linux iOS Targets
method ChartDirector MBS ChartDirector Plugin 9.6 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop, Console & Web
Adds a polar spline area layer to the polar chart.

ArgumentDefaultDescription
data(Mandatory)An array of numbers representing the data points in the layer.
color-1The color to draw the spline area. -1 means that the color is automatically selected from the palette.
name""The name of the layer. The name will be used in the legend box, if one is available. An empty string means the layer has no name.
Return Value
A PolarSplineAreaLayer object representing the chart layer created.

See also:

CDPolarChartMBS.addSplineLineLayer(data() as Double, colorvalue as Integer = -1, name as string = "") as CDPolarSplineLineLayerMBS

Type Topic Plugin Version macOS Windows Linux iOS Targets
method ChartDirector MBS ChartDirector Plugin 8.2 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Adds a polar spline line layer to the polar chart.

ArgumentDefaultDescription
data(Mandatory)An array of numbers representing the data points in the layer.
color-1The color to draw the spline line. -1 means that the color is automatically selected from the palette.
name""The name of the layer. The name will be used in the legend box, if one is available. An empty string means the layer has no name.
Return Value
A PolarSplineLineLayer object representing the chart layer created.

See also:

CDPolarChartMBS.addSplineLineLayer(dates() as date, colorvalue as Integer = -1, name as string = "") as CDPolarSplineLineLayerMBS

Type Topic Plugin Version macOS Windows Linux iOS Targets
method ChartDirector MBS ChartDirector Plugin 9.6 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop, Console & Web
Adds a polar spline line layer to the polar chart.

ArgumentDefaultDescription
data(Mandatory)An array of numbers representing the data points in the layer.
color-1The color to draw the spline line. -1 means that the color is automatically selected from the palette.
name""The name of the layer. The name will be used in the legend box, if one is available. An empty string means the layer has no name.
Return Value
A PolarSplineLineLayer object representing the chart layer created.

See also:

CDPolarChartMBS.addVectorLayer(rdata() as Double, adata() as Double, lengths() as Double, directions() as Double, lengthScale as Integer = 0, colorvalue as Integer = -1, name as string = "") as CDPolarVectorLayerMBS

Type Topic Plugin Version macOS Windows Linux iOS Targets
method ChartDirector MBS ChartDirector Plugin 8.2 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Adds a vector layer to the chart.

The vectors are specified as 4 data series, representing the radial and angular coordinates of the reference points to put the vectors, and the lengths and directions of the vectors.

By default, the vector starts from the reference point and points away from it. You may use PolarVectorLayer.setArrowAlignment to specify other options, such as for the vectors to point into the reference point, or to have the reference as a pivot at the mid-point of the vector.

ChartDirector supports specifying vectors lengths 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
rData(Mandatory)An array of numbers representing the radial coordinates for the reference points of the vectors.
aData(Mandatory)An array of numbers representing the angular coordinates for the reference points of the vectors.
lengths(Mandatory)An array of numbers representing the lengths of the vectors, in unit as specified in the lengthScale argument.
directions(Mandatory)An array of numbers representing the direction of the vectors as a clockwise angle in degrees, where 0 is upward pointing direction.
lengthScalePixelScaleThe unit for the lengths, which must be one of the predefined constants in the table above.
color-1The color to draw the data points. -1 means that the color is automatically selected from the palette.
name""The name of the layer. The name will be used in the legend box, if one is available. An empty string means the layer has no name.
Return Value
A PolarVectorLayer object representing the vector layer created.

See also:

CDPolarChartMBS.Constructor(width as Integer = 640, height as Integer = 480, bgColor as Integer = &hffff0000, edgeColor as Integer = &hff000000, raisedEffect as Integer = 0)

Type Topic Plugin Version macOS Windows Linux iOS Targets
method ChartDirector MBS ChartDirector Plugin 8.2 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Creates a new PolarChart object.

ArgumentDefaultDescription
width(Mandatory)The width of the chart in pixels.
height(Mandatory)The height of the chart in pixels.
bgColorBackgroundColorThe background color of the chart.
edgeColorTransparentThe edge color of the chart.
raisedEffect0The 3D border width. For positive values, the border will appear raised. For negative values, the border will appear depressed. A zero value means the border will appear flat.

See also:

CDPolarChartMBS.getXCoor(r as Double, a as Double) as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
method ChartDirector MBS ChartDirector Plugin 8.2 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Gets the x pixel coordinate of a point given its radial and angular coordinates.

The radial and angular coordinates are measured using the scale of the radial and angular axes. In particular, the scale of the angular axis may not be in degrees or radians. See AngularAxis.setLabels and AngularAxis.setLinearScale on how the angular axis scale is defined.

Note: You must call BaseChart.layout first before calling this method. It is because ChartDirector needs to perform auto-scaling and determine the axis scale first before it can compute the coordinates.
ArgumentDefaultDescription
r(Mandatory)The radial coordinate of the point.
a(Mandatory)The angular coordinate of the point.
Return Value
The x pixel coordinate of the point.

CDPolarChartMBS.getYCoor(r as Double, a as Double) as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
method ChartDirector MBS ChartDirector Plugin 8.2 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Gets the y pixel coordinate of a point given its radial and angular coordinates.

The radial and angular coordinates are measured using the scale of the radial and angular axes. In particular, the scale of the angular axis may not be in degrees or radians. See AngularAxis.setLabels and AngularAxis.setLinearScale on how the angular axis scale is defined.

Note: You must call BaseChart.layout first before calling this method. It is because ChartDirector needs to perform auto-scaling and determine the axis scale first before it can compute the coordinates.
ArgumentDefaultDescription
r(Mandatory)The radial coordinate of the point.
a(Mandatory)The angular coordinate of the point.
Return Value
The y pixel coordinate of the point.

CDPolarChartMBS.setGridColor(rGridColor as color, rGridWidth as Integer, aGridColor as color, aGridWidth as Integer = 1)

Type Topic Plugin Version macOS Windows Linux iOS Targets
method ChartDirector MBS ChartDirector Plugin 11.1 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Same as the other setGridColor method, but uses color instead of integer data type for passing color values.

See also:

CDPolarChartMBS.setGridColor(rGridColor as Integer = &h80000000, rGridWidth as Integer = 1, aGridColor as Integer = &h80000000, aGridWidth as Integer = 1)

Type Topic Plugin Version macOS Windows Linux iOS Targets
method ChartDirector MBS ChartDirector Plugin 8.2 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Sets the grid colors and widths of the polar plot area.

ArgumentDefaultDescription
rGridColor80000000The color of grid lines in the radial direction (from the center outwards).
rGridWidth1The line width for grid lines in the radial direction (from the center outwards).
aGridColor80000000The color of grid lines in the angular direction (concentric circles around the center).
aGridWidth1The line width of grid lines in the angular direction (concentric circles around the center) The line width is only used if the polar plot area is using a polygon grid (see PolarChart.setGridStyle). If circular grid is used, the line width is always 1.

See also:

CDPolarChartMBS.setGridStyle(polygonGrid as boolean, gridOnTop as boolean=true)

Type Topic Plugin Version macOS Windows Linux iOS Targets
method ChartDirector MBS ChartDirector Plugin 8.2 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Configure whether to use circular grids or polygon grids, and whether the grid lines are on top of the polar plot area or are at the back.

ArgumentDefaultDescription
polygonGrid(Mandatory)A true value means polygonal grid will be used. A false value means circular grid will be used.
gridOnToptrueA true value means the grid lines will be on top of the polar plot area. A false value means the grid lines will be at the bottom of the polar plot area.

Some examples using this method:

CDPolarChartMBS.setPlotArea(x as Integer, y as Integer, r as Integer, bgColor as color, edgeColor as color, edgeWidth as Integer = 1)

Type Topic Plugin Version macOS Windows Linux iOS Targets
method ChartDirector MBS ChartDirector Plugin 11.1 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Same as the other setPlotArea method, but uses color instead of integer data type for passing color values.

See also:

CDPolarChartMBS.setPlotArea(x as Integer, y as Integer, r as Integer, bgColor as Integer = &hff000000, edgeColor as Integer = &hff000000, edgeWidth as Integer = 1)

Type Topic Plugin Version macOS Windows Linux iOS Targets
method ChartDirector MBS ChartDirector Plugin 8.2 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Sets the position, background colors, border color and border width of the polar plot area.

ArgumentDefaultDescription
x(Mandatory)The x coordinate of the center of the polar plot area.
y(Mandatory)The y coordinate of the center of the polar plot area.
r(Mandatory)The radius of the polar plot area in pixels.
bgColorTransparentThe background color of the polar plot area.
edgeColorTransparentThe border color of the polar plot area.
edgeWidth1The border width of the polar plot area. The border width is only used if the polar plot area is using a polygon grid (see PolarChart.setGridStyle). If circular grid is used, the border width is always 1.

See also:

CDPolarChartMBS.setPlotAreaBg(bgColor1 as Integer, bgColor2 as Integer, altRings as boolean = true)

Type Topic Plugin Version macOS Windows Linux iOS Targets
method ChartDirector MBS ChartDirector Plugin 8.2 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Sets alternating background colors for the polar plot area.

ChartDirector supports using two alternating background colors for the polar plot area. The colors can change on the radial direction, resulting in concentric circles, on an the angular direction, resulting in alternating sectors.
ArgumentDefaultDescription
bgColor1(Mandatory)The first background color.
bgColor2-1The second background color. The default value of -1 means it is the same as the first background color.
altRingstrueA true value means the background colors alternate in the radial direction, resulting in concentric circles. A false value means the background colors alternates in the angular direction, resulting in alternating sectors.

See also:

CDPolarChartMBS.setStartAngle(startAngle as Double, clockwise as boolean=true)

Type Topic Plugin Version macOS Windows Linux iOS Targets
method ChartDirector MBS ChartDirector Plugin 8.2 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Sets the angle of the radial axis, and the layout direction of radial grid lines.

The default radial axis angle is 0 degree, which means the radial axis is upward pointing.
ArgumentDefaultDescription
startAngle(Mandatory)The angle of the radial axis in degrees. The upward pointing direction is 0 degree, with angle measured in the clockwise direction.
clockwisetrueA true value means the radial grid line will be laid out in the clockwise direction. A false value means the radial grid lines will be laid out in the counter-clockwise direction.

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


The biggest plugin in space...