Monkeybread Xojo plugin - CDAngularMeterMBS methods

CDAngularMeterMBS.addGlare

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

Adds glare effect to the meter.

The glare effect is created by brightening part of the meter face.
The face is divided by an arc, of which one part is brightened. The glare effect works best for meters with dark background.
All parameters are optional.

Argument Default Description

radius NoValue The radius of the face of the meter. The default is the meter scale radius as set by AngularMeter.setMeter.

span 135 The angular span of the arc that divides the face into two parts. The dividing arc intersects with the face border at two points. The angular span is defined as center angle of these two points (that is, the angle subtended at the meter center by these two points).

rotate 0 By default, the glare will be symmetrically with respect to the vertical axis. This argument can be used to rotate the glare clockwise in degrees.

glareRadius NoValue The radius of the arc that divides the face into two parts. A positive value means the arc will result in a convex glare, while a negative means concave glare. The default is equal to 1.5 times of the face radius.

intensity 0.13 The intensity of the glare, which must be from 0 to 1. A value of 0 means no glare, while a value of 1 means the glare will be 100% white.

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

Adds glare effect to the meter.

The glare effect is created by brightening part of the meter face.
The face is divided by an arc, of which one part is brightened. The glare effect works best for meters with dark background.
All parameters are optional.

Argument Default Description

radius NoValue The radius of the face of the meter. The default is the meter scale radius as set by AngularMeter.setMeter.

span 135 The angular span of the arc that divides the face into two parts. The dividing arc intersects with the face border at two points. The angular span is defined as center angle of these two points (that is, the angle subtended at the meter center by these two points).

rotate 0 By default, the glare will be symmetrically with respect to the vertical axis. This argument can be used to rotate the glare clockwise in degrees.

glareRadius NoValue The radius of the arc that divides the face into two parts. A positive value means the arc will result in a convex glare, while a negative means concave glare. The default is equal to 1.5 times of the face radius.

intensity 0.13 The intensity of the glare, which must be from 0 to 1. A value of 0 means no glare, while a value of 1 means the glare will be 100% white.

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

Adds glare effect to the meter.

The glare effect is created by brightening part of the meter face.
The face is divided by an arc, of which one part is brightened. The glare effect works best for meters with dark background.
All parameters are optional.

Argument Default Description

radius NoValue The radius of the face of the meter. The default is the meter scale radius as set by AngularMeter.setMeter.

span 135 The angular span of the arc that divides the face into two parts. The dividing arc intersects with the face border at two points. The angular span is defined as center angle of these two points (that is, the angle subtended at the meter center by these two points).

rotate 0 By default, the glare will be symmetrically with respect to the vertical axis. This argument can be used to rotate the glare clockwise in degrees.

glareRadius NoValue The radius of the arc that divides the face into two parts. A positive value means the arc will result in a convex glare, while a negative means concave glare. The default is equal to 1.5 times of the face radius.

intensity 0.13 The intensity of the glare, which must be from 0 to 1. A value of 0 means no glare, while a value of 1 means the glare will be 100% white.

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

Adds a new style pointer to the meter.

When compared to classical pointers (added by CDBaseMeterMBS.addPointer), new style pointers are thinner. They are designed to be used with the new style meter cap (see CDAngularMeterMBS.setCap2). They are also designed to have their base and tip movable in the radial direction, which means they can be detached from the center, and can even points from the outside inwards.
Parameters are optional and colors can be passed as Integer or color values.

Argument Default Description

value (Mandatory) The value that the pointer points to.

fillColor (Mandatory) The fill color of the pointer.

edgeColor -1 The edge color of the pointer. -1 means the edge color is the same as the fill color.

pointerType TriangularPointer2 The pointer shape. Please refer to MeterPointer.setShapeAndOffset for the available shapes.

startOffset NoValue The distance between the starting point of the pointer with the meter center, expressed as a ratio to the scale radius. NoValue means the radius is automatically determined. Please refer to MeterPointer.setShapeAndOffset for more information about this argument.

