CDBaseChartMBS.addExtraField(numbers() as Double)

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

Adds an array of numbers/dates to be used as an extra field in various places.

This method merely stores the data inside the chart object. The Parameter Substitution and Formatting mechanism will determine how the data are to be used.

A common use for extra fields is to specify extra information (such as a custom serial number for the data points) to be displayed on data labels or on tool tips, or to supply extra query parameters in clickable charts. All these are achieved by specifying the extra field on the data label template or image map templates during parameter substitution.

Argument	Default	Description
numbers	(Mandatory)	An array of numbers/dates to be stored inside the chart object.

See also:

• addExtraField(paths() as folderitem)
• addExtraField(texts() as string)

CDBaseChartMBS.addExtraField(paths() as folderitem)

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

Adds an array of file paths to be used as an extra field in various places.

This method merely stores the data inside the chart object. The Parameter Substitution and Formatting mechanism will determine how the data are to be used.

A common use for extra fields is to specify extra information (such as a custom serial number for the data points) to be displayed on data labels or on tool tips, or to supply extra query parameters in clickable charts. All these are achieved by specifying the extra field on the data label template or image map templates during parameter substitution.

Argument	Default	Description
texts	(Mandatory)	An array of text to be stored inside the chart object.

See also:

• addExtraField(numbers() as Double)
• addExtraField(texts() as string)

CDBaseChartMBS.addExtraField(texts() as string)

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

Adds an array of text to be used as an extra field in various places.

This method merely stores the data inside the chart object. The Parameter Substitution and Formatting mechanism will determine how the data are to be used.

A common use for extra fields is to specify extra information (such as a custom serial number for the data points) to be displayed on data labels or on tool tips, or to supply extra query parameters in clickable charts. All these are achieved by specifying the extra field on the data label template or image map templates during parameter substitution.

Argument	Default	Description
texts	(Mandatory)	An array of text to be stored inside the chart object.

Great to add point labels to the chart.

See also:

• addExtraField(numbers() as Double)
• addExtraField(paths() as folderitem)

CDBaseChartMBS.addLegend(x as Integer, y as Integer, noOfCols as Integer, font as string = "", fontsize as Double = 10) as CDLegendBoxMBS

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

Adds a legend box to the chart with grid layout.

In grid layout, the legend box will be divided into a table in which all cells are of of same width. The legend entries will fill the cells from left to right, top to bottom.

The number of columns can be specified using the noOfCols argument. If this argument is set to the special constant AutoGrid (= -2), the number of columns will be automatically determined based on the longest legend entry. If this argument is 0, the legend box will use a flow layout (from left to right and then top to bottom, in which the entries may not be vertically aligned).

In any case, the number of rows in the table is automatically determined so as to have enough cells for all legend entries.

Argument	Default	Description
x	(Mandatory)	The x coordinate of the reference point of the legend box. By default, the reference point is the top-left corner of the box, but can be configured by using TextBox.setAlignment.
y	(Mandatory)	The y coordinate of the reference point of the legend box. By default, the reference point is the top-left corner of the box, but can be configured by using TextBox.setAlignment.
noOfCols	(Mandatory)	The number of columns in the legend box. The special value AutoGrid (= -2) means the number of columns is automatically determined. If this argument is 0, the legend box will use a flow layout (from left to right and then top to bottom, in which the entries may not be vertically aligned).
font	""	The font name of the font for drawing the legend text. The default is "normal". See Font Specification for details on various font attributes.
fontSize	10	The font size of the legend text.

Return Value
A LegendBox object representing the legend box. You may use this object to fine-tune the appearance of the legend box.

See font specification here:
http://www.monkeybreadsoftware.net/faq-chartdirectorfontspecification.shtml

See also:

• addLegend(x as Integer, y as Integer, vertical as boolean=true, font as string = "", fontsize as Double = 10) as CDLegendBoxMBS

Some examples using this method:

• /ChartDirector/ChartDirector Control
• /ChartDirector/datatable
• /ChartDirector/heatmapcellsymbols
• /ChartDirector/math function plot centered
• /ChartDirector/surfacetexture
• /ChartDirector/symbolline zoom improved
• /ChartDirector/threedscatteraxis
• /ChartDirector/Tracking Cursor/Track Box with Legend
• /ChartDirector/Tracking Cursor/Track Line with Axis Labels
• /ChartDirector/Tracking Cursor/Track Line with Data Labels

CDBaseChartMBS.addLegend(x as Integer, y as Integer, vertical as boolean=true, font as string = "", fontsize as Double = 10) as CDLegendBoxMBS

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

Adds a legend box to the chart.

The entries in the legend box will flow from top to bottom (one line per entry), or from left to right and then top to bottom (like flowing text), depending on the vertical argument. For grid layout, use BaseChart.addLegend2.

Argument	Default	Description
x	(Mandatory)	The x coordinate of the reference point of the legend box. By default, the reference point is the top-left corner of the box, but can be configured by using TextBox.setAlignment.
y	(Mandatory)	The y coordinate of the reference point of the legend box. By default, the reference point is the top-left corner of the box, but can be configured by using TextBox.setAlignment.
vertical	true	A true value means the legend keys are laid out vertically (one line per entry). A false value means the legend keys are laid out horizontal and flow like text (from left to right, top to bottom).
font	""	The font name of the font for drawing the legend text. The default is "normal". See Font Specification for details on various font attributes.
fontSize	10	The font size of the legend text.

Return Value
A LegendBox object representing the legend box. You may use this object to fine-tune the appearance of the legend box.

See font specification here:
http://www.monkeybreadsoftware.net/faq-chartdirectorfontspecification.shtml

See also:

• addLegend(x as Integer, y as Integer, noOfCols as Integer, font as string = "", fontsize as Double = 10) as CDLegendBoxMBS

CDBaseChartMBS.addLine(x1 as Integer, y1 as Integer, x2 as Integer, y2 as Integer, colorvalue as color, lineWidth as Integer = 1) as CDLineMBS

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 addLine method, but uses color instead of integer data type for passing color values.

See also:

• addLine(x1 as Integer, y1 as Integer, x2 as Integer, y2 as Integer, colorvalue as Integer = &hffff0001, lineWidth as Integer = 1) as CDLineMBS

CDBaseChartMBS.addLine(x1 as Integer, y1 as Integer, x2 as Integer, y2 as Integer, colorvalue as Integer = &hffff0001, lineWidth as Integer = 1) as CDLineMBS

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

Adds a line to the chart.

Argument	Default	Description
x1	(Mandatory)	The x coordinate of the first endpoint of the line.
y1	(Mandatory)	The y coordinate of the first endpoint of the line.
x2	(Mandatory)	The x coordinate of the second endpoint of the line.
y2	(Mandatory)	The y coordinate of the second endpoint of the line.
color	LineColor	The color of the line.
lineWidth	1	The width of the line.

Return Value
A Line object representing the line added. You may use this object to fine- tune the appearance of the line.

See also:

• addLine(x1 as Integer, y1 as Integer, x2 as Integer, y2 as Integer, colorvalue as color, lineWidth as Integer = 1) as CDLineMBS

CDBaseChartMBS.addTable(x as Integer, y as Integer, alignment as Integer, col as Integer, row as Integer) as CDMLTableMBS

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

Adds a CDML table to the chart.

Arguments:

Argument	Default	Description
x	(Mandatory)	The x-coordinate of the reference point used to position the table.
y	(Mandatory)	The y-coordinate of the reference point used to position the table.
alignment	(Mandatory)	The alignment of the table with respect to the reference point. For example, a value of kTopLeft means the reference point is the top- left corner of the table. See Alignment Specification for supported alignment types..
col	(Mandatory)	The number of columns in the table.
row	(Mandatory)	The number of rows in the table.

Returns a CDMLTableMBS object representing the CDML table added.

CDBaseChartMBS.addText(x as Integer, y as Integer, text as string, font as string = "", fontsize as Double = 8, fontcolor as Integer = &hffff0002, alignment as Integer = 7, angle as Double = 0, vertical as boolean=false) as CDTextBoxMBS

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

