Platforms to show: All Mac Windows Linux Cross-Platform
Back to CDPyramidLayerMBS class.
CDPyramidLayerMBS.Constructor Private
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | ChartDirector | MBS ChartDirector Plugin | 15.2 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
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 | iOS | Targets |
method | ChartDirector | MBS ChartDirector Plugin | 9.2 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
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:
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 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:
CDPyramidLayerMBS.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 |
See also:
CDPyramidLayerMBS.setColor(ColorValue as color)
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | ChartDirector | MBS ChartDirector Plugin | 11.1 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
See also:
CDPyramidLayerMBS.setColor(ColorValue as Integer)
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | ChartDirector | MBS ChartDirector Plugin | 9.2 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
See also:
CDPyramidLayerMBS.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 |
See also:
CDPyramidLayerMBS.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 |
To apply this method to all pyramid layers, use CDPyramidChartMBS.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:
CDPyramidLayerMBS.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 |
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:
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:
CDPyramidLayerMBS.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 |
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:
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:
CDPyramidLayerMBS.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 |
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:
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:
CDPyramidLayerMBS.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 |
See also:
CDPyramidLayerMBS.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 |
To apply this method to all pyramid layers, use CDPyramidChartMBS.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:
CDPyramidLayerMBS.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 |
To apply this method to all pyramid layers, use CDPyramidChartMBS.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. |
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 | iOS | Targets |
method | ChartDirector | MBS ChartDirector Plugin | 9.2 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
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:
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 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:
CDPyramidLayerMBS.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 |
See also:
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 | iOS | Targets |
method | ChartDirector | MBS ChartDirector Plugin | 9.2 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
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:
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 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:
CDPyramidLayerMBS.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 |
See also:
The items on this page are in the following plugins: MBS ChartDirector Plugin.