public class RingChartWidget extends PieChartWidget
RingChartWidget A Dashboard Utility Widget that displays a ring or doughnut chart, which is similar to a pie chart with the middle cut out
BASIS_DASHBOARD_UTILITY_FILL_ERROR_ACTION_KEY_NAME$, CachedImage!, DashboardWidget!, FillErrorAction, ON_FILL_ERROR_IGNORE, ON_FILL_ERROR_STOP, ON_FILL_ERROR_WARN, UserData! BASIS_UTILITY_DEVICE_PIXEL_RATIO_KEY_NAME$, DevicePixelRatio! ColorThemeAgate, ColorThemeAntiquePewter, ColorThemeAntler, ColorThemeBamboo, ColorThemeBeachStrata, ColorThemeBerryPreserves, ColorThemeBerryTart, ColorThemeBiscayneBay, ColorThemeBlackberries, ColorThemeBloodOrange, ColorThemeBlue, ColorThemeBlueFrost, ColorThemeBlueJewel, ColorThemeBluesAndBrowns, ColorThemeBreezy, ColorThemeBreezyToo, ColorThemeBrown, ColorThemeBrownFur, ColorThemeCamo, ColorThemeCampsite, ColorThemeCanary, ColorThemeChocolateRaspberry, ColorThemeCitrus, ColorThemeCoastline, ColorThemeColorful1, ColorThemeColorful2, ColorThemeColorful3, ColorThemeColorful4, ColorThemeColorful5, ColorThemeColorful6, ColorThemeColorful7, ColorThemeCoral, ColorThemeCranberry, ColorThemeCranberryTart, ColorThemeDarkToLight, ColorThemeDeepBlueSea, ColorThemeDefault, ColorThemeDismal, ColorThemeDivergentBlueTanGreen, ColorThemeDivergentBlueTanRed, ColorThemeDivergentBlueWhiteRed, ColorThemeDivergentRedOrangeRed, ColorThemeDriedRoses, ColorThemeEarlyAmerican, ColorThemeEarthTones1, ColorThemeEarthTones2, ColorThemeEarthTones3, ColorThemeEscape, ColorThemeEveningThunder, ColorThemeFeathers, ColorThemeFlorida, ColorThemeGray, ColorThemeGrayscaleTransparent, ColorThemeGreen, ColorThemeHeirloom, ColorThemeHomestyle, ColorThemeIcyLeaves, ColorThemeIndex, ColorThemeLakeside, ColorThemeLavender, ColorThemeMargarita, ColorThemeMistyGarden, ColorThemeMountainMist, ColorThemeMountainSunset, ColorThemeOliveBranch, ColorThemeOrange, ColorThemePeacock, ColorThemePetals, ColorThemePomegranate, ColorThemePowderedCookie, ColorThemePurple, ColorThemePurpleBerry, ColorThemeRed, ColorThemeRetro, ColorThemeRooster, ColorThemeRope, ColorThemeRosemary, ColorThemeSandyBeach, ColorThemeSeaFoam, ColorThemeSepia, ColorThemeSky, ColorThemeTomorrowDark, ColorThemeTomorrowLight, ColorThemeTropicalSunset, ColorThemeWatermelon, ColorThemeWinterRobin, CustomChartColors!, DATA_ITEM_LABEL_POSITION_INSIDE_BOTTOM, DATA_ITEM_LABEL_POSITION_INSIDE_CENTER, DATA_ITEM_LABEL_POSITION_INSIDE_LEFT, DATA_ITEM_LABEL_POSITION_INSIDE_RIGHT, DATA_ITEM_LABEL_POSITION_INSIDE_TOP, DATA_ITEM_LABEL_POSITION_OUTSIDE_BOTTOM, DATA_ITEM_LABEL_POSITION_OUTSIDE_LEFT, DATA_ITEM_LABEL_POSITION_OUTSIDE_RIGHT, DATA_ITEM_LABEL_POSITION_OUTSIDE_TOP, HAlignCenter!, HAlignLeft!, HAlignRight!, LastRenderedImage!, LEGENDSHAPE_CAPSULE, LEGENDSHAPE_CIRCLE, LEGENDSHAPE_DIAMOND, LEGENDSHAPE_ELLIPSE, LEGENDSHAPE_RECTANGLE, LEGENDSHAPE_ROUNDEDRECTANGLE, LEGENDSHAPE_SQUARE, SideBottom!, SideLeft!, SideRight!, SideTop!, TipBackColor$, TipBackColorOpacity, TipDisplayTime, TipForeColor$, TipForeColorOpacity, VAlignBottom!, VAlignCenter!, VAlignTop! Columns!, ConnectString$, IsCircular, NumSlices, RecordSet!, SQL$, StartAngle | Constructor and Description |
|---|
RingChartWidget(BBjString p_name$, BBjString p_title$, BBjString p_previewText$, BBjString p_previewImage$, BBjString p_chartTitle$, BBjNumber p_flat, BBjNumber p_legend)Create an empty Ring Chart specifying all parameters to be filled after creation with setDataSetValue() Note: As of BBj 23.00, the Dashboard Utility uses JFreeCharts 1.5.x which removes the pseudo-3D charts. Therefore, the p_flat parameter will be ignored in version 23 and higher. |
RingChartWidget(BBjString p_name$, BBjString p_title$, BBjString p_previewText$, BBjString p_previewImage$, BBjString p_chartTitle$, BBjNumber p_flat, BBjNumber p_legend, BBjNumber p_numSlices)Create an empty Ring Chart specifying all parameters to be filled after creation with setDataSetValue() Note: As of BBj 23.00, the Dashboard Utility uses JFreeCharts 1.5.x which removes the pseudo-3D charts. Therefore, the p_flat parameter will be ignored in version 23 and higher. |
RingChartWidget(BBjString p_name$, BBjString p_title$, BBjString p_previewText$, BBjString p_previewImage$, BBjString p_chartTitle$, BBjNumber p_flat, BBjNumber p_legend, BBjString p_connectString$, BBjString p_sql$)Create an SQL-based Ring Chart specifying all parameters Note: As of BBj 23.00, the Dashboard Utility uses JFreeCharts 1.5.x which removes the pseudo-3D charts. Therefore, the p_flat parameter will be ignored in version 23 and higher. |
RingChartWidget(BBjString p_name$, BBjString p_title$, BBjString p_previewText$, BBjString p_previewImage$, BBjString p_chartTitle$, BBjNumber p_flat, BBjNumber p_legend, BBjRecordSet p_rs!, BBjVector p_columns!)Create a BBjRecordSet-based Pie Chart specifying all parameters Note: As of BBj 23.00, the Dashboard Utility uses JFreeCharts 1.5.x which removes the pseudo-3D charts. Therefore, the p_flat parameter will be ignored in version 23 and higher. |
RingChartWidget(BBjString p_name$, BBjString p_title$, BBjString p_previewText$, BBjString p_previewImage$, BBjString p_chartTitle$, BBjNumber p_flat, BBjNumber p_legend, BBjString p_connectString$, BBjString p_sql$, BBjString p_mode$)Create an SQL-based Ring Chart specifying all parameters Note: As of BBj 23.00, the Dashboard Utility uses JFreeCharts 1.5.x which removes the pseudo-3D charts. Therefore, the p_flat parameter will be ignored in version 23 and higher. |
| Modifier and Type | Method and Description |
|---|---|
RingChartWidget | clone()An internal method used by the Dashboard class to clone a category widget so that it may be displayed in a popped out window |
void | create(BBjChildWindow p_widgetControlWindow!)Creates the RingChartWidget |
void | setRingDepth(BBjNumber p_ringDepth)Sets the depth of the rings. The smaller the value the thinner the rings. A value of 0 will prevent the rings from being drawn at all, and a value of 1 is equivalent to a pie chart where the slices take up the full radius of the plot. |
active, destroy, getClientSlash, getFillError, getFillErrorDesc, getImage, getImage, imageFileSaveDialog, isDestroyed, logError, name, previewImage, previewText, setActive, setFillErrorDisplayImage, setFillErrorDisplayText, setLastSaveDir, spacesValid, title create, destroy, display, getDevicePixelRatio, isDestroyed, logQueryPerformance, resize, setDevicePixelRatio addChartDomainMarker, addChartRangeMarker, adjustColorBrightness, adjustColorOpacity, adjustColorSaturation, adjustColorVectorBrightness, adjustColorVectorOpacity, adjustColorVectorOpacityToFixedAmount, adjustColorVectorSaturation, cloneCommonChartWidgetParameters, createCombinedImage, createCombinedImagesWithText, createCombinedImageWithText, createImageFromText, createImageFromText, createImageFromText, createImageFromText, createRadialGradientPaint, darkenColor, email, exportData, fillJDBCXYSeries, fillJDBCXYSeries, fillJDBCXYSeries, getBBjColor, getBBjColorWithAlphaFromHexString, getChartDataItemFromPoint, getChartDataItemsFromPoint, getChartDomainAxisFormat, getChartFontFile, getChartHeight, getChartRangeAxisFormat, getChartRangeAxisToCurrency, getChartRangeAxisToPercent, getChartWidth, getColorTheme, getColorThemeCount, getColorThemeDescription, getColorWithAlpha, getColorWithAlpha, getColorWithAlphaFromHexString, getDataset, getDefaultChartColors, getDevicePixelRatio, getFont, getFontScalingFactor, getHexStringFromColor, getHSBValuesFromRGBColor, getHSLValuesFromRGBColor, getJavaColor, getJavaColor, getJDBCCategoryDataset, getJDBCCategoryDataset, getJDBCCategoryDataset, getJDBCPieDataset, getJDBCPieDataset, getJDBCPieDataset, getLegendFontSize, getRGBColorFromHSLValues, getUserFontScalingFactor, getVectorOfJavaColorsFromDivergentHexColorStrings, getVectorOfJavaColorsFromHexColorStrings, hasLegend, is3D, isAreaChart, isBarChart, isDataSetEmpty, isFlat, isLineChart, isPieChart, isRingChart, isStackedAreaChart, isStackedBarChart, isStackedPercentageBarChart, isXYChart, lightenColor, makeColorVectorFromCommaDelimitedHexColorString, makeColorVectorFromCommaDelimitedHexColorString, makeLargerColorVectorByDarkening, makeLargerColorVectorByLightening, makeLargerColorVectorByReducingOpacity, OnClearTip, refresh, resize, restoreCustomColorTheme, reverseColorVector, rotateColorVector, saturateColor, save, saveColorThemePaletteImagesToDirectory, saveColorVectorAsPaletteImage, setChartBackground, setChartBackground, setChartBackground, setChartBackgroundGradient, setChartBackgroundImage, setChartBackgroundImage, setChartColors, setChartColors, setChartColors, setChartColors, setChartColors, setChartColors, setChartColors, setChartColorTheme, setChartDataItemLabelFormat, setChartDataItemLabelFormat, setChartDataItemLabels, setChartDataItemLabels, setChartDataItemLabels, setChartDomainAxisFontScaling, setChartDomainAxisFormat, setChartDomainAxisFormat, setChartDomainAxisMargins, setChartDomainAxisNumLines, setChartDomainAxisTitle, setChartDomainAxisVisible, setChartDomainMarker, setChartDomainMarker, setChartDomainMarker, setChartEmptyDisplayImage, setChartEmptyDisplayText, setChartFontColor, setChartFontColor, setChartFontColors, setChartFontFile, setChartFontFile, setChartFontSizes, setChartFontStyles, setChartLegendBackground, setChartLegendFrame, setChartLegendPadding, setChartLegendShape, setChartLegendShape, setChartLegendShapeRadius, setChartLegendShapeRadiusScalingFactor, setChartMaximumDomainLabelWidthRatio, setChartPadding, setChartPlotShadow, setChartRangeAxisFormat, setChartRangeAxisFormat, setChartRangeAxisMinimumSize, setChartRangeAxisTitle, setChartRangeAxisToCurrency, setChartRangeAxisToCurrencyWithFractionalDigits, setChartRangeAxisToPercent, setChartRangeAxisUseIntegers, setChartRangeAxisVisible, setChartRangeColors, setChartRangeColors, setChartRangeColors, setChartRangeColors, setChartRangeMarker, setChartRangeMarker, setChartTitle, setChartTitles, setDevicePixelRatio, setFontScalingFactor, setGradientShadingAmount, setLegendBackground, setLegendBackground, setLegendLabelFormat, setLegendLabelFormat, setLegendPosition, setPlotBackground, setPlotBackground, setPlotBackground, setPlotBackgroundImage, setPlotBackgroundImage, setRangeValues, setUserFontScalingFactor, showTip, shuffleColorVector, viewCategoryDataSet, viewData, viewPieDataSet, writePNGToServerOnCreation, writePNGToServerOnCreation clearDataSet, clone, create, destroy, fill, fill, fill, getDataset, getFormattedValue, getNumRows, getResultSet, isDestroyed, isEmpty, isRecordSetBased, isSQLBased, refresh, set3dDepthFactor, setDataSetValue, setEmbeddedLabels, setExplodeAllSlicesPercent, setExplodePercent, setIgnoreZeroValues, setLabelBackgroundColor, setLabelFormat, setLabelFormat, setLabelsOff, setPlotPadding, setShadowColor, setSliceOutlineColor, setSliceOutlineWidth, viewDataSet public RingChartWidget(BBjString p_name$, BBjString p_title$, BBjString p_previewText$, BBjString p_previewImage$, BBjString p_chartTitle$, BBjNumber p_flat, BBjNumber p_legend)
Create an empty Ring Chart specifying all parameters to be filled after creation with setDataSetValue()
Note: As of BBj 23.00, the Dashboard Utility uses JFreeCharts 1.5.x which removes the pseudo-3D charts. Therefore, the p_flat parameter will be ignored in version 23 and higher.
p_name$ The unique name of the chart widgetp_title$ Title which will display in the title barp_previewText$ A description of the widget used for the preview text in the Customize screen and as the tooltip text on the widget's titlep_previewImage$ A preview of the chart widget that is shown in the Add/Remove widgets Customize dialogp_chartTitle$ The title to be displayed above the pie chart (may be empty)p_flat A number that indicates whether the chart will be flat or 3D. 0=3D, 1=Flat (2D), ignored in version 23 and higherp_legend A number that indicates whether to show a legend for the chart. 0=Do not show legend, 1=Show legendpublic RingChartWidget(BBjString p_name$, BBjString p_title$, BBjString p_previewText$, BBjString p_previewImage$, BBjString p_chartTitle$, BBjNumber p_flat, BBjNumber p_legend, BBjNumber p_numSlices)
Create an empty Ring Chart specifying all parameters to be filled after creation with setDataSetValue()
Note: As of BBj 23.00, the Dashboard Utility uses JFreeCharts 1.5.x which removes the pseudo-3D charts. Therefore, the p_flat parameter will be ignored in version 23 and higher.
p_name$ The unique name of the chart widgetp_title$ Title which will display in the title barp_previewText$ A description of the widget used for the preview text in the Customize screen and as the tooltip text on the widget's titlep_previewImage$ A preview of the chart widget that is shown in the Add/Remove widgets Customize dialogp_chartTitle$ The title to be displayed above the pie chart (may be empty)p_flat A number that indicates whether the chart will be flat or 3D. 0=3D, 1=Flat (2D), ignored in version 23 and higherp_legend A number that indicates whether to show a legend for the chart. 0=Do not show legend, 1=Show legendp_numSlices A number that indicates the total number of slices in the chart after it has been filled with datapublic RingChartWidget(BBjString p_name$, BBjString p_title$, BBjString p_previewText$, BBjString p_previewImage$, BBjString p_chartTitle$, BBjNumber p_flat, BBjNumber p_legend, BBjString p_connectString$, BBjString p_sql$)
Create an SQL-based Ring Chart specifying all parameters
Note: As of BBj 23.00, the Dashboard Utility uses JFreeCharts 1.5.x which removes the pseudo-3D charts. Therefore, the p_flat parameter will be ignored in version 23 and higher.
p_name$ The unique name of the chart widgetp_title$ Title which will display in the title barp_previewText$ A description of the widget used for the preview text in the Customize screen and as the tooltip text on the widget's titlep_previewImage$ A preview of the chart widget that is shown in the Add/Remove widgets Customize dialogp_chartTitle$ The title to be displayed above the pie chart (may be empty)p_flat A number that indicates whether the chart will be flat or 3D. 0=3D, 1=Flat (2D), ignored in version 23 and higherp_legend A number that indicates whether to show a legend for the chart. 0=Do not show legend, 1=Show legendp_connectString$ The connection string to the desired database. Example: "jdbc:basis:localhost?database=ChileCompany&user=admin&password=admin123"p_sql$ The sql query used to populate the chart. The two columns should be key, value. Example: select salesperson, count(salesperson) from customer group by salespersonpublic RingChartWidget(BBjString p_name$, BBjString p_title$, BBjString p_previewText$, BBjString p_previewImage$, BBjString p_chartTitle$, BBjNumber p_flat, BBjNumber p_legend, BBjRecordSet p_rs!, BBjVector p_columns!)
Create a BBjRecordSet-based Pie Chart specifying all parameters
Note: As of BBj 23.00, the Dashboard Utility uses JFreeCharts 1.5.x which removes the pseudo-3D charts. Therefore, the p_flat parameter will be ignored in version 23 and higher.
p_name$ The unique name of the chart widgetp_title$ Title which will display in the title barp_previewText$ A description of the widget used for the preview text in the Customize screen and as the tooltip text on the widget's titlep_previewImage$ A preview of the chart widget that is shown in the Add/Remove widgets Customize dialogp_chartTitle$ The title to be displayed above the pie chart (may be empty)p_flat A number that indicates whether the chart will be flat or 3D. 0=3D, 1=Flat (2D), ignored in version 23 and higherp_legend A number that indicates whether to show a legend for the chart. 0=Do not show legend, 1=Show legendp_rs! The BBjRecordSet containing the data used to populate the chartp_columns! A BBjVector that contains an ordered list of the columns to be used for the charts's data. The entries may be a string corresponding to a field name, or a 0-based index of the column number. If null() is passed in for the p_columns! vector then the first two columns of the BBjRecordSet will be used. BBjRecordSet BBjVectorpublic RingChartWidget(BBjString p_name$, BBjString p_title$, BBjString p_previewText$, BBjString p_previewImage$, BBjString p_chartTitle$, BBjNumber p_flat, BBjNumber p_legend, BBjString p_connectString$, BBjString p_sql$, BBjString p_mode$)
Create an SQL-based Ring Chart specifying all parameters
Note: As of BBj 23.00, the Dashboard Utility uses JFreeCharts 1.5.x which removes the pseudo-3D charts. Therefore, the p_flat parameter will be ignored in version 23 and higher.
p_name$ The unique name of the chart widgetp_title$ Title which will display in the title barp_previewText$ A description of the widget used for the preview text in the Customize screen and as the tooltip text on the widget's titlep_previewImage$ A preview of the chart widget that is shown in the Add/Remove widgets Customize dialogp_chartTitle$ The title to be displayed above the pie chart (may be empty)p_flat A number that indicates whether the chart will be flat or 3D. 0=3D, 1=Flat (2D), ignored in version 23 and higherp_legend A number that indicates whether to show a legend for the chart. 0=Do not show legend, 1=Show legendp_connectString$ The connection string to the desired database. Example: "jdbc:basis:localhost?database=ChileCompany&user=admin&password=admin123"p_sql$ The sql query used to populate the chart. The two columns should be key, value. Example: select salesperson, count(salesperson) from customer group by salespersonp_mode$ A string comprised of a list of properties and values separated by commas that will be passed to the database or JDBC connection at connect time. For example: "USER=myusername, PWD=mypass, AUTOCOMMIT=N" BBj 16.00public RingChartWidget clone()An internal method used by the Dashboard class to clone a category widget so that it may be displayed in a popped out window
public void create(BBjChildWindow p_widgetControlWindow!)
Creates the RingChartWidget
p_widgetControlWindow! The BBjChildWindow that will contain the widgetpublic void setRingDepth(BBjNumber p_ringDepth)
Sets the depth of the rings.
The smaller the value the thinner the rings. A value of 0 will prevent the rings from being drawn at all, and a value of 1 is equivalent to a pie chart where the slices take up the full radius of the plot.
p_ringDepth A number from 0-1 that determines ring depth as percentage of the plot radius