netcharts.pro.charts.box
Class NFBoxchart

java.lang.Object
  netcharts.pro.common.NFGraph
      netcharts.pro.common.zoomable.NFZoomableChart
          netcharts.pro.common.rectangular.NFDataChart
              netcharts.pro.charts.box.NFBoxchart

All Implemented Interfaces:

java.io.Externalizable, java.io.Serializable, NFDragObserver, NFDwellObserver, NFGraphObserver, NFScrollObserver

public class NFBoxchart
extends NFDataChart

Represents a box chart. Provides the ability to configure the chart via object manipulation or directly from CDL.

See Also:

Serialized Form

Field Summary

static int	BOX_ANIMATION_STYLE_FADE Box animation style fade
static int	BOX_ANIMATION_STYLE_NONE No box animation style
static int	BOX_ANIMATION_STYLE_SCALE Box animation style scale
static int	BOX_WHISKER Box whisker type
static int	EDA EDA plot type
static int	GAUSSIAN Gaussian plot type
static int	HORIZONTAL Horizontal orientation
static int	LINE_WHISKER Line whisker type
static int	LINEAR Linear Box Symbol Width
static int	OFF Off Box Symbol Width
static int	OVER Over fence position
static int	PERCENTN PercentN plot type
static int	SQRT SQRT Box Symbol Width
static int	STANDARD Standard plot type
static int	TENNINETY Tenninety plot type
static int	UNDER Under fence position
static int	VERTICAL Vertical orientation

Fields inherited from class netcharts.pro.common.rectangular.NFDataChart

GRID_ANIMATION_STYLE_FADE, GRID_ANIMATION_STYLE_NONE

Fields inherited from class netcharts.pro.common.zoomable.NFZoomableChart

NOZOOM, zoomActionsMap, ZOOMIN, ZOOMOUT

Fields inherited from class netcharts.pro.common.NFGraph

ANTIALIAS_OFF, ANTIALIAS_ON, ANTIALIAS_ONDRAW, ANTIALIAS_ONTEXT, antiAliasModeMap, BAR, BAR3D, BOX, BUBBLE, COMBO, DIAGRAM, DIAL, DWELL_ANIMATION_STYLE_HIGHLIGHT, DWELL_ANIMATION_STYLE_NONE, FADE, HEATMAP, HIGHLIGHT, HISTOGRAM, LABEL_ANIMATION_STYLE_FADE, LABEL_ANIMATION_STYLE_NONE, LEGEND_ANIMATION_STYLE_FADE, LEGEND_ANIMATION_STYLE_NONE, LEGEND_DWELL_ANIMATION_STYLE_HIGHLIGHT, LEGEND_DWELL_ANIMATION_STYLE_NONE, LINE, MULTIPIE, PARETO, PIE, POLAR, RADAR, STOCK, STRIP, TIME, XY

Constructor Summary

NFBoxchart()
Constructs a default chart object.

NFBoxchart(javax.swing.JPanel panel)
Constructs a chart object on the given JPanel.

NFBoxchart(javax.swing.JPanel panel, java.util.Properties initProperties)
Constructs a chart object on the given JPanel.

NFBoxchart(java.util.Properties initProperties)
Constructs a chart object on the given JPanel.

Method Summary