endOffset NoValue The distance between the ending point of the pointer with the meter center, expressed as a ratio to the scale radius. NoValue means the radius is automatically determined. Please refer to MeterPointer.setShapeAndOffset for more information about this argument.

widthRatio NoValue The width of the pointer relative to the default width. NoValue means the width is automatically determined.

Return a MeterPointer object representing the pointer. You may use this object to fine-tune the appearance of the pointer.

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

Adds a new style pointer to the meter.

When compared to classical pointers (added by CDBaseMeterMBS.addPointer), new style pointers are thinner. They are designed to be used with the new style meter cap (see CDAngularMeterMBS.setCap2). They are also designed to have their base and tip movable in the radial direction, which means they can be detached from the center, and can even points from the outside inwards.
Parameters are optional and colors can be passed as Integer or color values.

Argument Default Description

value (Mandatory) The value that the pointer points to.

fillColor (Mandatory) The fill color of the pointer.

edgeColor -1 The edge color of the pointer. -1 means the edge color is the same as the fill color.

pointerType TriangularPointer2 The pointer shape. Please refer to MeterPointer.setShapeAndOffset for the available shapes.

startOffset NoValue The distance between the starting point of the pointer with the meter center, expressed as a ratio to the scale radius. NoValue means the radius is automatically determined. Please refer to MeterPointer.setShapeAndOffset for more information about this argument.

endOffset NoValue The distance between the ending point of the pointer with the meter center, expressed as a ratio to the scale radius. NoValue means the radius is automatically determined. Please refer to MeterPointer.setShapeAndOffset for more information about this argument.

widthRatio NoValue The width of the pointer relative to the default width. NoValue means the width is automatically determined.

Return a MeterPointer object representing the pointer. You may use this object to fine-tune the appearance of the pointer.

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

Adds a new style pointer to the meter.

When compared to classical pointers (added by CDBaseMeterMBS.addPointer), new style pointers are thinner. They are designed to be used with the new style meter cap (see CDAngularMeterMBS.setCap2). They are also designed to have their base and tip movable in the radial direction, which means they can be detached from the center, and can even points from the outside inwards.
Parameters are optional and colors can be passed as Integer or color values.

Argument Default Description

value (Mandatory) The value that the pointer points to.

fillColor (Mandatory) The fill color of the pointer.

edgeColor -1 The edge color of the pointer. -1 means the edge color is the same as the fill color.

pointerType TriangularPointer2 The pointer shape. Please refer to MeterPointer.setShapeAndOffset for the available shapes.

startOffset NoValue The distance between the starting point of the pointer with the meter center, expressed as a ratio to the scale radius. NoValue means the radius is automatically determined. Please refer to MeterPointer.setShapeAndOffset for more information about this argument.

endOffset NoValue The distance between the ending point of the pointer with the meter center, expressed as a ratio to the scale radius. NoValue means the radius is automatically determined. Please refer to MeterPointer.setShapeAndOffset for more information about this argument.

widthRatio NoValue The width of the pointer relative to the default width. NoValue means the width is automatically determined.

Return a MeterPointer object representing the pointer. You may use this object to fine-tune the appearance of the pointer.

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

Adds a new style pointer to the meter.

When compared to classical pointers (added by CDBaseMeterMBS.addPointer), new style pointers are thinner. They are designed to be used with the new style meter cap (see CDAngularMeterMBS.setCap2). They are also designed to have their base and tip movable in the radial direction, which means they can be detached from the center, and can even points from the outside inwards.
Parameters are optional and colors can be passed as Integer or color values.

Argument Default Description

value (Mandatory) The value that the pointer points to.

fillColor (Mandatory) The fill color of the pointer.

edgeColor -1 The edge color of the pointer. -1 means the edge color is the same as the fill color.

pointerType TriangularPointer2 The pointer shape. Please refer to MeterPointer.setShapeAndOffset for the available shapes.

startOffset NoValue The distance between the starting point of the pointer with the meter center, expressed as a ratio to the scale radius. NoValue means the radius is automatically determined. Please refer to MeterPointer.setShapeAndOffset for more information about this argument.

