CDBaseChartMBS.AllPassFilter as Integer

This method is typically used in Axis.setMultiFormat and Axis.setMultiFormat2 as a "catch all" filter.
Return Value
An integer filter id representing the filter.

Some examples using this method:

• /ChartDirector/binaryseries

CDBaseChartMBS.ArrowShape(angle as Double = 0.0, widthRatio as Double = 1, stemWidthRatio as Double = 0.5, stemLengthRatio as Double = 0.5) as Integer

Please refer to Shape Specification for samples and more information on using shapes in ChartDirector.

Argument	Default	Description
angle	0	The clockwise angle of the arrow relative to the upward pointing position.
widthRatio	1	The width of the base of the arrow head as a ratio to the height of the entire arrow. Must be between 0 and 1.
stemWidthRatio	0.5	The width of the arrow stem as a ratio to the width of the base of the arrow head. Must be between 0 and 1.
stemLengthRatio	0.5	The length of the arrow stem as a ratio to the height of the entire arrow. Must be between 0 and 1.

Returns an integer shape id representing the arrow shape.

CDBaseChartMBS.barLighting(startBrightness as Double = 0.75, endBrightness as Double = 1.5) as Integer

It shades all surfaces of a 2D or 3D bar with gradient colors.

For the front surface of a bar, the gradient is from base line of the bar to the end of the bar. For example, for a vertical bar pointing upwards, the gradient is from bottom to the top. Similarly, for a horizontal bar pointing rightwards, the gradient is from left to right.

For a 3D bar, the gradient for the top surface of a vertical bar or the right surface of a horizontal bar is from front to back. The gradients for the side surfaces are the same as for the front surface.

The gradient is specified with two brightness values at the gradient end points. A brightness less than 1 means the color is darkened, while a brightness greater than 1 means the color is brightened. For example, a brightness of 0.5 means the color is half as bright as the original color. If the original color is red, the color will become dark red. Conversely, a brightness of 2 means the color is twice as bright as the original color. If the original color is red, the color will become light red.

The followings are some examples demonstrating this effect.

The barLighting method returns an integer representing this effect. The integer can be used as the second argument to CDLayerMBS.setBorderColor for CDBarLayerMBS objects to apply the effect to bars.

Arguments:

Argument	Default	Description
startBrightness	0.75	The brightness at the starting point.
endBrightness	1.5	The brightness at the ending point.

Return Value
An integer representing the bar lighting effect.

CDBaseChartMBS.blueMetalGradient as Integer()

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

00 9898E0 60 F0F0FF B0 D8D8F0 100 9898E0
See Color Specification on how colors are represented in ChartDirector.

CDBaseChartMBS.brushedGoldColor(texture as Integer = 2, angle as Integer = 90) as Integer

This method is a short cut to the CDBaseChartMBS.brushedMetalColor method, using yellow (FFEE44 in hex) as the base color.

Arguments:

Argument	Default	Description
texture	2	The strength of the brushed texture. Must be 0, 1, 2 or 3 for no texture, light texture, medium texture and strong texture.
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 brushed golden color.

CDBaseChartMBS.brushedMetalColor(c as Integer, texture as Integer = 2, angle as Integer = 90) as Integer

The brightness of the color will vary smoothly across the image in a given a direction, so as to produce a shiny effect. The color will then be modulated with a horizontal texture to create the brushed effect. The modulation period will be the same as the size of the image, so this method is best use to create background colors.

Arguments:

Argument	Default	Description
c	(Mandatory)	The color to be modulated.
texture	2	The strength of the brushed texture. Must be 0, 1, 2 or 3 for no texture, light texture, medium texture and strong texture.
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 brushed metallic color.

CDBaseChartMBS.brushedSilverColor(texture as Integer = 2, angle as Integer = 90) as Integer

This method is a short cut to the CDBaseChartMBS.brushedMetalColor method, using grey (DDDDDD in hex) as the base color.

Arguments:

Argument	Default	Description
texture	2	The strength of the brushed texture. Must be 0, 1, 2 or 3 for no texture, light texture, medium texture and strong texture.
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 brushed silver color.

CDBaseChartMBS.bSearch(values() as Double, value as Double) as Double

This method returns the array index of the value in the array, which must be sorted in ascending order.

If the value is in between two elements of the array, this method returns a non-integer that interpolates the indexes of the two elements. For example, suppose the array consists of 3 elements [4, 6, 10]. If this method is used to search for the value 7, it will return 1.25.

If the value is smaller or larger than all the elements in the array, this method returns the nearest index, which must be either 0 or the index of the last element of the array.

Argument	Default	Description
a	(Mandatory)	The array to be searched.
v	(Mandatory)	The value to search for.

Returns the index of the value within the array. If the value is in between two elements of the array, this method returns a non-integer that interpolates the indexes of the two elements. If the value is smaller or larger than all the elements in the array, thie method returns the nearest index.

Some examples using this method:

• /ChartDirector/RealTime ViewPort

