NetCharts Pro

netcharts.pro.common.lineset
Class NFAbstractLineChart

java.lang.Object
  extended by netcharts.pro.common.NFGraph
      extended by netcharts.pro.common.zoomable.NFZoomableChart
          extended by netcharts.pro.common.rectangular.NFDataChart
              extended by netcharts.pro.common.lineset.NFAbstractLineChart
All Implemented Interfaces:
java.io.Externalizable, java.io.Serializable, NFDragObserver, NFDwellObserver, NFGraphObserver, NFScrollObserver
Direct Known Subclasses:
NFCombochart, NFLinechart, NFXYchart

public abstract class NFAbstractLineChart
extends NFDataChart

Represents chart that supports line drawing.

See Also:
Serialized Form

Field Summary
static int LINE_ANIMATION_STYLE_BEND
          Line animation style bend
static int LINE_ANIMATION_STYLE_FADE
          Line animation style fade
static int LINE_ANIMATION_STYLE_NONE
          No line animation style
static int LINE_SYMBOL_ANIMATION_STYLE_FADE
          Line symbol animation style fade
static int LINE_SYMBOL_ANIMATION_STYLE_NONE
          No line symbol animation style
static int LINE_SYMBOL_ANIMATION_STYLE_SCALE
          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
NFAbstractLineChart()
          Constructs a default chart object.
NFAbstractLineChart(javax.swing.JPanel panel)
          Constructs a chart object on the given JPanel.
NFAbstractLineChart(javax.swing.JPanel panel, java.util.Properties initProperties)
          Constructs a chart object on the given JPanel.
NFAbstractLineChart(java.util.Properties initProperties)
          Constructs a chart object on the given JPanel.
 
Method Summary
 void addLineSet(NFLineSet lineSet)
          Adds a line set to the current list of linesets.
 int getDepth()
          Get 3DDepth
 int getLineAnimationStyle()
          Get the line animation style.
 NFDropShadow getLineDropShadow()
          Get the drop shadow for the lines
 NFLineSeries getLineSeries()
          Get the line series.
 int getLineSymbolAnimationStyle()
          Get the line symbol animation style.
 NFSpotlightSeries getLineSymbolSpotlightSeries()
          Get the line symbol spotlight series.
 NFModalLabel getLineValueLabel()
          Get the text style to use for line labels.
 NFRegion getLineValueLabelRegion()
          Get the text background style to use for line labels.
 int getLineZWidth()
          Get the lineZWidth.
 void resetState()
          Resets all of the parameter values to their initial state.
 void setDepth(int depth)
          Set 3DDepth
 void setLineAnimationStyle(int style)
          Set the line animation style.
 void setLineDropShadow(NFDropShadow lineDropShadow)
          Set the drop shadow for the lines
 void setLineSeries(NFLineSeries lineSeries)
          Set the line series.
 void setLineSymbolAnimationStyle(int style)
          Set the line symbol animation style.
 void setLineSymbolSpotlightSeries(NFSpotlightSeries lineSymbolSpotlightSeries)
          Set the line symbol spotlight series.
 void setLineValueLabel(NFModalLabel lineValueLabel)
          Set the text style to use for line labels.
 void setLineValueLabelRegion(NFRegion lineValueRegion)
          Set the text background style to use for line labels.
 void setLineZWidth(int lineZWidth)
          Set the lineZWidth.
 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, getNoteSeriesDrawnBeforeData, getRightAxis, getRightAxisSeries, getTopAxis, getTopAxisSeries, getXAxis, getYAxis, setAutoscalePad, setAxesSizes, setAxisThickness, setBottomAxis, setBottomAxisSeries, setGrid, setGridAnimationStyle, setGridDepth, setGridSeries, setLeftAxis, setLeftAxisSeries, setNoteSeriesDrawnBeforeData, 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, getDefaultData, getDwell, getDwellAnimation, getDwellAnimationHighlight, getDwellAnimationStyle, getDwellOffset, getErrors, getFooter, getGraph, getGraphFromTemplate, getGraphFromTemplate, getGraphFromTemplate, getGraphFromTemplate, getGraphFromTemplate, getGraphFromTemplate, getGraphFromTemplate, getGraphFromTemplate, getGraphFromTemplate, getGraphFromTemplate, getGraphFromTemplate, getGraphFromTemplate, getGraphFromTemplate, getGraphFromTemplate, getGraphFromTemplate, getGraphFromTemplate, getGraphGraphics, getHeader, getLabelAnimationStyle, getLeftTitle, getLegend, getLegendAnimationStyle, getLegendDwellAnimation, getLegendDwellAnimationHighlight, getLegendDwellAnimationStyle, getLicenseActivationKey, getLocale, getMetaData, getMinimumSize, getNoteSeries, getNumberFormat, getNumErrors, getPanel, getPlotArea, getPreferredSize, getRightTitle, getRootPanel, getRubberband, getScaleFactor, getTitleSpacing, getToggleDataVisibility, getType, 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, setLocale, 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