endOffset NoValue The distance between the ending point of the pointer with the meter center, expressed as a ratio to the scale radius. NoValue means the radius is automatically determined. Please refer to MeterPointer.setShapeAndOffset for more information about this argument.

widthRatio NoValue The width of the pointer relative to the default width. NoValue means the width is automatically determined.

Return a MeterPointer object representing the pointer. You may use this object to fine-tune the appearance of the pointer.

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

Adds a new style pointer to the meter.

When compared to classical pointers (added by CDBaseMeterMBS.addPointer), new style pointers are thinner. They are designed to be used with the new style meter cap (see CDAngularMeterMBS.setCap2). They are also designed to have their base and tip movable in the radial direction, which means they can be detached from the center, and can even points from the outside inwards.
Parameters are optional and colors can be passed as Integer or color values.

Argument Default Description

value (Mandatory) The value that the pointer points to.

fillColor (Mandatory) The fill color of the pointer.

edgeColor -1 The edge color of the pointer. -1 means the edge color is the same as the fill color.

pointerType TriangularPointer2 The pointer shape. Please refer to MeterPointer.setShapeAndOffset for the available shapes.

startOffset NoValue The distance between the starting point of the pointer with the meter center, expressed as a ratio to the scale radius. NoValue means the radius is automatically determined. Please refer to MeterPointer.setShapeAndOffset for more information about this argument.

endOffset NoValue The distance between the ending point of the pointer with the meter center, expressed as a ratio to the scale radius. NoValue means the radius is automatically determined. Please refer to MeterPointer.setShapeAndOffset for more information about this argument.

widthRatio NoValue The width of the pointer relative to the default width. NoValue means the width is automatically determined.

Return a MeterPointer object representing the pointer. You may use this object to fine-tune the appearance of the pointer.

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

Adds a new style pointer to the meter.

When compared to classical pointers (added by CDBaseMeterMBS.addPointer), new style pointers are thinner. They are designed to be used with the new style meter cap (see CDAngularMeterMBS.setCap2). They are also designed to have their base and tip movable in the radial direction, which means they can be detached from the center, and can even points from the outside inwards.
Parameters are optional and colors can be passed as Integer or color values.

Argument Default Description

value (Mandatory) The value that the pointer points to.

fillColor (Mandatory) The fill color of the pointer.

edgeColor -1 The edge color of the pointer. -1 means the edge color is the same as the fill color.

pointerType TriangularPointer2 The pointer shape. Please refer to MeterPointer.setShapeAndOffset for the available shapes.

startOffset NoValue The distance between the starting point of the pointer with the meter center, expressed as a ratio to the scale radius. NoValue means the radius is automatically determined. Please refer to MeterPointer.setShapeAndOffset for more information about this argument.

endOffset NoValue The distance between the ending point of the pointer with the meter center, expressed as a ratio to the scale radius. NoValue means the radius is automatically determined. Please refer to MeterPointer.setShapeAndOffset for more information about this argument.

widthRatio NoValue The width of the pointer relative to the default width. NoValue means the width is automatically determined.

Return a MeterPointer object representing the pointer. You may use this object to fine-tune the appearance of the pointer.

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

Adds a new style pointer to the meter.

When compared to classical pointers (added by CDBaseMeterMBS.addPointer), new style pointers are thinner. They are designed to be used with the new style meter cap (see CDAngularMeterMBS.setCap2). They are also designed to have their base and tip movable in the radial direction, which means they can be detached from the center, and can even points from the outside inwards.
Parameters are optional and colors can be passed as Integer or color values.

Argument Default Description

value (Mandatory) The value that the pointer points to.

fillColor (Mandatory) The fill color of the pointer.

edgeColor -1 The edge color of the pointer. -1 means the edge color is the same as the fill color.

pointerType TriangularPointer2 The pointer shape. Please refer to MeterPointer.setShapeAndOffset for the available shapes.

startOffset NoValue The distance between the starting point of the pointer with the meter center, expressed as a ratio to the scale radius. NoValue means the radius is automatically determined. Please refer to MeterPointer.setShapeAndOffset for more information about this argument.