CDBaseChartMBS.chartTime(t as Integer) as Double

The UNIX time will be converted assuming based on local time zone (the time zone settings of the operating system).

Argument	Default	Description
t	(Mandatory)	A time represented as seconds elapsed since 01-01-1970 00:00:00 GMT.

Return Value
The second elapsed since 01-01-0001 00:00:00 to the given time.

See also:

• chartTime(year as Integer, month as Integer, day as Integer, hour as Integer = 0, minute as Integer = 0, second as Integer = 0) as Double

Some examples using this method:

• /ChartDirector/binaryseries
• /ChartDirector/Finance Chart Track Line Retina
• /ChartDirector/finance with ChartDirector Control
• /ChartDirector/High Resolution Chart Examples/surfaceaxis
• /ChartDirector/surfaceaxis
• /ChartDirector/symbolline datezoom
• /ChartDirector/threedscatteraxis
• /ChartDirector/Tracking Cursor/Finance Chart Track Line
• /ChartDirector/Tracking Cursor/Track Line Web
• /ChartDirector/Tracking Cursor/Track Line with Axis Labels

CDBaseChartMBS.chartTime(year as Integer, month as Integer, day as Integer, hour as Integer = 0, minute as Integer = 0, second as Integer = 0) as Double

Argument	Default	Description
y	(Mandatory)	The year component of the given time.
m	(Mandatory)	The month component of the given time
d	(Mandatory)	The day of month component of the given time.
h	0	The hour component of the given time.
n	0	The minute component of the given time.
s	0	The second component of the given time.

Return Value
The second elapsed since 01-01-0001 00:00:00 to the given time.

See also:

• chartTime(t as Integer) as Double

CDBaseChartMBS.ClearTypeColor(gamma as Double = 0) as Integer

This constant is used in BaseChart.setAntiAlias and DrawArea.setAntiAlias.

ClearType is a Microsoft font rendering technology that renders text more accurately with subpixel rendering. Similar technologies include Quartz in Mac OS X, Adobe CoolType and other unnamed algorithms. Although this API uses ClearType in its name, ChartDirector may use ClearType or a similar technology depending on the operating system and programming language.

In most modern flat panel displays, a pixel is consisted of 3 sub-pixels R, G and B for the red, green and blue colors, typically arranged horizontally. So a row of pixels is actually a sequence of subpixels like RGBRGBRGBRGB... To display a white pixel, the display hardware turns on the RGB subpixels.

It happens a white dot can also be made by turning on the GB subpixels of one pixel, and the R subpixel of the next pixel to the right. This will result in 3 consecutive subpixels GBR, which is also white. This white dot will be in between the two pixels, with 2/3 on the left pixel, and 1/3 on the right pixel. In other words, it is possible to position a white dot in between two pixels without blurring it. ClearType uses this effect to render text with subpixel accuracy.

Apart from subpixel rendering, ClearType may adjust the glyph shapes to fit the pixel grid (technically called hinting) differently from classical rendering. As a result, the glyph shapes and sizes in ClearType may be different from classical rendering.

One issue with ClearType is that it is hardware dependent. To work perfectly, it needs to know the subpixels ordering of the display. In many applications, the charts are rendered on one computer, but viewed using another computer. For example, in a web application, the charts can be rendered on the server but displayed on the browser computer. The chart generating computer may not know the subpixel configuration of the viewing computer. If ClearType is used, there is a risk that the text may look suboptimal on the viewing computer.

To address the above issues, ChartDirector supports a hardware independent ClearType method, represented by ClearTypeMono. This is basically ClearType with subpixel rendering disabled. The resulting text has no color distortion. Black and white text will not be as sharp as standard ClearType, but is still better than classical anti-alias. The charts rendered can be viewed equally well with different types of displays. This is especially useful for applications in which the charts are rendered and viewed by different computers.

Argument	Default	Description
gamma	0	Specifies the level of gamma correction used for ClearType font rendering. This is usually a number between 1 to 2.5. A value of 0 means the default gamma level.

CDBaseChartMBS.ClearTypeMono(gamma as Double = 0) as Integer

This constant is used in BaseChart.setAntiAlias and DrawArea.setAntiAlias.

Please refer to ClearTypeColor on the detail explanation of what is standard ClearType and hardware independent ClearType.

Argument	Default	Description
gamma	0	Specifies the level of gamma correction used for ClearType font rendering. This is usually a number between 1 to 2.5. A value of 0 means the default gamma level.

CDBaseChartMBS.ColorToInteger(c as color, alpha as Integer = 0) as Integer

CDBaseChartMBS.Cross2Shape(width as Double = 0.5) as Integer

Please refer to Shape Specification for samples and more information on using shapes in ChartDirector.

Argument	Default	Description
width	(Mandatory)	The percentage width of the arms of the a 'X' relative to the entire shape. Must be between 0 and 1.

Return Value
An integer shape id representing the a 'X' shape.

Some examples using this method:

• /ChartDirector/ChartDirector Control
• /ChartDirector/ChartDirector Control for Web
• /ChartDirector/ChartDirector Control Retina
• /ChartDirector/heatmapcellsymbols
• /ChartDirector/Place PDF Chart with DynaPDF
• /ChartDirector/symbolline datezoom
• /ChartDirector/symbolline datezoom with date
• /ChartDirector/symbolline zoom
• /ChartDirector/symbolline zoom improved
• /ChartDirector/threedscatteraxis

CDBaseChartMBS.CrossShape(width as Double = 0.5) as Integer

Please refer to Shape Specification for samples and more information on using shapes in ChartDirector.

Argument	Default	Description
width	(Mandatory)	The percentage width of the arms of the a '+' relative to the entire shape. Must be between 0 and 1.

Return Value
An integer shape id representing the a '+' shape.

CDBaseChartMBS.cylinderEffect(orientation as Integer = 5, ambientIntensity as Double = 0.5, diffuseIntensity as Double = 0.5, specularIntensity as Double = 0.75, shininess as Integer = 8) as Integer

This effect adjusts the brightness of the color of a rectangular box to make it look like cylindrical. The brightness is adjusted as according to the Phong lighting model, in which the light source is from the viewer direction and is far away.

The cylinderEffect method returns an integer representing this effect. The integer can be used as the third argument to CDBoxMBS.setBackground to apply the effect to Box objects (including derived objects such as CDTextBoxMBS objects).

This effect is automatically used for cylindrical bars in a CDBarLayerMBS. You may use this method to adjust the lighting parameters by using its return value as the second argument to CDLayerMBS.setBorderColor.

Arguments:

Argument	Default	Description
orientation	kCenter	The orientation of the cylinder. A value of kTop or kBottom means the cylinder is vertical. A value of kLeft or kRight means the cylinder is horizontal. A value of kCenter means the orientation is automatically determined. For a CDBarLayerMBS, the orientation will be the same as the orientation of the bars. For other objects (eg. CDTextBoxMBS objects), if the object height is bigger than its width, the cylinder will be treated as vertical, otherwise it will be treated as horizontal.
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.

Return Value
An integer representing the cylinder effect.

CDBaseChartMBS.defaultPalette as Integer()

CDBaseChartMBS.flatBorder(thickness as Integer) as Integer

// set edge to be 2 pixel wide line
Var table As CDMLTableMBS
Var t As CDTextBoxMBS = table.getStyle
Var x As Integer = c.flatBorder(2)
t.setBackground(&heeeeee, CDXYChartMBS.kLineColor, x)

The flatBorder method returns an integer representing this effect. The integer can be used as the third argument to Box.setBackground to apply the effect to Box objects (including derived objects such as TextBox objects). It may also be used as the second argument to Layer.setBorderColor for BarLayer or BoxWhiskerLayer objects to apply the effect to bars or boxes.

Argument	Default	Description
width	(Mandatory)	The border width. A positive value means the border is drawn inside the box or bar. A negative value means the border is outside the box or bar.

Returns an integer representing using flat border of the specified width.

Some examples using this method:

• /ChartDirector/treemapcolors

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

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:

• /ChartDirector/roundmeter
• /ChartDirector/roundmeter with control
• /ChartDirector/roundmeters with animation
• /ChartDirector/simplePie with DynaPDF
• /ChartDirector/wideameter

CDBaseChartMBS.NonePassFilter as Integer

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

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

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

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

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()

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

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

CDBaseChartMBS.kDataBound as Double

A constant equals to -1.7E-100 to represent that the interpolated z values should not exceed the minimum or maximum values of the original data.
This constant is used in ContourLayer.setZBounds.

CDBaseChartMBS.kLinearTick as Double

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

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

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

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

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:

• /ChartDirector/ChartDirector Control
• /ChartDirector/ChartDirector Control Retina
• /ChartDirector/Finance Chart Track Line Retina
• /ChartDirector/heatmapcelllabels
• /ChartDirector/simpleline day
• /ChartDirector/simpleline day with shadow
• /ChartDirector/simpleline realtime
• /ChartDirector/Tracking Cursor/Finance Chart Track Line
• /ChartDirector/Tracking Cursor/Track Box with Legend
• /ChartDirector/wafermap

CDBaseChartMBS.kTickInc as Double

A constant equals to +1E+200 to represent the distance between major ticks.
This constant is used in CDAxisMBS.setLogScale.

CDBaseChartMBS.kTouchBar as Double

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.testFont(font as string, fontIndex as Integer, fontHeight as Double, fontWidth as Double, angle as Double, byref buffer as string) as boolean

Var buffer as string
call CDBaseChartMBS.testFont("arial.ttf", 0, 12, 12, 0, buffer)
MsgBox buffer

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.

Argument	Default	Description
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()

CDBaseChartMBS.whiteOnBlackPalette as Integer()

Some examples using this method:

• /ChartDirector/circularbarmeter
• /ChartDirector/circularbarmeter2