CDPyramidChartMBS.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	9.2	✅ Yes	✅ Yes	✅ Yes	✅ Yes	All

Creates a new PyramidChart object.

Arguments:

Argument	Default	Description
width	(Mandatory)	The width of the chart in pixels.
height	(Mandatory)	The height of the chart in pixels.
bgColor	kBackgroundColor	The background color of the chart.
edgeColor	kTransparent	The edge color of the chart.
raisedEffect	0	The 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:

• Constructor(width as Integer, height as Integer, bgColor as color, edgeColor as color, raisedEffect as Integer = 0)

CDPyramidChartMBS.Constructor(width as Integer, height as Integer, bgColor as color, edgeColor as color, raisedEffect as Integer = 0)

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 Constructor method, but uses color instead of integer data type for passing color values.

See also:

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

CDPyramidChartMBS.getLayer(layerNo as Integer) as CDPyramidLayerMBS

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
method	ChartDirector	MBS ChartDirector Plugin	9.2	✅ Yes	✅ Yes	✅ Yes	✅ Yes	All

Retrieves the PyramidLayer object representing a single pyramid layer in the pyramid chart.

You must call CDPyramidChartMBS.setData to create the layers first before calling this method.
Arguments

Argument	Default	Description
layerNo	(Mandatory)	The layer number of the pyramid layer to retrieve, starting from 0. The first pyramid layer is 0. The nth pyramid layer is (n-1).

Return Value
The requested CDPyramidLayerMBS object.

CDPyramidChartMBS.setCenterLabel(labelTemplate as string = "", font as string = "", fontSize as Double = 8, fontColor as Integer = -1) as CDTextBoxMBS

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
method	ChartDirector	MBS ChartDirector Plugin	9.2	✅ Yes	✅ Yes	✅ Yes	✅ Yes	All

Adds labels to the center of the pyramid layers.

This method affects all pyramid layers. To apply this method to one particular pyramid layer only, use CDPyramidLayerMBS.setCenterLabel.

See Parameter Substitution and Formatting on available format parameters for the template.

See Font Specification for details on various font attributes.

Arguments:

Argument	Default	Description
template	"{skip}"	The label template. "{skip}" means to keep the existing value unchanged.
font	"{skip}"	The font style. "{skip}" means to keep the existing value unchanged.
fontSize	-1	The font size in points. -1 means to keep the existing value unchanged.
fontColor	-1	The font color. -1 means to keep the existing value unchanged.

Return Value
A CDTextBoxMBS object representing the prototype of the labels. This may be used to fine-tune the appearance of the labels.

See font specification here:
http://www.monkeybreadsoftware.net/faq-chartdirectorfontspecification.shtml

See also:

• setCenterLabel(labelTemplate as string, font as string, fontSize as Double, fontColor as color) as CDTextBoxMBS

CDPyramidChartMBS.setCenterLabel(labelTemplate as string, font as string, fontSize as Double, fontColor as color) as CDTextBoxMBS

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 setCenterLabel method, but uses color instead of integer data type for passing color values.

See also:

• setCenterLabel(labelTemplate as string = "", font as string = "", fontSize as Double = 8, fontColor as Integer = -1) as CDTextBoxMBS

CDPyramidChartMBS.setConeSize(cx as Integer, cy as Integer, radius as Integer, height as Integer)

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
method	ChartDirector	MBS ChartDirector Plugin	9.2	✅ Yes	✅ Yes	✅ Yes	✅ Yes	All

Sets the position and size of the cone in a cone chart.

Arguments:

Argument	Default	Description
cx	(Mandatory)	The x-coordinate of the center of the cone. The center of the cone is the midpoint of the vertical axis of the cone.
cy	(Mandatory)	The y-coordinate of the center of the cone. The center of the cone is the midpoint of the vertical axis of the cone.
radius	(Mandatory)	The radius of the base of the cone.
height	(Mandatory)	The height of the cone.

Some examples using this method:

• /ChartDirector/ChartDirector Control
• /ChartDirector/ChartDirector Control for Web
• /ChartDirector/ChartDirector Control Retina
• /ChartDirector/cone
• /ChartDirector/cone animated
• /ChartDirector/High Resolution Chart Examples/cone
• /ChartDirector/Place PDF Chart with DynaPDF
• /ChartDirector/quadview

CDPyramidChartMBS.setData(data() 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 data used to draw the pyramid chart.

Arguments:

Argument	Default	Description
data	(Mandatory)	An array of numbers representing the data values.
labels	[Empty_Array]	An array of text strings representing the labels of the layers. An empty array means no layer label.

See also:

• setData(data() as Double, labels() as string)

CDPyramidChartMBS.setData(data() as Double, labels() as string)

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
method	ChartDirector	MBS ChartDirector Plugin	9.2	✅ Yes	✅ Yes	✅ Yes	✅ Yes	All

Sets the data used to draw the pyramid chart.

Arguments:

Argument	Default	Description
data	(Mandatory)	An array of numbers representing the data values.
labels	[Empty_Array]	An array of text strings representing the labels of the layers. An empty array means no layer label.

See also:

• setData(data() as Double)

CDPyramidChartMBS.setFunnelSize(cx as Integer, cy as Integer, radius as Integer, height as Integer, tubeRadius as Double = 0.2, tubeHeight as Double = 0.3)

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
method	ChartDirector	MBS ChartDirector Plugin	9.2	✅ Yes	✅ Yes	✅ Yes	✅ Yes	All

Sets the position and size of the funnel in a funnel chart.

A funnel is similar to an inverted cone, except that the vertex of the cone is replaced by a tube.

Arguments:

Argument	Default	Description
cx	(Mandatory)	The x-coordinate of the center of the funnel. The center of the funnel is the midpoint of the vertical axis of the funnel.
cy	(Mandatory)	The y-coordinate of the center of the funnel. The center of the funnel is the midpoint of the vertical axis of the funnel.
radius	(Mandatory)	The radius of the mouth of the funnel.
height	(Mandatory)	The height of the funnel, inclusive of the tube.
tubeRadius	0.2	The radius of the tube, as a ratio to the radius of the mouth of the funnel.
tubeHeight	0.3	The height (length) of the tube, as a ratio to the total height of the funnel. It must be between 0 to 1.

Some examples using this method:

• /ChartDirector/funnel
• /ChartDirector/quadview

CDPyramidChartMBS.setGradientShading(startBrightness as Double, endBrightness as Double)

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
method	ChartDirector	MBS ChartDirector Plugin	9.2	✅ Yes	✅ Yes	✅ Yes	✅ Yes	All

Sets gradient shading mode.

Gradient shading only applies to 2D and 3D pyramids, and 2D cones and funnels. 3D cones and funnels always use Phong lighting (see CDPyramidChartMBS.setLighting).

The gradient is specified with two brightness values at the gradient end points. A brightness less than 1 means the color is darkened, while a brightness greater than 1 means the color is brightened. For example, a brightness of 0.5 means the color is half as bright as the original color. If the original color is red, the color will become dark red. Conversely, a brightness of 2 means the color is twice as bright as the original color. If the original color is red, the color will become light red.

For a pyramid or cone layer, the gradient is from left edge to the right edge. For a funnel chart, the gradient is from the right edge to the left edge.

For a pyramid chart, this is the default coloring method. If this method is never called, the default brightness is from 0.75 to 2.

Arguments:

Argument	Default	Description
startBrightness	(Mandatory)	The brightness at the starting point.
endBrightness	(Mandatory)	The brightness at the ending point.

CDPyramidChartMBS.setJoinLine(ColorValue as color, width 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 setJoinLine method, but uses color instead of integer data type for passing color values.

See also:

• setJoinLine(ColorValue as Integer, width as Integer = -1)

CDPyramidChartMBS.setJoinLine(ColorValue as Integer, width as Integer = -1)

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
method	ChartDirector	MBS ChartDirector Plugin	9.2	✅ Yes	✅ Yes	✅ Yes	✅ Yes	All

Sets the color and line width of the join lines that join the pyramid layers with the left and right labels.

This method affects all pyramid layers. To apply this method to one particular pyramid layer only, use PyramidLayer.setJoinLine.

Arguments:

Argument	Default	Description
color	(Mandatory)	The color of the join line. -1 means to keep the existing value unchanged.
width	-1	The width of the line join. -1 means to keep the existing value unchanged.

See also:

• setJoinLine(ColorValue as color, width as Integer = -1)

CDPyramidChartMBS.setJoinLineGap(pyramidGap as Integer)

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
method	ChartDirector	MBS ChartDirector Plugin	9.2	✅ Yes	✅ Yes	✅ Yes	✅ Yes	All

Sets the gaps of the join lines that join the pyramid layers with the left and right labels.

This method affects all pyramid layers. To apply this method to one particular pyramid layer only, use CDPyramidLayerMBS.setJoinLineGap.

By default, the starting point of the join line connects to the pyramid layer edge with a 3 pixels gap. The join line is horizontal, and its length is such that the ending point is 10 pixels outside the pyramid bounding box. The label text box connects to the ending point with a 3 pixels gap.

This method allows the gaps and positions of the join line end points to be configured to other values.

Arguments:

Argument	Default	Description
pyramidGap	(Mandatory)	The gap in pixels between the starting point of the join line and the pyramid layer edge.
pyramidMargin	10	The distance in pixels between the ending point of the join line and the pyramid bounding box.
textGap	3	The gap in pixels between the label text box and the ending point of the join line.

See also:

• setJoinLineGap(pyramidGap as Integer, pyramidMargin as Integer)
• setJoinLineGap(pyramidGap as Integer, pyramidMargin as Integer, textGap as Integer)

CDPyramidChartMBS.setJoinLineGap(pyramidGap as Integer, pyramidMargin as Integer)

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
method	ChartDirector	MBS ChartDirector Plugin	9.2	✅ Yes	✅ Yes	✅ Yes	✅ Yes	All

Sets the gaps of the join lines that join the pyramid layers with the left and right labels.

This method affects all pyramid layers. To apply this method to one particular pyramid layer only, use CDPyramidLayerMBS.setJoinLineGap.

By default, the starting point of the join line connects to the pyramid layer edge with a 3 pixels gap. The join line is horizontal, and its length is such that the ending point is 10 pixels outside the pyramid bounding box. The label text box connects to the ending point with a 3 pixels gap.

This method allows the gaps and positions of the join line end points to be configured to other values.

Arguments:

Argument	Default	Description
pyramidGap	(Mandatory)	The gap in pixels between the starting point of the join line and the pyramid layer edge.
pyramidMargin	10	The distance in pixels between the ending point of the join line and the pyramid bounding box.
textGap	3	The gap in pixels between the label text box and the ending point of the join line.

See also:

• setJoinLineGap(pyramidGap as Integer)
• setJoinLineGap(pyramidGap as Integer, pyramidMargin as Integer, textGap as Integer)

CDPyramidChartMBS.setJoinLineGap(pyramidGap as Integer, pyramidMargin as Integer, textGap as Integer)

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
method	ChartDirector	MBS ChartDirector Plugin	9.2	✅ Yes	✅ Yes	✅ Yes	✅ Yes	All

Sets the gaps of the join lines that join the pyramid layers with the left and right labels.

This method affects all pyramid layers. To apply this method to one particular pyramid layer only, use CDPyramidLayerMBS.setJoinLineGap.

By default, the starting point of the join line connects to the pyramid layer edge with a 3 pixels gap. The join line is horizontal, and its length is such that the ending point is 10 pixels outside the pyramid bounding box. The label text box connects to the ending point with a 3 pixels gap.

This method allows the gaps and positions of the join line end points to be configured to other values.

Arguments:

Argument	Default	Description
pyramidGap	(Mandatory)	The gap in pixels between the starting point of the join line and the pyramid layer edge.
pyramidMargin	10	The distance in pixels between the ending point of the join line and the pyramid bounding box.
textGap	3	The gap in pixels between the label text box and the ending point of the join line.

See also:

• setJoinLineGap(pyramidGap as Integer)
• setJoinLineGap(pyramidGap as Integer, pyramidMargin as Integer)

CDPyramidChartMBS.setLayerBorder(ColorValue as color, width 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 setLayerBorder method, but uses color instead of integer data type for passing color values.

See also:

• setLayerBorder(ColorValue as Integer, width as Integer = -1)

CDPyramidChartMBS.setLayerBorder(ColorValue as Integer, width as Integer = -1)

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
method	ChartDirector	MBS ChartDirector Plugin	9.2	✅ Yes	✅ Yes	✅ Yes	✅ Yes	All

Sets the color and line width of the layer border.

This method affects all pyramid layers. To apply this method to one particular pyramid layer only, use CDPyramidLayerMBS.setLayerBorder.

Arguments:

Argument	Default	Description
color	(Mandatory)	The color of the layer border. -1 means to keep the existing value unchanged.
width	-1	The width of the layer border. -1 means to keep the existing value unchanged.

See also:

• setLayerBorder(ColorValue as color, width as Integer = -1)

CDPyramidChartMBS.setLayerGap(layerGap 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 gaps between pyramid layers.

This method affects all pyramid layers. To apply this method to one particular pyramid layer only, use CDPyramidLayerMBS.setLayerGap.

Arguments:

Argument	Default	Description
layerGap	(Mandatory)	The gap between layers as a ratio to the height of the pyramid. The gap must be greater than or equals 0. The sum of all gaps must be less than 1.

CDPyramidChartMBS.setLeftLabel(labelTemplate as string = "", font as string = "", fontSize as Double = 8, fontColor as Integer = -1) as CDTextBoxMBS

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
method	ChartDirector	MBS ChartDirector Plugin	9.2	✅ Yes	✅ Yes	✅ Yes	✅ Yes	All

Adds labels to the left of the pyramid layers.

This method affects all pyramid layers. To apply this method to one particular pyramid layer only, use CDPyramidLayerMBS.setLeftLabel.

See Parameter Substitution and Formatting on available format parameters for the template.

See Font Specification for details on various font attributes.

Arguments:

Argument	Default	Description
template	"{skip}"	The label template. "{skip}" means to keep the existing value unchanged.
font	"{skip}"	The font style. "{skip}" means to keep the existing value unchanged.
fontSize	-1	The font size in points. -1 means to keep the existing value unchanged.
fontColor	-1	The font color. -1 means to keep the existing value unchanged.

Return Value
A CDTextBoxMBS object representing the prototype of the labels. This may be used to fine-tune the appearance of the labels.

See font specification here:
http://www.monkeybreadsoftware.net/faq-chartdirectorfontspecification.shtml

See also:

• setLeftLabel(labelTemplate as string, font as string, fontSize as Double, fontColor as color) as CDTextBoxMBS

CDPyramidChartMBS.setLeftLabel(labelTemplate as string, font as string, fontSize as Double, fontColor as color) as CDTextBoxMBS

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 setLeftLabel method, but uses color instead of integer data type for passing color values.

See also:

• setLeftLabel(labelTemplate as string = "", font as string = "", fontSize as Double = 8, fontColor as Integer = -1) as CDTextBoxMBS

CDPyramidChartMBS.setLighting(ambientIntensity as Double = 0.5, diffuseIntensity as Double = 0.5,specularIntensity as Double = 1, shininess as Double = 8)

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
method	ChartDirector	MBS ChartDirector Plugin	9.2	✅ Yes	✅ Yes	✅ Yes	✅ Yes	All

Sets Phong lighting mode.

This method adjusts the brightness of the surfaces as according to the Phong lighting model, in which the light source is from the viewer direction and is far away.

For a cone or funnel chart, this is the default coloring method.

For a pyramid chart, only ambient and diffuse reflections are used.

Arguments:

Argument	Default	Description
ambientIntensity	0.5	The ambient reflection coefficient of the Phong lighting model.
diffuseIntensity	0.5	The diffuse reflection coefficient of the Phong lighting model.
specularIntensity	1	The specular reflection coefficient of the Phong lighting model.
shininess	8	The shininess coefficient of the Phong lighting model.

CDPyramidChartMBS.setPyramidSides(noOfSides as Integer)

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
method	ChartDirector	MBS ChartDirector Plugin	9.2	✅ Yes	✅ Yes	✅ Yes	✅ Yes	All

Sets the number of sides of the base polygon in a pyramid chart.

By default, the base of a pyramid is a square. This method can be used to change it to other regular polygon.

Arguments:

Argument	Default	Description
noOfSides	(Mandatory)	The number of sides of the base polygon in a pyramid chart.

CDPyramidChartMBS.setPyramidSize(cx as Integer, cy as Integer, radius as Integer, height as Integer)

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
method	ChartDirector	MBS ChartDirector Plugin	9.2	✅ Yes	✅ Yes	✅ Yes	✅ Yes	All

Sets the position and size of the pyramid in a pyramid chart.

Arguments:

Argument	Default	Description
cx	(Mandatory)	The x-coordinate of the center of the pyramid. The center of the pyramid is the midpoint of the vertical axis of the pyramid.
cy	(Mandatory)	The y-coordinate of the center of the pyramid. The center of the pyramid is the midpoint of the vertical axis of the pyramid.
radius	(Mandatory)	For a square pyramid, it is the length of the square. For a pyramid with other regular polygonal base, it is the radius of the circumcircle of the base.
height	(Mandatory)	The height of the pyramid.

Some examples using this method:

• /ChartDirector/High Resolution Chart Examples/pyramidrotation
• /ChartDirector/pyramidelevation
• /ChartDirector/pyramidgap
• /ChartDirector/pyramidrotation
• /ChartDirector/quadview
• /ChartDirector/rotatedpyramid
• /ChartDirector/simplepyramid
• /ChartDirector/threedpyramid
• /ChartDirector/threedpyramid animated

CDPyramidChartMBS.setRightLabel(labelTemplate as string = "", font as string = "", fontSize as Double = 8, fontColor as Integer = -1) as CDTextBoxMBS

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
method	ChartDirector	MBS ChartDirector Plugin	9.2	✅ Yes	✅ Yes	✅ Yes	✅ Yes	All

Adds labels to the right of the pyramid layers.

This method affects all pyramid layers. To apply this method to one particular pyramid layer only, use CDPyramidLayerMBS.setRightLabel.

See Parameter Substitution and Formatting on available format parameters for the template.

See Font Specification for details on various font attributes.

Arguments:

Argument	Default	Description
template	"{skip}"	The label template. "{skip}" means to keep the existing value unchanged.
font	"{skip}"	The font style. "{skip}" means to keep the existing value unchanged.
fontSize	-1	The font size in points. -1 means to keep the existing value unchanged.
fontColor	-1	The font color. -1 means to keep the existing value unchanged.

Return Value:
A TextBox object representing the prototype of the labels. This may be used to fine-tune the appearance of the labels.

See font specification here:
http://www.monkeybreadsoftware.net/faq-chartdirectorfontspecification.shtml

See also:

• setRightLabel(labelTemplate as string, font as string, fontSize as Double, fontColor as color) as CDTextBoxMBS

CDPyramidChartMBS.setRightLabel(labelTemplate as string, font as string, fontSize as Double, fontColor as color) as CDTextBoxMBS

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 setRightLabel method, but uses color instead of integer data type for passing color values.

See also:

• setRightLabel(labelTemplate as string = "", font as string = "", fontSize as Double = 8, fontColor as Integer = -1) as CDTextBoxMBS

CDPyramidChartMBS.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	9.2	✅ Yes	✅ Yes	✅ Yes	✅ Yes	All

Sets the 3D view angles.

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.

Arguments:

Argument	Default	Description
elevation	(Mandatory)	The elevation angle in degrees.
rotation	0	The rotation angle in degrees.
twist	0	The twist angle in degrees.