endOffset NoValue The distance between the ending point of the pointer with the meter center, expressed as a ratio to the scale radius. NoValue means the radius is automatically determined. Please refer to MeterPointer.setShapeAndOffset for more information about this argument.

widthRatio NoValue The width of the pointer relative to the default width. NoValue means the width is automatically determined.

Return a MeterPointer object representing the pointer. You may use this object to fine-tune the appearance of the pointer.

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

Adds a new style pointer to the meter.

When compared to classical pointers (added by CDBaseMeterMBS.addPointer), new style pointers are thinner. They are designed to be used with the new style meter cap (see CDAngularMeterMBS.setCap2). They are also designed to have their base and tip movable in the radial direction, which means they can be detached from the center, and can even points from the outside inwards.
Parameters are optional and colors can be passed as Integer or color values.

Argument Default Description

value (Mandatory) The value that the pointer points to.

fillColor (Mandatory) The fill color of the pointer.

edgeColor -1 The edge color of the pointer. -1 means the edge color is the same as the fill color.

pointerType TriangularPointer2 The pointer shape. Please refer to MeterPointer.setShapeAndOffset for the available shapes.

startOffset NoValue The distance between the starting point of the pointer with the meter center, expressed as a ratio to the scale radius. NoValue means the radius is automatically determined. Please refer to MeterPointer.setShapeAndOffset for more information about this argument.

endOffset NoValue The distance between the ending point of the pointer with the meter center, expressed as a ratio to the scale radius. NoValue means the radius is automatically determined. Please refer to MeterPointer.setShapeAndOffset for more information about this argument.

widthRatio NoValue The width of the pointer relative to the default width. NoValue means the width is automatically determined.

Return a MeterPointer object representing the pointer. You may use this object to fine-tune the appearance of the pointer.

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

Same as the other addRing method, but uses color instead of integer data type for passing color values.

See also:

addRing(startRadius as Integer, endRadius as Integer, fillColor as Integer, edgeColor as Integer = -1)

Some examples using this method:

CDAngularMeterMBS.addRing(startRadius as Integer, endRadius as Integer, fillColor as Integer, edgeColor as Integer = -1)

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

Adds a circular ring or a circle to the meter.

A ring is the region between two concentric circles. This method is most often used for adding circular borders and backgrounds for the meter, and for some other decorative purposes. For example, one can add a circle with a metallic background color as the 'face' of the meter meter using this method.

Parameter Default Description

startRadius (Mandatory) The starting radius of the ring in pixels. To add a circle, set the start radius to 0.

endRadius (Mandatory) The ending radius of the ring in pixels.

fillColor (Mandatory) The fill color of the ring.

edgeColor -1 The edge color of the ring. The default is the same as the fill color.

See also:

addRing(startRadius as Integer, endRadius as Integer, fillColor as color, edgeColor as color)

CDAngularMeterMBS.addRingSector(startRadius as Integer, endRadius as Integer, a1 as Double, a2 as Double, fillColor as color, edgeColor as color)

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

Same as the other addRingSector method, but uses color instead of integer data type for passing color values.

See also:

addRingSector(startRadius as Integer, endRadius as Integer, a1 as Double, a2 as Double, fillColor as Integer, edgeColor as Integer = -1)

Some examples using this method:

CDAngularMeterMBS.addRingSector(startRadius as Integer, endRadius as Integer, a1 as Double, a2 as Double, fillColor as Integer, edgeColor as Integer = -1)

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

Adds a ring sector or a sector to the meter.

This method is similar to the AngularMeter.addRing method, except that the ring it adds does not span the complete circle, but just part of the circle.

Parameter Default Description

startRadius (Mandatory) The starting radius of the ring sector in pixels. To add a sector, set the starting radius to 0.

endRadius (Mandatory) The ending radius of the ring sector in pixels.

a1 (Mandatory) The starting angle of the ring sector in degrees. The angle is measured in degrees clockwise, with 0 being the upward pointing direction.

a2 (Mandatory) The ending angle of the ring sector in degrees. The angle is measured in degrees clockwise, with 0 being the upward pointing direction.

fillColor (Mandatory) The fill color of the ring sector.