void	addBoxLimitLineStyle(NFLine lineStyle) Adds a style definition to the set of limit line styles.
void	addBoxSet(NFBoxSet boxSet) Adds a box set to the current list of boxsets.
void	addMeanActiveLabel(NFActiveLabel activeLabel) Adds a single active label to the list of mean active labels for this set.
NFVector	getBoxActiveLabels() Get active labels to be associated with each data label.
int	getBoxAnimationStyle() Get the box animation style.
boolean	getBoxFences() Returns whether fences will be drawn at the ends of the Inter Quartile Range.
int	getBoxHeight() Gets the height (in pixels) for each box displayed.
NFVector	getBoxLimitLines() Return the values of the limit lines.
NFVector	getBoxLimitLineStyle() Return the styles of the limit lines.
NFBoxSeries	getBoxSeries() Get the box series.
int	getBoxSymbolWidth() Get box symbol width.
int	getBoxWidth() Get box width.
boolean	getDataIsSummary() Gets if the data provided is already in summary form.
boolean	getDataIsSummaryWithMean() Gets if the data provided is already in summary with mean form.
NFVector	getDataLabels() Get the labels to be displayed under each box.
java.awt.Color	getDataPointColor() Get the color of the data points.
boolean	getDataPointJitter() Returns whether data point jitter is enabled.
java.lang.String	getDefaultData() Returns a string of default data
boolean	getDrawFences() Returns whether fences will be drawn on the chart.
int	getFencePosition() Gets the fence position, whether the fences that are within the IQR over or under the box.
int	getLayout() Get box orientation, either VERTICAL (default) or HORIZONTAL
NFVector	getMeanActiveLabels() Returns the mean active labels for this set
java.awt.Color	getMeanColor() Get the base color of the mean line and symbols.
NFLine	getMeanLine() Gets the style of the mean line.
java.awt.Color	getMedianColor() Get the color of the median line.
int	getMinimumDataPoints() Gets the minimum number of allowable data points.
boolean	getNaturalDisplayOrder() Returns whether show to show the data from left to right.
java.awt.Color	getOutlierColor() Get the color of the outliers.
int	getPercentileN() Gets the percentile to use when in PERCENTN mode.
int	getPlotType() Gets the plot type, one of STANDARD (default), EDA, GAUSSIAN or TENNINETY.
int	getRelativeBoxSymbolWidth() Returns the relative symbol box width value.
boolean	getShowDataPoints() Returns whether show the data points.
int	getType() Gets the chart type.
int	getWhiskerType() Gets the whisker type, either BOX_WHISKER (default) or LINE_WHISKER.
void	resetState() Resets all of the parameter values to their initial state.
void	setBoxActiveLabels(NFVector boxActiveLabels) Set active labels to be associated with each data label.
void	setBoxAnimationStyle(int style) Set the box animation style.
void	setBoxFences(boolean boxFences) Sets whether to draw fences at the ends of the Inter Quartile Range.
void	setBoxHeight(int boxHeight) Sets the height (in pixels) for each box displayed.
void	setBoxLimitLines(NFVector boxLimitLines) Sets the values of the limit lines.
void	setBoxLimitLineStyle(NFVector boxLimitLineStyles) Sets the styles of the limit lines.
void	setBoxSeries(NFBoxSeries boxSeries) Set the box series.
void	setBoxSymbolWidth(int boxSymbolWidth) Set box symbol width.
void	setBoxWidth(int boxWidth) Set box width.
void	setDataIsSummary(boolean dataIsSummary) Sets if the data provided is already in summary form (SUMMARY).
void	setDataIsSummary(boolean dataIsSummary, boolean summaryHasMean) Sets if the data provided is already in summary form and if it includes a mean.
void	setDataLabels(NFVector dataLabels) Set the labels to be displayed under each box.
void	setDataPointColor(java.awt.Color dataPointColor) Set the color of the data points.
void	setDataPointJitter(boolean dataPointJitter) Sets whether data point jitter should be enabled or disabled.
void	setDefaultBoxSymbolWidth() Set default box symbol width.
void	setDefaultBoxWidth() Set default box width.
void	setDrawFences(boolean drawFences) Sets whether to draw fences on the chart
void	setFencePosition(int fencePosition) Sets the fence position, whether the fences that are within the IQR over or under the box.
void	setLayout(int layout) Set box orientation, either VERTICAL (default) or HORIZONTAL.
void	setMeanActiveLabels(NFVector meanActiveLabels) Set the mean active labels for this set.
void	setMeanColor(java.awt.Color meanColor) Set the base color of the mean line and symbols.
void	setMeanLine(int style, int thickness, java.awt.Color color) Sets the style of the mean line.
void	setMeanLine(NFLine meanLine) Sets the style of the mean line.
void	setMedianColor(java.awt.Color medianColor) Set the color of the median line.
void	setMinimumDataPoints(int minimumDataPoints) Sets the minimum number of allowable data points.
void	setNaturalDisplayOrder(boolean naturalDisplayOrder) Sets whether show to show the data from left to right.
void	setOutlierColor(java.awt.Color outlierColor) Set the color of the outliers.
void	setPercentileN(int percentileN) Sets the percentile to use when in PERCENTN mode.
void	setPlotType(int plotType) Sets the plot type, one of STANDARD (default), EDA, GAUSSIAN or TENNINETY.
void	setRelativeBoxSymbolWidth(int relativeBoxSymbolWidth) Sets the relative symbol box width value.
void	setShowDataPoints(boolean showDataPoints) Sets whether show the data points.
void	setWhiskerType(int whiskerType) Sets the whisker type, either BOX_WHISKER (default) or LINE_WHISKER.
void	writeChart(java.lang.StringBuffer sb) Writes this chart into a string buffer
void	writeExternal(java.io.ObjectOutput out) Writes this chart into an object for serialization.

