Platforms to show: All Mac Windows Linux Cross-Platform
CDBaseChartMBS.addExtraField(numbers() as double)
method, ChartDirector, MBS Real Studio ChartDirector Plugin (ChartDirector5), class CDBaseChartMBS,
Plugin version: 8.2, Mac: Yes, Win: Yes, Linux: Yes, Console & Web: Yes, Feedback.
Function: Adds an array of numbers/dates to be used as an extra field in various places.
Notes:
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.
method, ChartDirector, MBS Real Studio ChartDirector Plugin (ChartDirector5), class CDBaseChartMBS,
Plugin version: 8.2, Mac: Yes, Win: Yes, Linux: Yes, Console & Web: Yes, Feedback.
Function: Adds an array of numbers/dates to be used as an extra field in various places.
Notes:
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:
CDBaseChartMBS.addExtraField(paths() as folderitem)
method, ChartDirector, MBS Real Studio ChartDirector Plugin (ChartDirector5), class CDBaseChartMBS,
Plugin version: 8.2, Mac: Yes, Win: Yes, Linux: Yes, Console & Web: Yes, Feedback.
Function: Adds an array of file paths to be used as an extra field in various places.
Notes:
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.
method, ChartDirector, MBS Real Studio ChartDirector Plugin (ChartDirector5), class CDBaseChartMBS,
Plugin version: 8.2, Mac: Yes, Win: Yes, Linux: Yes, Console & Web: Yes, Feedback.
Function: Adds an array of file paths to be used as an extra field in various places.
Notes:
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:
CDBaseChartMBS.addExtraField(texts() as string)
method, ChartDirector, MBS Real Studio ChartDirector Plugin (ChartDirector5), class CDBaseChartMBS,
Plugin version: 8.2, Mac: Yes, Win: Yes, Linux: Yes, Console & Web: Yes, Feedback.
Function: Adds an array of text to be used as an extra field in various places.
Notes:
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.
method, ChartDirector, MBS Real Studio ChartDirector Plugin (ChartDirector5), class CDBaseChartMBS,
Plugin version: 8.2, Mac: Yes, Win: Yes, Linux: Yes, Console & Web: Yes, Feedback.
Function: Adds an array of text to be used as an extra field in various places.
Notes:
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:
CDBaseChartMBS.addLegend(x as integer, y as integer, noOfCols as integer, font as string = "", fontsize as double = 10) as CDLegendBoxMBS
method, ChartDirector, MBS Real Studio ChartDirector Plugin (ChartDirector5), class CDBaseChartMBS,
Plugin version: 8.2, Mac: Yes, Win: Yes, Linux: Yes, Console & Web: Yes, Feedback.
Function: Adds a legend box to the chart with grid layout.
Notes:
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.
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
method, ChartDirector, MBS Real Studio ChartDirector Plugin (ChartDirector5), class CDBaseChartMBS,
Plugin version: 8.2, Mac: Yes, Win: Yes, Linux: Yes, Console & Web: Yes, Feedback.
Function: Adds a legend box to the chart with grid layout.
Notes:
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. |
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:
CDBaseChartMBS.addLegend(x as integer, y as integer, vertical as boolean=true, font as string = "", fontsize as double = 10) as CDLegendBoxMBS
method, ChartDirector, MBS Real Studio ChartDirector Plugin (ChartDirector5), class CDBaseChartMBS,
Plugin version: 8.2, Mac: Yes, Win: Yes, Linux: Yes, Console & Web: Yes, Feedback.
Function: Adds a legend box to the chart.
Notes:
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.
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
method, ChartDirector, MBS Real Studio ChartDirector Plugin (ChartDirector5), class CDBaseChartMBS,
Plugin version: 8.2, Mac: Yes, Win: Yes, Linux: Yes, Console & Web: Yes, Feedback.
Function: Adds a legend box to the chart.
Notes:
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. |
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:
CDBaseChartMBS.addLine(x1 as integer, y1 as integer, x2 as integer, y2 as integer, colorvalue as color, lineWidth as integer = 1) as CDLineMBS
method, ChartDirector, MBS Real Studio ChartDirector Plugin (ChartDirector5), class CDBaseChartMBS,
Plugin version: 11.1, Mac: Yes, Win: Yes, Linux: Yes, Console & Web: Yes, Feedback.
Function: Same as the other addLine method, but uses color instead of integer data type for passing color values.
method, ChartDirector, MBS Real Studio ChartDirector Plugin (ChartDirector5), class CDBaseChartMBS,
Plugin version: 11.1, Mac: Yes, Win: Yes, Linux: Yes, Console & Web: Yes, Feedback.
Function: Same as the other addLine method, but uses color instead of integer data type for passing color values.
See also:
CDBaseChartMBS.addLine(x1 as integer, y1 as integer, x2 as integer, y2 as integer, colorvalue as integer = &hffff0001, lineWidth as integer = 1) as CDLineMBS
method, ChartDirector, MBS Real Studio ChartDirector Plugin (ChartDirector5), class CDBaseChartMBS,
Plugin version: 8.2, Mac: Yes, Win: Yes, Linux: Yes, Console & Web: Yes, Feedback.
Function: Adds a line to the chart.
Notes:
Return Value
A Line object representing the line added. You may use this object to fine- tune the appearance of the line.
method, ChartDirector, MBS Real Studio ChartDirector Plugin (ChartDirector5), class CDBaseChartMBS,
Plugin version: 8.2, Mac: Yes, Win: Yes, Linux: Yes, Console & Web: Yes, Feedback.
Function: Adds a line to the chart.
Notes:
| 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. |
A Line object representing the line added. You may use this object to fine- tune the appearance of the line.
See also:
CDBaseChartMBS.addTable(x as integer, y as integer, alignment as integer, col as integer, row as integer) as CDMLTableMBS
method, ChartDirector, MBS Real Studio ChartDirector Plugin (ChartDirector5), class CDBaseChartMBS,
Plugin version: 9.2, Mac: Yes, Win: Yes, Linux: Yes, Console & Web: Yes, Feedback.
Function: Adds a CDML table to the chart.
Notes:
Arguments:
Returns a CDMLTableMBS object representing the CDML table added.
method, ChartDirector, MBS Real Studio ChartDirector Plugin (ChartDirector5), class CDBaseChartMBS,
Plugin version: 9.2, Mac: Yes, Win: Yes, Linux: Yes, Console & Web: Yes, Feedback.
Function: Adds a CDML table to the chart.
Notes:
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
method, ChartDirector, MBS Real Studio ChartDirector Plugin (ChartDirector5), class CDBaseChartMBS,
Plugin version: 8.2, Mac: Yes, Win: Yes, Linux: Yes, Console & Web: Yes, Feedback.
Function: Adds a text box to the chart.
Notes:
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.
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
method, ChartDirector, MBS Real Studio ChartDirector Plugin (ChartDirector5), class CDBaseChartMBS,
Plugin version: 8.2, Mac: Yes, Win: Yes, Linux: Yes, Console & Web: Yes, Feedback.
Function: Adds a text box to the chart.
Notes:
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). |
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:
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
method, ChartDirector, MBS Real Studio ChartDirector Plugin (ChartDirector5), class CDBaseChartMBS,
Plugin version: 11.1, Mac: Yes, Win: Yes, Linux: Yes, Console & Web: Yes, Feedback.
Function: Same as the other addText method, but uses color instead of integer data type for passing color values.
method, ChartDirector, MBS Real Studio ChartDirector Plugin (ChartDirector5), class CDBaseChartMBS,
Plugin version: 11.1, Mac: Yes, Win: Yes, Linux: Yes, Console & Web: Yes, Feedback.
Function: Same as the other addText method, but uses color instead of integer data type for passing color values.
See also:
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
method, ChartDirector, MBS Real Studio ChartDirector Plugin (ChartDirector5), class CDBaseChartMBS,
Plugin version: 8.2, Mac: Yes, Win: Yes, Linux: Yes, Console & Web: Yes, Feedback.
Function: Adds a title to the chart.
Notes:
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
method, ChartDirector, MBS Real Studio ChartDirector Plugin (ChartDirector5), class CDBaseChartMBS,
Plugin version: 8.2, Mac: Yes, Win: Yes, Linux: Yes, Console & Web: Yes, Feedback.
Function: Adds a title to the chart.
Notes:
| 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. |
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
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
method, ChartDirector, MBS Real Studio ChartDirector Plugin (ChartDirector5), class CDBaseChartMBS,
Plugin version: 11.1, Mac: Yes, Win: Yes, Linux: Yes, Console & Web: Yes, Feedback.
Function: Same as the other addTitle method, but uses color instead of integer data type for passing color values.
method, ChartDirector, MBS Real Studio ChartDirector Plugin (ChartDirector5), class CDBaseChartMBS,
Plugin version: 11.1, Mac: Yes, Win: Yes, Linux: Yes, Console & Web: Yes, Feedback.
Function: 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
method, ChartDirector, MBS Real Studio ChartDirector Plugin (ChartDirector5), class CDBaseChartMBS,
Plugin version: 8.2, Mac: Yes, Win: Yes, Linux: Yes, Console & Web: Yes, Feedback.
Function: Adds a title at the top center of the chart.
Notes:
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.
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
method, ChartDirector, MBS Real Studio ChartDirector Plugin (ChartDirector5), class CDBaseChartMBS,
Plugin version: 8.2, Mac: Yes, Win: Yes, Linux: Yes, Console & Web: Yes, Feedback.
Function: Adds a title at the top center of the chart.
Notes:
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. |
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
method, ChartDirector, MBS Real Studio ChartDirector Plugin (ChartDirector5), class CDBaseChartMBS,
Plugin version: 11.1, Mac: Yes, Win: Yes, Linux: Yes, Console & Web: Yes, Feedback.
Function: Same as the other addTitle method, but uses color instead of integer data type for passing color values.
method, ChartDirector, MBS Real Studio ChartDirector Plugin (ChartDirector5), class CDBaseChartMBS,
Plugin version: 11.1, Mac: Yes, Win: Yes, Linux: Yes, Console & Web: Yes, Feedback.
Function: 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
method, ChartDirector, MBS Real Studio ChartDirector Plugin (ChartDirector5), class CDBaseChartMBS,
Plugin version: 11.1, Mac: Yes, Win: Yes, Linux: Yes, Console & Web: Yes, Feedback.
Function: Same as the other adjustBrightness method, but uses color instead of integer data type for passing color values.
method, ChartDirector, MBS Real Studio ChartDirector Plugin (ChartDirector5), class CDBaseChartMBS,
Plugin version: 11.1, Mac: Yes, Win: Yes, Linux: Yes, Console & Web: Yes, Feedback.
Function: Same as the other adjustBrightness method, but uses color instead of integer data type for passing color values.
See also:
CDBaseChartMBS.adjustBrightness(ColorValue as integer, brightness as double) as integer
method, ChartDirector, MBS Real Studio ChartDirector Plugin (ChartDirector5), class CDBaseChartMBS,
Plugin version: 9.2, Mac: Yes, Win: Yes, Linux: Yes, Console & Web: Yes, Feedback.
Function: Creates a color that is a darkened or brightened version of the given color.
Notes:
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:
Return Value
A 32-bit integer representing the darkened or brightened color.
method, ChartDirector, MBS Real Studio ChartDirector Plugin (ChartDirector5), class CDBaseChartMBS,
Plugin version: 9.2, Mac: Yes, Win: Yes, Linux: Yes, Console & Web: Yes, Feedback.
Function: Creates a color that is a darkened or brightened version of the given color.
Notes:
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:
CDBaseChartMBS.AllPassFilter as integer
shared method, ChartDirector, MBS Real Studio ChartDirector Plugin (ChartDirector5), class CDBaseChartMBS,
Plugin version: 8.2, Mac: Yes, Win: Yes, Linux: Yes, Console & Web: Yes, Feedback.
Function: Creates a data filter that matches every element.
Notes:
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.
shared method, ChartDirector, MBS Real Studio ChartDirector Plugin (ChartDirector5), class CDBaseChartMBS,
Plugin version: 8.2, Mac: Yes, Win: Yes, Linux: Yes, Console & Web: Yes, Feedback.
Function: Creates a data filter that matches every element.
Notes:
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.
CDBaseChartMBS.barLighting(startBrightness as double = 0.75, endBrightness as double = 1.5) as integer
shared method, ChartDirector, MBS Real Studio ChartDirector Plugin (ChartDirector5), class CDBaseChartMBS,
Plugin version: 9.2, Mac: Yes, Win: Yes, Linux: Yes, Console & Web: Yes, Feedback.
Function: A special shading effect for rectangular and polygonal bars on a CDBarLayerMBS.
Notes:
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:
Return Value
An integer representing the bar lighting effect.
shared method, ChartDirector, MBS Real Studio ChartDirector Plugin (ChartDirector5), class CDBaseChartMBS,
Plugin version: 9.2, Mac: Yes, Win: Yes, Linux: Yes, Console & Web: Yes, Feedback.
Function: A special shading effect for rectangular and polygonal bars on a CDBarLayerMBS.
Notes:
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()
shared method, ChartDirector, MBS Real Studio ChartDirector Plugin (ChartDirector5), class CDBaseChartMBS,
Plugin version: 8.2, Mac: Yes, Win: Yes, Linux: Yes, Console & Web: Yes, Feedback.
Function: A constant array of integers to represent a gradient that looks like a blue metallic color.
Notes:
The array is in a format that can be directly used in BaseChart.gradientColor2 and DrawArea.gradientColor2. Its contents (in hex) is:
00 9898E0 60 F0F0FF B0 D8D8F0 100 9898E0
See Color Specification on how colors are represented in ChartDirector.
shared method, ChartDirector, MBS Real Studio ChartDirector Plugin (ChartDirector5), class CDBaseChartMBS,
Plugin version: 8.2, Mac: Yes, Win: Yes, Linux: Yes, Console & Web: Yes, Feedback.
Function: A constant array of integers to represent a gradient that looks like a blue metallic color.
Notes:
The array is in a format that can be directly used in BaseChart.gradientColor2 and DrawArea.gradientColor2. Its contents (in hex) is:
00 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
shared method, ChartDirector, MBS Real Studio ChartDirector Plugin (ChartDirector5), class CDBaseChartMBS,
Plugin version: 9.2, Mac: Yes, Win: Yes, Linux: Yes, Console & Web: Yes, Feedback.
Function: Creates a brushed golden color, most commonly used as a background color.
Notes:
This method is a short cut to the CDBaseChartMBS.brushedMetalColor method, using yellow (FFEE44 in hex) as the base color.
Arguments:
Return Value:
A 32-bit integer representing the brushed golden color.
shared method, ChartDirector, MBS Real Studio ChartDirector Plugin (ChartDirector5), class CDBaseChartMBS,
Plugin version: 9.2, Mac: Yes, Win: Yes, Linux: Yes, Console & Web: Yes, Feedback.
Function: Creates a brushed golden color, most commonly used as a background color.
Notes:
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
shared method, ChartDirector, MBS Real Studio ChartDirector Plugin (ChartDirector5), class CDBaseChartMBS,
Plugin version: 9.2, Mac: Yes, Win: Yes, Linux: Yes, Console & Web: Yes, Feedback.
Function: Creates a color by modulates the brightness of another color to create brushed metallic shiny effects.
Notes:
The brightness of the color will vary smoothly across the image in a given a direction, so as to produce a shiny effect. The 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:
Return Value:
A 32-bit integer representing the brushed metallic color.
shared method, ChartDirector, MBS Real Studio ChartDirector Plugin (ChartDirector5), class CDBaseChartMBS,
Plugin version: 9.2, Mac: Yes, Win: Yes, Linux: Yes, Console & Web: Yes, Feedback.
Function: Creates a color by modulates the brightness of another color to create brushed metallic shiny effects.
Notes:
The brightness of the color will vary smoothly across the image in a given a direction, so as to produce a shiny effect. The 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
shared method, ChartDirector, MBS Real Studio ChartDirector Plugin (ChartDirector5), class CDBaseChartMBS,
Plugin version: 9.2, Mac: Yes, Win: Yes, Linux: Yes, Console & Web: Yes, Feedback.
Function: Creates a brushed silver color, most commonly used as a background color.
Notes:
This method is a short cut to the CDBaseChartMBS.brushedMetalColor method, using grey (DDDDDD in hex) as the base color.
Arguments:
Return Value
A 32-bit integer representing the brushed silver color.
shared method, ChartDirector, MBS Real Studio ChartDirector Plugin (ChartDirector5), class CDBaseChartMBS,
Plugin version: 9.2, Mac: Yes, Win: Yes, Linux: Yes, Console & Web: Yes, Feedback.
Function: Creates a brushed silver color, most commonly used as a background color.
Notes:
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
shared method, ChartDirector, MBS Real Studio ChartDirector Plugin (ChartDirector5), class CDBaseChartMBS,
Plugin version: 12.3, Mac: Yes, Win: Yes, Linux: Yes, Console & Web: Yes, Feedback.
Function: Uses binary search to search for a value in an array.
Notes:
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.
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.
shared method, ChartDirector, MBS Real Studio ChartDirector Plugin (ChartDirector5), class CDBaseChartMBS,
Plugin version: 12.3, Mac: Yes, Win: Yes, Linux: Yes, Console & Web: Yes, Feedback.
Function: Uses binary search to search for a value in an array.
Notes:
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.
CDBaseChartMBS.chartTime(t as integer) as double
shared method, ChartDirector, MBS Real Studio ChartDirector Plugin (ChartDirector5), class CDBaseChartMBS,
Plugin version: 8.2, Mac: Yes, Win: Yes, Linux: Yes, Console & Web: Yes, Feedback.
Function: Converts a UNIX time (seconds elapsed since 01-01-1970 00:00:00 GMT) to the date/time format used by ChartDirector.
Notes:
The UNIX time will be converted assuming based on local time zone (the time zone settings of the operating system).
Return Value
The second elapsed since 01-01-0001 00:00:00 to the given time.
shared method, ChartDirector, MBS Real Studio ChartDirector Plugin (ChartDirector5), class CDBaseChartMBS,
Plugin version: 8.2, Mac: Yes, Win: Yes, Linux: Yes, Console & Web: Yes, Feedback.
Function: Converts a UNIX time (seconds elapsed since 01-01-1970 00:00:00 GMT) to the date/time format used by ChartDirector.
Notes:
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. |
The second elapsed since 01-01-0001 00:00:00 to the given time.
See also:
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
shared method, ChartDirector, MBS Real Studio ChartDirector Plugin (ChartDirector5), class CDBaseChartMBS,
Plugin version: 8.2, Mac: Yes, Win: Yes, Linux: Yes, Console & Web: Yes, Feedback.
Function: Obtain the second elapsed since 01-01-0001 00:00:00 to the given time, which is the date/time format used by ChartDirector.
Notes:
Return Value
The second elapsed since 01-01-0001 00:00:00 to the given time.
shared method, ChartDirector, MBS Real Studio ChartDirector Plugin (ChartDirector5), class CDBaseChartMBS,
Plugin version: 8.2, Mac: Yes, Win: Yes, Linux: Yes, Console & Web: Yes, Feedback.
Function: Obtain the second elapsed since 01-01-0001 00:00:00 to the given time, which is the date/time format used by ChartDirector.
Notes:
| 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. |
The second elapsed since 01-01-0001 00:00:00 to the given time.
See also:
CDBaseChartMBS.ClearTypeColor(gamma as double = 0) as integer
shared method, ChartDirector, MBS Real Studio ChartDirector Plugin (ChartDirector5), class CDBaseChartMBS,
Plugin version: 12.3, Mac: Yes, Win: Yes, Linux: Yes, Console & Web: Yes, Feedback.
Function: Gets a value to represent that standard ClearType or a similar technology be used for font rendering.
Notes:
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.
shared method, ChartDirector, MBS Real Studio ChartDirector Plugin (ChartDirector5), class CDBaseChartMBS,
Plugin version: 12.3, Mac: Yes, Win: Yes, Linux: Yes, Console & Web: Yes, Feedback.
Function: Gets a value to represent that standard ClearType or a similar technology be used for font rendering.
Notes:
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
shared method, ChartDirector, MBS Real Studio ChartDirector Plugin (ChartDirector5), class CDBaseChartMBS,
Plugin version: 12.3, Mac: Yes, Win: Yes, Linux: Yes, Console & Web: Yes, Feedback.
Function: Gets a value to represent that hardware independent ClearType or a similar technology be used for font rendering.
Notes:
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.
shared method, ChartDirector, MBS Real Studio ChartDirector Plugin (ChartDirector5), class CDBaseChartMBS,
Plugin version: 12.3, Mac: Yes, Win: Yes, Linux: Yes, Console & Web: Yes, Feedback.
Function: Gets a value to represent that hardware independent ClearType or a similar technology be used for font rendering.
Notes:
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
shared method, ChartDirector, MBS Real Studio ChartDirector Plugin (ChartDirector5), class CDBaseChartMBS,
Plugin version: 8.2, Mac: Yes, Win: Yes, Linux: Yes, Console & Web: Yes, Feedback.
Function: Converts a REALbasic color object to an integer for ChartDirector.
shared method, ChartDirector, MBS Real Studio ChartDirector Plugin (ChartDirector5), class CDBaseChartMBS,
Plugin version: 8.2, Mac: Yes, Win: Yes, Linux: Yes, Console & Web: Yes, Feedback.
Function: Converts a REALbasic color object to an integer for ChartDirector.
CDBaseChartMBS.Cross2Shape(width as double = 0.5) as integer
shared method, ChartDirector, MBS Real Studio ChartDirector Plugin (ChartDirector5), class CDBaseChartMBS,
Plugin version: 8.2, Mac: Yes, Win: Yes, Linux: Yes, Console & Web: Yes, Feedback.
Function: Gets the shape id that represents a 'X' shape.
Notes:
Please refer to Shape Specification for samples and more information on using shapes in ChartDirector.
Return Value
An integer shape id representing the a 'X' shape.
shared method, ChartDirector, MBS Real Studio ChartDirector Plugin (ChartDirector5), class CDBaseChartMBS,
Plugin version: 8.2, Mac: Yes, Win: Yes, Linux: Yes, Console & Web: Yes, Feedback.
Function: Gets the shape id that represents a 'X' shape.
Notes:
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. |
An integer shape id representing the a 'X' shape.
CDBaseChartMBS.CrossShape(width as double = 0.5) as integer
shared method, ChartDirector, MBS Real Studio ChartDirector Plugin (ChartDirector5), class CDBaseChartMBS,
Plugin version: 8.2, Mac: Yes, Win: Yes, Linux: Yes, Console & Web: Yes, Feedback.
Function: Gets the shape id that represents a '+' shape.
Notes:
Please refer to Shape Specification for samples and more information on using shapes in ChartDirector.
Return Value
An integer shape id representing the a '+' shape.
shared method, ChartDirector, MBS Real Studio ChartDirector Plugin (ChartDirector5), class CDBaseChartMBS,
Plugin version: 8.2, Mac: Yes, Win: Yes, Linux: Yes, Console & Web: Yes, Feedback.
Function: Gets the shape id that represents a '+' shape.
Notes:
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. |
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
shared method, ChartDirector, MBS Real Studio ChartDirector Plugin (ChartDirector5), class CDBaseChartMBS,
Plugin version: 9.2, Mac: Yes, Win: Yes, Linux: Yes, Console & Web: Yes, Feedback.
Function: A special shading effect that emulates the lighting of a cylinder surface.
Notes:
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:
Return Value
An integer representing the cylinder effect.
shared method, ChartDirector, MBS Real Studio ChartDirector Plugin (ChartDirector5), class CDBaseChartMBS,
Plugin version: 9.2, Mac: Yes, Win: Yes, Linux: Yes, Console & Web: Yes, Feedback.
Function: A special shading effect that emulates the lighting of a cylinder surface.
Notes:
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.dashLineColor(colorvalue as color, patternCode as integer = &h0505) as integer
method, ChartDirector, MBS Real Studio ChartDirector Plugin (ChartDirector5), class CDBaseChartMBS,
Plugin version: 11.1, Mac: Yes, Win: Yes, Linux: Yes, Console & Web: Yes, Feedback.
Function: Same as the other dashLineColor method, but uses color instead of integer data type for passing color values.
method, ChartDirector, MBS Real Studio ChartDirector Plugin (ChartDirector5), class CDBaseChartMBS,
Plugin version: 11.1, Mac: Yes, Win: Yes, Linux: Yes, Console & Web: Yes, Feedback.
Function: Same as the other dashLineColor method, but uses color instead of integer data type for passing color values.
See also:
CDBaseChartMBS.dashLineColor(colorvalue as integer, patternCode as integer = &h0505) as integer
method, ChartDirector, MBS Real Studio ChartDirector Plugin (ChartDirector5), class CDBaseChartMBS,
Plugin version: 8.2, Mac: Yes, Win: Yes, Linux: Yes, Console & Web: Yes, Feedback.
Function: A constant equals to 0505 (in hex) to represent a dash line pattern for use in dash colors.
Notes: See Color Specification on how colors are represented in ChartDirector.
method, ChartDirector, MBS Real Studio ChartDirector Plugin (ChartDirector5), class CDBaseChartMBS,
Plugin version: 8.2, Mac: Yes, Win: Yes, Linux: Yes, Console & Web: Yes, Feedback.
Function: A constant equals to 0505 (in hex) to represent a dash line pattern for use in dash colors.
Notes: See Color Specification on how colors are represented in ChartDirector.
See also:
CDBaseChartMBS.defaultPalette as integer()
shared method, ChartDirector, MBS Real Studio ChartDirector Plugin (ChartDirector5), class CDBaseChartMBS,
Plugin version: 12.4, Mac: Yes, Win: Yes, Linux: Yes, Console & Web: Yes, Feedback.
Function: Returns the default palette.
shared method, ChartDirector, MBS Real Studio ChartDirector Plugin (ChartDirector5), class CDBaseChartMBS,
Plugin version: 12.4, Mac: Yes, Win: Yes, Linux: Yes, Console & Web: Yes, Feedback.
Function: Returns the default palette.
CDBaseChartMBS.Destructor
method, ChartDirector, MBS Real Studio ChartDirector Plugin (ChartDirector5), class CDBaseChartMBS,
Plugin version: 9.2, Mac: Yes, Win: Yes, Linux: Yes, Console & Web: Yes, Feedback.
Function: The destructor for the base chart.
method, ChartDirector, MBS Real Studio ChartDirector Plugin (ChartDirector5), class CDBaseChartMBS,
Plugin version: 9.2, Mac: Yes, Win: Yes, Linux: Yes, Console & Web: Yes, Feedback.
Function: The destructor for the base chart.
The items on this page are in the following plugins: MBS Real Studio ChartDirector Plugin.
Links
MBS Realbasic Plugins