Platforms to show: All Mac Windows Linux Cross-Platform

Back to CDBaseChartMBS class.

CDBaseChartMBS.getChartWeekDay(t as Double) as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
shared method ChartDirector MBS ChartDirector Plugin 8.2 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Gets the weekday represented by a ChartDirector date/time.

ArgumentDefaultDescription
t(Mandatory)A ChartDirector date/time, that is, a number representing seconds elapsed since 01-01-0001 00:00:00.
Return Value
An integer from 0 - 6 representing Sun - Sat.

CDBaseChartMBS.getChartYMD(t as Double) as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
shared method ChartDirector MBS ChartDirector Plugin 8.2 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Gets the year, month and day represented by a ChartDirector date/time.

ArgumentDefaultDescription
t(Mandatory)A ChartDirector date/time, that is, a number representing seconds elapsed since 01-01-0001 00:00:00.
Return Value
An integer which when represented in decimal notation is yyyymmdd, where yyyy is the year, mm is the month (1 - 12), and dd is the day (1 - 31).

CDBaseChartMBS.getCopyright as string

Type Topic Plugin Version macOS Windows Linux iOS Targets
shared method ChartDirector MBS ChartDirector Plugin 8.2 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Returns the copyright string of the ChartDirector library.
Example
MsgBox CDBaseChartMBS.getCopyright
// displays "Copyright (c) 2006 Advanced Software Engineering Limited"

CDBaseChartMBS.getDescription as string

Type Topic Plugin Version macOS Windows Linux iOS Targets
shared method ChartDirector MBS ChartDirector Plugin 8.2 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Returns the library description.
Example
MsgBox CDBaseChartMBS.getDescription // displays "ChartDirector"

CDBaseChartMBS.GetPath(path as folderitem) as string

Type Topic Plugin Version macOS Windows Linux iOS Targets
shared method ChartDirector MBS ChartDirector Plugin 8.2 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Gets a path string for a folderitem.

Returns the path in the UTF8 format as ChartDirector needs them.

Some examples using this method:

CDBaseChartMBS.getVersion as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
shared method ChartDirector MBS ChartDirector Plugin 8.2 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Gets ChartDirector version information.
Example
Var v as Integer = CDBaseChartMBS.getVersion

Var v1 as Integer = Bitwise.BitAnd( Bitwise.ShiftRight(v, 24), 255)
Var v2 as Integer = Bitwise.BitAnd( Bitwise.ShiftRight(v, 16), 255)
Var v3 as Integer = Bitwise.BitAnd( v, 65535)

MsgBox str(v1)+"."+str(V2)+"."+str(V3)

The version number is encoded as a 32-bit integer. The most significant 8 bits is the major version number. The next 8 bits are the minor version number. The least significant 16 bits are the build number.
Return Value
The version information encoded in a 32-bit integer.

CDBaseChartMBS.glassEffect(glareSize as Integer = 3, glareDirection as Integer = 8, raisedEffect as Integer = 5) as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
shared method ChartDirector MBS ChartDirector Plugin 8.2 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
A complex shading effect that emulates tinted glass or semi-transparent plastic material.

This effect involves glare and variation of lighting caused by reflection and refraction inside the material. It is best explained by viewing the examples.

ExampleLocation of lighting effect
Error Line ChartThe title is shaded using glass effect, with NormalGlare, lighting from Top, and raised effect of 5 pixels.
Donut ChartBoth the title and the sector labels are shaded using glass effect with ReducedGlare, lighting from Top, and raised effect of 5 pixels.
Glass Multi-Bar ChartThe bars are shaded using glass effect, with NormalGlare, lighting from Left, and raised effect of 5 pixels.

Currently, this effect only works well for long, thin objects, such as title bars, text boxes and bars in bar charts.

The glassEffect 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
glareSizeNormalGlareThe amount of glare. Must be one of the predefined constants NormalGlare, ReducedGlare or NoGlare. With NormalGlare and ReducedGlare, the glare will cover around 50% and 35% of the object. If NoGlare is used, there will be no glare and the effect will not look like glass at all, but is equivalent to the CDBaseChartMBS.softLighting effect.

Usually, NormalGlare is best for thin objects with lightly colored background, while ReducedGlare is best for dark background objects or not-so-thin objects (eg. text boxes using white text on a dark background, or with more than 1 line of text).
glareDirectionTopThe direction of the glare, which must be one of the predefined constants Top, Right, Bottom, Left.
raisedEffect5With glass shading 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 glass effect.

Some examples using this method:

CDBaseChartMBS.goldColor(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
Creates a golden color, most commonly used as a background color.

This method is a short cut to the CDBaseChartMBS.metalColor method, using yellow (FFEE44 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 golden color.

Some examples using this method:

CDBaseChartMBS.goldGradient as Integer()

Type Topic Plugin Version macOS Windows Linux iOS Targets
shared method ChartDirector MBS ChartDirector Plugin 8.2 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
A constant array of integers to represent a gradient that looks like a golden color.

The array is in a format that can be directly used in BaseChart.gradientColor and DrawArea.gradientColor. Its contents (in hex) is:

00 FFE743 60 FFFFE0 B0 FFF0B0 100 FFE743
See Color Specification on how colors are represented in ChartDirector.

CDBaseChartMBS.greenMetalGradient as Integer()

Type Topic Plugin Version macOS Windows Linux iOS Targets
shared method ChartDirector MBS ChartDirector Plugin 8.2 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
A constant array of integers to represent a gradient that looks like a green metallic color.

The array is in a format that can be directly used in BaseChart.gradientColor2 and DrawArea.gradientColor2. Its contents (in hex) is:

00 98E098 60 F0FFF0 B0 D8F0D8 100 98E098
See Color Specification on how colors are represented in ChartDirector.

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


The biggest plugin in space...