Methods inherited from class netcharts.pro.common.rectangular.NFDataChart

addGrid, getAutoscalePad, getAxesSizes, getAxisThickness, getBottomAxis, getBottomAxisSeries, getGrid, getGridAnimationStyle, getGridDepth, getGridSeries, getLeftAxis, getLeftAxisSeries, getRightAxis, getRightAxisSeries, getTopAxis, getTopAxisSeries, getXAxis, getYAxis, setAutoscalePad, setAxesSizes, setAxisThickness, setBottomAxis, setBottomAxisSeries, setGrid, setGridAnimationStyle, setGridDepth, setGridSeries, setLeftAxis, setLeftAxisSeries, setRightAxis, setRightAxisSeries, setTopAxis, setTopAxisSeries

Methods inherited from class netcharts.pro.common.zoomable.NFZoomableChart

getMouseControlDown, getMouseMetaDown, getMouseShiftDown, getZoomingEnabled, setMouseControlDown, setMouseMetaDown, setMouseShiftDown, setZoomingEnabled, zoom

Methods inherited from class netcharts.pro.common.NFGraph

addChartActionListener, addGraphObserver, addNote, addPropertyChangeListener, display, dwellDisplay, dwellPress, finalize, getActiveClicks, getAlwaysUpdate, getAntiAlias, getAntiAliasMode, getBackgroundActiveLabel, getBackgroundFillPattern, getBackgroundRegion, getBuildAnimationEnabled, getCDL, getChartElementSpacing, getChartName, getChartSize, getColorTable, getDataActiveLabelsEnabled, getDwell, getDwellAnimation, getDwellAnimationHighlight, getDwellAnimationStyle, getDwellOffset, getErrors, getFooter, getGraph, getGraphFromTemplate, getGraphFromTemplate, getGraphFromTemplate, getGraphFromTemplate, getGraphFromTemplate, getGraphFromTemplate, getGraphFromTemplate, getGraphFromTemplate, getGraphGraphics, getHeader, getLabelAnimationStyle, getLeftTitle, getLegend, getLegendAnimationStyle, getLegendDwellAnimation, getLegendDwellAnimationHighlight, getLegendDwellAnimationStyle, getLicenseActivationKey, getMetaData, getMinimumSize, getNoteSeries, getNumberFormat, getNumErrors, getPanel, getPlotArea, getPreferredSize, getRightTitle, getRootPanel, getRubberband, getScaleFactor, getTitleSpacing, getToggleDataVisibility, getVersion, graphDrawn, graphTooSmall, initializeFromFile, initializeFromString, initializeFromURL, loadFromTemplate, loadFromTemplate, loadFromTemplate, loadLicenseFile, paint, postDrag, postScroll, preDrag, preScroll, readExternal, removeChartActionListener, removeGraphObserver, removePropertyChangeListener, sendData, sendData, sendData, sendData, sendUpdate, set, set, set, set, set, set, setActiveClicks, setAlwaysUpdate, setAntiAlias, setAntiAliasMode, setBackgroundActiveLabel, setBackgroundFillPattern, setBackgroundRegion, setBuildAnimationEnabled, setChartElementSpacing, setChartName, setChartSize, setColorTable, setDataActiveLabelsEnabled, setDocumentBase, setDwell, setDwellAnimation, setDwellAnimationHighlight, setDwellAnimationStyle, setDwellOffset, setFooter, setHeader, setLabelAnimationStyle, setLeftTitle, setLegend, setLegendAnimationStyle, setLegendDwellAnimation, setLegendDwellAnimationHighlight, setLegendDwellAnimationStyle, setLicenseKey, setLicenseKey, setLicenseLocation, setMetaData, setNoteSeries, setNumberFormat, setParentApplet, setPlotArea, setRightTitle, setRubberband, setScaleFactor, setSize, setSize, setTitleSpacing, setToggleDataVisibility, start, stop, toString

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

