netcharts.pro.charts.line
Class NFLinechart

java.lang.Object
  netcharts.pro.common.NFGraph
      netcharts.pro.common.zoomable.NFZoomableChart
          netcharts.pro.common.rectangular.NFDataChart
              netcharts.pro.common.lineset.NFAbstractLineChart
                  netcharts.pro.charts.line.NFLinechart

All Implemented Interfaces:

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

public class NFLinechart
extends NFAbstractLineChart

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

See Also:

Serialized Form

Field Summary

static int	ITEM Discrete value shown on popup when linechart type is stack item value.
static java.util.Hashtable	linechartTypeMap linechart type hashtable
static int	PERCENT Percentage linechart type.
static int	ROWS Row linechart type.
static int	STACK Stacked linechart type.
static java.util.Hashtable	stackTypeMap linechart stack type hashtable
static int	TOTAL Total value shown on popup when linechart type is stack total.

Fields inherited from class netcharts.pro.common.lineset.NFAbstractLineChart

LINE_ANIMATION_STYLE_BEND, LINE_ANIMATION_STYLE_FADE, LINE_ANIMATION_STYLE_NONE, LINE_SYMBOL_ANIMATION_STYLE_FADE, LINE_SYMBOL_ANIMATION_STYLE_NONE, LINE_SYMBOL_ANIMATION_STYLE_SCALE

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

NFLinechart()
Constructs a default chart object.

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

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

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

Method Summary

NFGridBackground	getDataLegendGridBackground() Get the data legend grid background.
NFGridLine	getDataLegendGridLine() Get the data legend grid line.
java.lang.String	getDefaultData() Returns a string of default data
int	getLinechartType() Get linechart type, either STACK (default) PERCENT, or ROWS
int	getStackType() Get linechart stack type, either TOTAL (default), ITEM, or PERCENT.
int	getType() Gets the chart type.
boolean	isDataLegendEnabled() Get whether the data legend is enabled or not.
void	resetState() Resets all of the parameter values to their initial state.
void	setDataLegendEnabled(boolean dataLegendEnabled) Set whether the data legend is enabled or not.
void	setDataLegendGridBackground(NFGridBackground dataLegendGridBackground) Set the data legend grid background.
void	setDataLegendGridLine(NFGridLine dataLegendGridLine) Set the data legend grid line.
void	setLinechartType(int type) Set linechart type, either STACK (default) PERCENT, or ROWS
void	setStackType(int stackType) Set linechart stack type, either TOTAL (default), ITEM, or PERCENT.
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.lineset.NFAbstractLineChart

addLineSet, getDepth, getLineAnimationStyle, getLineDropShadow, getLineSeries, getLineSymbolAnimationStyle, getLineSymbolSpotlightSeries, getLineValueLabel, getLineValueLabelRegion, getLineZWidth, setDepth, setLineAnimationStyle, setLineDropShadow, setLineSeries, setLineSymbolAnimationStyle, setLineSymbolSpotlightSeries, setLineValueLabel, setLineValueLabelRegion, setLineZWidth

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

ROWS

public static final int ROWS

Row linechart type. The line sets are displayed separately. If depth is nonzero, then they will be displayed in separate rows, from front to back.

See Also:

Constant Field Values

STACK

public static final int STACK

Stacked linechart type. The linesets are stacked on top of each other. That is, as each line set is drawn, it's values are added to previous values displayed. Negative and NULL values are treated as zero.

See Also:

Constant Field Values

PERCENT

public static final int PERCENT

Percentage linechart type. The linesets are stacked on top of each other, normalized to 100 percent. That is, as each line set is drawn, it's values are added to previous values displayed and displayed as a percentage of the total of all values. Negative and NULL values are treated as zero. PERCENT also may be applied as a StackType - shows percentage value on popup.

See Also:

Constant Field Values

TOTAL

public static final int TOTAL

Total value shown on popup when linechart type is stack total.

See Also:

Constant Field Values

ITEM

public static final int ITEM

Discrete value shown on popup when linechart type is stack item value.

See Also:

Constant Field Values

linechartTypeMap

public static java.util.Hashtable linechartTypeMap

linechart type hashtable

stackTypeMap

public static java.util.Hashtable stackTypeMap

linechart stack type hashtable

Constructor Detail

NFLinechart

public NFLinechart()

Constructs a default chart object.

NFLinechart

public NFLinechart(javax.swing.JPanel panel)

Constructs a chart object on the given JPanel.

Parameters:

panel - Panel to draw chart on.

NFLinechart

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

NFLinechart

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

setLinechartType

public void setLinechartType(int type)

Set linechart type, either STACK (default) PERCENT, or ROWS

Parameters:

type -

getLinechartType

public int getLinechartType()

Get linechart type, either STACK (default) PERCENT, or ROWS

Returns:

type

setStackType

public void setStackType(int stackType)

Set linechart stack type, either TOTAL (default), ITEM, or PERCENT. This parameter affects how data values will be shown on the mouseover popup. When stackType is TOTAL, the accumulated value of the stack lines will be shown. When stackType is ITEM, the value of the moused over segment will be displayed. When the stackType is PERCENT, the accumulated value is shown as a percentage.

Parameters:

stackType -

getStackType

public int getStackType()

Get linechart stack type, either TOTAL (default), ITEM, or PERCENT. This parameter affects how data values will be shown on the mouseover popup. When stackType is TOTAL, the accumulated value of the stack lines will be shown. When stackType is ITEM, the value of the moused over segment will be displayed. When the stackType is PERCENT, the accumulated value is shown as a percentage.

Parameters:

stackType -

getType

public int getType()

Gets the chart type.

Specified by:

getType in class NFGraph

Returns:

the type of this chart, always netcharts.pro.charts.line.NFGraph.LINE

isDataLegendEnabled

public boolean isDataLegendEnabled()

Get whether the data legend is enabled or not.

Returns:

data legend enabled

setDataLegendEnabled

public void setDataLegendEnabled(boolean dataLegendEnabled)

Set whether the data legend is enabled or not.

Parameters:

dataLegendEnabled - Whether the data legend is enabled or not.

getDataLegendGridBackground

public NFGridBackground getDataLegendGridBackground()

Get the data legend grid background.

Returns:

the data legend grid background

setDataLegendGridBackground

public void setDataLegendGridBackground(NFGridBackground dataLegendGridBackground)

Set the data legend grid background.

Parameters:

dataLegendGridBackground - the data legend grid background

getDataLegendGridLine

public NFGridLine getDataLegendGridLine()

Get the data legend grid line.

Returns:

the data legend grid line

setDataLegendGridLine

public void setDataLegendGridLine(NFGridLine dataLegendGridLine)

Set the data legend grid line.

Parameters:

dataLegendGridLine - the data legend grid line

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 NFAbstractLineChart

Throws:

java.io.IOException

writeChart

public void writeChart(java.lang.StringBuffer sb)

Writes this chart into a string buffer

Overrides:

writeChart in class NFAbstractLineChart

resetState

public void resetState()

Resets all of the parameter values to their initial state.

Overrides:

resetState in class NFAbstractLineChart