edgeColor -1 The edge color of the ring sector. The default is the same as the fill color.

See also:

addRingSector(startRadius as Integer, endRadius as Integer, a1 as Double, a2 as Double, fillColor as color, edgeColor as color)

CDAngularMeterMBS.addScaleBackground(bgRadius as Integer, fillColor as color, edgeWidth as Integer = 0, edgeColor as color = &cFFFFFFFF, scaleRadius as Integer = -2147483647)

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

Adds a background to the meter scale.

The scale background is a circle segment (a circle with a part cut-off by a chord). Its radius is usually configured as larger than that of the meter scale. In this case, its angular span will also be larger than that of the meter scale. In the above sample, the meter scale spans 180 degrees. The scale background spans more than 180 degrees so that it can maintain a margin at the bottom side (the chord side).
Most arguments are optional and colors can be passed as Integer or color value.

Argument Default Description

bgRadius (Mandatory) The radius of the circle segment to be used as the scale background.

fillColor (Mandatory) The fill color of the circle segment (the background color).

edgeWidth 0 The edge width of the circle segment. A positive width means the edge is internal to the circle segment. A negative width means the edge is external to the circle segment.

edgeColor -1 The edge color. The default value of -1 means the edge color is the same as the fill color.

scaleRadius -0x7fffffff The radius of the meter scale. ChartDirector uses this value to compute the extra angular span the circle segment must have in order to maintain proper margin at the chord side. This argument is usually not necessary as ChartDirector already know the scale radius from the meter configuration. This argument can be used if you would like to use a "fake" scale radius to draw the scale background for special effects.

startAngle NoValue The start angle of the meter scale. ChartDirector uses this value to compute start angle of the circle segment. This argument is usually not necessary as ChartDirector already know the start angle from the meter configuration. This argument can be used if you would like to use a "fake" angle to draw the scale background for special effects.

endAngle NoValue The end angle of the meter scale. ChartDirector uses this value to compute end angle of the circle segment. This argument is usually not necessary as ChartDirector already know the end angle from the meter configuration. This argument can be used if you would like to use a "fake" angle to draw the scale background for special effects.

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

Adds a background to the meter scale.

The scale background is a circle segment (a circle with a part cut-off by a chord). Its radius is usually configured as larger than that of the meter scale. In this case, its angular span will also be larger than that of the meter scale. In the above sample, the meter scale spans 180 degrees. The scale background spans more than 180 degrees so that it can maintain a margin at the bottom side (the chord side).
Most arguments are optional and colors can be passed as Integer or color value.

Argument Default Description

bgRadius (Mandatory) The radius of the circle segment to be used as the scale background.

fillColor (Mandatory) The fill color of the circle segment (the background color).

edgeWidth 0 The edge width of the circle segment. A positive width means the edge is internal to the circle segment. A negative width means the edge is external to the circle segment.

edgeColor -1 The edge color. The default value of -1 means the edge color is the same as the fill color.

scaleRadius -0x7fffffff The radius of the meter scale. ChartDirector uses this value to compute the extra angular span the circle segment must have in order to maintain proper margin at the chord side. This argument is usually not necessary as ChartDirector already know the scale radius from the meter configuration. This argument can be used if you would like to use a "fake" scale radius to draw the scale background for special effects.

startAngle NoValue The start angle of the meter scale. ChartDirector uses this value to compute start angle of the circle segment. This argument is usually not necessary as ChartDirector already know the start angle from the meter configuration. This argument can be used if you would like to use a "fake" angle to draw the scale background for special effects.

endAngle NoValue The end angle of the meter scale. ChartDirector uses this value to compute end angle of the circle segment. This argument is usually not necessary as ChartDirector already know the end angle from the meter configuration. This argument can be used if you would like to use a "fake" angle to draw the scale background for special effects.

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

Adds a background to the meter scale.

The scale background is a circle segment (a circle with a part cut-off by a chord). Its radius is usually configured as larger than that of the meter scale. In this case, its angular span will also be larger than that of the meter scale. In the above sample, the meter scale spans 180 degrees. The scale background spans more than 180 degrees so that it can maintain a margin at the bottom side (the chord side).
Most arguments are optional and colors can be passed as Integer or color value.