HORIZONTAL

public static final int HORIZONTAL

Horizontal orientation

VERTICAL

public static final int VERTICAL

Vertical orientation

STANDARD

public static final int STANDARD

Standard plot type

EDA

public static final int EDA

EDA plot type

GAUSSIAN

public static final int GAUSSIAN

Gaussian plot type

TENNINETY

public static final int TENNINETY

Tenninety plot type

PERCENTN

public static final int PERCENTN

PercentN plot type

BOX_WHISKER

public static final int BOX_WHISKER

Box whisker type

LINE_WHISKER

public static final int LINE_WHISKER

Line whisker type

OVER

public static final int OVER

Over fence position

UNDER

public static final int UNDER

Under fence position

OFF

public static final int OFF

Off Box Symbol Width

LINEAR

public static final int LINEAR

Linear Box Symbol Width

SQRT

public static final int SQRT

SQRT Box Symbol Width

BOX_ANIMATION_STYLE_NONE

public static final int BOX_ANIMATION_STYLE_NONE

No box animation style

See Also:

Constant Field Values

BOX_ANIMATION_STYLE_SCALE

public static final int BOX_ANIMATION_STYLE_SCALE

Box animation style scale

See Also:

Constant Field Values

BOX_ANIMATION_STYLE_FADE

public static final int BOX_ANIMATION_STYLE_FADE

Box animation style fade

See Also:

Constant Field Values

Constructor Detail

NFBoxchart

public NFBoxchart()

Constructs a default chart object.

NFBoxchart

public NFBoxchart(javax.swing.JPanel panel)

Constructs a chart object on the given JPanel.

Parameters:

panel - Panel to draw chart on.

NFBoxchart

public NFBoxchart(java.util.Properties initProperties)

Constructs a chart object on the given JPanel.

Parameters:

initProperties - A java.util.Properties object containing the set of runtime properties to use when generating the chart. See the netcharts.pro.common.NFGraph(java.util.Properties) constructor for a list of valid Properties.

NFBoxchart

public NFBoxchart(javax.swing.JPanel panel,
                  java.util.Properties initProperties)

Constructs a chart object on the given JPanel.

Parameters:

panel - Panel to draw chart on.

initProperties - A java.util.Properties object containing the set of runtime properties to use when generating the chart. See the netcharts.pro.common.NFGraph(java.util.Properties) constructor for a list of valid Properties.

Method Detail

getDefaultData

public java.lang.String getDefaultData()

Returns a string of default data

Specified by:

getDefaultData in class NFGraph

Returns:

The default data used to initialize a chart.

setOutlierColor

public void setOutlierColor(java.awt.Color outlierColor)

Set the color of the outliers. The OutlierColor allows users to specify the color to be used to display the mean value. This value is used if no color is specified in the OutlierSymbol parameter of a box set.

Parameters:

outlierColor - Color of the outliers

getOutlierColor

public java.awt.Color getOutlierColor()

Get the color of the outliers. The OutlierColor allows users to specify the color to be used to display the mean value. This value is used if no color is specified in the OutlierSymbol parameter of a box set.

Returns:

color of the outliers or null if not defined.

setMedianColor

public void setMedianColor(java.awt.Color medianColor)

Set the color of the median line.

Parameters:

medianColor - Color of the median line.

getMedianColor

public java.awt.Color getMedianColor()

Get the color of the median line.

Returns:

color of the median line or null if not defined.

setMeanColor

public void setMeanColor(java.awt.Color meanColor)

Set the base color of the mean line and symbols. The MeanColor allows users to specify the color to be used to display the mean value. This value is used if no color is specified in the MeanSymbol parameter of a box set.

Parameters:

meanColor - Color of the mean line and symbols.

