Platforms to show: All Mac Windows Linux Cross-Platform

Back to CDFinanceChartMBS class.

Previous items

CDFinanceChartMBS.enableAntiAlias(antiAlias as boolean)

Type Topic Plugin Version macOS Windows Linux iOS Targets
method ChartDirector MBS ChartDirector Plugin 9.2 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Enables/Disables anti-alias.

Enabling anti-alias makes the line smoother. Disabling anti-alias make the chart file size smaller, and so can be downloaded faster through the Internet. The default is to enable anti-alias.

Arguments:
ArgumentDefaultDescription
antiAlias(Mandatory)True to enable anti-alias. False to disable anti-alias.

CDFinanceChartMBS.getToolTipDateFormat as string

Type Topic Plugin Version macOS Windows Linux iOS Targets
method ChartDirector MBS ChartDirector Plugin 9.2 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Gets the date/time format string to use for tool tips.

The format string returned will be one of the format strings specified when calling CDFinanceChartMBS.setToolTipDateFormat based on data point spacing, or the equivalent default value. The format string may then be used in other ChartDirector functions such as CDBaseChartMBS.getHTMLImageMap for producing image maps.

Returns the date/time format string to use for tool tips.

CDFinanceChartMBS.mainChart as CDXYChartMBS

Type Topic Plugin Version macOS Windows Linux iOS Targets
method ChartDirector MBS ChartDirector Plugin 12.0 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Returns the main chart of this finance chart.

CDFinanceChartMBS.setAxisOnRight(b as Boolean)

Type Topic Plugin Version macOS Windows Linux iOS Targets
method ChartDirector MBS ChartDirector Plugin 9.2 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Sets whether the main y-axis is on right of left side of the plot area.

The default is on right.

Arguments:
ArgumentDefaultDescription
b(Mandatory)A true value means the y-axis is on right. A false value means the y-axis is on left.

CDFinanceChartMBS.setData(timeStamps() as Double, highData() as Double, lowData() as Double, openData() as Double, closeData() as Double, volData() as Double, extraPoints as Integer)

Type Topic Plugin Version macOS Windows Linux iOS Targets
method ChartDirector MBS ChartDirector Plugin 9.2 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Sets the data to be used in the chart.

If some of the data are not available, some artificial values should be used. For example, if the high and low values are not available, you may use closeData as highData and lowData.

Arguments:
ArgumentDefaultDescription
timeStamps(Mandatory)An array of dates/times for the time intervals.
highData(Mandatory)The high values in the time intervals.
lowData(Mandatory)The low values in the time intervals.
openData(Mandatory)The open values in the time intervals.
closeData(Mandatory)The close values in the time intervals.
volData(Mandatory)The volume values in the time intervals.
extraPoints(Mandatory)The number of leading time intervals that are not displayed in the chart. These intervals are typically used for computing indicators that require extra leading data, such as moving averages.

CDFinanceChartMBS.setDateLabelFormat(yearFormat as string, firstMonthFormat as string, otherMonthFormat as string, firstDayFormat as string, otherDayFormat as string, firstHourFormat as string, otherHourFormat as string)

Type Topic Plugin Version macOS Windows Linux iOS Targets
method ChartDirector MBS ChartDirector Plugin 9.2 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Sets the date/time formats to use for the x-axis labels under various cases.

See Parameter Substitution and Formatting on the syntax of ChartDirector format strings.

Arguments:
ArgumentDefaultDescription
yearFormat(Mandatory)The format for displaying labels on an axis with yearly ticks. The default is "{value|yyyy}".
firstMonthFormat(Mandatory)The format for displaying labels on an axis with monthly ticks. This parameter applies to the first available month of a year (usually January) only, so it can be formatted differently from the other labels. The default is "<*font=bold*>{value|mmm yy}".
otherMonthFormat(Mandatory)The format for displaying labels on an axis with monthly ticks. This parameter applies to months other than the first available month of a year. The default is "{value|mmm}".
firstDayFormat(Mandatory)The format for displaying labels on an axis with daily ticks. This parameter applies to the first available day of a month only, so it can be formatted differently from the other labels. The default is "<*font=bold*>{value|d mmm}".
otherDayFormat(Mandatory)The format for displaying labels on an axis with daily ticks. This parameter applies to days other than the first available day of a month. The default is "{value|d}".
firstHourFormat(Mandatory)The format for displaying labels on an axis with hourly resolution. This parameter applies to the first tick of a day only, so it can be formatted differently from the other labels. The default is "<*font=bold*>{value|d mmm<*br*>h:nna}".
otherHourFormat(Mandatory)The format for displaying labels on an axis with hourly. resolution. This parameter applies to ticks at hourly boundaries, except the first tick of a day. The default is "{value|h:nna}".

