MBS Xojo Developer Conference and Training
Join us from 11th to 14th September 2013 in Koblenz.
Join us from 11th to 14th September 2013 in Koblenz.
Platforms to show: All Mac Windows Linux Cross-Platform
CDBaseChartMBS.makeChart as CDDrawAreaMBS
method, ChartDirector, MBS Real Studio ChartDirector Plugin (ChartDirector5), class CDBaseChartMBS,
Plugin version: 8.2, Mac: Yes, Win: Yes, Linux: Yes, Console & Web: Yes, Feedback.
Function: Generates the chart in internal format and return a DrawArea object to allow adding custom drawings on top of the chart.
Notes:
If you want to add custom drawings at the background of the chart, use the BaseChart.getDrawArea method to obtain the DrawArea instead.
After finish adding custom drawings, the resulting chart can then be output using other chart output methods.
Return Value
A DrawArea object that can be used to add custom text and shapes to the chart.
method, ChartDirector, MBS Real Studio ChartDirector Plugin (ChartDirector5), class CDBaseChartMBS,
Plugin version: 8.2, Mac: Yes, Win: Yes, Linux: Yes, Console & Web: Yes, Feedback.
Function: Generates the chart in internal format and return a DrawArea object to allow adding custom drawings on top of the chart.
Notes:
If you want to add custom drawings at the background of the chart, use the BaseChart.getDrawArea method to obtain the DrawArea instead.
After finish adding custom drawings, the resulting chart can then be output using other chart output methods.
Return Value
A DrawArea object that can be used to add custom text and shapes to the chart.
See also:
CDBaseChartMBS.makeChart(format as integer) as string
method, ChartDirector, MBS Real Studio ChartDirector Plugin (ChartDirector5), class CDBaseChartMBS,
Plugin version: 8.2, Mac: Yes, Win: Yes, Linux: Yes, Console & Web: Yes, Feedback.
Function: Generates the chart as an image in memory.
Notes:
This method is most often used to output the chart directly to an HTTP stream.
ChartDirector supports PNG, JPG, GIF, WBMP and BMP formats, denoted by the following predefined constants:
ConstantValueDescription
Return Value
A memory block containing the binary image of the chart in the requested format.
method, ChartDirector, MBS Real Studio ChartDirector Plugin (ChartDirector5), class CDBaseChartMBS,
Plugin version: 8.2, Mac: Yes, Win: Yes, Linux: Yes, Console & Web: Yes, Feedback.
Function: Generates the chart as an image in memory.
Notes:
This method is most often used to output the chart directly to an HTTP stream.
ChartDirector supports PNG, JPG, GIF, WBMP and BMP formats, denoted by the following predefined constants:
ConstantValueDescription
| PNG | 0 | The PNG format. |
| GIF | 1 | The GIF format. |
| JPG | 2 | The JPEG format. |
| WMP | 3 | The WAP bitmap format. |
| BMP | 4 | The BMP format. |
| Argument | Default | Description |
| format | (Mandatory) | A constant representing the format of the image. |
A memory block containing the binary image of the chart in the requested format.
See also:
CDBaseChartMBS.makeChart(path as folderitem) as boolean
method, ChartDirector, MBS Real Studio ChartDirector Plugin (ChartDirector5), class CDBaseChartMBS,
Plugin version: 8.2, Mac: Yes, Win: Yes, Linux: Yes, Console & Web: Yes, Feedback.
Function: Generates the chart image and save it into a file.
Notes:
ChartDirector supports PNG, JPG, GIF, WBMP and BMP. The format used are selected based on file extension, which should be png, jpg, jpeg, gif, wbmp, wmp or bmp.
Return Value
A true value indicates no error. A false value indicates the operation is unsuccessful.
method, ChartDirector, MBS Real Studio ChartDirector Plugin (ChartDirector5), class CDBaseChartMBS,
Plugin version: 8.2, Mac: Yes, Win: Yes, Linux: Yes, Console & Web: Yes, Feedback.
Function: Generates the chart image and save it into a file.
Notes:
ChartDirector supports PNG, JPG, GIF, WBMP and BMP. The format used are selected based on file extension, which should be png, jpg, jpeg, gif, wbmp, wmp or bmp.
| Argument | Default | Description |
| filename | (Mandatory) | The name of the file to save the image. |
A true value indicates no error. A false value indicates the operation is unsuccessful.
See also:
CDBaseChartMBS.makeChartPicture as picture
method, ChartDirector, MBS Real Studio ChartDirector Plugin (ChartDirector5), class CDBaseChartMBS,
Plugin version: 8.2, Mac: Yes, Win: Yes, Linux: Yes, Console & Web: Yes, Feedback.
Function: Generates the chart as a picture.
Notes: Returns nil on any error.
method, ChartDirector, MBS Real Studio ChartDirector Plugin (ChartDirector5), class CDBaseChartMBS,
Plugin version: 8.2, Mac: Yes, Win: Yes, Linux: Yes, Console & Web: Yes, Feedback.
Function: Generates the chart as a picture.
Notes: Returns nil on any error.
CDBaseChartMBS.metalColor(c as integer, angle as integer = 90) as integer
shared method, ChartDirector, MBS Real Studio ChartDirector Plugin (ChartDirector5), class CDBaseChartMBS,
Plugin version: 8.2, Mac: Yes, Win: Yes, Linux: Yes, Console & Web: Yes, Feedback.
Function: Creates a color by modulates the brightness of another color to create metallic shiny effects.
Notes:
The brightness of the color will vary smoothly across the image in a given a direction, so as to produce a shiny effect. The modulation period will be the same as the size of the image, so this method is best use to create background colors.
Return Value
A 32-bit integer representing the metallic color.
shared method, ChartDirector, MBS Real Studio ChartDirector Plugin (ChartDirector5), class CDBaseChartMBS,
Plugin version: 8.2, Mac: Yes, Win: Yes, Linux: Yes, Console & Web: Yes, Feedback.
Function: Creates a color by modulates the brightness of another color to create metallic shiny effects.
Notes:
The brightness of the color will vary smoothly across the image in a given a direction, so as to produce a shiny effect. The modulation period will be the same as the size of the image, so this method is best use to create background colors.
| Argument | Default | Description |
| c | (Mandatory) | The color to be modulated. |
| angle | 90 | The direction for brightness modulation, specified as a clockwise angle in degrees, with 0 being the upward pointing direction. |
A 32-bit integer representing the metallic color.
CDBaseChartMBS.NonePassFilter as integer
shared method, ChartDirector, MBS Real Studio ChartDirector Plugin (ChartDirector5), class CDBaseChartMBS,
Plugin version: 8.2, Mac: Yes, Win: Yes, Linux: Yes, Console & Web: Yes, Feedback.
Function: Creates a data filter that matches no element.
Notes:
This method is typically used in Axis.setMultiFormat and Axis.setMultiFormat2 as a "deny all" filter.
Return Value
An integer filter id representing the filter.
shared method, ChartDirector, MBS Real Studio ChartDirector Plugin (ChartDirector5), class CDBaseChartMBS,
Plugin version: 8.2, Mac: Yes, Win: Yes, Linux: Yes, Console & Web: Yes, Feedback.
Function: Creates a data filter that matches no element.
Notes:
This method is typically used in Axis.setMultiFormat and Axis.setMultiFormat2 as a "deny all" filter.
Return Value
An integer filter id representing the filter.
CDBaseChartMBS.patternColor(colorvalues() as color, height as integer, startX as integer = 0, startY as integer = 0) as integer
method, ChartDirector, MBS Real Studio ChartDirector Plugin (ChartDirector5), class CDBaseChartMBS,
Plugin version: 11.1, Mac: Yes, Win: Yes, Linux: Yes, Console & Web: Yes, Feedback.
Function: Same as the other patternColor method, but uses color instead of integer data type for passing color values.
method, ChartDirector, MBS Real Studio ChartDirector Plugin (ChartDirector5), class CDBaseChartMBS,
Plugin version: 11.1, Mac: Yes, Win: Yes, Linux: Yes, Console & Web: Yes, Feedback.
Function: Same as the other patternColor method, but uses color instead of integer data type for passing color values.
See also:
CDBaseChartMBS.patternColor(colorvalues() as integer, height as integer, startX as integer = 0, startY as integer = 0) as integer
method, ChartDirector, MBS Real Studio ChartDirector Plugin (ChartDirector5), class CDBaseChartMBS,
Plugin version: 8.2, Mac: Yes, Win: Yes, Linux: Yes, Console & Web: Yes, Feedback.
Function: Creates a pattern color using an array of colors as the bitmap pattern.
Notes:
A pattern color is a dynamic color that changes according to a 2D periodic pattern. When it is used to fill an area, the area will look like being tiled with a wallpaper pattern.
Return Value
A 32-bit integer representing the pattern color.
method, ChartDirector, MBS Real Studio ChartDirector Plugin (ChartDirector5), class CDBaseChartMBS,
Plugin version: 8.2, Mac: Yes, Win: Yes, Linux: Yes, Console & Web: Yes, Feedback.
Function: Creates a pattern color using an array of colors as the bitmap pattern.
Notes:
A pattern color is a dynamic color that changes according to a 2D periodic pattern. When it is used to fill an area, the area will look like being tiled with a wallpaper pattern.
| Argument | Default | Description |
| colorArray | (Mandatory) | An array of colors representing the colors of the bitmap pixels. The color of the pixel at (x, y) should correspond to index (x + y * width - 1) of the array. |
| height | (Mandatory) | The height of the bitmap in pixels. (The width is automatically computed as the size of the color array divided by the height.) |
| startX | 0 | The x coordinate of a reference point to align with the top-left corner the pattern. |
| startY | 0 | The y coordinate of a reference point to align with the top-left corner the pattern. |
A 32-bit integer representing the pattern color.
See also:
CDBaseChartMBS.patternColor(file as folderitem, startX as integer = 0, startY as integer = 0) as integer
method, ChartDirector, MBS Real Studio ChartDirector Plugin (ChartDirector5), class CDBaseChartMBS,
Plugin version: 8.2, Mac: Yes, Win: Yes, Linux: Yes, Console & Web: Yes, Feedback.
Function: Creates a pattern color by loading the pattern from an image file.
Notes:
A pattern color is a dynamic color that changes according to a 2D periodic pattern. When it is used to fill an area, the area will look like being tiled with a wallpaper pattern.
ChartDirector will automatically detect the image file format using the file extension, which must either png, jpg, jpeg, gif, wbmp or wmp (case insensitive).
Please refer to BaseChart.setSearchPath on the directory that ChartDirector will search for the file.
Return Value
A 32-bit integer representing the pattern color.
method, ChartDirector, MBS Real Studio ChartDirector Plugin (ChartDirector5), class CDBaseChartMBS,
Plugin version: 8.2, Mac: Yes, Win: Yes, Linux: Yes, Console & Web: Yes, Feedback.
Function: Creates a pattern color by loading the pattern from an image file.
Notes:
A pattern color is a dynamic color that changes according to a 2D periodic pattern. When it is used to fill an area, the area will look like being tiled with a wallpaper pattern.
ChartDirector will automatically detect the image file format using the file extension, which must either png, jpg, jpeg, gif, wbmp or wmp (case insensitive).
Please refer to BaseChart.setSearchPath on the directory that ChartDirector will search for the file.
| Argument | Default | Description |
| filename | (Mandatory) | An image file providing the pattern. |
| startX | 0 | The x coordinate of a reference point to align with the top-left corner the pattern. |
| startY | 0 | The y coordinate of a reference point to align with the top-left corner the pattern. |
A 32-bit integer representing the pattern color.
See also:
- patternColor(colorvalues() as color, height as integer, startX as integer = 0, startY as integer = 0) as integer
- patternColor(colorvalues() as integer, height as integer, startX as integer = 0, startY as integer = 0) as integer
- patternColor(pic as picture, startX as integer = 0, startY as integer = 0) as integer
CDBaseChartMBS.patternColor(pic as picture, startX as integer = 0, startY as integer = 0) as integer
method, ChartDirector, MBS Real Studio ChartDirector Plugin (ChartDirector5), class CDBaseChartMBS,
Plugin version: 12.4, Mac: Yes, Win: Yes, Linux: Yes, Console & Web: Yes, Feedback.
Function: Creates a pattern color using a picture.
Notes:
A pattern color is a dynamic color that changes according to a 2D periodic pattern. When it is used to fill an area, the area will look like being tiled with a wallpaper pattern.
Return Value
A 32-bit integer representing the pattern color.
method, ChartDirector, MBS Real Studio ChartDirector Plugin (ChartDirector5), class CDBaseChartMBS,
Plugin version: 12.4, Mac: Yes, Win: Yes, Linux: Yes, Console & Web: Yes, Feedback.
Function: Creates a pattern color using a picture.
Notes:
A pattern color is a dynamic color that changes according to a 2D periodic pattern. When it is used to fill an area, the area will look like being tiled with a wallpaper pattern.
| Argument | Default | Description |
| pic | (Mandatory) | A picture. The color of the pixel at (x, y) should correspond to index (x + y * width - 1) of the array. |
| startX | 0 | The x coordinate of a reference point to align with the top-left corner the pattern. |
| startY | 0 | The y coordinate of a reference point to align with the top-left corner the pattern. |
A 32-bit integer representing the pattern color.
See also:
- patternColor(colorvalues() as color, height as integer, startX as integer = 0, startY as integer = 0) as integer
- patternColor(colorvalues() as integer, height as integer, startX as integer = 0, startY as integer = 0) as integer
- patternColor(file as folderitem, startX as integer = 0, startY as integer = 0) as integer
CDBaseChartMBS.phongLighting(ambientIntensity as double = 0.5, diffuseIntensity as double = 0.5, specularIntensity as double = 0.75, shininess as integer = 8) as integer
shared method, ChartDirector, MBS Real Studio ChartDirector Plugin (ChartDirector5), class CDBaseChartMBS,
Plugin version: 12.3, Mac: Yes, Win: Yes, Linux: Yes, Console & Web: Yes, Feedback.
Function: Sets the parameters for the phong lighting effect.
Notes:
The return value of this method can be used as the second argument to Layer.setBorderColor to configure phong lighting effect for the layer.
shared method, ChartDirector, MBS Real Studio ChartDirector Plugin (ChartDirector5), class CDBaseChartMBS,
Plugin version: 12.3, Mac: Yes, Win: Yes, Linux: Yes, Console & Web: Yes, Feedback.
Function: Sets the parameters for the phong lighting effect.
Notes:
The return value of this method can be used as the second argument to Layer.setBorderColor to configure phong lighting effect for the layer.
| 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 | 0.75 | The specular reflection coefficient of the Phong lighting model. |
| shininess | 8 | The shininess coefficient of the Phong lighting model. |
CDBaseChartMBS.Polygon2Shape(slide as integer) as integer
shared method, ChartDirector, MBS Real Studio ChartDirector Plugin (ChartDirector5), class CDBaseChartMBS,
Plugin version: 8.2, Mac: Yes, Win: Yes, Linux: Yes, Console & Web: Yes, Feedback.
Function: Gets the shape id that represents a polygon in an alternative orientation.
Notes:
Please refer to Shape Specification for samples and more information on using shapes in ChartDirector.
Return Value
An integer shape id representing the polygon in an alternative orientation.
shared method, ChartDirector, MBS Real Studio ChartDirector Plugin (ChartDirector5), class CDBaseChartMBS,
Plugin version: 8.2, Mac: Yes, Win: Yes, Linux: Yes, Console & Web: Yes, Feedback.
Function: Gets the shape id that represents a polygon in an alternative orientation.
Notes:
Please refer to Shape Specification for samples and more information on using shapes in ChartDirector.
| Argument | Default | Description |
| side | (Mandatory) | The number of sides the polygon has. |
An integer shape id representing the polygon in an alternative orientation.
CDBaseChartMBS.PolygonShape(slide as integer) as integer
shared method, ChartDirector, MBS Real Studio ChartDirector Plugin (ChartDirector5), class CDBaseChartMBS,
Plugin version: 8.2, Mac: Yes, Win: Yes, Linux: Yes, Console & Web: Yes, Feedback.
Function: Gets the shape id that represents a polygon.
Notes:
Please refer to Shape Specification for samples and more information on using shapes in ChartDirector.
Return Value
An integer shape id representing the polygon.
shared method, ChartDirector, MBS Real Studio ChartDirector Plugin (ChartDirector5), class CDBaseChartMBS,
Plugin version: 8.2, Mac: Yes, Win: Yes, Linux: Yes, Console & Web: Yes, Feedback.
Function: Gets the shape id that represents a polygon.
Notes:
Please refer to Shape Specification for samples and more information on using shapes in ChartDirector.
| Argument | Default | Description |
| side | (Mandatory) | The number of sides the polygon has. |
An integer shape id representing the polygon.
CDBaseChartMBS.PolynomialRegression(n as integer) as integer
shared method, ChartDirector, MBS Real Studio ChartDirector Plugin (ChartDirector5), class CDBaseChartMBS,
Plugin version: 9.2, Mac: Yes, Win: Yes, Linux: Yes, Console & Web: Yes, Feedback.
Function: Sets the degree of the polynomial regression to be used in a trend layer.
Notes:
This method is used to specify the polynomial regression type in CDTrendLayerMBS.setRegressionType.
Arguments:
Return Value
An integer representing a polynomial regression of degree n to be used as an argument to CDTrendLayerMBS.setRegressionType.
shared method, ChartDirector, MBS Real Studio ChartDirector Plugin (ChartDirector5), class CDBaseChartMBS,
Plugin version: 9.2, Mac: Yes, Win: Yes, Linux: Yes, Console & Web: Yes, Feedback.
Function: Sets the degree of the polynomial regression to be used in a trend layer.
Notes:
This method is used to specify the polynomial regression type in CDTrendLayerMBS.setRegressionType.
Arguments:
| Argument | Default | Description |
| n | (Mandatory) | The degree of the polynomial. |
Return Value
An integer representing a polynomial regression of degree n to be used as an argument to CDTrendLayerMBS.setRegressionType.
CDBaseChartMBS.radialGradientColor(cx as integer, cy as integer, rx as integer, ry as integer, data() as integer, periodic as boolean=false) as integer
method, ChartDirector, MBS Real Studio ChartDirector Plugin (ChartDirector5), class CDBaseChartMBS,
Plugin version: 8.2, Mac: Yes, Win: Yes, Linux: Yes, Console & Web: Yes, Feedback.
Function: Creates a multi-point radial gradient color.
Notes:
In this method, the color points are defined as an array of radial distances and colors, in the following format:
distance0, color0, distance1, color1, .... distanceN, colorN
The distances are specified as a number from 0 - 256 (0 - 100 in hex), in which 0 represents the center of the gradient defining ellipse, and 256 (100 in hex) represents the perimeter of the gradient defining ellipse.
For example, the array (in hex):
000000, FF0000, 000080, FFFF00, 000100, 00FF00
means the center (000000) is red (FF0000), the mid-point (000080 in hex) is yellow (FFFF00), and the perimeter (000100 in hex) is green (00FF00).
Return Value
A 32-bit integer representing the radial gradient color.
method, ChartDirector, MBS Real Studio ChartDirector Plugin (ChartDirector5), class CDBaseChartMBS,
Plugin version: 8.2, Mac: Yes, Win: Yes, Linux: Yes, Console & Web: Yes, Feedback.
Function: Creates a multi-point radial gradient color.
Notes:
In this method, the color points are defined as an array of radial distances and colors, in the following format:
distance0, color0, distance1, color1, .... distanceN, colorN
The distances are specified as a number from 0 - 256 (0 - 100 in hex), in which 0 represents the center of the gradient defining ellipse, and 256 (100 in hex) represents the perimeter of the gradient defining ellipse.
For example, the array (in hex):
000000, FF0000, 000080, FFFF00, 000100, 00FF00
means the center (000000) is red (FF0000), the mid-point (000080 in hex) is yellow (FFFF00), and the perimeter (000100 in hex) is green (00FF00).
| Argument | Default | Description |
| cx | (Mandatory) | The x coordinate of the center of the radial gradient. |
| cy | (Mandatory) | The y coordinate of the center of the radial gradient. |
| rx | (Mandatory) | The horizontal radius of the radial gradient defining ellipse. |
| ry | (Mandatory) | The vertical radius of the radial gradient defining ellipse. |
| colorArray | (Mandatory) | An array defining the radial distances and colors. |
| periodic | false | Specifies whether the gradient will repeat itself periodically. If the gradient does not repeat itself, the points that lie outside the gradient defining ellipse will assume the color at the perimeter of the gradient defining ellipse. |
A 32-bit integer representing the radial gradient color.
See also:
- radialGradientColor(cx as integer, cy as integer, rx as integer, ry as integer, startColor as color, endColor as color, periodic as boolean=false) as integer
- radialGradientColor(cx as integer, cy as integer, rx as integer, ry as integer, startColor as integer, endColor as integer, periodic as boolean=false) as integer
CDBaseChartMBS.radialGradientColor(cx as integer, cy as integer, rx as integer, ry as integer, startColor as color, endColor as color, periodic as boolean=false) as integer
method, ChartDirector, MBS Real Studio ChartDirector Plugin (ChartDirector5), class CDBaseChartMBS,
Plugin version: 11.1, Mac: Yes, Win: Yes, Linux: Yes, Console & Web: Yes, Feedback.
Function: Same as the other radialGradientColor method, but uses color instead of integer data type for passing color values.
method, ChartDirector, MBS Real Studio ChartDirector Plugin (ChartDirector5), class CDBaseChartMBS,
Plugin version: 11.1, Mac: Yes, Win: Yes, Linux: Yes, Console & Web: Yes, Feedback.
Function: Same as the other radialGradientColor method, but uses color instead of integer data type for passing color values.
See also:
CDBaseChartMBS.radialGradientColor(cx as integer, cy as integer, rx as integer, ry as integer, startColor as integer, endColor as integer, periodic as boolean=false) as integer
method, ChartDirector, MBS Real Studio ChartDirector Plugin (ChartDirector5), class CDBaseChartMBS,
Plugin version: 8.2, Mac: Yes, Win: Yes, Linux: Yes, Console & Web: Yes, Feedback.
Function: Creates a two-point radial gradient color.
Notes:
Return Value
A 32-bit integer representing the radial gradient color.
method, ChartDirector, MBS Real Studio ChartDirector Plugin (ChartDirector5), class CDBaseChartMBS,
Plugin version: 8.2, Mac: Yes, Win: Yes, Linux: Yes, Console & Web: Yes, Feedback.
Function: Creates a two-point radial gradient color.
Notes:
| Argument | Default | Description |
| cx | (Mandatory) | The x coordinate of the center of the radial gradient. |
| cy | (Mandatory) | The y coordinate of the center of the radial gradient. |
| rx | (Mandatory) | The horizontal radius of the radial gradient defining ellipse. |
| ry | (Mandatory) | The vertical radius of the radial gradient defining ellipse. |
| startColor | (Mandatory) | The color at the center of the gradient defining ellipse. |
| endColor | (Mandatory) | The color at the perimeter of the gradient defining ellipse. |
| periodic | false | Specifies whether the gradient will repeat itself periodically. If the gradient does not repeat itself, the points that lie outside the gradient defining ellipse will assume the color at the perimeter of the gradient defining ellipse. |
A 32-bit integer representing the radial gradient color.
See also:
CDBaseChartMBS.redMetalGradient as integer()
shared method, ChartDirector, MBS Real Studio ChartDirector Plugin (ChartDirector5), class CDBaseChartMBS,
Plugin version: 8.2, Mac: Yes, Win: Yes, Linux: Yes, Console & Web: Yes, Feedback.
Function: A constant array of integers to represent a gradient that looks like a red metallic color.
Notes:
The array is in a format that can be directly used in BaseChart.gradientColor and DrawArea.gradientColor. Its contents (in hex) is:
00 E09898 60 FFF0F0 B0 F0D8D8 100 E09898
See Color Specification on how colors are represented in ChartDirector.
shared method, ChartDirector, MBS Real Studio ChartDirector Plugin (ChartDirector5), class CDBaseChartMBS,
Plugin version: 8.2, Mac: Yes, Win: Yes, Linux: Yes, Console & Web: Yes, Feedback.
Function: A constant array of integers to represent a gradient that looks like a red metallic color.
Notes:
The array is in a format that can be directly used in BaseChart.gradientColor and DrawArea.gradientColor. Its contents (in hex) is:
00 E09898 60 FFF0F0 B0 F0D8D8 100 E09898
See Color Specification on how colors are represented in ChartDirector.
CDBaseChartMBS.RegularSpacingFilter(labelStep as integer = 1, initialMargin as integer = 0) as integer
shared method, ChartDirector, MBS Real Studio ChartDirector Plugin (ChartDirector5), class CDBaseChartMBS,
Plugin version: 8.2, Mac: Yes, Win: Yes, Linux: Yes, Console & Web: Yes, Feedback.
Function: Creates a data filter that matches 1 out of every N elements.
Notes:
This method is typically used in Axis.setMultiFormat and Axis.setMultiFormat2 to select specific elements for formatting as axis labels.
Return Value
An integer filter id representing the filter.
shared method, ChartDirector, MBS Real Studio ChartDirector Plugin (ChartDirector5), class CDBaseChartMBS,
Plugin version: 8.2, Mac: Yes, Win: Yes, Linux: Yes, Console & Web: Yes, Feedback.
Function: Creates a data filter that matches 1 out of every N elements.
Notes:
This method is typically used in Axis.setMultiFormat and Axis.setMultiFormat2 to select specific elements for formatting as axis labels.
| Argument | Default | Description |
| labelStep | 1 | Picks 1 out of every "labelStep" number of elements. For example, if this argument is 3, only 1 of every 3 elements will be selected. |
| initialMargin | 0 | Adds an offset when determining the elements to be selected. For example, if the labelStep is 3, the selected indexes should be 0, 3, 6, 9, .... If initialMargin is set to 1, the indexes becomes 1, 4, 7, 10, .... |
An integer filter id representing the filter.
CDBaseChartMBS.removeDynamicLayer
method, ChartDirector, MBS Real Studio ChartDirector Plugin (ChartDirector5), class CDBaseChartMBS,
Plugin version: 12.3, Mac: Yes, Win: Yes, Linux: Yes, Console & Web: Yes, Feedback.
Function: Removes the dynamic layer if any.
method, ChartDirector, MBS Real Studio ChartDirector Plugin (ChartDirector5), class CDBaseChartMBS,
Plugin version: 12.3, Mac: Yes, Win: Yes, Linux: Yes, Console & Web: Yes, Feedback.
Function: Removes the dynamic layer if any.
CDBaseChartMBS.RGB(r as integer, g as integer, b as integer, a as integer = 0) as integer
shared method, ChartDirector, MBS Real Studio ChartDirector Plugin (ChartDirector5), class CDBaseChartMBS,
Plugin version: 8.2, Mac: Yes, Win: Yes, Linux: Yes, Console & Web: Yes, Feedback.
Function: Creates a RGB color.
shared method, ChartDirector, MBS Real Studio ChartDirector Plugin (ChartDirector5), class CDBaseChartMBS,
Plugin version: 8.2, Mac: Yes, Win: Yes, Linux: Yes, Console & Web: Yes, Feedback.
Function: Creates a RGB color.
CDBaseChartMBS.SelectItemFilter(item as integer) as integer
shared method, ChartDirector, MBS Real Studio ChartDirector Plugin (ChartDirector5), class CDBaseChartMBS,
Plugin version: 8.2, Mac: Yes, Win: Yes, Linux: Yes, Console & Web: Yes, Feedback.
Function: Creates a data filter that matches the specified item.
Notes:
This method is typically used in Axis.setMultiFormat and Axis.setMultiFormat2 to select a specific element for special formatting.
Return Value
An integer filter id representing the filter.
shared method, ChartDirector, MBS Real Studio ChartDirector Plugin (ChartDirector5), class CDBaseChartMBS,
Plugin version: 8.2, Mac: Yes, Win: Yes, Linux: Yes, Console & Web: Yes, Feedback.
Function: Creates a data filter that matches the specified item.
Notes:
This method is typically used in Axis.setMultiFormat and Axis.setMultiFormat2 to select a specific element for special formatting.
| Argument | Default | Description |
| item | (Mandatory) | The index of the specified item. |
An integer filter id representing the filter.
CDBaseChartMBS.setAMPM(am as string, pm as string)
method, ChartDirector, MBS Real Studio ChartDirector Plugin (ChartDirector5), class CDBaseChartMBS,
Plugin version: 8.2, Mac: Yes, Win: Yes, Linux: Yes, Console & Web: Yes, Feedback.
Function: Sets the names to be used to denote morning and afternoon.
Notes:
The default is to use "am" and "pm".
method, ChartDirector, MBS Real Studio ChartDirector Plugin (ChartDirector5), class CDBaseChartMBS,
Plugin version: 8.2, Mac: Yes, Win: Yes, Linux: Yes, Console & Web: Yes, Feedback.
Function: Sets the names to be used to denote morning and afternoon.
Notes:
The default is to use "am" and "pm".
| Argument | Default | Description |
| am | (Mandatory) | The name used to denote morning. |
| pm | (Mandatory) | The name used to denote afternoon. |
CDBaseChartMBS.setAntiAlias(shapeAntiAlias as Boolean, textAntiAlias as integer)
method, ChartDirector, MBS Real Studio ChartDirector Plugin (ChartDirector5), class CDBaseChartMBS,
Plugin version: 8.2, Mac: Yes, Win: Yes, Linux: Yes, Console & Web: Yes, Feedback.
Function: Controls whether anti-alias is used when drawing lines, shapes and text.
Notes:
For anti-aliasing text, ChartDirector supports the following modes.
ConstantValueDescription
Currently, ChartDirector will anti-alias only large or bold fonts. For small fonts, assuming it is of high quality, anti-alias is unnecessary. It is because high quality fonts are normally designed to be sharp and clear at low resolution. Anti-aliasing will blur the fonts and make them look worse.
However, for complicated fonts (e.g. some fonts with oriental characters), or for lower quality fonts (e.g. some freeware fonts), anti-alias may be necessary. In this case, it may be needed to force anti-aliasing of all fonts using AntiAlias mode.
method, ChartDirector, MBS Real Studio ChartDirector Plugin (ChartDirector5), class CDBaseChartMBS,
Plugin version: 8.2, Mac: Yes, Win: Yes, Linux: Yes, Console & Web: Yes, Feedback.
Function: Controls whether anti-alias is used when drawing lines, shapes and text.
Notes:
For anti-aliasing text, ChartDirector supports the following modes.
ConstantValueDescription
| NoAntiAlias | 0 | Disable anti-alias when drawing text |
| AntiAlias | 1 | Always use anti-alias when drawing text |
| AutoAntiAlias | 2 | Automatically determine if anti-alias should be used for the text. This is the default. |
Currently, ChartDirector will anti-alias only large or bold fonts. For small fonts, assuming it is of high quality, anti-alias is unnecessary. It is because high quality fonts are normally designed to be sharp and clear at low resolution. Anti-aliasing will blur the fonts and make them look worse.
However, for complicated fonts (e.g. some fonts with oriental characters), or for lower quality fonts (e.g. some freeware fonts), anti-alias may be necessary. In this case, it may be needed to force anti-aliasing of all fonts using AntiAlias mode.
| Argument | Default | Description |
| shapeAntiAlias | true | A true value enables anti-alias when drawing lines and shapes. A false value disables anti-alias when drawing lines and shapes |
| textAntiAlias | AutoAntiAlias | The text anti-alias mode, which must be one of AutoAntiAlias, AntiAlias or NoAntiAlias. |
CDBaseChartMBS.setBackground(colorvalue as color, edgeColor as color, raisedEffect as integer = 0)
method, ChartDirector, MBS Real Studio ChartDirector Plugin (ChartDirector5), class CDBaseChartMBS,
Plugin version: 11.1, Mac: Yes, Win: Yes, Linux: Yes, Console & Web: Yes, Feedback.
Function: Same as the other setBackground method, but uses color instead of integer data type for passing color values.
method, ChartDirector, MBS Real Studio ChartDirector Plugin (ChartDirector5), class CDBaseChartMBS,
Plugin version: 11.1, Mac: Yes, Win: Yes, Linux: Yes, Console & Web: Yes, Feedback.
Function: Same as the other setBackground method, but uses color instead of integer data type for passing color values.
See also:
CDBaseChartMBS.setBackground(colorvalue as integer, edgeColor as integer = &hff000000, raisedEffect as integer = 0)
method, ChartDirector, MBS Real Studio ChartDirector Plugin (ChartDirector5), class CDBaseChartMBS,
Plugin version: 8.2, Mac: Yes, Win: Yes, Linux: Yes, Console & Web: Yes, Feedback.
Function: Sets the background color, border color and 3D border effect of the chart.
Notes:
method, ChartDirector, MBS Real Studio ChartDirector Plugin (ChartDirector5), class CDBaseChartMBS,
Plugin version: 8.2, Mac: Yes, Win: Yes, Linux: Yes, Console & Web: Yes, Feedback.
Function: Sets the background color, border color and 3D border effect of the chart.
Notes:
| Argument | Default | Description |
| color | (Mandatory) | The background color of the chart. |
| edgeColor | Transparent | The border 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:
CDBaseChartMBS.setBgImage(img as string, align as integer = 5)
method, ChartDirector, MBS Real Studio ChartDirector Plugin (ChartDirector5), class CDBaseChartMBS,
Plugin version: 8.2, Mac: Yes, Win: Yes, Linux: Yes, Console & Web: Yes, Feedback.
Function: Uses the image from the specified file as the background image of the chart.
Notes:
ChartDirector will automatically detect the image file format using the file extension, which must either png, jpg, jpeg, gif, wbmp or wmp (case insensitive).
Please refer to BaseChart.setSearchPath on the directory that ChartDirector will search for the file.
method, ChartDirector, MBS Real Studio ChartDirector Plugin (ChartDirector5), class CDBaseChartMBS,
Plugin version: 8.2, Mac: Yes, Win: Yes, Linux: Yes, Console & Web: Yes, Feedback.
Function: Uses the image from the specified file as the background image of the chart.
Notes:
ChartDirector will automatically detect the image file format using the file extension, which must either png, jpg, jpeg, gif, wbmp or wmp (case insensitive).
Please refer to BaseChart.setSearchPath on the directory that ChartDirector will search for the file.
| Argument | Default | Description |
| img | (Mandatory) | The image file that is used as the background image of the chart. |
| align | Center | The alignment of the background image relative to the chart. See Alignment Specification for supported alignment types. |
CDBaseChartMBS.setBorder(colorvalue as color)
method, ChartDirector, MBS Real Studio ChartDirector Plugin (ChartDirector5), class CDBaseChartMBS,
Plugin version: 11.1, Mac: Yes, Win: Yes, Linux: Yes, Console & Web: Yes, Feedback.
Function: Same as the other setBorder method, but uses color instead of integer data type for passing color values.
method, ChartDirector, MBS Real Studio ChartDirector Plugin (ChartDirector5), class CDBaseChartMBS,
Plugin version: 11.1, Mac: Yes, Win: Yes, Linux: Yes, Console & Web: Yes, Feedback.
Function: Same as the other setBorder method, but uses color instead of integer data type for passing color values.
See also:
CDBaseChartMBS.setBorder(colorvalue as integer)
method, ChartDirector, MBS Real Studio ChartDirector Plugin (ChartDirector5), class CDBaseChartMBS,
Plugin version: 8.2, Mac: Yes, Win: Yes, Linux: Yes, Console & Web: Yes, Feedback.
Function: Deprecated. Use SetBackground instead.
method, ChartDirector, MBS Real Studio ChartDirector Plugin (ChartDirector5), class CDBaseChartMBS,
Plugin version: 8.2, Mac: Yes, Win: Yes, Linux: Yes, Console & Web: Yes, Feedback.
Function: Deprecated. Use SetBackground instead.
See also:
CDBaseChartMBS.setColor(paletteEntry as integer, colorvalue as color)
method, ChartDirector, MBS Real Studio ChartDirector Plugin (ChartDirector5), class CDBaseChartMBS,
Plugin version: 11.1, Mac: Yes, Win: Yes, Linux: Yes, Console & Web: Yes, Feedback.
Function: Same as the other setColor method, but uses color instead of integer data type for passing color values.
method, ChartDirector, MBS Real Studio ChartDirector Plugin (ChartDirector5), class CDBaseChartMBS,
Plugin version: 11.1, Mac: Yes, Win: Yes, Linux: Yes, Console & Web: Yes, Feedback.
Function: Same as the other setColor method, but uses color instead of integer data type for passing color values.
See also:
CDBaseChartMBS.setColor(paletteEntry as integer, colorvalue as integer)
method, ChartDirector, MBS Real Studio ChartDirector Plugin (ChartDirector5), class CDBaseChartMBS,
Plugin version: 8.2, Mac: Yes, Win: Yes, Linux: Yes, Console & Web: Yes, Feedback.
Function: Change the color at the specified position in the palette.
Notes:
See Color Specification on how colors are represented in ChartDirector.
method, ChartDirector, MBS Real Studio ChartDirector Plugin (ChartDirector5), class CDBaseChartMBS,
Plugin version: 8.2, Mac: Yes, Win: Yes, Linux: Yes, Console & Web: Yes, Feedback.
Function: Change the color at the specified position in the palette.
Notes:
See Color Specification on how colors are represented in ChartDirector.
| Argument | Default | Description |
| paletteEntry | (Mandatory) | An index to the palette. |
| color | (Mandatory) | The color to change to. |
See also:
CDBaseChartMBS.setColors(numbers() as color)
method, ChartDirector, MBS Real Studio ChartDirector Plugin (ChartDirector5), class CDBaseChartMBS,
Plugin version: 11.1, Mac: Yes, Win: Yes, Linux: Yes, Console & Web: Yes, Feedback.
Function: Same as the other setColors method, but uses color instead of integer data type for passing color values.
method, ChartDirector, MBS Real Studio ChartDirector Plugin (ChartDirector5), class CDBaseChartMBS,
Plugin version: 11.1, Mac: Yes, Win: Yes, Linux: Yes, Console & Web: Yes, Feedback.
Function: Same as the other setColors method, but uses color instead of integer data type for passing color values.
See also:
CDBaseChartMBS.setColors(numbers() as integer)
method, ChartDirector, MBS Real Studio ChartDirector Plugin (ChartDirector5), class CDBaseChartMBS,
Plugin version: 8.2, Mac: Yes, Win: Yes, Linux: Yes, Console & Web: Yes, Feedback.
Function: Change the colors in the palette.
Notes:
See Color Specification on how colors are represented in ChartDirector.
method, ChartDirector, MBS Real Studio ChartDirector Plugin (ChartDirector5), class CDBaseChartMBS,
Plugin version: 8.2, Mac: Yes, Win: Yes, Linux: Yes, Console & Web: Yes, Feedback.
Function: Change the colors in the palette.
Notes:
See Color Specification on how colors are represented in ChartDirector.
| Argument | Default | Description |
| colors | (Mandatory) | An array of colors to change to. |
See also:
CDBaseChartMBS.setColors(paletteEntry as integer, numbers() as color)
method, ChartDirector, MBS Real Studio ChartDirector Plugin (ChartDirector5), class CDBaseChartMBS,
Plugin version: 11.1, Mac: Yes, Win: Yes, Linux: Yes, Console & Web: Yes, Feedback.
Function: Same as the other setColors method, but uses color instead of integer data type for passing color values.
method, ChartDirector, MBS Real Studio ChartDirector Plugin (ChartDirector5), class CDBaseChartMBS,
Plugin version: 11.1, Mac: Yes, Win: Yes, Linux: Yes, Console & Web: Yes, Feedback.
Function: Same as the other setColors method, but uses color instead of integer data type for passing color values.
See also:
CDBaseChartMBS.setColors(paletteEntry as integer, numbers() as integer)
method, ChartDirector, MBS Real Studio ChartDirector Plugin (ChartDirector5), class CDBaseChartMBS,
Plugin version: 8.2, Mac: Yes, Win: Yes, Linux: Yes, Console & Web: Yes, Feedback.
Function: Change the colors in the palette, starting from the specified position in the palette.
Notes:
See Color Specification on how colors are represented in ChartDirector.
method, ChartDirector, MBS Real Studio ChartDirector Plugin (ChartDirector5), class CDBaseChartMBS,
Plugin version: 8.2, Mac: Yes, Win: Yes, Linux: Yes, Console & Web: Yes, Feedback.
Function: Change the colors in the palette, starting from the specified position in the palette.
Notes:
See Color Specification on how colors are represented in ChartDirector.
| Argument | Default | Description |
| paletteEntry | (Mandatory) | An index to the palette to start changing the colors. |
| colors | (Mandatory) | An array of colors to change to. |
See also:
CDBaseChartMBS.setDefaultColors(paletteEntry as integer = 0)
method, ChartDirector, MBS Real Studio ChartDirector Plugin (ChartDirector5), class CDBaseChartMBS,
Plugin version: 8.2, Mac: Yes, Win: Yes, Linux: Yes, Console & Web: Yes, Feedback.
Function: Sets the default colors.
method, ChartDirector, MBS Real Studio ChartDirector Plugin (ChartDirector5), class CDBaseChartMBS,
Plugin version: 8.2, Mac: Yes, Win: Yes, Linux: Yes, Console & Web: Yes, Feedback.
Function: Sets the default colors.
CDBaseChartMBS.setDefaultFonts(normal as string, bold as string, italic as string, boldItalic as string)
method, ChartDirector, MBS Real Studio ChartDirector Plugin (ChartDirector5), class CDBaseChartMBS,
Plugin version: 8.2, Mac: Yes, Win: Yes, Linux: Yes, Console & Web: Yes, Feedback.
Function: Sets the defaults for normal, bold, italic and bold-italic fonts.
Notes:
See Font Specification for details on various font attributes.
See font specification here:
http://www.monkeybreadsoftware.net/faq-chartdirectorfontspecification.shtml
method, ChartDirector, MBS Real Studio ChartDirector Plugin (ChartDirector5), class CDBaseChartMBS,
Plugin version: 8.2, Mac: Yes, Win: Yes, Linux: Yes, Console & Web: Yes, Feedback.
Function: Sets the defaults for normal, bold, italic and bold-italic fonts.
Notes:
See Font Specification for details on various font attributes.
| Argument | Default | Description |
| normal | (Mandatory) | The default normal font. This is the same as the first font in the font table. |
| bold | "" | The default bold font. This is the same as the second font in the font table. An empty string means the default is unchanged. |
| italic | "" | The default italic font. This is the same as the third font in the font table. An empty string means the default is unchanged. |
| boldItalic | "" | The default bold-italic font. This is the same as the fourth font in the font table. An empty string means the default is unchanged. |
See font specification here:
http://www.monkeybreadsoftware.net/faq-chartdirectorfontspecification.shtml
CDBaseChartMBS.setDropShadow(ColorValue as color, OffsetX as integer = 5, OffsetY as integer = &h7fffffff, blurRadius as integer = 5)
method, ChartDirector, MBS Real Studio ChartDirector Plugin (ChartDirector5), class CDBaseChartMBS,
Plugin version: 11.1, Mac: Yes, Win: Yes, Linux: Yes, Console & Web: Yes, Feedback.
Function: Same as the other setDropShadow method, but uses color instead of integer data type for passing color values.
method, ChartDirector, MBS Real Studio ChartDirector Plugin (ChartDirector5), class CDBaseChartMBS,
Plugin version: 11.1, Mac: Yes, Win: Yes, Linux: Yes, Console & Web: Yes, Feedback.
Function: Same as the other setDropShadow method, but uses color instead of integer data type for passing color values.
See also:
CDBaseChartMBS.setDropShadow(ColorValue as integer = &hAAAAAA, OffsetX as integer = 5, OffsetY as integer = &h7fffffff, blurRadius as integer = 5)
method, ChartDirector, MBS Real Studio ChartDirector Plugin (ChartDirector5), class CDBaseChartMBS,
Plugin version: 9.2, Mac: Yes, Win: Yes, Linux: Yes, Console & Web: Yes, Feedback.
Function: Adds a drop shadow to the chart.
Notes:
The drop shadow effect is created using a single color representation of the non-transparent part of the chart, offsetted by an amount, and put under the chart. The drop shadow can be blurred to create a soft drop shadow effect.
Note that adding a drop shadow will increase the width and height of the chart image so as to accommodate the drop shadow.
Because the drop shadow is located exterior to the original chart, it uses an exterior background color different from the background color of the original chart. The exterior background color is by default white, and can be configured with CDBaseChartMBS.setRoundedFrame.
Arguments:
method, ChartDirector, MBS Real Studio ChartDirector Plugin (ChartDirector5), class CDBaseChartMBS,
Plugin version: 9.2, Mac: Yes, Win: Yes, Linux: Yes, Console & Web: Yes, Feedback.
Function: Adds a drop shadow to the chart.
Notes:
The drop shadow effect is created using a single color representation of the non-transparent part of the chart, offsetted by an amount, and put under the chart. The drop shadow can be blurred to create a soft drop shadow effect.
Note that adding a drop shadow will increase the width and height of the chart image so as to accommodate the drop shadow.
Because the drop shadow is located exterior to the original chart, it uses an exterior background color different from the background color of the original chart. The exterior background color is by default white, and can be configured with CDBaseChartMBS.setRoundedFrame.
Arguments:
| Argument | Default | Description |
| color | AAAAAA | The color of the drop shadow. |
| offsetX | 5 | The x offset of the drop shadow. |
| offsetY | 7fffffff | The y offset of the drop shadow. 7fffffff means it is the same as the x offset. |
| blurRadius | 5 | The blur radius of the drop shadow. |
See also:
CDBaseChartMBS.SetFontSearchPath(path as string)
shared method, ChartDirector, MBS Real Studio ChartDirector Plugin (ChartDirector5), class CDBaseChartMBS,
Plugin version: 9.2, Mac: Yes, Win: Yes, Linux: Yes, Console & Web: Yes, Feedback.
Function: Sets the font search path.
Example:
Notes:
This method can be used to configure the font search path. You may set your own font search path, or add additional search path before or after the default search path. The usage us like:
CDBaseChartMBS.setFontSearchPath("myPath1;myPath2;%PATH%;myPath3;myPath4");
In the above %PATH% (case sensitive) represents the default search path. This method must be called before the ChartDirector font system is used. It is suggested it be called before any ChartDirector methods. Once ChartDirector tries to look for the fonts (eg. to get font metrics so as to layout a chart), the search path cannot be changed without restarting the process.
e.g. if you use ubuntu, you can install the ttf-mscorefonts-installer package and call this method with "/usr/share/fonts/truetype/msttcorefonts" as the path. No backslash on the end of a path, please.
shared method, ChartDirector, MBS Real Studio ChartDirector Plugin (ChartDirector5), class CDBaseChartMBS,
Plugin version: 9.2, Mac: Yes, Win: Yes, Linux: Yes, Console & Web: Yes, Feedback.
Function: Sets the font search path.
Example:
if TargetLinux then
CDBaseChartMBS.SetFontSearchPath "/usr/share/fonts/truetype"
else
// on Mac and Windows we use system fonts.
end if
This method can be used to configure the font search path. You may set your own font search path, or add additional search path before or after the default search path. The usage us like:
CDBaseChartMBS.setFontSearchPath("myPath1;myPath2;%PATH%;myPath3;myPath4");
In the above %PATH% (case sensitive) represents the default search path. This method must be called before the ChartDirector font system is used. It is suggested it be called before any ChartDirector methods. Once ChartDirector tries to look for the fonts (eg. to get font metrics so as to layout a chart), the search path cannot be changed without restarting the process.
e.g. if you use ubuntu, you can install the ttf-mscorefonts-installer package and call this method with "/usr/share/fonts/truetype/msttcorefonts" as the path. No backslash on the end of a path, please.
CDBaseChartMBS.setFontTable(index as integer, font as string)
method, ChartDirector, MBS Real Studio ChartDirector Plugin (ChartDirector5), class CDBaseChartMBS,
Plugin version: 8.2, Mac: Yes, Win: Yes, Linux: Yes, Console & Web: Yes, Feedback.
Function: Sets an entry in the font table to the specified font name.
Notes:
The first 4 fonts in the font table have special significance. They are the defaults for normal, bold, italic and bold-italic fonts.
See Font Specification for details on various font attributes.
See font specification here:
http://www.monkeybreadsoftware.net/faq-chartdirectorfontspecification.shtml
method, ChartDirector, MBS Real Studio ChartDirector Plugin (ChartDirector5), class CDBaseChartMBS,
Plugin version: 8.2, Mac: Yes, Win: Yes, Linux: Yes, Console & Web: Yes, Feedback.
Function: Sets an entry in the font table to the specified font name.
Notes:
The first 4 fonts in the font table have special significance. They are the defaults for normal, bold, italic and bold-italic fonts.
See Font Specification for details on various font attributes.
| Argument | Default | Description |
| index | (Mandatory) | An index to the font table, starting from 0. |
| font | (Mandatory) | The font name to be put into the font table. |
See font specification here:
http://www.monkeybreadsoftware.net/faq-chartdirectorfontspecification.shtml
The items on this page are in the following plugins: MBS Real Studio ChartDirector Plugin.
Links
MBS Real Studio Plugins