getMeanColor

public java.awt.Color getMeanColor()

Get the base color of the mean line and symbols. The MeanColor allows users to specify the color to be used to display the mean value. This value is used if no color is specified in the MeanSymbol parameter of a box set.

Returns:

color of the mean line and symbols or null if not defined.

setDataPointColor

public void setDataPointColor(java.awt.Color dataPointColor)

Set the color of the data points. The DataPointColor allows users to specify the color to be used to display the raw data points. This value is used if no color is specified in the DataPointSymbol parameter of the box set.

Parameters:

dataPointColor - Color of the data points.

getDataPointColor

public java.awt.Color getDataPointColor()

Get the color of the data points. The DataPointColor allows users to specify the color to be used to display the raw data points. This value is used if no color is specified in the DataPointSymbol parameter of the box set.

Returns:

color of the data points or null if not defined.

setBoxHeight

public void setBoxHeight(int boxHeight)

Sets the height (in pixels) for each box displayed. If the value is 0, then a default height will be selected based on the size of the display and the number of data sets being displayed. The default size will also be used if the specified height is taller than the amount of space that is physically available to a given box.

Parameters:

boxHeight -

getBoxHeight

public int getBoxHeight()

Gets the height (in pixels) for each box displayed. If the value is 0, then a default height will be selected based on the size of the display and the number of data sets being displayed. The default size will also be used if the specified height is taller than the amount of space that is physically available to a given box.

Returns:

boxHeight

addBoxSet

public void addBoxSet(NFBoxSet boxSet)

Adds a box set to the current list of boxsets.

Parameters:

boxSet - The boxset to add.

setBoxSeries

public void setBoxSeries(NFBoxSeries boxSeries)
                  throws NFParamException

Set the box series. This is a vector of boxsets. To set a property on the box series, you must first retrieve the series, then set the property (properties) and finally set the bar series.

     NFBoxchart chart = new NFBoxchart();
     NFBoxSeries bs = chart.getBoxSeries();
     NFBoxSet set = (NFBoxSet)bs.elementAt(0);
     // Set some of the properties on the NFBoxSet
     ...
     bs.setElementAt(set, 0);
     chart.setBoxSeries(bs);
 

Parameters:

boxSeries -

Throws:

NFParamException

getBoxSeries

public NFBoxSeries getBoxSeries()

Get the box series. This is a vector of boxsets. To set a property on the box series, you must first retrieve the series, then set the property (properties) and finally set the bar series.

     NFBoxchart chart = new NFBoxchart();
     NFBoxSeries bs = chart.getBoxSeries();
     NFBoxSet set = (NFBoxSet)bs.elementAt(0);
     // Set some of the properties on the NFBoxSet
     ...
     bs.setElementAt(set, 0);
     chart.setBoxSeries(bs);
 

Returns:

boxSeries

setDataIsSummary

public void setDataIsSummary(boolean dataIsSummary)

Sets if the data provided is already in summary form (SUMMARY).

Parameters:

dataIsSummary - True if data is in summary form.

setDataIsSummary

public void setDataIsSummary(boolean dataIsSummary,
                             boolean summaryHasMean)

Sets if the data provided is already in summary form and if it includes a mean.

Parameters:

dataIsSummary - True if data is in summary form (SUMMARY or SUMMARYWITHMEAN), false if otherwise (RAW).

summaryHasMean - True if the summary includes a mean.

getDataIsSummary

public boolean getDataIsSummary()

Gets if the data provided is already in summary form. Summary information assumes that percentile information has already been computed.

Returns:

true if data is in summary form (SUMMARY or SUMMARYWITHMEAN), false if otherwise (RAW).

getDataIsSummaryWithMean

public boolean getDataIsSummaryWithMean()

Gets if the data provided is already in summary with mean form. Summary with mean information assumes that percentile and mean information has already been computed.

Returns:

true if data is in summary with mean form.

setMinimumDataPoints

public void setMinimumDataPoints(int minimumDataPoints)

Sets the minimum number of allowable data points. MinimumDataPoints defines the number of data points that must be present in a series in order for the chart to draw in summary mode. IF ShowDataPoints is OFF (false), and the minimum number of data points necessary to calculate a summary display are not present, the raw data will be displayed.