CDFinanceChartMBS.setDateLabelSpacing(labelSpacing as Integer)

Type Topic Plugin Version macOS Windows Linux iOS Targets
method ChartDirector MBS ChartDirector Plugin 9.2 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Sets the minimum label spacing between two labels on the time axis.

Arguments:
ArgumentDefaultDescription
labelSpacing(Mandatory)The label spacing in pixels. The default is 50 pixels.

CDFinanceChartMBS.setLegendStyle(font as string, fontSize as Double, fontColor as color, bgColor 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 setLegendStyle method, but uses color instead of integer data type for passing color values.

See also:

Some examples using this method:

CDFinanceChartMBS.setLegendStyle(font as string, fontSize as Double, fontColor as Integer, bgColor as Integer)

Type Topic Plugin Version macOS Windows Linux iOS Targets
method ChartDirector MBS ChartDirector Plugin 9.2 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Sets legend font style and background color.

The default is Arial 8 pt black font on a semi-transparent light grey (80CCCCCC) background.

Arguments:
ArgumentDefaultDescription
font(Mandatory)The font of the legend text.
fontSize(Mandatory)The font size of the legend text in points.
fontColor(Mandatory)The color of the legend text.
bgColor(Mandatory)The background color of the legend box.

See also:

CDFinanceChartMBS.setLogScale(b as Boolean)

Type Topic Plugin Version macOS Windows Linux iOS Targets
method ChartDirector MBS ChartDirector Plugin 9.2 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Determines if log scale should be used for the main chart.

The default is to use linear scale.

Arguments:
ArgumentDefaultDescription
b(Mandatory)A true value means using log scale. A false value means using linear scale.

CDFinanceChartMBS.setMargins(leftMargin as Integer, topMargin as Integer, rightMargin as Integer, bottomMargin as Integer)

Type Topic Plugin Version macOS Windows Linux iOS Targets
method ChartDirector MBS ChartDirector Plugin 9.2 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Sets the margins around the plot area.

The default is 40 pixels for the left and right margins, and 30 pixels for the top margin and 35 pixels for the bottom margin.

Arguments:
ArgumentDefaultDescription
leftMargin(Mandatory)The distance from the left side of the plot area to the left side of the chart.
topMargin(Mandatory)The distance from the top of the plot area to the top of the chart.
rightMargin(Mandatory)The distance from the right side of the plot area to the right side of the chart.
bottomMargin(Mandatory)The distance from the bottom of the plot area to the bottom of the chart.

CDFinanceChartMBS.setNumberLabelFormat(formatString as string)

Type Topic Plugin Version macOS Windows Linux iOS Targets
method ChartDirector MBS ChartDirector Plugin 9.2 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Sets the number format to use.

The default number format in FinanceChart is "P3". See Parameter Substitution and Formatting on the syntax of ChartDirector format strings.

Arguments:
ArgumentDefaultDescription
formatString(Mandatory)The format for displaying numbers.

CDFinanceChartMBS.setPercentageAxis as CDAxisMBS

Type Topic Plugin Version macOS Windows Linux iOS Targets
method ChartDirector MBS ChartDirector Plugin 9.2 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Label the axis of the main chart in percentage unit.

By default, the axis of the main chart will be labelled in price unit. If a percentage axis is used, the axis will be labelled in percentage unit, with the first visible point of the closing price being 100%.

CDFinanceChartMBS.setPlotAreaBorder(borderColor as color, borderGap 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 setPlotAreaBorder method, but uses color instead of integer data type for passing color values.

See also:

CDFinanceChartMBS.setPlotAreaBorder(borderColor as Integer, borderGap as Integer)

Type Topic Plugin Version macOS Windows Linux iOS Targets
method ChartDirector MBS ChartDirector Plugin 9.2 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Sets the plot area border color and the gap distance between charts.

The default is a grey (888888) border with two 2 pixels gap between charts.

Arguments:
ArgumentDefaultDescription
borderColor(Mandatory)The plot area border color.
borderGap(Mandatory)The distance between charts.

See also:

CDFinanceChartMBS.setPlotAreaStyle(bgColor as color, majorHGridColor as color, majorVGridColor as color, minorHGridColor as color, minorVGridColor 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 setPlotAreaStyle method, but uses color instead of integer data type for passing color values.

See also:

CDFinanceChartMBS.setPlotAreaStyle(bgColor as Integer, majorHGridColor as Integer, majorVGridColor as Integer, minorHGridColor as Integer, minorVGridColor as Integer)

Type Topic Plugin Version macOS Windows Linux iOS Targets
method ChartDirector MBS ChartDirector Plugin 9.2 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Sets the plot area background and grid colors.

The default is a white background with light grey (DDDDDD) grid lines.

Arguments:
ArgumentDefaultDescription
bgColor(Mandatory)The plot area background color.
majorHGridColor(Mandatory)Major horizontal grid color.
majorVGridColor(Mandatory)Major vertical grid color.
minorHGridColor(Mandatory)Minor horizontal grid color. In current version, minor horizontal grid is not used.
minorVGridColor(Mandatory)Minor vertical grid color.

See also:

CDFinanceChartMBS.setToolTipDateFormat(monthFormat as string, dayFormat as string, hourFormat as string)

Type Topic Plugin Version macOS Windows Linux iOS Targets
method ChartDirector MBS ChartDirector Plugin 9.2 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Sets the date/time formats to use for the tool tips under various cases.

See Parameter Substitution and Formatting on the syntax of ChartDirector format strings.

Arguments:
ArgumentDefaultDescription
monthFormat(Mandatory)The tool tip format to use if the data point spacing is one or more months (more than 30 days). The default is "[{xLabel|mmm yyyy}]".
dayFormat(Mandatory)The tool tip format to use if the data point spacing is 1 day to less than 30 days. The default is "[{xLabel|mmm d, yyyy}]".
hourFormat(Mandatory)The tool tip format to use if the data point spacing is less than 1 day. The default is "[{xLabel|mmm d, yyyy hh:nn:ss}]".

CDFinanceChartMBS.setXAxisStyle(font as string, fontSize as Double, fontColor as color, fontAngle as Double)

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

See also:

CDFinanceChartMBS.setXAxisStyle(font as string, fontSize as Double, fontColor as Integer, fontAngle as Double)

Type Topic Plugin Version macOS Windows Linux iOS Targets
method ChartDirector MBS ChartDirector Plugin 9.2 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Sets x-axis label style.

The default is Arial 8 pt black color as font with no text rotation.

Arguments:
ArgumentDefaultDescription
font(Mandatory)The font of the axis labels.
fontSize(Mandatory)The font size of the axis labels in points.
fontColor(Mandatory)The color of the axis labels.
fontAngle(Mandatory)The rotation of the axis labels.

See also:

CDFinanceChartMBS.setYAxisStyle(font as string, fontSize as Double, fontColor as color, bgColor 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 setYAxisStyle method, but uses color instead of integer data type for passing color values.

See also:

CDFinanceChartMBS.setYAxisStyle(font as string, fontSize as Double, fontColor as Integer, bgColor as Integer)

Type Topic Plugin Version macOS Windows Linux iOS Targets
method ChartDirector MBS ChartDirector Plugin 9.2 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Sets y-axis label style.

The default is Arial 8 pt black color, with 14 pixels margin.

Arguments:
ArgumentDefaultDescription
font(Mandatory)The font of the axis labels.
fontSize(Mandatory)The font size of the axis labels in points.
fontColor(Mandatory)The color of the axis labels.
axisMargin(Mandatory)The margin at the top of the y-axis in pixels (to leave space for the legend box).

See also:

Previous items

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


💬 Ask a question or report a problem
The biggest plugin in space...