Argument Default Description

bgRadius (Mandatory) The radius of the circle segment to be used as the scale background.

fillColor (Mandatory) The fill color of the circle segment (the background color).

edgeWidth 0 The edge width of the circle segment. A positive width means the edge is internal to the circle segment. A negative width means the edge is external to the circle segment.

edgeColor -1 The edge color. The default value of -1 means the edge color is the same as the fill color.

scaleRadius -0x7fffffff The radius of the meter scale. ChartDirector uses this value to compute the extra angular span the circle segment must have in order to maintain proper margin at the chord side. This argument is usually not necessary as ChartDirector already know the scale radius from the meter configuration. This argument can be used if you would like to use a "fake" scale radius to draw the scale background for special effects.

startAngle NoValue The start angle of the meter scale. ChartDirector uses this value to compute start angle of the circle segment. This argument is usually not necessary as ChartDirector already know the start angle from the meter configuration. This argument can be used if you would like to use a "fake" angle to draw the scale background for special effects.

endAngle NoValue The end angle of the meter scale. ChartDirector uses this value to compute end angle of the circle segment. This argument is usually not necessary as ChartDirector already know the end angle from the meter configuration. This argument can be used if you would like to use a "fake" angle to draw the scale background for special effects.

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

Adds a background to the meter scale.

The scale background is a circle segment (a circle with a part cut-off by a chord). Its radius is usually configured as larger than that of the meter scale. In this case, its angular span will also be larger than that of the meter scale. In the above sample, the meter scale spans 180 degrees. The scale background spans more than 180 degrees so that it can maintain a margin at the bottom side (the chord side).
Most arguments are optional and colors can be passed as Integer or color value.

Argument Default Description

bgRadius (Mandatory) The radius of the circle segment to be used as the scale background.

fillColor (Mandatory) The fill color of the circle segment (the background color).

edgeWidth 0 The edge width of the circle segment. A positive width means the edge is internal to the circle segment. A negative width means the edge is external to the circle segment.

edgeColor -1 The edge color. The default value of -1 means the edge color is the same as the fill color.

scaleRadius -0x7fffffff The radius of the meter scale. ChartDirector uses this value to compute the extra angular span the circle segment must have in order to maintain proper margin at the chord side. This argument is usually not necessary as ChartDirector already know the scale radius from the meter configuration. This argument can be used if you would like to use a "fake" scale radius to draw the scale background for special effects.

startAngle NoValue The start angle of the meter scale. ChartDirector uses this value to compute start angle of the circle segment. This argument is usually not necessary as ChartDirector already know the start angle from the meter configuration. This argument can be used if you would like to use a "fake" angle to draw the scale background for special effects.

endAngle NoValue The end angle of the meter scale. ChartDirector uses this value to compute end angle of the circle segment. This argument is usually not necessary as ChartDirector already know the end angle from the meter configuration. This argument can be used if you would like to use a "fake" angle to draw the scale background for special effects.

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

Same as the other addZone method, but uses color instead of integer data type for passing color values.

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

Adds a colored zone to the meter.

This method is just a short cut to AngularMeter.addZone, in which the starting radius is always 0, and ending radius is the radius of the meter scale. In other words, the zone is a sector on the meter.

Parameter Default Description

startValue (Mandatory) The data value that marks the start position of the zone.

endValue (Mandatory) The data value that marks the end position of the zone.

fillColor (Mandatory) The fill color of the zone.

edgeColor -1 The edge color of the zone. The default is the same as the fill color.

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

Same as the other addZone method, but uses color instead of integer data type for passing color values.

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

Adds a colored zone to the meter.

Parameter Default Description

startValue (Mandatory) The data value that marks the start position of the zone.

endValue (Mandatory) The data value that marks the end position of the zone.

startRadius (Mandatory) The starting radius of the zone in pixels.

endRadius (Mandatory) The ending radius of the zone in pixels.

fillColor (Mandatory) The fill color of the zone.

edgeColor -1 The edge color of the zone. The default is the same as the fill color.

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