Parameters:

minimumDataPoints - The minimum number of allowable data points.

getMinimumDataPoints

public int getMinimumDataPoints()

Gets the minimum number of allowable data points. MinimumDataPoints defines the number of data points that must be present in a series in order for the chart to draw in summary mode. IF ShowDataPoints is OFF (false), and the minimum number of data points necessary to calculate a summary display are not present, the raw data will be displayed.

Returns:

minDataPoints The minimum number of allowable data points. If null, 0 is returned.

setLayout

public void setLayout(int layout)

Set box orientation, either VERTICAL (default) or HORIZONTAL.

Parameters:

layout - One of HORIZONTAL, VERTICAL

getLayout

public int getLayout()

Get box orientation, either VERTICAL (default) or HORIZONTAL

Returns:

layout One of HORIZONTAL, VERTICAL. If null, VERTICAL is returned by default.

setBoxWidth

public void setBoxWidth(int boxWidth)

Set box width. Defines the relative width of the box as a percentage of available space. A smaller number results in more space between boxes. The minimum allowable value is 0. The maximum allowable value is 100.

Parameters:

boxWidth -

setDefaultBoxWidth

public void setDefaultBoxWidth()

Set default box width. Defines the relative width of the box as a percentage of available space. A smaller number results in more space between boxes.

getBoxWidth

public int getBoxWidth()

Get box width. Defines the relative width of the box as a percentage of available space. A smaller number results in more space between boxes.

Returns:

boxWidth

setBoxSymbolWidth

public void setBoxSymbolWidth(int boxSymbolWidth)

Set box symbol width. Defines the relative width of the box symbols as a percentage of available space. The minimum allowable value is 0. The maximum allowable value is 100.

Parameters:

boxSymbolWidth -

setDefaultBoxSymbolWidth

public void setDefaultBoxSymbolWidth()

Set default box symbol width. Defines the relative width of the box symbols as a percentage of available space.

getBoxSymbolWidth

public int getBoxSymbolWidth()

Get box symbol width. Defines the relative width of the box symbols as a percentage of available space.

Returns:

boxSymbolWidth

setPlotType

public void setPlotType(int plotType)

Sets the plot type, one of STANDARD (default), EDA, GAUSSIAN or TENNINETY.

Parameters:

plotType - One of STANDARD (default), EDA, GAUSSIAN or TENNINETY.

getPlotType

public int getPlotType()

Gets the plot type, one of STANDARD (default), EDA, GAUSSIAN or TENNINETY.

Returns:

plotType One of STANDARD, EDA, GAUSSIAN or TENNINETY. STANDARD is returned by default.

setPercentileN

public void setPercentileN(int percentileN)

Sets the percentile to use when in PERCENTN mode. The box will be drawn using percentileN and 100-percentileN as its bounds.

Parameters:

percentileN - The percentile to use when in PERCENTN mode.

getPercentileN

public int getPercentileN()

Gets the percentile to use when in PERCENTN mode. The box will be drawn using percentileN and 100-percentileN as its bounds.

Returns:

percentileN The percentile to use when in PERCENTN mode.

setWhiskerType

public void setWhiskerType(int whiskerType)

Sets the whisker type, either BOX_WHISKER (default) or LINE_WHISKER.

Parameters:

whiskerType - One of BOX_WHISKER, LINE_WHISKER

getWhiskerType

public int getWhiskerType()

Gets the whisker type, either BOX_WHISKER (default) or LINE_WHISKER.

Returns:

layout One of BOX_WHISKER or LINE_WHISKER. If null, BOX_WHISKER is returned by default.

setFencePosition

public void setFencePosition(int fencePosition)

Sets the fence position, whether the fences that are within the IQR over or under the box. Either OVER (default) or UNDER.

Parameters:

fencePosition - One of OVER, UNDER

getFencePosition

public int getFencePosition()

Gets the fence position, whether the fences that are within the IQR over or under the box. Either OVER (default) or UNDER.

Returns:

fencePosition One of OVER or UNDER. If null, OVER is returned by default.

setDrawFences

public void setDrawFences(boolean drawFences)

Sets whether to draw fences on the chart

