Monkeybread Xojo plugin - CDBaseChartMBS shared methods

CDBaseChartMBS.kLinearTick as Double

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
shared method	ChartDirector	MBS ChartDirector Plugin	9.2	✅ Yes	✅ Yes	✅ Yes	✅ Yes	All

Function: One of the special constants.
Notes: 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.

CDBaseChartMBS.kLogTick as Double

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
shared method	ChartDirector	MBS ChartDirector Plugin	8.2	✅ Yes	✅ Yes	✅ Yes	✅ Yes	All

Function: One of the special constants.
Notes:
A constant equals to +1.6e308 to represent that the ticks in a log scale axis should be 1 - 2 - 5 - 10 style increments.
This constant is used in Axis.setLogScale.

CDBaseChartMBS.kMicroTickOnly as Double

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
shared method	ChartDirector	MBS ChartDirector Plugin	8.2	✅ Yes	✅ Yes	✅ Yes	✅ Yes	All

Function: One of the special constants.
Notes:
A constant equals to -1.6e308 to represent that the label position should contain a micro tick only.
This constant is used in Axis.setLabels and BaseMeter.setScale.

CDBaseChartMBS.kMinorTickOnly as Double

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
shared method	ChartDirector	MBS ChartDirector Plugin	8.2	✅ Yes	✅ Yes	✅ Yes	✅ Yes	All

Function: One of the special constants.
Notes:
A constant equals to -1.7e308 to represent that the label position should contain a minor tick only.
This constant is used in Axis.setLabels.

CDBaseChartMBS.kNoValue as Double

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
shared method	ChartDirector	MBS ChartDirector Plugin	8.2	✅ Yes	✅ Yes	✅ Yes	✅ Yes	All

Function: One of the special constants.
Notes:
A constant equals to 1.7E+308 to represent missing values in ChartDirector.
Please refer to No Value Specification for more details.

Some examples using this method:

CDBaseChartMBS.kTickInc as Double

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
shared method	ChartDirector	MBS ChartDirector Plugin	9.2	✅ Yes	✅ Yes	✅ Yes	✅ Yes	All

Function: One of the special constants.
Notes:
A constant equals to +1E+200 to represent the distance between major ticks.
This constant is used in CDAxisMBS.setLogScale.

CDBaseChartMBS.kTouchBar as Double

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
shared method	ChartDirector	MBS ChartDirector Plugin	8.2	✅ Yes	✅ Yes	✅ Yes	✅ Yes	All

Function: One of the special constants.
Notes:
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.
This constant is used in BarLayer.setBarGap.

Some examples using this method:

/ChartDirector/Tracking Cursor/Track Box with Legend

CDBaseChartMBS.metalColor(c as Integer, angle as Integer = 90) as Integer

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
shared method	ChartDirector	MBS ChartDirector Plugin	8.2	✅ Yes	✅ Yes	✅ Yes	✅ Yes	All

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.

Return Value
A 32-bit integer representing the metallic color.

Some examples using this method:

CDBaseChartMBS.NonePassFilter as Integer

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
shared method	ChartDirector	MBS ChartDirector Plugin	8.2	✅ Yes	✅ Yes	✅ Yes	✅ Yes	All

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.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	iOS	Targets
shared method	ChartDirector	MBS ChartDirector Plugin	12.3	✅ Yes	✅ Yes	✅ Yes	✅ Yes	All

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

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
shared method	ChartDirector	MBS ChartDirector Plugin	8.2	✅ Yes	✅ Yes	✅ Yes	✅ Yes	All

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.

Return Value
An integer shape id representing the polygon in an alternative orientation.

CDBaseChartMBS.PolygonShape(slide as Integer) as Integer

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
shared method	ChartDirector	MBS ChartDirector Plugin	8.2	✅ Yes	✅ Yes	✅ Yes	✅ Yes	All

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.

Return Value
An integer shape id representing the polygon.

