Platforms to show: All Mac Windows Linux Cross-Platform
Back to CDThreeDChartMBS class.
CDThreeDChartMBS.colorAxis as CDColorAxisMBS
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| method | ChartDirector | MBS ChartDirector Plugin | 12.3 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
Returns the ColorAxis object representing the color axis.
CDThreeDChartMBS.Constructor Private
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| method | ChartDirector | MBS ChartDirector Plugin | 12.3 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
The ThreeDChart class is an abstract class containing methods that are common to all true 3D chart types.
ThreeDChart is a subclass of BaseChart.
This constructor is private to make sure you don't create an object from this class by error. Please use designated functions to create objects.
CDThreeDChartMBS.getElevationAngle as double
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| method | ChartDirector | MBS ChartDirector Plugin | 21.2 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
CDThreeDChartMBS.getPlotRegionDepth as integer
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| method | ChartDirector | MBS ChartDirector Plugin | 21.2 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
CDThreeDChartMBS.getPlotRegionHeight as integer
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| method | ChartDirector | MBS ChartDirector Plugin | 21.2 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
CDThreeDChartMBS.getPlotRegionWidth as integer
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| method | ChartDirector | MBS ChartDirector Plugin | 21.2 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
CDThreeDChartMBS.getRotationAngle as double
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| method | ChartDirector | MBS ChartDirector Plugin | 21.2 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
CDThreeDChartMBS.getXCoor(xValue as Double, yValue as Double, zValue as Double) as Integer
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| method | ChartDirector | MBS ChartDirector Plugin | 15.1 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
Note: You must call BaseChart.layout first before calling this method. ChartDirector needs to perform auto-scaling and layout the axis before it can compute pixel coordinates from data values.
| Argument | Default | Description |
| x | (Mandatory) | The x data value of the point. |
| y | (Mandatory) | The y data value of the point. |
| z | (Mandatory) | The z data value of the point. |
Returns the x pixel coordinate of the point.
CDThreeDChartMBS.getYCoor(xValue as Double, yValue as Double, zValue as Double) as Integer
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| method | ChartDirector | MBS ChartDirector Plugin | 15.1 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
You must call BaseChart.layout first before calling this method. ChartDirector needs to perform auto-scaling and layout the axis before it can compute pixel coordinates from data values.
| Argument | Default | Description |
| x | (Mandatory) | The x data value of the point. |
| y | (Mandatory) | The y data value of the point. |
| z | (Mandatory) | The z data value of the point. |
Returns the y pixel coordinate of the point.
CDThreeDChartMBS.setColorAxis(x as Integer, y as Integer, alignment as Integer, length as Integer, orientation as Integer) as CDColorAxisMBS
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| method | ChartDirector | MBS ChartDirector Plugin | 12.3 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
| Argument | Default | Description |
| x | (Mandatory) | The x-coordinate of the reference point used to position the color axis. |
| y | (Mandatory) | The y-coordinate of the reference point used to position the color axis. |
| alignment | (Mandatory) | The alignment of the color axis with respect to the reference point. For example, a value of TopLeft means the reference point is the top- left corner of the color axis. See Alignment Specification for supported alignment types.. |
| length | (Mandatory) | The length of the color axis in pixels. |
| orientation | (Mandatory) | The orientation of the color axis. A value of Top/Bottom means the axis is horizontal, and the axis labels are at top/bottom side of the axis. A value of Left/Right means the axis is vertical, and the axis labels are at the left/right side of the axis. |
CDThreeDChartMBS.setPerspective(perspective as Double)
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| method | ChartDirector | MBS ChartDirector Plugin | 12.3 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
When taking the photograph of a scene, things closer to the camera are larger in the photograph, while things farther from the camera are smaller. For example, two trees of exactly the same height but at different distances from the camera will have different heights as measured in the photograph. This is known as the perspective effect.
This method configures the strength of the perspective effect for a ThreeDChart object. The nearer part of the plot region will be magnified, while the farther part will be reduced. The average size of the plot region will be approximately unchanged.
| Argument | Default | Description |
| perspective | (Mandatory) | The strength of the perspective effect. It approximately represents the maximum percentage magnification of the plot region, which is the same as the maximum percentage reduction. A value of 0 means no perspective effect. This value is usually between 0 to 100. If this method is never called, the default is 12. |
CDThreeDChartMBS.setPlotRegion(cx as Integer, cy as Integer, xWidth as Integer, yDepth as Integer, zHeight as Integer)
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| method | ChartDirector | MBS ChartDirector Plugin | 12.3 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
The plot region is a 3D box, with x, y, and z axes along its border, using a right-hand cartesian coordinate system.
To create the chart image, you may imagine a camera taking a photograph of the box. The photograph can be taken at different angles, configurable with ThreeDChart.setViewAngle. The position of the plot region in the photograph is such that the center of the plot region is at a given point (cx, cy) on the image.
| Argument | Default | Description |
| cx | (Mandatory) | The x pixel coordinate of the point on the image at which the center of the plot region is located. |
| cy | (Mandatory) | The y pixel coordinate of the point on the image at which the center of the plot region is located. |
| xWidth | (Mandatory) | The length of the x-dimension of the plot region in pixels. |
| yDepth | (Mandatory) | The length of the y-dimension of the plot region in pixels. |
| zHeight | (Mandatory) | The length of the z-dimension of the plot region in pixels. |
CDThreeDChartMBS.setViewAngle(elevation as Double, rotation as Double = 0, twist as Double = 0)
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| method | ChartDirector | MBS ChartDirector Plugin | 12.3 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
ChartDirector uses elevation, rotation and twist angles to specify the 3D view angles.
To explain the meaning of the angles, imagine the object being viewed is put at the center of a hollow sphere, and a camera (the view point) is put at the surface of the sphere, directed inwards to the center to look at the object.
The elevation angle refers to the "latitude" of the camera. An elevation angle of 0 degrees means the camera is at the "equator" pointing to the object from the side. An elevation angle of 90 degrees means the camera is at the "north pole" pointing down to the object. An angle elevation of -90 degrees means the camera is at the "south pole", pointing up to the object.
The rotation angle refers to the "longitude" of the camera. If the elevation is 0 degrees, and the rotation angle varies from 0 to 360 degrees, the camera will move around the "equator" in the easterly direction (counter-clockwise when viewed from the north pole).
The twist angle is for rotating the camera itself while still pointing to the object. For example, a twist angle of 90 degrees means you are holder the camera "vertically" instead of "horizontally". The rotation is clockwise from the view point of the person holding the camera.
Note that from the view point of the camera, the object will appear to be rotating in the opposite direction. For example, as the rotation angle rotates the camera counter-clockwise along the "equator", the object will appear to be rotating clockwise on the screen.
Note: The twist angle is not supported in the current version of ChartDirector. It should always be 0, and should be considered as a reserved argument for future use.
| Argument | Default | Description |
| elevation | (Mandatory) | The elevation angle in degrees. |
| rotation | 0 | The rotation angle in degrees. |
| twist | 0 | The twist angle in degrees. |
CDThreeDChartMBS.setWallColor(xyColor as color, yzColor as color, zxColor as color, borderColor as color)
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| method | ChartDirector | MBS ChartDirector Plugin | 12.3 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
By default, the plot region walls are light grey (eeeeee) in color, with a grey (888888) border . This method can be used to modify the colors.
| Argument | Default | Description |
| xyColor | (Mandatory) | The color of the xy wall. |
| yzColor | -1 | The color of the yz wall. -1 means it is the same as xyColor. |
| zxColor | -1 | The color of the zx wall. -1 means it is the same as xyColor. |
| borderColor | -1 | The color of the wall border. -1 means to keep the existing value unchanged. |
See also:
CDThreeDChartMBS.setWallColor(xyColor as Integer, yzColor as Integer = -1, zxColor as Integer = -1, borderColor as Integer = -1)
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| method | ChartDirector | MBS ChartDirector Plugin | 12.3 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
By default, the plot region walls are light grey (eeeeee) in color, with a grey (888888) border . This method can be used to modify the colors.
| Argument | Default | Description |
| xyColor | (Mandatory) | The color of the xy wall. |
| yzColor | -1 | The color of the yz wall. -1 means it is the same as xyColor. |
| zxColor | -1 | The color of the zx wall. -1 means it is the same as xyColor. |
| borderColor | -1 | The color of the wall border. -1 means to keep the existing value unchanged. |
See also:
CDThreeDChartMBS.setWallGrid(majorXGridColor as color, majorYGridColor as color, majorZGridColor as color, minorXGridColor as color, minorYGridColor as color, minorZGridColor as color)
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| method | ChartDirector | MBS ChartDirector Plugin | 12.3 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
The grid lines on the walls are associated with the ticks on the x, y and z axes. Major ticks associate with major grid lines. Minor ticks associate with minor grid lines. By default, the major grid lines are light grey (cccccc), and the minor grid lines are lighter grey (dddddd). This method can be used to modify the grid line colors.
| Argument | Default | Description |
| majorXGridColor | (Mandatory) | The color of the major x-axis grid lines on the walls. |
| majorYGridColor | -1 | The color of the major y-axis grid lines on the walls. -1 means it is the same as the majorXGridColor. |
| majorZGridColor | -1 | The color of the major z-axis grid lines on the walls. -1 means it is the same as the majorXGridColor. |
| minorXGridColor | -1 | The color of the minor x-axis grid lines on the walls. -1 means it is the same as the majorXGridColor. |
| minorYGridColor | -1 | The color of the minor y-axis grid lines on the walls. -1 means it is the same as the majorYGridColor. |
| minorZGridColor | -1 | The color of the minor z-axis grid lines on the walls. -1 means it is the same as the majorZGridColor. |
See also:
CDThreeDChartMBS.setWallGrid(majorXGridColor as Integer, majorYGridColor as Integer = -1, majorZGridColor as Integer = -1, minorXGridColor as Integer = -1, minorYGridColor as Integer = -1, minorZGridColor as Integer = -1)
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| method | ChartDirector | MBS ChartDirector Plugin | 12.3 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
The grid lines on the walls are associated with the ticks on the x, y and z axes. Major ticks associate with major grid lines. Minor ticks associate with minor grid lines. By default, the major grid lines are light grey (cccccc), and the minor grid lines are lighter grey (dddddd). This method can be used to modify the grid line colors.
| Argument | Default | Description |
| majorXGridColor | (Mandatory) | The color of the major x-axis grid lines on the walls. |
| majorYGridColor | -1 | The color of the major y-axis grid lines on the walls. -1 means it is the same as the majorXGridColor. |
| majorZGridColor | -1 | The color of the major z-axis grid lines on the walls. -1 means it is the same as the majorXGridColor. |
| minorXGridColor | -1 | The color of the minor x-axis grid lines on the walls. -1 means it is the same as the majorXGridColor. |
| minorYGridColor | -1 | The color of the minor y-axis grid lines on the walls. -1 means it is the same as the majorYGridColor. |
| minorZGridColor | -1 | The color of the minor z-axis grid lines on the walls. -1 means it is the same as the majorZGridColor. |
See also:
CDThreeDChartMBS.setWallThickness(xyThickness as Integer, yzThickness as Integer = -1, zxThickness as Integer = -1)
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| method | ChartDirector | MBS ChartDirector Plugin | 12.3 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
By default, the plot region walls are 10 pixels thick. This method can be used to modify the thickness.
| Argument | Default | Description |
| xyThickness | (Mandatory) | The thickness of the xy wall in pixels. |
| yzThickness | -1 | The thickness of the yz wall in pixels. -1 means it is the same as xyThickness. |
| zxThickness | -1 | The thickness of the zx wall in pixels. -1 means it is the same as xyThickness. |
CDThreeDChartMBS.setWallVisibility(xyVisible as boolean, yzVisible as boolean, zxVisible as boolean)
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| method | ChartDirector | MBS ChartDirector Plugin | 12.3 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
By default, all walls are visible. This method can be used to hide some or all of the walls.
| Argument | Default | Description |
| xyVisible | (Mandatory) | A true value means the xy wall is visible. A false value means the xy wall is hidden. |
| yzVisible | (Mandatory) | A true value means the yz wall is visible. A false value means the yz wall is hidden. |
| zxVisible | (Mandatory) | A true value means the zx wall is visible. A false value means the zx wall is hidden. |
CDThreeDChartMBS.setZAxisPos(pos as Integer)
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| method | ChartDirector | MBS ChartDirector Plugin | 12.3 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
In a ThreeDChart object, the z-axis can be drawn either on the left side or the right side. By default, ChartDirector will draw the z-axis on the side that is nearer to the viewer.
This method can be used to specify which side the z-axis should be drawn.
| Argument | Default | Description |
| pos | (Mandatory) | The position of the z-axis, which must be either Left or Right. |
The items on this page are in the following plugins: MBS ChartDirector Plugin.
