Platforms to show: All Mac Windows Linux Cross-Platform
Back to CDBaseChartMBS class.
CDBaseChartMBS.StartOfMonthFilter(labelStep as Integer = 1, initialMargin as Double = 0.05) as Integer
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
shared method | ChartDirector | MBS ChartDirector Plugin | 8.2 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
This method is typically used in Axis.setMultiFormat and Axis.setMultiFormat2 to select specific dates/times for formatting as axis labels.
In a date/time series, an element is considered that start of a new month if it is of a different month than the previous element. It does not need to be at exactly the starting instance of the month.
For the first element of the date/time series, because there is no previous element to compare with, it will be considered as the start of a new month if it is "near" the exact starting instance of the current month, in which "near" is defined using the initialMargin argument, expressed as a ratio (0 to 1) of the month duration.
Argument | Default | Description |
labelStep | 1 | For dates/times that matches the start of month criteria, picks only 1 out of every "labelStep" number of elements. For example, if this argument is 3, only 1 of every 3 elements that at at the start of month will be selected. |
initialMargin | 0.05 | If the first label is "near" the exact starting instance of the current month to within the ratio specified in the initial margin, it will be considered to have matched the start of month criteria. |
An integer filter id representing the filter.
Some examples using this method:
- /ChartDirector/Track Line Web
- /ChartDirector/Track Line with Data Labels Retina
- /ChartDirector/Track Line with Legend Retina
- /ChartDirector/Tracking Cursor/Track Line Web
- /ChartDirector/Tracking Cursor/Track Line with Axis Labels
- /ChartDirector/Tracking Cursor/Track Line with Data Labels
- /ChartDirector/Tracking Cursor/Track Line with Data Labels Retina
- /ChartDirector/Tracking Cursor/Track Line with Legend
- /ChartDirector/Tracking Cursor/Track Line with Legend Retina
CDBaseChartMBS.StartOfSecondFilter(labelStep as Integer = 1, initialMargin as Double = 0.05) as Integer
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
shared method | ChartDirector | MBS ChartDirector Plugin | 15.1 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
This method is typically used in Axis.setMultiFormat and Axis.setMultiFormat2 to select specific dates/times for formatting as axis labels.
In a date/time series, an element is considered that start of a new second if it is of a different second than the previous element. It does not need to be at exactly the starting instance of the second.
For the first element of the date/time series, because there is no previous element to compare with, it will be considered as the start of a new second if it is "near" the exact starting instance of the current second, in which "near" is defined using the initialMargin argument, expressed as a ratio (0 to 1) of the second duration.
Argument | Default | Description |
labelStep | 1 | For dates/times that matches the start of second criteria, picks only 1 out of every "labelStep" number of elements. For example, if this argument is 3, only 1 of every 3 elements that at at the start of second will be selected. |
initialMargin | 0.05 | If the first label is "near" the exact starting instance of the current second to within the ratio specified in the initial margin, it will be considered to have matched the start of second criteria. |
Returns an integer filter id representing the filter.
CDBaseChartMBS.StartOfWeekFilter(labelStep as Integer = 1, initialMargin as Double = 0.05) as Integer
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
shared method | ChartDirector | MBS ChartDirector Plugin | 8.2 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
This method is typically used in Axis.setMultiFormat and Axis.setMultiFormat2 to select specific dates/times for formatting as axis labels.
In a date/time series, an element is considered that start of a new week if it is of a different week than the previous element. It does not need to be at exactly the starting instance of the week.
For the first element of the date/time series, because there is no previous element to compare with, it will be considered as the start of a new week if it is "near" the exact starting instance of the current week, in which "near" is defined using the initialMargin argument, expressed as a ratio (0 to 1) of the week duration.
Argument | Default | Description |
labelStep | 1 | For dates/times that matches the start of week criteria, picks only 1 out of every "labelStep" number of elements. For example, if this argument is 3, only 1 of every 3 elements that at at the start of week will be selected. |
initialMargin | 0.05 | If the first label is "near" the exact starting instance of the current week to within the ratio specified in the initial margin, it will be considered to have matched the start of week criteria. |
An integer filter id representing the filter.
CDBaseChartMBS.StartOfYearFilter(labelStep as Integer = 1, initialMargin as Double = 0.05) as Integer
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
shared method | ChartDirector | MBS ChartDirector Plugin | 8.2 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
This method is typically used in Axis.setMultiFormat and Axis.setMultiFormat2 to select specific dates/times for formatting as axis labels.
In a date/time series, an element is considered that start of a new year if it is of a different year than the previous element. It does not need to be at exactly the starting instance of the year.
For the first element of the date/time series, because there is no previous element to compare with, it will be considered as the start of a new year if it is "near" the exact starting instance of the current year, in which "near" is defined using the initialMargin argument, expressed as a ratio (0 to 1) of the year duration.
Argument | Default | Description |
labelStep | 1 | For dates/times that matches the start of year criteria, picks only 1 out of every "labelStep" number of elements. For example, if this argument is 3, only 1 of every 3 elements that at at the start of year will be selected. |
initialMargin | 0.05 | If the first label is "near" the exact starting instance of the current year to within the ratio specified in the initial margin, it will be considered to have matched the start of year criteria. |
An integer filter id representing the filter.
Some examples using this method:
- /ChartDirector/Track Line Web
- /ChartDirector/Track Line with Data Labels Retina
- /ChartDirector/Track Line with Legend Retina
- /ChartDirector/Tracking Cursor/Track Line Web
- /ChartDirector/Tracking Cursor/Track Line with Axis Labels
- /ChartDirector/Tracking Cursor/Track Line with Data Labels
- /ChartDirector/Tracking Cursor/Track Line with Data Labels Retina
- /ChartDirector/Tracking Cursor/Track Line with Legend
- /ChartDirector/Tracking Cursor/Track Line with Legend Retina
CDBaseChartMBS.testFont(font as string, fontIndex as Integer, fontHeight as Double, fontWidth as Double, angle as Double, byref buffer as string) as boolean
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
shared method | ChartDirector | MBS ChartDirector Plugin | 8.2 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
From experience, the most common issue for font loading is unable to access server side fonts using anonymous user account for a web application, probably due to security restrictions. This diagnostic function can return the cause of problem to aid trouble-shooting.
Other uses of this function is to trace out where does ChartDirector search for the fonts, and the substitution font in case the request font is not available.
Argument | Default | Description |
font | (Mandatory) | The font name. See Font Specification for details on various font attributes. |
fontIndex | (Mandatory) | The font index if the font name refers to a font collection. An index of 0 means the first font. |
fontHeight | (Mandatory) | The font height in points. This parameter will not affect font loading if the exact font exists, but will affect which substitution font to use if the font does not exist. |
fontWidth | (Mandatory) | The font width in points. This parameter will not affect font loading if the exact font exists, but will affect which substitution font to use if the font does not exist. |
angle | (Mandatory) | The rotation angle of the text. The angle is measured in degrees in clockwise direction. This parameter will not affect font loading if the exact font exists, but will affect which substitution font to use if the font does not exist. |
buffer | (Mandatory) | A string to hold the result of the font loading test. |
See font specification here:
http://www.monkeybreadsoftware.net/faq-chartdirectorfontspecification.shtml
CDBaseChartMBS.transparentPalette as Integer()
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
shared method | ChartDirector | MBS ChartDirector Plugin | 12.4 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
CDBaseChartMBS.whiteOnBlackPalette as Integer()
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
shared method | ChartDirector | MBS ChartDirector Plugin | 12.4 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
Some examples using this method:
CDBaseChartMBS.xySize(x as Integer, y as Integer) as Integer
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
shared method | ChartDirector | MBS ChartDirector Plugin | 21.2 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
This is intended to be used in certain ChartDirector API that that supports the encoded value.
Argument | Default | Description |
width | (Mandatory) | An integer between 0 and 30000. |
height | (Mandatory) | An integer between 0 and 30000. |
Returns a number that encodes the width and height.
The items on this page are in the following plugins: MBS ChartDirector Plugin.