CDBaseChartMBS.PolynomialRegression(n as Integer) as Integer

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
shared method	ChartDirector	MBS ChartDirector Plugin	9.2	✅ Yes	✅ Yes	✅ Yes	✅ Yes	All

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.redMetalGradient as Integer()

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
shared method	ChartDirector	MBS ChartDirector Plugin	8.2	✅ Yes	✅ Yes	✅ Yes	✅ Yes	All

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

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
shared method	ChartDirector	MBS ChartDirector Plugin	8.2	✅ Yes	✅ Yes	✅ Yes	✅ Yes	All

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

Return Value
An integer filter id representing the filter.

CDBaseChartMBS.RGB(r as Integer, g as Integer, b as Integer, a as Integer = 0) as Integer

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
shared method	ChartDirector	MBS ChartDirector Plugin	8.2	✅ Yes	✅ Yes	✅ Yes	✅ Yes	All

Function: Creates a RGB color.

CDBaseChartMBS.SelectItemFilter(item as Integer) as Integer

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
shared method	ChartDirector	MBS ChartDirector Plugin	8.2	✅ Yes	✅ Yes	✅ Yes	✅ Yes	All

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.

Return Value
An integer filter id representing the filter.

CDBaseChartMBS.SetFontSearchPath(path as folderitem)

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
shared method	ChartDirector	MBS ChartDirector Plugin	14.4	✅ Yes	✅ Yes	✅ Yes	✅ Yes	All

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:

SetFontSearchPath(path as string)

CDBaseChartMBS.SetFontSearchPath(path as string)

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
shared method	ChartDirector	MBS ChartDirector Plugin	9.2	✅ Yes	✅ Yes	✅ Yes	✅ Yes	All

Function: Sets the font search path.
Example:

if TargetLinux then
  CDBaseChartMBS.SetFontSearchPath "/usr/share/fonts/truetype;/usr/share/fonts/truetype/msttcorefonts"
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:

SetFontSearchPath(path as folderitem)

CDBaseChartMBS.setLicenseCode(n as string, enddate as Integer, v1 as Integer, v2 as Integer)

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
shared method	ChartDirector	MBS ChartDirector Plugin	8.2	✅ Yes	✅ Yes	✅ Yes	✅ Yes	All

Function: Registeres the chartdirector plugin and library.

CDBaseChartMBS.setResourceGlobal(id as string, data as MemoryBlock)

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
shared method	ChartDirector	MBS ChartDirector Plugin	18.5	✅ Yes	✅ Yes	✅ Yes	✅ Yes	All

Function: Assigns a resource ID to a memory block to allow it to be referenced using a resource path.
Notes:
Many ChartDirector features, such as BaseChart.setBgImage and the <*img*> tag in CDML, expect a file or resource path for loading an image. If the image happens to be in memory, such as if the image is retrieved from a database, setResource can be used to assign a resource ID to the memory. It can then be referenced using "@/res_id", in which res_id is the resource ID.

This method stores only a pointer to the memory. It does not copy the memory. You must ensure the memory contains valid content for as long as the resource is being used.

Argument	Default	Description
id	(Mandatory)	The resource ID to be used to reference the memory image.
data	(Mandatory)	The memory that the image occupies.

While ChartDirector does not copy the data, the MBS Plugin will put the resources in a dictionary to make sure they stay available till the chart is destroyed and avoid a crash.

See also:

CDBaseChartMBS.setResourceGlobal(id as string, data as string)

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
shared method	ChartDirector	MBS ChartDirector Plugin	18.5	✅ Yes	✅ Yes	✅ Yes	✅ Yes	All

Function: Assigns a resource ID to a memory block to allow it to be referenced using a resource path.
Notes:
Many ChartDirector features, such as BaseChart.setBgImage and the <*img*> tag in CDML, expect a file or resource path for loading an image. If the image happens to be in memory, such as if the image is retrieved from a database, setResource can be used to assign a resource ID to the memory. It can then be referenced using "@/res_id", in which res_id is the resource ID.

This method stores only a pointer to the memory. It does not copy the memory. You must ensure the memory contains valid content for as long as the resource is being used.