Adds a text box to the chart.

By default, only the text is visible, the box is transparent. This method returns a TextBox object that can be used to change the appearance of the text box.

Argument	Default	Description
x	(Mandatory)	The x coordinate of the left of the text box.
y	(Mandatory)	The y coordinate of the top of the text box.
text	(Mandatory)	The text to shown in the text box. See ChartDirector Mark Up Language on how to embed special tags in the text for sophisticated formatting.
font	""	The font used to draw the text. See Font Specification for details on various font attributes.
fontSize	8	The font size used to draw the text.
fontColor	TextColor	The color used to draw the text.
alignment	TopLeft	The alignment of the text within the text box. See Alignment Specification for supported alignment types.
angle	0	The rotation angle of the text within the text box.
vertical	false	Indicate whether the text should be laid out vertically (from top to bottom) or horizontally (from left to right).

Return Value
A TextBox object representing the text box. This may be used to fine-tune the appearance of the text box.

See font specification here:
http://www.monkeybreadsoftware.net/faq-chartdirectorfontspecification.shtml

See also:

• addText(x as Integer, y as Integer, text as string, font as string, fontsize as Double, fontcolor as color, alignment as Integer = 7, angle as Double = 0, vertical as boolean=false) as CDTextBoxMBS

CDBaseChartMBS.addText(x as Integer, y as Integer, text as string, font as string, fontsize as Double, fontcolor as color, alignment as Integer = 7, angle as Double = 0, vertical as boolean=false) as CDTextBoxMBS

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 addText method, but uses color instead of integer data type for passing color values.

See also:

• addText(x as Integer, y as Integer, text as string, font as string = "", fontsize as Double = 8, fontcolor as Integer = &hffff0002, alignment as Integer = 7, angle as Double = 0, vertical as boolean=false) as CDTextBoxMBS

CDBaseChartMBS.addTitle(alignment as Integer, text as string, font as string = "", fontsize as Double = 12, fontColor as Integer = &hffff0002, bgColor as Integer = &hff000000, edgeColor as Integer = &hff000000) as CDTextBoxMBS

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

Adds a title to the chart.

Argument	Default	Description
alignment	(Mandatory)	The position on the title on the chart. See Alignment Specification for supported alignment types.
text	(Mandatory)	The text for the title. See ChartDirector Mark Up Language on how to embed special tags in the text for sophisticated formatting.
font	""	The font used to draw the title text. The default is "bold". See Font Specification for details on various font attributes.
fontSize	12	The font size in points for the title text.
fontColor	TextColor	The color of the title text.
bgColor	Transparent	The background color of the title box.
edgeColor	Transparent	The border color of the title box.

Return Value
A TextBox object representing the title box. This may be used to fine-tune the appearance of the title box.

See font specification here:
http://www.monkeybreadsoftware.net/faq-chartdirectorfontspecification.shtml

See also:

• addTitle(alignment as Integer, text as string, font as string, fontsize as Double, fontColor as color, bgColor as color, edgeColor as color) as CDTextBoxMBS
• addTitle(text as string, font as string = "", fontsize as Double = 12, fontColor as Integer = &hffff0002, bgColor as Integer = &hff000000, edgeColor as Integer = &hff000000) as CDTextBoxMBS
• addTitle(text as string, font as string, fontsize as Double, fontColor as color, bgColor as color, edgeColor as color) as CDTextBoxMBS

Some examples using this method:

• /ChartDirector/binaryseries
• /ChartDirector/linearzonemeter
• /ChartDirector/math function plot
• /ChartDirector/Place PDF Chart with DynaPDF
• /ChartDirector/simplePie with DynaPDF
• /ChartDirector/threedscatteraxis
• /ChartDirector/Tracking Cursor/Finance Chart Track Line
• /ChartDirector/Tracking Cursor/Track Box with Legend
• /ChartDirector/Tracking Cursor/Track Line with Axis Labels
• /ChartDirector/Tracking Cursor/Track Line with Legend