Same as the other Constructor method, but uses color instead of integer data type for passing color values.

See also:

Constructor(width as Integer, height as Integer, bgColor as Integer = &hffff0000, edgeColor as Integer = &hff000000, raisedEffect as Integer = 0)

CDAngularMeterMBS.Constructor(width as Integer, height as Integer, bgColor as Integer = &hffff0000, edgeColor as Integer = &hff000000, raisedEffect as Integer = 0)

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

Creates a new AngularMeter object.

Parameter Default Description

width (Mandatory) The width of the chart in pixels.

height (Mandatory) The height of the chart in pixels.

bgColor BackgroundColor The background color of the chart.

edgeColor Transparent The edge color of the chart.

raisedEffect 0 The 3D border width. For positive values, the border will appear raised. For negative values, the border will appear depressed. A zero value means the border will appear flat.

See also:

Constructor(width as Integer, height as Integer, bgColor as color, edgeColor as color, raisedEffect as Integer = 0)

CDAngularMeterMBS.relativeLinearGradient(gradient() as Double, angle as Double = 0.0, radius as Double = -1.0) as Integer

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

Creates a linear gradient color relative to the meter center and radius.

A general linear gradient color can be created by CDBaseChartMBS.linearGradientColor, which involves specifying the x and y coordinates of the starting and ending points and the color stops. The relativeLinearGradient simplifies creating a linear gradient by assuming the gradient line passes through the meter center at an configurable angle.

The linear gradient is defined using an array of numbers, in which each pair of numbers represents the relative distance and its associated color. The relative distance is the ratio of the absolute distance to the reference radius, which defaults to the meter scale radius (set by AngularMeter.setMeter).

For example, to define a linear gradient with blue (0000FF) at the bottom-left of reference radius, green (00FF00) at the center, and red (FF0000) at the top-right of the reference radius, the angle should be set to 45 degrees, and the array of numbers should be:

-1.0, &H0000ff, 0.0, &H00ff00, 1.0, &Hff0000

The relative distances in the array should be arranged in increasing order. It is possible to define a relative linear gradient shorter or longer than the reference radius by using a relative distance of magnitude smaller or greater than 1. A negative relative distance means the distance is measured at the opposite side of center.

Argument Default Description

gradient (Mandatory) An numeric array defining the color stops. Please refer to the description above for details.

angle 0 The direction of the linear gradient line. It is specified as a clockwise angle in degrees, with 0 being the upward pointing direction.

radius -1 The reference radius to define the relative distance. The default is the meter scale radius (set by CDAngularMeterMBS.setMeter).

Returns a 32-bit integer representing the linear gradient color.

CDAngularMeterMBS.relativeRadialGradient(gradient() as Double, radius as Double = -1.0) as Integer

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

Creates a radial gradient color relative to the meter center and radius.

A general radial gradient color can be created by CDBaseChartMBS.radialGradientColor, which involves specifying the center x and y coordinates, horizontal and vertical radii, and the color stops. The relativeRadialGradient simplifies creating a radial gradient by assuming the center of the radial gradient to be the meter center, and the radial pattern is circular (so that the vertical and horizontal radii are the same), and default to using the meter scale radius (set by AngularMeter.setMeter) as the reference radius.

The radial gradient is defined using an array of numbers, in which each pair of numbers represents the relative radius and its associated color. The relative radius is the ratio of the absolute radius to the reference radius.

For example, to define a radial gradient with blue (0000FF) at the center, green (00FF00) at the mid-point between the center and the reference radius, and red at the reference radius, the numbers should be:

0.0, &H0000ff, 0.5, &H00ff00, 1.0, &Hff0000

The relative radii in the array must be arranged in increasing order. It is possible to define a relative radial gradient smaller or larger than the reference radius by using a relative radius smaller or greater than 1.

Argument Default Description

gradient (Mandatory) An numeric array defining the color stops. Please refer to the description above for details.

radius -1 The reference radius of the radial gradient. The default is the meter scale radius (set by CDAngularMeterMBS.setMeter).

Returns a 32-bit integer representing the radial gradient color.