Argument	Default	Description
id	(Mandatory)	The resource ID to be used to reference the memory image.
data	(Mandatory)	The memory that the image occupies.

While ChartDirector does not copy the data, the MBS Plugin will put the resources in a dictionary to make sure they stay available till the chart is destroyed and avoid a crash.

See also:

CDBaseChartMBS.setResourceGlobal(id as string, DrawArea as CDDrawAreaMBS)

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
shared method	ChartDirector	MBS ChartDirector Plugin	18.5	✅ Yes	✅ Yes	✅ Yes	✅ Yes	All

Function: Assigns a resource ID to a DrawArea object to allow it to be referenced using a resource path.
Notes:
This method is the same DrawArea.setResource, except that it assigns the resource ID to a CDBaseChartMBS object instead of a memory image. This allows the CDBaseChartMBS object to be reference as an image resource using "@/res_id".

Argument	Default	Description
id	(Mandatory)	The resource ID to be used to reference the DrawArea object.
drawArea	(Mandatory)	The CDDrawAreaMBS object to be used as a resource.

While ChartDirector does not copy the draw area, the MBS Plugin will put the resources in a dictionary to make sure they stay available till the chart is destroyed and avoid a crash.

See also:

CDBaseChartMBS.silverColor(angle as Integer = 90) as Integer

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
shared method	ChartDirector	MBS ChartDirector Plugin	8.2	✅ Yes	✅ Yes	✅ Yes	✅ Yes	All

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.

Argument	Default	Description
angle	90	The 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.

Some examples using this method:

CDBaseChartMBS.silverGradient as Integer()

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
shared method	ChartDirector	MBS ChartDirector Plugin	8.2	✅ Yes	✅ Yes	✅ Yes	✅ Yes	All

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

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
shared method	ChartDirector	MBS ChartDirector Plugin	8.2	✅ Yes	✅ Yes	✅ Yes	✅ Yes	All

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 Chart	The bars are shaded using soft lighting effect, with light direction from Top, and raised effect of 4 pixels.
Soft Bar Shading	The bars are shaded using soft lighting effect, with light direction from Left, and raised effect of 4 pixels.
Spline Line Chart	The 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.

Argument	Default	Description
direction	Top	The direction of the lighting, which must be one of the predefined constants Top, Bottom, Right or Left.
raisedEffect	4	With 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.

Some examples using this method:

/ChartDirector/simplePie with DynaPDF

CDBaseChartMBS.StarShape(slide as Integer) as Integer

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
shared method	ChartDirector	MBS ChartDirector Plugin	8.2	✅ Yes	✅ Yes	✅ Yes	✅ Yes	All

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.

Argument	Default	Description
side	(Mandatory)	The number of points the polygon has.

Return Value
An integer shape id representing the star shape.

Some examples using this method:

/ChartDirector/heatmapcellsymbols

CDBaseChartMBS.StartOfDayFilter(labelStep as Integer = 1, initialMargin as Double = 0.05) as Integer

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
shared method	ChartDirector	MBS ChartDirector Plugin	8.2	✅ Yes	✅ Yes	✅ Yes	✅ Yes	All

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.

Argument	Default	Description
labelStep	1	For 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.
initialMargin	0.05	If 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.

Some examples using this method:

/ChartDirector/binaryseries

CDBaseChartMBS.StartOfHourFilter(labelStep as Integer = 1, initialMargin as Double = 0.05) as Integer

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
shared method	ChartDirector	MBS ChartDirector Plugin	8.2	✅ Yes	✅ Yes	✅ Yes	✅ Yes	All

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.

Argument	Default	Description
labelStep	1	For 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.
initialMargin	0.05	If 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.StartOfMinuteFilter(labelStep as Integer = 1, initialMargin as Double = 0.05) as Integer

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
shared method	ChartDirector	MBS ChartDirector Plugin	15.1	✅ Yes	✅ Yes	✅ Yes	✅ Yes	All

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.

Argument	Default	Description
labelStep	1	For 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.
initialMargin	0.05	If 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.