LINE_SYMBOL_ANIMATION_STYLE_NONE

public static final int LINE_SYMBOL_ANIMATION_STYLE_NONE
No line symbol animation style

See Also:
Constant Field Values

LINE_SYMBOL_ANIMATION_STYLE_SCALE

public static final int LINE_SYMBOL_ANIMATION_STYLE_SCALE
Line symbol animation style scale

See Also:
Constant Field Values

LINE_SYMBOL_ANIMATION_STYLE_FADE

public static final int LINE_SYMBOL_ANIMATION_STYLE_FADE
Line symbol animation style fade

See Also:
Constant Field Values

LINE_ANIMATION_STYLE_NONE

public static final int LINE_ANIMATION_STYLE_NONE
No line animation style

See Also:
Constant Field Values

LINE_ANIMATION_STYLE_BEND

public static final int LINE_ANIMATION_STYLE_BEND
Line animation style bend

See Also:
Constant Field Values

LINE_ANIMATION_STYLE_FADE

public static final int LINE_ANIMATION_STYLE_FADE
Line animation style fade

See Also:
Constant Field Values
Constructor Detail

NFAbstractLineChart

public NFAbstractLineChart()
Constructs a default chart object.


NFAbstractLineChart

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

Parameters:
panel - Panel to draw graph on.

NFAbstractLineChart

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

NFAbstractLineChart

