Xojo Developer Conference
25/27th April 2018 in Denver.
MBS Xojo Conference
6/7th September 2018 in Munich, Germany.

Platforms to show: All Mac Windows Linux Cross-Platform

Previous items Next items

CDBaseChartMBS.kLinearTick as Double
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
shared method ChartDirector MBS ChartDirector Plugin 9.2 Yes Yes Yes Yes No
Function: A constant equals to +1.5E+308 to represent that the ticks in a log scale axis should be 1 - 2 - 3 - 4 - 5 - 6 - 7 - 8 - 9 - 10 style increments.

Feedback, Comments & Corrections

CDBaseChartMBS.kLogTick as Double
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
shared method ChartDirector MBS ChartDirector Plugin 8.2 Yes Yes Yes Yes No
Function: A constant equals to +1.6e308 to represent that the ticks in a log scale axis should be 1 - 2 - 5 - 10 style increments.
Notes: This constant is used in Axis.setLogScale.

Feedback, Comments & Corrections

CDBaseChartMBS.kMicroTickOnly as Double
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
shared method ChartDirector MBS ChartDirector Plugin 8.2 Yes Yes Yes Yes No
Function: A constant equals to -1.6e308 to represent that the label position should contain a micro tick only.
Notes: This constant is used in Axis.setLabels and BaseMeter.setScale.

Feedback, Comments & Corrections

CDBaseChartMBS.kMinorTickOnly as Double
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
shared method ChartDirector MBS ChartDirector Plugin 8.2 Yes Yes Yes Yes No
Function: A constant equals to -1.7e308 to represent that the label position should contain a minor tick only.
Notes: This constant is used in Axis.setLabels.

Feedback, Comments & Corrections

CDBaseChartMBS.kNoValue as Double
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
shared method ChartDirector MBS ChartDirector Plugin 8.2 Yes Yes Yes Yes No
Function: A constant equals to 1.7E+308 to represent missing values in ChartDirector.
Notes: Please refer to No Value Specification for more details.

Feedback, Comments & Corrections

CDBaseChartMBS.kTickInc as Double
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
shared method ChartDirector MBS ChartDirector Plugin 9.2 Yes Yes Yes Yes No
Function: A constant equals to +1E+200 to represent the distance between major ticks.
Notes: This constant is used in CDAxisMBS.setLogScale.

Feedback, Comments & Corrections

CDBaseChartMBS.kTouchBar as Double
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
shared method ChartDirector MBS ChartDirector Plugin 8.2 Yes Yes Yes Yes No
Function: A constant equals to -1.7e-100 to represent that the bars in a bar layer should touch each others with no gap in between.
Notes: This constant is used in BarLayer.setBarGap.

Feedback, Comments & Corrections

CDBaseChartMBS.metalColor(c as Integer, angle as Integer = 90) as Integer
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
shared method ChartDirector MBS ChartDirector Plugin 8.2 Yes Yes Yes Yes No
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.
ArgumentDefaultDescription
c(Mandatory)The color to be modulated.
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 metallic color.

Feedback, Comments & Corrections

CDBaseChartMBS.NonePassFilter as Integer
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
shared method ChartDirector MBS ChartDirector Plugin 8.2 Yes Yes Yes Yes No
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.

Feedback, Comments & Corrections

CDBaseChartMBS.phongLighting(ambientIntensity as Double = 0.5, diffuseIntensity as Double = 0.5, specularIntensity as Double = 0.75, shininess as Integer = 8) as Integer
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
shared method ChartDirector MBS ChartDirector Plugin 12.3 Yes Yes Yes Yes No
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.

ArgumentDefaultDescription
ambientIntensity0.5The ambient reflection coefficient of the Phong lighting model.
diffuseIntensity0.5The diffuse reflection coefficient of the Phong lighting model.
specularIntensity0.75The specular reflection coefficient of the Phong lighting model.
shininess8The shininess coefficient of the Phong lighting model.

Feedback, Comments & Corrections

CDBaseChartMBS.Polygon2Shape(slide as Integer) as Integer
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
shared method ChartDirector MBS ChartDirector Plugin 8.2 Yes Yes Yes Yes No
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.
ArgumentDefaultDescription
side(Mandatory)The number of sides the polygon has.
Return Value
An integer shape id representing the polygon in an alternative orientation.

Feedback, Comments & Corrections

CDBaseChartMBS.PolygonShape(slide as Integer) as Integer
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
shared method ChartDirector MBS ChartDirector Plugin 8.2 Yes Yes Yes Yes No
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.
ArgumentDefaultDescription
side(Mandatory)The number of sides the polygon has.
Return Value
An integer shape id representing the polygon.

Feedback, Comments & Corrections

CDBaseChartMBS.PolynomialRegression(n as Integer) as Integer
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
shared method ChartDirector MBS ChartDirector Plugin 9.2 Yes Yes Yes Yes No
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:
ArgumentDefaultDescription
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.

Feedback, Comments & Corrections

CDBaseChartMBS.redMetalGradient as Integer()
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
shared method ChartDirector MBS ChartDirector Plugin 8.2 Yes Yes Yes Yes No
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.

Feedback, Comments & Corrections

CDBaseChartMBS.RegularSpacingFilter(labelStep as Integer = 1, initialMargin as Integer = 0) as Integer
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
shared method ChartDirector MBS ChartDirector Plugin 8.2 Yes Yes Yes Yes No
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.
ArgumentDefaultDescription
labelStep1Picks 1 out of every "labelStep" number of elements. For example, if this argument is 3, only 1 of every 3 elements will be selected.
initialMargin0Adds 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, ....
Return Value
An integer filter id representing the filter.

