netcharts.pro.charts.histogram
Class NFHistogramchart

java.lang.Object
  netcharts.pro.common.NFGraph
      netcharts.pro.common.zoomable.NFZoomableChart
          netcharts.pro.common.rectangular.NFDataChart
              netcharts.pro.common.barset.NFAbstractBarchart
                  netcharts.pro.charts.bar.NFAbstractGroupStackableBarchart
                      netcharts.pro.charts.histogram.NFHistogramchart

All Implemented Interfaces:

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

public class NFHistogramchart
extends NFAbstractGroupStackableBarchart

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

See Also:

Serialized Form

Field Summary

static int	BYNUMBER A description of the Histogram data distribution.
static java.util.Hashtable	histogramTypeMap Histogram chart type hashtable
static int	PERCENTAGE A description of the Histogram data distribution.
static int	PROBABILITY A description of the Histogram data distribution.

Fields inherited from class netcharts.pro.common.barset.NFAbstractBarchart

BAR_ANIMATION_STYLE_FADE, BAR_ANIMATION_STYLE_GROW, BAR_ANIMATION_STYLE_NONE, barchartTypeMap, BOTTOMUP, GROUP, GROUPSTACK, HORIZONTAL, ITEM, orientationMap, ROWS, STACK, stackDisplayOrderMap, stackTypeMap, TOPDOWN, TOTAL, VERTICAL

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

NFHistogramchart()
Constructs a default chart object.

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

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

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

Method Summary

NFVector	getDataLabels() Get the labels to be displayed under each bar.
java.lang.String	getDefaultData() Returns a string of default data
NFHistogramBin	getHistogramBin() Returns the histogram bin for this histogram chart
NFHistogramScale	getHistogramScale() Returns the histogram scale for this histogram chart
int	getHistogramType() Get histogram chart type, either BYNUMBER (default), PERCENTAGE, or PROBABILITY.
int	getType() Gets the chart type.
void	resetState() Resets all of the parameter values to their initial state.
void	setDataLabels(NFVector dataLabels) Set the labels to be displayed under each bar.
void	setHistogramBin(NFHistogramBin bin) Set histogram bin for this histogram chart
void	setHistogramScale(NFHistogramScale scale) Set histogram scale for this histogram chart
void	setHistogramType(int histogramType) Set histogram chart type, either BYNUMBER (default), PERCENTAGE, or PROBABILITY.
void	writeChart(java.lang.StringBuffer sb) Writes this chart into a string buffer

Methods inherited from class netcharts.pro.charts.bar.NFAbstractGroupStackableBarchart

getBarchartType, getDepth, getGroupStackLabels, getGroupStackSegmentLabels, getOrientation, getShowGroupStackLabels, setBarchartType, setDepth, setGroupStackLabels, setGroupStackSegmentLabels, setOrientation, setShowGroupStackLabels

Methods inherited from class netcharts.pro.common.barset.NFAbstractBarchart

addBarSet, getBarActiveLabels, getBarAnimationStyle, getBarBorder, getBarCorners, getBarDropShadow, getBarHighlightSeries, getBarSeries, getBarSpotlightSeries, getBarValueLabel, getBarValueLabelRegion, getBarWidth, getBarWidths, getStackDisplayOrder, getStackType, getZAxisLabels, setBarActiveLabels, setBarAnimationStyle, setBarBorder, setBarCorners, setBarDropShadow, setBarHighlightSeries, setBarSeries, setBarSpotlightSeries, setBarValueLabel, setBarValueLabelRegion, setBarWidth, setBarWidths, setStackDisplayOrder, setStackType, setZAxisLabels, writeExternal

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

BYNUMBER

public static final int BYNUMBER

A description of the Histogram data distribution. Specifies that a bin will hold a count of the number of data points in the bin's range

See Also:

Constant Field Values

PERCENTAGE

public static final int PERCENTAGE

A description of the Histogram data distribution. Specifies that a bin will hold the percentage of the total data points that are in the bin's range.

See Also:

Constant Field Values

PROBABILITY

public static final int PROBABILITY

A description of the Histogram data distribution. Specifies that a bin will hold the probability that any given point is in the bin's range.

See Also:

Constant Field Values

histogramTypeMap

public static java.util.Hashtable histogramTypeMap

Histogram chart type hashtable

Constructor Detail

NFHistogramchart

public NFHistogramchart()

Constructs a default chart object.

NFHistogramchart

public NFHistogramchart(javax.swing.JPanel panel)

Constructs a chart object on the given JPanel.

Parameters:

panel - Panel to draw chart on.

NFHistogramchart

public NFHistogramchart(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.

NFHistogramchart

public NFHistogramchart(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.

getType

public int getType()

Gets the chart type.

Specified by:

getType in class NFGraph

Returns:

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

setHistogramType

public void setHistogramType(int histogramType)

Set histogram chart type, either BYNUMBER (default), PERCENTAGE, or PROBABILITY.

If the value passed is not a valid histogram chart type, BYNUMBER will be used.

Parameters:

histogramType - either BYNUMBER, PERCENTAGE, or PROBABILITY

getHistogramType

public int getHistogramType()

Get histogram chart type, either BYNUMBER (default), PERCENTAGE, or PROBABILITY.

Returns:

histogram type (either BYNUMBER, PERCENTAGE, or PROBABILITY)

setHistogramBin

public void setHistogramBin(NFHistogramBin bin)

Set histogram bin for this histogram chart

Parameters:

bin - the histogram bin to use

getHistogramBin

public NFHistogramBin getHistogramBin()

Returns the histogram bin for this histogram chart

Returns:

the histogram bin

setHistogramScale

public void setHistogramScale(NFHistogramScale scale)

Set histogram scale for this histogram chart

Parameters:

scale - the histogram scale to use

getHistogramScale

public NFHistogramScale getHistogramScale()

Returns the histogram scale for this histogram chart

Returns:

the histogram scale

setDataLabels

public void setDataLabels(NFVector dataLabels)

Description copied from class: NFAbstractBarchart

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

Overrides:

setDataLabels in class NFAbstractBarchart

getDataLabels

public NFVector getDataLabels()

Description copied from class: NFAbstractBarchart

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

Overrides:

getDataLabels in class NFAbstractBarchart

Returns:

dataLabels

writeChart

public void writeChart(java.lang.StringBuffer sb)

Writes this chart into a string buffer

Overrides:

writeChart in class NFAbstractGroupStackableBarchart

resetState

public void resetState()

Resets all of the parameter values to their initial state.

Overrides:

resetState in class NFAbstractGroupStackableBarchart