public NFAbstractLineChart(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

setDepth

public void setDepth(int depth)
Set 3DDepth

Parameters:
depth - 3D shadow depth

getDepth

public int getDepth()
Get 3DDepth

Returns:
depth 3D shadow depth

setLineZWidth

public void setLineZWidth(int lineZWidth)
Set the lineZWidth. This percentage value (0-100) or (0.0-1.0) determines the amount of space actually used to display 3D lines when depth is greater than 1. If 100 percent is specified, then each line will completely fill the amount of space specified by depth in the Z dimension. If 50 percent is specified, then each line will occupy only 50 percent of that space, which will result in a visible separation between each line set. The default value is 100.

Parameters:
lineZWidth -

getLineZWidth

public int getLineZWidth()
Get the lineZWidth. This percentage value (0-100) or (0.0-1.0) determines the amount of space actually used to display 3D lines when depth is greater than 1. If 100 percent is specified, then each line will completely fill the amount of space specified by depth in the Z dimension. If 50 percent is specified, then each line will occupy only 50 percent of that space, which will result in a visible separation between each line set. The default value is 100.

Parameters:
lineZWidth -

addLineSet

public void addLineSet(NFLineSet lineSet)
Adds a line set to the current list of linesets.

Parameters:
lineSet - The lineset to add.

setLineSeries

public void setLineSeries(NFLineSeries lineSeries)
                   throws NFParamException
Set the line series. This is a vector of NFLineSets. To set a property on the line series, you must first retrieve the series, then set the property (properties) and finally set the line series.
     NFLinechart chart = new NFLinechart();
     NFLineSeries ls = chart.getLineSeries();
     NFLineSet set = (NFLineSet)ls.elementAt(0);
     // Set some of the properties on the NFLineSet
     ...
     ls.setElementAt(set, 0);
     chart.setLineSeries(ls);
 

Parameters:
lineSeries -
Throws:
NFParamException

getLineSeries

public NFLineSeries getLineSeries()
Get the line series. This is a vector of NFLineSets. To set a property on the line series, you must first retrieve the series, then set the property (properties) and finally set the line series.
     NFLinechart chart = new NFLinechart();
     NFLineSeries ls = chart.getLineSeries();
     NFLineSet set = (NFLineSet)ls.elementAt(0);
     // Set some of the properties on the NFLineSet
     ...
     ls.setElementAt(set, 0);
     chart.setLineSeries(ls);
 

Returns:
lineSeries

setLineValueLabel

public void setLineValueLabel(NFModalLabel lineValueLabel)
Set the text style to use for line labels.

Parameters:
lineValueLabel - Text style.

getLineValueLabel

public NFModalLabel getLineValueLabel()
Get the text style to use for line labels.

Returns:
text style or null if not defined.

setLineValueLabelRegion

public void setLineValueLabelRegion(NFRegion lineValueRegion)
Set the text background style to use for line labels.

Parameters:
lineValueRegion - Text background style.

getLineValueLabelRegion

public NFRegion getLineValueLabelRegion()
Get the text background style to use for line labels.

Returns:
text background style.

setLineDropShadow

public void setLineDropShadow(NFDropShadow lineDropShadow)
Set the drop shadow for the lines

Parameters:
lineDropShadow - The drop shadow to use under the lines

getLineDropShadow

public NFDropShadow getLineDropShadow()
Get the drop shadow for the lines

Returns:
The drop shadow to use under the lines

setLineSymbolAnimationStyle

public void setLineSymbolAnimationStyle(int style)
Set the line symbol animation style.

If the value passed is not a valid line symbol animation style, LINE_SYMBOL_ANIMATION_STYLE_NONE will be used.

Parameters:
style - One of LINE_SYMBOL_ANIMATION_STYLE_NONE (default), LINE_SYMBOL_ANIMATION_STYLE_SCALE or LINE_SYMBOL_ANIMATION_STYLE_FADE

getLineSymbolAnimationStyle

public int getLineSymbolAnimationStyle()
Get the line symbol animation style.

Returns:
type One of LINE_SYMBOL_ANIMATION_STYLE_NONE (default), LINE_SYMBOL_ANIMATION_STYLE_SCALE or LINE_SYMBOL_ANIMATION_STYLE_FADE

setLineAnimationStyle

public void setLineAnimationStyle(int style)
Set the line animation style.

If the value passed is not a valid line animation style, LINE_ANIMATION_STYLE_NONE will be used.

Parameters:
style - One of LINE_ANIMATION_STYLE_NONE (default), LINE_ANIMATION_STYLE_BEND or LINE_ANIMATION_STYLE_FADE

getLineAnimationStyle

public int getLineAnimationStyle()
Get the line animation style.

Returns:
type One of LINE_ANIMATION_STYLE_NONE (default), LINE_ANIMATION_STYLE_BEND or LINE_ANIMATION_STYLE_FADE

setLineSymbolSpotlightSeries

public void setLineSymbolSpotlightSeries(NFSpotlightSeries lineSymbolSpotlightSeries)
Set the line symbol spotlight series.

Parameters:
lineSymbolSpotlightSeries - The series of line symbol spotlights

getLineSymbolSpotlightSeries

public NFSpotlightSeries getLineSymbolSpotlightSeries()
Get the line symbol spotlight series.

Returns:
The series of line symbol spotlights

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

NetCharts Pro


Visual Mining, Inc.
2099 Gaither Rd.
Suite 220
Rockville, MD 20850
800.308.0731
301.947.8293 FAX

Copyright © Visual Mining, Inc. 1996 - 2018
All Rights Reserved.

NetCharts Pro TM is a registered trademark of Visual Mining, Inc. Other brands and their products are trademarks of their respective holders.

Last Modified: Jan 7, 2018