Feedback, Comments & Corrections

CDBaseChartMBS.RGB(r as Integer, g as Integer, b as Integer, a as Integer = 0) as Integer
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
shared method ChartDirector MBS ChartDirector Plugin 8.2 Yes Yes Yes Yes No
Function: Creates a RGB color.

Feedback, Comments & Corrections

CDBaseChartMBS.SelectItemFilter(item as Integer) as Integer
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
shared method ChartDirector MBS ChartDirector Plugin 8.2 Yes Yes Yes Yes No
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.
ArgumentDefaultDescription
item(Mandatory)The index of the specified item.
Return Value
An integer filter id representing the filter.

Feedback, Comments & Corrections

CDBaseChartMBS.SetFontSearchPath(path as folderitem)
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
shared method ChartDirector MBS ChartDirector Plugin 14.4 Yes Yes Yes Yes No
Function: Sets the font search path.
Example:
dim FontFolder as folderitem = SpecialFolder.Desktop.Child("fonts")
CDBaseChartMBS.SetFontSearchPath FontFolder
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.

See also:

Feedback, Comments & Corrections

CDBaseChartMBS.SetFontSearchPath(path as string)
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
shared method ChartDirector MBS ChartDirector Plugin 9.2 Yes Yes Yes Yes No
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
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.

See also:

Feedback, Comments & Corrections

CDBaseChartMBS.setLicenseCode(n as string, enddate as Integer, v1 as Integer, v2 as Integer)
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
shared method ChartDirector MBS ChartDirector Plugin 8.2 Yes Yes Yes Yes No
Function: Registeres the chartdirector plugin and library.

Feedback, Comments & Corrections

CDBaseChartMBS.silverColor(angle as Integer = 90) as Integer
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
shared method ChartDirector MBS ChartDirector Plugin 8.2 Yes Yes Yes Yes No
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.

Feedback, Comments & Corrections

CDBaseChartMBS.silverGradient as Integer()
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
shared method ChartDirector MBS ChartDirector Plugin 8.2 Yes Yes Yes Yes No
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.

Feedback, Comments & Corrections

CDBaseChartMBS.softLighting(direction as Integer = 8, raisedEffect as Integer = 4) as Integer
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
shared method ChartDirector MBS ChartDirector Plugin 8.2 Yes Yes Yes Yes No
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.

Feedback, Comments & Corrections

CDBaseChartMBS.StarShape(slide as Integer) as Integer
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
shared method ChartDirector MBS ChartDirector Plugin 8.2 Yes Yes Yes Yes No
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.

Feedback, Comments & Corrections

CDBaseChartMBS.StartOfDayFilter(labelStep as Integer = 1, initialMargin as Double = 0.05) as Integer
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
shared method ChartDirector MBS ChartDirector Plugin 8.2 Yes Yes Yes Yes No
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.

Feedback, Comments & Corrections

CDBaseChartMBS.StartOfHourFilter(labelStep as Integer = 1, initialMargin as Double = 0.05) as Integer
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
shared method ChartDirector MBS ChartDirector Plugin 8.2 Yes Yes Yes Yes No
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.

Feedback, Comments & Corrections

CDBaseChartMBS.StartOfMinuteFilter(labelStep as Integer = 1, initialMargin as Double = 0.05) as Integer
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
shared method ChartDirector MBS ChartDirector Plugin 15.1 Yes Yes Yes Yes No
Function: Creates a data filter that matches date/times that represent the start of a new minute 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 minute if it is of a different minute than the previous element. It does not need to be at exactly the starting instance of the minute.

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 minute if it is "near" the exact starting instance of the current minute, in which "near" is defined using the initialMargin argument, expressed as a ratio (0 to 1) of the minute duration.

ArgumentDefaultDescription
labelStep1For dates/times that matches the start of minute 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 minute will be selected.
initialMargin0.05If the first label is "near" the exact starting instance of the current minute to within the ratio specified in the initial margin, it will be considered to have matched the start of minute criteria.

Returns an integer filter id representing the filter.

Feedback, Comments & Corrections

CDBaseChartMBS.StartOfMonthFilter(labelStep as Integer = 1, initialMargin as Double = 0.05) as Integer
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
shared method ChartDirector MBS ChartDirector Plugin 8.2 Yes Yes Yes Yes No
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.

Feedback, Comments & Corrections

CDBaseChartMBS.StartOfSecondFilter(labelStep as Integer = 1, initialMargin as Double = 0.05) as Integer
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
shared method ChartDirector MBS ChartDirector Plugin 15.1 Yes Yes Yes Yes No
Function: Creates a data filter that matches date/times that represent the start of a new second 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 second if it is of a different second than the previous element. It does not need to be at exactly the starting instance of the second.

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 second if it is "near" the exact starting instance of the current second, in which "near" is defined using the initialMargin argument, expressed as a ratio (0 to 1) of the second duration.

ArgumentDefaultDescription
labelStep1For dates/times that matches the start of second 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 second will be selected.
initialMargin0.05If the first label is "near" the exact starting instance of the current second to within the ratio specified in the initial margin, it will be considered to have matched the start of second criteria.

Returns an integer filter id representing the filter.

Feedback, Comments & Corrections

CDBaseChartMBS.StartOfWeekFilter(labelStep as Integer = 1, initialMargin as Double = 0.05) as Integer
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
shared method ChartDirector MBS ChartDirector Plugin 8.2 Yes Yes Yes Yes No
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.

Feedback, Comments & Corrections

Previous items Next items

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




Links
MBS Xojo PDF Plugins