CDBaseChartMBS.addTitle(alignment as Integer, text as string, font as string, fontsize as Double, fontColor as color, bgColor as color, edgeColor as color) as CDTextBoxMBS

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 addTitle method, but uses color instead of integer data type for passing color values.

See also:

• addTitle(alignment as Integer, text as string, font as string = "", fontsize as Double = 12, fontColor as Integer = &hffff0002, bgColor as Integer = &hff000000, edgeColor as Integer = &hff000000) as CDTextBoxMBS
• addTitle(text as string, font as string = "", fontsize as Double = 12, fontColor as Integer = &hffff0002, bgColor as Integer = &hff000000, edgeColor as Integer = &hff000000) as CDTextBoxMBS
• addTitle(text as string, font as string, fontsize as Double, fontColor as color, bgColor as color, edgeColor as color) as CDTextBoxMBS

CDBaseChartMBS.addTitle(text as string, font as string = "", fontsize as Double = 12, fontColor as Integer = &hffff0002, bgColor as Integer = &hff000000, edgeColor as Integer = &hff000000) as CDTextBoxMBS

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

Adds a title at the top center of the chart.

The title is contained within a box, of which the width is the same as the width of the chart, and the height is automatically adjusted to fit the text. The box is initially invisible, but can be made visible by setting the bgColor and edgeColor.

Argument	Default	Description
text	(Mandatory)	The text for the title. See ChartDirector Mark Up Language on how to embed special tags in the text for sophisticated formatting.
font	""	The font used to draw the title text. The default is "bold". See Font Specification for details on various font attributes.
fontSize	12	The font size in points for the title text.
fontColor	TextColor	The color of the title text.
bgColor	Transparent	The background color of the title box.
edgeColor	Transparent	The border color of the title box.

Return Value
A TextBox object representing the title box. This may be used to fine-tune the appearance of the title box.

See font specification here:
http://www.monkeybreadsoftware.net/faq-chartdirectorfontspecification.shtml

See also:

• addTitle(alignment as Integer, text as string, font as string = "", fontsize as Double = 12, fontColor as Integer = &hffff0002, bgColor as Integer = &hff000000, edgeColor as Integer = &hff000000) as CDTextBoxMBS
• addTitle(alignment as Integer, text as string, font as string, fontsize as Double, fontColor as color, bgColor as color, edgeColor as color) as CDTextBoxMBS
• addTitle(text as string, font as string, fontsize as Double, fontColor as color, bgColor as color, edgeColor as color) as CDTextBoxMBS

CDBaseChartMBS.addTitle(text as string, font as string, fontsize as Double, fontColor as color, bgColor as color, edgeColor as color) as CDTextBoxMBS

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 addTitle method, but uses color instead of integer data type for passing color values.

See also:

• addTitle(alignment as Integer, text as string, font as string = "", fontsize as Double = 12, fontColor as Integer = &hffff0002, bgColor as Integer = &hff000000, edgeColor as Integer = &hff000000) as CDTextBoxMBS
• addTitle(alignment as Integer, text as string, font as string, fontsize as Double, fontColor as color, bgColor as color, edgeColor as color) as CDTextBoxMBS
• addTitle(text as string, font as string = "", fontsize as Double = 12, fontColor as Integer = &hffff0002, bgColor as Integer = &hff000000, edgeColor as Integer = &hff000000) as CDTextBoxMBS

CDBaseChartMBS.adjustBrightness(ColorValue as color, brightness as Double) as Integer

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 adjustBrightness method, but uses color instead of integer data type for passing color values.

See also:

• adjustBrightness(ColorValue as Integer, brightness as Double) as Integer

CDBaseChartMBS.adjustBrightness(ColorValue as Integer, brightness as Double) as Integer

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

Creates a color that is a darkened or brightened version of the given color.

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.

Arguments:

Argument	Default	Description
c	(Mandatory)	The given color.
brightness	(Mandatory)	A non-negative number represent the factor to darken or brighten the color.

Return Value
A 32-bit integer representing the darkened or brightened color.

See also:

• adjustBrightness(ColorValue as color, brightness as Double) as Integer