Parameters:

drawFences - true to enable drawing fences on the chart, false to disable drawing fences.

getDrawFences

public boolean getDrawFences()

Returns whether fences will be drawn on the chart.

Returns:

true if fences will be drawn on the chart, false if fences will not be drawn.

setBoxFences

public void setBoxFences(boolean boxFences)

Sets whether to draw fences at the ends of the Inter Quartile Range. Note that no fences will be drawn if setDrawFences(false) has been called.

Parameters:

boxFences - true to enable drawing the fences, false false to disable.

getBoxFences

public boolean getBoxFences()

Returns whether fences will be drawn at the ends of the Inter Quartile Range. Note that no fences will be drawn if setDrawFences(false) has been called.

Returns:

boxFences true if the fences are enabled, false otherwise.

setNaturalDisplayOrder

public void setNaturalDisplayOrder(boolean naturalDisplayOrder)

Sets whether show to show the data from left to right. The default behavior for a Box Chart in VERTICAL mode is to display the series from right to left. NaturalDisplayOrder provides control over this behavior.

Parameters:

naturalDisplayOrder - true to show the data from left to right, false false otherwise.

getNaturalDisplayOrder

public boolean getNaturalDisplayOrder()

Returns whether show to show the data from left to right. The default behavior for a Box Chart in VERTICAL mode is to display the series from right to left. NaturalDisplayOrder provides control over this behavior.

Returns:

naturalDisplayOrder true to show the data from left to right, false false otherwise. If null, false is returned.

setShowDataPoints

public void setShowDataPoints(boolean showDataPoints)

Sets whether show the data points. ShowDataPoints is used to display the raw data in addition to the summary data for each series

Parameters:

showDataPoints - true to show the data points, false false otherwise.

getShowDataPoints

public boolean getShowDataPoints()

Returns whether show the data points. ShowDataPoints is used to display the raw data in addition to the summary data for each series

Returns:

showDataPoints true to show the data points, false false otherwise. If null, false is returned.

setRelativeBoxSymbolWidth

public void setRelativeBoxSymbolWidth(int relativeBoxSymbolWidth)

Sets the relative symbol box width value. RelativeBoxSymbolWidth is used to specify widths to assign to the the boxes in the chart based on the relative number of points in each data series. For example, if set to LINEAR, a data series with 100 data points will be have a box width twice that of a box representing a data series with only 50 data points. If set to SQRT, the relative boxes will be calculated as a function of the square root of the number of points in each series.

Parameters:

relativeBoxSymbolWidth - One of OFF, LINEAR or SQRT.

getRelativeBoxSymbolWidth

public int getRelativeBoxSymbolWidth()

Returns the relative symbol box width value. RelativeBoxSymbolWidth is used to specify widths to assign to the the boxes in the chart based on the relative number of points in each data series. For example, if set to LINEAR, a data series with 100 data points will be have a box width twice that of a box representing a data series with only 50 data points. If set to SQRT, the relative boxes will be calculated as a function of the square root of the number of points in each series.

Returns:

relativeBoxSymbolWidth One of OFF, LINEAR or SQRT. If null, OFF is returned by default.

setDataPointJitter

public void setDataPointJitter(boolean dataPointJitter)

Sets whether data point jitter should be enabled or disabled. DataPointJitter is used to increase the visibility of individual points when displaying raw data. The jitter option adds random horizontal jitter to the x values of each data point, allowing multiple points with the same Y value to be distinguishable.

Parameters:

dataPointJitter - true to enable the fences, false false otherwise.

getDataPointJitter

public boolean getDataPointJitter()

Returns whether data point jitter is enabled. DataPointJitter is used to increase the visibility of individual points when displaying raw data. The jitter option adds random horizontal jitter to the x values of each data point, allowing multiple points with the same Y value to be distinguishable.

Returns:

dataPointJitter true if data point jitter is enabled, false false otherwise. If null, true is returned.

setMeanLine

public void setMeanLine(int style,
                        int thickness,
                        java.awt.Color color)

Sets the style of the mean line. The MeanLine allows the users to draw a line that connects the mean of each data series in a Box Chart.

Parameters:

style - One of NFLine.NONE, NFLine.SOLID, NFLineDOTTED, NFLine.DASHED, NFLine.DOTDASH.

thickness - Line thickness (in pixels)

color - Line color

setMeanLine

public void setMeanLine(NFLine meanLine)

Sets the style of the mean line. The MeanLine allows the users to draw a line that connects the mean of each data series in a Box Chart.

Parameters:

meanLine - NFLine style.

getMeanLine

public NFLine getMeanLine()

Gets the style of the mean line.

Returns:

The

addMeanActiveLabel

public void addMeanActiveLabel(NFActiveLabel activeLabel)

Adds a single active label to the list of mean active labels for this set.

Parameters:

activeLabel - The activeLabel to add to the list of active labels.

setMeanActiveLabels

public void setMeanActiveLabels(NFVector meanActiveLabels)

Set the mean active labels for this set.

If the vector contains elements that are not NFActiveLabel objects, an IllegalArgumentException will be thrown.

Parameters:

meanActiveLabels - Vector of NFActiveLabels

getMeanActiveLabels

public NFVector getMeanActiveLabels()

Returns the mean active labels for this set

Returns:

the vector of NFActiveLabel objects.

setBoxLimitLineStyle

public void setBoxLimitLineStyle(NFVector boxLimitLineStyles)

Sets the styles of the limit lines.

Parameters:

boxLimitLineStyles - a NFVector containing a set of NFLine objects defining the styles.

getBoxLimitLineStyle

public NFVector getBoxLimitLineStyle()

Return the styles of the limit lines.

Returns:

NFVector containing a set of NFLine objects defining the styles.

setBoxLimitLines

public void setBoxLimitLines(NFVector boxLimitLines)

Sets the values of the limit lines.

Parameters:

boxLimitLines - a NFVector containing a set of NFVector objects defining the data values.

getBoxLimitLines

public NFVector getBoxLimitLines()

Return the values of the limit lines.

Returns:

NFVector containing a set of NFVector objects defining the data values.

addBoxLimitLineStyle

public void addBoxLimitLineStyle(NFLine lineStyle)

Adds a style definition to the set of limit line styles.

Parameters:

lineStyle - The line style definition to add.

getType

public int getType()

Gets the chart type.

Specified by:

getType in class NFGraph

Returns:

the type of this chart, always netcharts.pro.charts.box.NFGraph.BAR

setBoxAnimationStyle

public void setBoxAnimationStyle(int style)

Set the box animation style.

If the value passed is not a valid box animation style, BOX_ANIMATION_STYLE_NONE will be used.

Parameters:

style - One of BOX_ANIMATION_STYLE_NONE (default), BOX_ANIMATION_STYLE_SCALE or BOX_ANIMATION_STYLE_FADE

getBoxAnimationStyle

public int getBoxAnimationStyle()

Get the box animation style.

Returns:

type One of BOX_ANIMATION_STYLE_NONE (default), BOX_ANIMATION_STYLE_SCALE or BOX_ANIMATION_STYLE_FADE

writeExternal

public void writeExternal(java.io.ObjectOutput out)
                   throws java.io.IOException

Writes this chart into an object for serialization.

Specified by:

writeExternal in interface java.io.Externalizable

Overrides:

writeExternal in class NFDataChart

Throws:

java.io.IOException

writeChart

public void writeChart(java.lang.StringBuffer sb)

Writes this chart into a string buffer

Overrides:

writeChart in class NFDataChart

resetState

public void resetState()

Resets all of the parameter values to their initial state.

Overrides:

resetState in class NFDataChart

setDataLabels

public void setDataLabels(NFVector dataLabels)

Set the labels to be displayed under each box. The vector contains a list of string values.

getDataLabels

public NFVector getDataLabels()

Get the labels to be displayed under each box. The vector contains a list of string values.

Returns:

dataLabels

setBoxActiveLabels

public void setBoxActiveLabels(NFVector boxActiveLabels)

Set active labels to be associated with each data label.

Parameters:

boxActiveLabels - Vector of NFActiveLabels

getBoxActiveLabels

public NFVector getBoxActiveLabels()

Get active labels to be associated with each data label.

Returns:

boxActiveLabels Vector of NFActiveLabels