CDAngularMeterMBS.setCap(radius as Integer, fillColor as color, edgeColor as color)

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

Set the radius and color of the pointer cap.

The pointer cap is a circle at the center of the meter above the meter pointer. By default, it is a small circle 3 pixels in radius, so it looks like a "pivot" for the pointer for it to rotate about the center.

You may change the radius and colors of this circle using this method to achieve other visual effects.

Parameter Default Description

radius (Mandatory) The radius of pointer cap circle in pixels.

fillColor (Mandatory) The fill color of the pointer cap circle.

edgeColor LineColor The edge color of the pointer cap circle.

See also:

setCap(radius as Integer, fillColor as Integer, edgeColor as Integer = &hffff0001)

Some examples using this method:

CDAngularMeterMBS.setCap(radius as Integer, fillColor as Integer, edgeColor as Integer = &hffff0001)

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

Set the radius and color of the pointer cap.

The pointer cap is a circle at the center of the meter above the meter pointer. By default, it is a small circle 3 pixels in radius, so it looks like a "pivot" for the pointer for it to rotate about the center.

You may change the radius and colors of this circle using this method to achieve other visual effects.

Parameter Default Description

radius (Mandatory) The radius of pointer cap circle in pixels.

fillColor (Mandatory) The fill color of the pointer cap circle.

edgeColor LineColor The edge color of the pointer cap circle.

See also:

setCap(radius as Integer, fillColor as color, edgeColor as color)

CDAngularMeterMBS.setCap2(backcolor as Color = &c888888, frontColor as Color = &c000000, frontEdgeColor as Color = &c888888)

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

Configures the meter to use new style pointer cap.

The new style pointer cap is a circular object covering the the center of the meter. If is designed to be used with new style pointers (added with AngularMeter.addPointer2). The cap consists of two circles, one at the background below the pointer, and one covering the pointer. The pointer will appear to be sandwiched between these two circles.
Arguments are optional and colors can be passed as Integer or color value.

Argument Default Description

backColor 0x888888 The fill color of the back circle.

frontColor 0x000000 The fill color of the front circle.

frontEdgeColor 0x888888 The edge color of the front circle.

lightingRatio NoValue By default, lighting effect is applied to the back circle and the edge of the front circle, such that the bottom-right side will appear to be darkened. This argument configures how bright the bottom-right side is. The default value is 0.2, which means the bottom-right side is 20% as bright as the top-left side. Setting this argument to 1 disables the lighting effect.

backRadiusRatio NoValue The radius of the back circle, expressed as a ratio to the meter scale radius (set with AngularMeter.setMeter). The default is 0.15.

frontRadiusRatio NoValue The radius of the front circle, expressed as a ratio to the meter scale radius (set with AngularMeter.setMeter). The default is 0.11.

frontEdgeWidthRatio NoValue The edge width of the front circle, expressed as a ratio to the meter scale radius (set with AngularMeter.setMeter). The default is 0.01.

See also:

Argument	Default	Description
radius	NoValue	The radius of the face of the meter. The default is the meter scale radius as set by AngularMeter.setMeter.
span	135	The angular span of the arc that divides the face into two parts. The dividing arc intersects with the face border at two points. The angular span is defined as center angle of these two points (that is, the angle subtended at the meter center by these two points).
rotate	0	By default, the glare will be symmetrically with respect to the vertical axis. This argument can be used to rotate the glare clockwise in degrees.
glareRadius	NoValue	The radius of the arc that divides the face into two parts. A positive value means the arc will result in a convex glare, while a negative means concave glare. The default is equal to 1.5 times of the face radius.
intensity	0.13	The intensity of the glare, which must be from 0 to 1. A value of 0 means no glare, while a value of 1 means the glare will be 100% white.

Parameter	Default	Description
startRadius	(Mandatory)	The starting radius of the ring in pixels. To add a circle, set the start radius to 0.
endRadius	(Mandatory)	The ending radius of the ring in pixels.
fillColor	(Mandatory)	The fill color of the ring.
edgeColor	-1	The edge color of the ring. The default is the same as the fill color.