MBS Xojo Developer Conference and Training
Join us from 11th to 14th September 2013 in Koblenz.

Platforms to show: All Mac Windows Linux Cross-Platform

Previous items

CDBaseChartMBS.setLicenseCode(n as string, enddate as integer, v1 as integer, v2 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: Registeres the chartdirector plugin and library.
CDBaseChartMBS.setMonthNames(names() 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 of the months for date/time formatting purposes.
Notes:
The default is to use the first 3 characters of the English month names (Jan, Feb, Mar ...).
ArgumentDefaultDescription
names(Mandatory)An array of 12 text strings to be used as the month names.
CDBaseChartMBS.setNumberFormat(thousandSeparator as string = "~", decimalPointChar as string = ".", signChar 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 characters used for thousand separator, decimal point, and negative sign.
Notes:
ArgumentDefaultDescription
thousandSeparator'~'The thousand separator. Use '~' to mean no thousand separator.
decimalPointChar'.'The decimal point character.
signChar'-'The negative sign character.
CDBaseChartMBS.setRoundedFrame(extColor as color, r1 as integer = 10, r2 as integer = -1, r3 as integer = -1, r4 as integer = -1)
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 setRoundedFrame method, but uses color instead of integer data type for passing color values.

See also:

CDBaseChartMBS.setRoundedFrame(extColor as integer = &hFFFFFF, r1 as integer = 10, r2 as integer = -1, r3 as integer = -1, r4 as integer = -1)
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 border style of the chart to rounded corners.
Notes:
The underlying drawing surface for a chart is always rectangular. When rounded corners are used, part of the drawing surface (the regions external to the rounded corners) will be outside the chart border. The extColor argument specifies the color to be used for the external regions. Typically, it is set to the same color as the background the container that will be hosting the chart.

For example, in a web page, the extColor may be set to the same color as the web page background.
ArgumentDefaultDescription
extColorFFFFFFThe exterior background color.
r110The radius of the top-left rounded corner in pixels.
r2-1The radius of the top-right rounded corner in pixels. The default value of -1 means it is the same as the radius of the top-left corner.
r3-1The radius of the bottom-right rounded corner in pixels. The default value of -1 means it is the same as the radius of the top-left corner.
r4-1The radius of the bottom-left rounded corner in pixels. The default value of -1 means it is the same as the radius of the top-left corner.

See also:

CDBaseChartMBS.setSearchPath(path 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 file system search path for loading image files.
Notes:
The plugin uses folderitems for most file operations, so this method is not needed for most operations.

Several ChartDirector operations involve loading image files. Examples are wallpapers (BaseChart.setWallpaper), background images (BaseChart.setBgImage and PlotArea.setBackground2), user-defined symbols (DataSet.setDataSymbol2) or for embedding images in text using ChartDirector Mark Up Language.
ArgumentDefaultDescription
path(Mandatory)A list of directories, separated with the path separator of your operating system (";" for Windows, ":" for Linux/UNIX).
CDBaseChartMBS.setSize(width as integer, height 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: Sets the size of the chart.
Notes:
ArgumentDefaultDescription
width(Mandatory)The width of the chart in pixels.
height(Mandatory)The height of the chart in pixels.
CDBaseChartMBS.setTransparentColor(c 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 setTransparentColor method, but uses color instead of integer data type for passing color values.

See also:

CDBaseChartMBS.setTransparentColor(c 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: Specifies a certain color to mean transparent when creating the image output, or to include alpha transparency channel in the output.
Notes:
Alpha transparency: In addition to red, green and blue levels, there is a transparency level associated with each pixel, which can range from completely transparent to completely opaque. The data associated with the transparency information is called the alpha channel.

Single color transparency: The image itself has no alpha channel, but a certain color is used to mean completely transparent. For internal drawing, ChartDirector always use alpha transparency. However, when outputting the image as an image file, ChartDirector by default will remove the alpha channel to reduce image size. It is because many image displaying software do not support alpha transparency. For example, the IE browser only supports single color transparency but not alpha transparency.

If you want to use single color transparency in the output, you may specify the transparent color as the argument to the setTransparentColor method. Note that only GIF and PNG can support single color transparency. JPEG, BMP and WBMP cannot support transparency at all.

If you do want to keep the alpha channel in final output, you may pass -1 as the argument to setTransparentColor. Note that the only image format that can support alpha transparency is PNG.

One important thing to note is that the IE browser (and possibly many image displaying software) only supports single color transparency for palette based images with up to 256 colors, but not for true color images. For this reason, if single color transparency is used, ChartDirector will automatically reduce the image to 256 colors if it has more than 256 colors. This may result in lost of image quality, especially if the image contains gradient colors.

Therefore, due to the limitations of the current generations of image displaying software, for highest image quality, sometimes it may be beneficial to not using transparency in image output, but to set the image background color to the same color as the container background.
ArgumentDefaultDescription
c(Mandatory)The color that is designated as the transparent color. If -1 is used, the full alpha transparency channel will be included in the final output.

See also:

CDBaseChartMBS.setTransparentColors(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 color palette to transparent colors.
CDBaseChartMBS.setWallpaper(img as folderitem)
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 wallpaper to repetitively fill the background 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.
ArgumentDefaultDescription
img(Mandatory)The image file that is used as the background wallpaper of the chart.
CDBaseChartMBS.setWeekDayNames(names() 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 of the week days for date/time formatting purposes.
Notes:
The default is to use the first 3 characters of the English week day names (Sun, Mon, Tue, ...).
ArgumentDefaultDescription
names(Mandatory)An array of 7 text strings to be used as the week day names.
CDBaseChartMBS.setWhiteOnBlackColors(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 color palette to white on black colors.
CDBaseChartMBS.silverColor(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 silver color, most commonly used as a background color.
Notes:
This method is a short cut to the CDBaseChartMBS.metalColor method, using grey (CCCCCC in hex) as the base color.
ArgumentDefaultDescription
angle90The direction for brightness modulation, specified as a clockwise angle in degrees, with 0 being the upward pointing direction.
Return Value
A 32-bit integer representing the silver color.
CDBaseChartMBS.silverGradient 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 silver color.
Notes:
The array is in a format that can be directly used in BaseChart.gradientColor2 and DrawArea.gradientColor2. Its contents (in hex) is:

00 C8C8C8 60 F8F8F8 B0 E0E0E0 100 C8C8C8
See Color Specification on how colors are represented in ChartDirector.
CDBaseChartMBS.softLighting(direction as integer = 8, raisedEffect as integer = 4) 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 special shading effect that looks like gradient coloring.
Notes:
This effect is best explained by viewing the examples.

ExampleLocation of lighting effect
Soft Multi-Bar ChartThe bars are shaded using soft lighting effect, with light direction from Top, and raised effect of 4 pixels.
Soft Bar ShadingThe bars are shaded using soft lighting effect, with light direction from Left, and raised effect of 4 pixels.
Spline Line ChartThe title is shaded using soft lighting effect, with light direction from Right, and raised effect of 4 pixels.

The softLighting method returns an integer representing this effect. The integer can be used as the third argument to Box.setBackground to apply the effect it objects derived from Box (such as labels and titles represented by TextBox). It may also be used as the second argument to Layer.setBorderColor for BarLayer objects to apply the effect to bars.
ArgumentDefaultDescription
directionTopThe direction of the lighting, which must be one of the predefined constants Top, Bottom, Right or Left.
raisedEffect4With soft lighting effect, the object will appear to have some 3D depth. The raisedEffect argument controls the amount of 3D depth in pixels.
Return Value
An integer representing the soft lighting effect.
CDBaseChartMBS.StarShape(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 star shape.
Notes:
Please refer to Shape Specification for samples and more information on using shapes in ChartDirector.
ArgumentDefaultDescription
side(Mandatory)The number of points the polygon has.
Return Value
An integer shape id representing the star shape.
CDBaseChartMBS.StartOfDayFilter(labelStep as integer = 1, initialMargin as double = 0.05) 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 date/times that represent the start of a new day in a date/time series.
Notes:
This method is typically used in Axis.setMultiFormat and Axis.setMultiFormat2 to select specific dates/times for formatting as axis labels.

In a date/time series, an element is considered that start of a new day if it is of a different day than the previous element. It does not need to be at exactly the starting instance of the day.

For the first element of the date/time series, because there is no previous element to compare with, it will be considered as the start of a new day if it is "near" the exact starting instance of the current day, in which "near" is defined using the initialMargin argument, expressed as a ratio (0 to 1) of the day duration.
ArgumentDefaultDescription
labelStep1For dates/times that matches the start of day criteria, picks only 1 out of every "labelStep" number of elements. For example, if this argument is 3, only 1 of every 3 elements that at at the start of day will be selected.
initialMargin0.05If the first label is "near" the exact starting instance of the current day to within the ratio specified in the initial margin, it will be considered to have matched the start of day criteria.
Return Value
An integer filter id representing the filter.
CDBaseChartMBS.StartOfHourFilter(labelStep as integer = 1, initialMargin as double = 0.05) 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 date/times that represent the start of a new hour in a date/time series.
Notes:
This method is typically used in Axis.setMultiFormat and Axis.setMultiFormat2 to select specific dates/times for formatting as axis labels.

In a date/time series, an element is considered that start of a new hour if it is of a different hour than the previous element. It does not need to be at exactly the starting instance of the hour.

For the first element of the date/time series, because there is no previous element to compare with, it will be considered as the start of a new hour if it is "near" the exact starting instance of the current hour, in which "near" is defined using the initialMargin argument, expressed as a ratio (0 to 1) of the hour duration.
ArgumentDefaultDescription
labelStep1For dates/times that matches the start of hour criteria, picks only 1 out of every "labelStep" number of elements. For example, if this argument is 3, only 1 of every 3 elements that at at the start of hour will be selected.
initialMargin0.05If the first label is "near" the exact starting instance of the current hour to within the ratio specified in the initial margin, it will be considered to have matched the start of hour criteria.
Return Value
An integer filter id representing the filter.
CDBaseChartMBS.StartOfMonthFilter(labelStep as integer = 1, initialMargin as double = 0.05) 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 date/times that represent the start of a new month in a date/time series.
Notes:
This method is typically used in Axis.setMultiFormat and Axis.setMultiFormat2 to select specific dates/times for formatting as axis labels.

In a date/time series, an element is considered that start of a new month if it is of a different month than the previous element. It does not need to be at exactly the starting instance of the month.

For the first element of the date/time series, because there is no previous element to compare with, it will be considered as the start of a new month if it is "near" the exact starting instance of the current month, in which "near" is defined using the initialMargin argument, expressed as a ratio (0 to 1) of the month duration.
ArgumentDefaultDescription
labelStep1For dates/times that matches the start of month criteria, picks only 1 out of every "labelStep" number of elements. For example, if this argument is 3, only 1 of every 3 elements that at at the start of month will be selected.
initialMargin0.05If the first label is "near" the exact starting instance of the current month to within the ratio specified in the initial margin, it will be considered to have matched the start of month criteria.
Return Value
An integer filter id representing the filter.
CDBaseChartMBS.StartOfWeekFilter(labelStep as integer = 1, initialMargin as double = 0.05) 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 date/times that represent the start of a new week in a date/time series.
Notes:
This method is typically used in Axis.setMultiFormat and Axis.setMultiFormat2 to select specific dates/times for formatting as axis labels.

In a date/time series, an element is considered that start of a new week if it is of a different week than the previous element. It does not need to be at exactly the starting instance of the week.

For the first element of the date/time series, because there is no previous element to compare with, it will be considered as the start of a new week if it is "near" the exact starting instance of the current week, in which "near" is defined using the initialMargin argument, expressed as a ratio (0 to 1) of the week duration.
ArgumentDefaultDescription
labelStep1For dates/times that matches the start of week criteria, picks only 1 out of every "labelStep" number of elements. For example, if this argument is 3, only 1 of every 3 elements that at at the start of week will be selected.
initialMargin0.05If the first label is "near" the exact starting instance of the current week to within the ratio specified in the initial margin, it will be considered to have matched the start of week criteria.
Return Value
An integer filter id representing the filter.
CDBaseChartMBS.StartOfYearFilter(labelStep as integer = 1, initialMargin as double = 0.05) 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 date/times that represent the start of a new year in a date/time series.
Notes:
This method is typically used in Axis.setMultiFormat and Axis.setMultiFormat2 to select specific dates/times for formatting as axis labels.

In a date/time series, an element is considered that start of a new year if it is of a different year than the previous element. It does not need to be at exactly the starting instance of the year.

For the first element of the date/time series, because there is no previous element to compare with, it will be considered as the start of a new year if it is "near" the exact starting instance of the current year, in which "near" is defined using the initialMargin argument, expressed as a ratio (0 to 1) of the year duration.
ArgumentDefaultDescription
labelStep1For dates/times that matches the start of year criteria, picks only 1 out of every "labelStep" number of elements. For example, if this argument is 3, only 1 of every 3 elements that at at the start of year will be selected.
initialMargin0.05If the first label is "near" the exact starting instance of the current year to within the ratio specified in the initial margin, it will be considered to have matched the start of year criteria.
Return Value
An integer filter id representing the filter.
CDBaseChartMBS.testFont(font as string, fontIndex as integer, fontHeight as double, fontWidth as double, angle as double, byref buffer as string) as boolean
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 diagnostic function to perform a font loading test.
Notes:
From experience, the most common issue for font loading is unable to access server side fonts using anonymous user account for a web application, probably due to security restrictions. This diagnostic function can return the cause of problem to aid trouble-shooting.

Other uses of this function is to trace out where does ChartDirector search for the fonts, and the substitution font in case the request font is not available.
ArgumentDefaultDescription
font(Mandatory)The font name. See Font Specification for details on various font attributes.
fontIndex(Mandatory)The font index if the font name refers to a font collection. An index of 0 means the first font.
fontHeight(Mandatory)The font height in points. This parameter will not affect font loading if the exact font exists, but will affect which substitution font to use if the font does not exist.
fontWidth(Mandatory)The font width in points. This parameter will not affect font loading if the exact font exists, but will affect which substitution font to use if the font does not exist.
angle(Mandatory)The rotation angle of the text. The angle is measured in degrees in clockwise direction. This parameter will not affect font loading if the exact font exists, but will affect which substitution font to use if the font does not exist.
buffer(Mandatory)A string to hold the result of the font loading test.

See font specification here:
http://www.monkeybreadsoftware.net/faq-chartdirectorfontspecification.shtml
CDBaseChartMBS.transparentPalette as integer()
shared 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: Returns the default transparent palette.
CDBaseChartMBS.whiteOnBlackPalette as integer()
shared 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: Returns the default white on black palette.

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




Links
MBS Filemaker Plugins