Xojo Conferences
MBSSep2018MunichDE
XDCMay2019MiamiUSA

Platforms to show: All Mac Windows Linux Cross-Platform

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

CDPyramidLayerMBS.setCenterLabel(labelTemplate as string = "", font as string = "", fontSize as Double = 8, fontColor as Integer = -1) as CDTextBoxMBS
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method ChartDirector MBS ChartDirector Plugin 9.2 Yes Yes Yes Yes No
Function: Adds a label to the center of the pyramid layer.
Notes:
To apply this method to all pyramid layers, use CDPyramidChartMBS.setCenterLabel.

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

See Font Specification for details on various font attributes.

Arguments:
ArgumentDefaultDescription
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-1The font size in points. -1 means to keep the existing value unchanged.
fontColor-1The font color. -1 means to keep the existing value unchanged.

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

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

See also:

Feedback, Comments & Corrections

CDPyramidLayerMBS.setCenterLabel(labelTemplate as string, font as string, fontSize as Double, fontColor as color) as CDTextBoxMBS
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 setCenterLabel method, but uses color instead of integer data type for passing color values.

See also:

Feedback, Comments & Corrections

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

See also:

Feedback, Comments & Corrections

CDPyramidLayerMBS.setColor(ColorValue as Integer)
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method ChartDirector MBS ChartDirector Plugin 9.2 Yes Yes Yes Yes No
Function: Sets the color of the pyramid layer.

See also:

Feedback, Comments & Corrections

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

See also:

Feedback, Comments & Corrections

CDPyramidLayerMBS.setJoinLine(ColorValue as Integer, width as Integer = -1)
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method ChartDirector MBS ChartDirector Plugin 9.2 Yes Yes Yes Yes No
Function: Sets the color and line width of the join line that joins the pyramid layer with the left and right labels.
Notes:
To apply this method to all pyramid layers, use CDPyramidChartMBS.setJoinLine.

Arguments:
ArgumentDefaultDescription
color(Mandatory)The color of the join line. -1 means to keep the existing value unchanged.
width-1The width of the line join. -1 means to keep the existing value unchanged.

See also:

Feedback, Comments & Corrections

CDPyramidLayerMBS.setJoinLineGap(pyramidGap as Integer)
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method ChartDirector MBS ChartDirector Plugin 9.2 Yes Yes Yes Yes No
Function: Sets the gaps of the join line that joins the pyramid layer with the left and right labels.
Notes:
To apply this method to all pyramid layers, use CDPyramidChartMBS.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:
ArgumentDefaultDescription
pyramidGap(Mandatory)The gap in pixels between the starting point of the join line and the pyramid layer edge.
pyramidMargin10The distance in pixels between the ending point of the join line and the pyramid bounding box.
textGap3The gap in pixels between the label text box and the ending point of the join line.

See also:

Feedback, Comments & Corrections

CDPyramidLayerMBS.setJoinLineGap(pyramidGap as Integer, pyramidMargin as Integer)
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method ChartDirector MBS ChartDirector Plugin 9.2 Yes Yes Yes Yes No
Function: Sets the gaps of the join line that joins the pyramid layer with the left and right labels.
Notes:
To apply this method to all pyramid layers, use CDPyramidChartMBS.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:
ArgumentDefaultDescription
pyramidGap(Mandatory)The gap in pixels between the starting point of the join line and the pyramid layer edge.
pyramidMargin10The distance in pixels between the ending point of the join line and the pyramid bounding box.
textGap3The gap in pixels between the label text box and the ending point of the join line.

See also:

Feedback, Comments & Corrections

CDPyramidLayerMBS.setJoinLineGap(pyramidGap as Integer, pyramidMargin as Integer, textGap as Integer)
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method ChartDirector MBS ChartDirector Plugin 9.2 Yes Yes Yes Yes No
Function: Sets the gaps of the join line that joins the pyramid layer with the left and right labels.
Notes:
To apply this method to all pyramid layers, use CDPyramidChartMBS.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:
ArgumentDefaultDescription
pyramidGap(Mandatory)The gap in pixels between the starting point of the join line and the pyramid layer edge.
pyramidMargin10The distance in pixels between the ending point of the join line and the pyramid bounding box.
textGap3The gap in pixels between the label text box and the ending point of the join line.

See also:

Feedback, Comments & Corrections

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

See also:

Feedback, Comments & Corrections

CDPyramidLayerMBS.setLayerBorder(ColorValue as Integer, width as Integer = -1)
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method ChartDirector MBS ChartDirector Plugin 9.2 Yes Yes Yes Yes No
Function: Sets the color and line width of the layer border.
Notes:
To apply this method to all pyramid layers, use CDPyramidChartMBS.setLayerBorder.

Arguments:
ArgumentDefaultDescription
color(Mandatory)The color of the layer border. -1 means to keep the existing value unchanged.
width-1The width of the layer border. -1 means to keep the existing value unchanged.

See also:

Feedback, Comments & Corrections

CDPyramidLayerMBS.setLayerGap(layerGap as Double)
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method ChartDirector MBS ChartDirector Plugin 9.2 Yes Yes Yes Yes No
Function: Sets the gap between this pyramid layer and the next pyramid layer.
Notes:
To apply this method to all pyramid layers, use CDPyramidChartMBS.setLayerGap.

Arguments:
ArgumentDefaultDescription
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.

Feedback, Comments & Corrections

CDPyramidLayerMBS.setLeftLabel(labelTemplate as string = "", font as string = "", fontSize as Double = 8, fontColor as Integer = -1) as CDTextBoxMBS
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method ChartDirector MBS ChartDirector Plugin 9.2 Yes Yes Yes Yes No
Function: Adds a label to the left of the pyramid layer.
Notes:
To apply this method to all pyramid layers, use CDPyramidChartMBS.setLeftLabel.

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

See Font Specification for details on various font attributes.

Arguments:
ArgumentDefaultDescription
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-1The font size in points. -1 means to keep the existing value unchanged.
fontColor-1The font color. -1 means to keep the existing value unchanged.

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

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

See also:

Feedback, Comments & Corrections

CDPyramidLayerMBS.setLeftLabel(labelTemplate as string, font as string, fontSize as Double, fontColor as color) as CDTextBoxMBS
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 setLeftLabel method, but uses color instead of integer data type for passing color values.

See also:

Feedback, Comments & Corrections

CDPyramidLayerMBS.setRightLabel(labelTemplate as string = "", font as string = "", fontSize as Double = 8, fontColor as Integer = -1) as CDTextBoxMBS
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method ChartDirector MBS ChartDirector Plugin 9.2 Yes Yes Yes Yes No
Function: Adds a label to the right of the pyramid layer.
Notes:
To apply this method to all pyramid layers, use CDPyramidChartMBS.setRightLabel.

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

See Font Specification for details on various font attributes.

Arguments:
ArgumentDefaultDescription
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-1The font size in points. -1 means to keep the existing value unchanged.
fontColor-1The font color. -1 means to keep the existing value unchanged.

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

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

See also:

Feedback, Comments & Corrections

CDPyramidLayerMBS.setRightLabel(labelTemplate as string, font as string, fontSize as Double, fontColor as color) as CDTextBoxMBS
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 setRightLabel method, but uses color instead of integer data type for passing color values.

See also:

Feedback, Comments & Corrections

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




Links
MBS Xojo Plugins