Platforms to show: All Mac Windows Linux Cross-Platform

Back to CDPolarVectorLayerMBS class.

CDPolarVectorLayerMBS.setArrowAlignment(alignment as Integer)

Type Topic Plugin Version macOS Windows Linux iOS Targets
method ChartDirector MBS ChartDirector Plugin 8.2 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Sets the alignment of the vector relative to the data point.

ArgumentDefaultDescription
alignment(Mandatory)A BottomCenter value means the vector will point away from the data point (the default). A TopCenter value means the vector will point into the data point. A Center value means the center of the vector will be at the data point.

CDPolarVectorLayerMBS.setArrowHead(polygon() as Integer)

Type Topic Plugin Version macOS Windows Linux iOS Targets
method ChartDirector MBS ChartDirector Plugin 8.2 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Sets a custom shape to be used as the arrow head.

The custom shape is specified as an array of integers x0, y0, x1, y1, x2, y2 ... representing the coordinates of the vertices of the custom polygonal shape.

The polygon should be defined with a bounding square of 10 x 10 units, in which the x-axis is from left to right, and the y-axis from bottom to top. The origin is assumed to be the bottom center of the arrow (the point where the arrow head joins the arrow stem). The shape is assumed to represent an arrow pointing upwards.

As an example, the followings are the integer array that represents the standard ChartDirector vector arrow head:

-5, -5, 0, 0, 5, -5, 0, 5
ChartDirector will automatically scale the shape to the actual width and height as specified in PolarVectorLayer.setArrowHead.
ArgumentDefaultDescription
polygon(Mandatory)An array of integers x0, y0, x1, y1, x2, y2 ... representing the coordinates the polygon vertices on a 10 x 10 units grid.

See also:

CDPolarVectorLayerMBS.setArrowHead(width as Integer, height as Integer)

Type Topic Plugin Version macOS Windows Linux iOS Targets
method ChartDirector MBS ChartDirector Plugin 8.2 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Sets the size of the arrow head.

ArgumentDefaultDescription
width(Mandatory)The width of the arrow head in pixels. The default width is 8 pixels.
height0The height of the arrow head in pixels. The default value of 0 means the height is the same as the width.

See also:

CDPolarVectorLayerMBS.setArrowStem(polygon() as Integer)

Type Topic Plugin Version macOS Windows Linux iOS Targets
method ChartDirector MBS ChartDirector Plugin 8.2 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Sets a custom shape to be used as the arrow stem.

By default, the arrow stem is just a straight line, with the line width controlled using PolarLayer.setLineWidth. The setArrowStem method can specify a custom shape for the arrow stem.

The custom shape is specified as an array of integers x0, y0, x1, y1, x2, y2 ... representing the coordinates of the vertices of the custom polygonal shape.

The polygon should be defined with a bounding square of 10 x 100 units, in which the x-axis is from left to right, and the y-axis from bottom to top. The origin is assumed to be the starting point of the arrow stem, and the shape is assumed to represent an arrow stem pointing upwards.

ChartDirector will automatically scale the shape so that the total arrow length (head + stem) is the required length of the arrow as according to actual data, and the stem width is as specified in PolarLayer.setLineWidth.
ArgumentDefaultDescription
polygon(Mandatory)An array of integers x0, y0, x1, y1, x2, y2 ... representing the coordinates the polygon vertices on a 10 x 100 units grid.

CDPolarVectorLayerMBS.setIconSize(height as Integer, width as Integer = 0)

Type Topic Plugin Version macOS Windows Linux iOS Targets
method ChartDirector MBS ChartDirector Plugin 8.2 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Sets the size of the icon to be used in legend box.

By default, if a legend box is available on the chart, ChartDirector will insert an legend entry if the PolarVectorLayer is named. The size of the icon will be the size of the vectors used on the chart, using a short vector length to fit the legend box.

This method can be used to override the legend box settings to specify a custom width/height for the icons of the current PolarVectorLayer.
ArgumentDefaultDescription
height(Mandatory)The height of the icon in pixels.
width0The width of the icon in pixels. The default value of 0 means the width is automatically determined.

CDPolarVectorLayerMBS.setVector(lengths() as Double, directions() as Double, lengthScale as Integer = 0)

Type Topic Plugin Version macOS Windows Linux iOS Targets
method ChartDirector MBS ChartDirector Plugin 8.2 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Sets the lengths and directions for the vectors.

ChartDirector supports specifying 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
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.

CDPolarVectorLayerMBS.setVectorMargin(startMargin as Double)

Type Topic Plugin Version macOS Windows Linux iOS Targets
method ChartDirector MBS ChartDirector Plugin 9.2 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Sets the vector margin.

See also:

CDPolarVectorLayerMBS.setVectorMargin(startMargin as Double, endMargin as Double)

Type Topic Plugin Version macOS Windows Linux iOS Targets
method ChartDirector MBS ChartDirector Plugin 9.2 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Sets the vector margin.

See also:

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


The biggest plugin in space...