netcharts.pro.charts.radar
Class NFRadarchart

java.lang.Object
  netcharts.pro.common.NFGraph
      netcharts.pro.common.circular.NFSizedChart
          netcharts.pro.charts.radar.NFRadarchart

All Implemented Interfaces:

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

public class NFRadarchart
extends NFSizedChart

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

See Also:

Serialized Form

Field Summary

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.circular.NFSizedChart

SIZE_MAX_HEIGHT_DEFAULT, SIZE_MAX_WIDTH_DEFAULT, SIZE_MIN_HEIGHT_DEFAULT, SIZE_MIN_WIDTH_DEFAULT

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

NFRadarchart()
Constructs a default chart object.

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

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

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

Method Summary

void	addAxis(NFRadialAxis axis) Adds an axis to the current list of radial axes.
void	addAxis(java.lang.String axisName, double min, double max, double step) Adds an axis to the current list of radial axes.
NFRadialAxisSeries	getAxisSeries() Gets the radial axis series.
double	getCenterRadius() Gets the gap in the center of the radar chart as a percentage
java.lang.String	getDefaultData() Returns a string of default data
NFVector	getGridSeries() Gets the grid objects for this chart.
NFRadialLineSeries	getLineSeries() Get the line series.
int	getLineSymbolAnimationStyle() Get the line symbol animation style.
NFModalLabel	getLineValueLabel() Get the text style to use for line labels.
NFRegion	getLineValueLabelRegion() Get the text background style to use for line labels.
boolean	getRadarSquare() Get radar square
int	getType() Gets the chart type.
void	resetState() Resets all of the parameter values to their initial state.
void	setAxisSeries(NFRadialAxisSeries axisSeries) Sets the radial axis series.
void	setCenterRadius(double centerRadius) Sets the gap in the center of the radar chart as a percentage
void	setGridSeries(NFVector gridSeries) Sets the grid objects for this chart.
void	setLineSeries(NFRadialLineSeries lineSeries) Set the line series.
void	setLineSymbolAnimationStyle(int style) Set the line symbol animation style.
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	setRadarSize(int minWidth, int minHeight, int maxWidth, int maxHeight) Set the minimum and maximum size of the Radarchart.
void	setRadarSquare(boolean radarSquare) Set radar square
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.circular.NFSizedChart

getMaxHeight, getMaxWidth, getMinHeight, getMinWidth, setMaxHeight, setMaxWidth, setMinHeight, setMinWidth

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

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

Constructor Detail

NFRadarchart

public NFRadarchart()

Constructs a default chart object.

NFRadarchart

public NFRadarchart(javax.swing.JPanel panel)

Constructs a chart object on the given JPanel.

Parameters:

panel - Panel to draw chart on.

NFRadarchart

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

NFRadarchart

public NFRadarchart(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.radar.NFGraph.RADAR

addAxis

public void addAxis(NFRadialAxis axis)
             throws NFParamException

Adds an axis to the current list of radial axes.

Parameters:

axis - The axis to add.

Throws:

NFParamException

addAxis

public void addAxis(java.lang.String axisName,
                    double min,
                    double max,
                    double step)
             throws NFParamException

Adds an axis to the current list of radial axes.

Parameters:

min - Minimum value

max - Maximum value

step - Tic step

Throws:

NFParamException

setAxisSeries

public void setAxisSeries(NFRadialAxisSeries axisSeries)
                   throws NFParamException

Sets the radial axis series. To set a property on the axis series, you must first retrieve the series, then set the property (properties) and finally set the dial series.

     NFRadarchart chart = new NFRadarchart();
     NFRadialAxisSeries ras = chart.getAxisSeries();
     NFRadialAxis axis = (NFRadialAxis)ras.elementAt(0);
     // Set some of the properties on the NFDial
     ...
     ras.setElementAt(axis, 0);
     chart.setAxisSeries(ras);
 

Parameters:

axisSeries -

Throws:

NFParamException

getAxisSeries

public NFRadialAxisSeries getAxisSeries()

Gets the radial axis series. To set a property on the axis series, you must first retrieve the series, then set the property (properties) and finally set the dial series.

     NFRadarchart chart = new NFRadarchart();
     NFRadialAxisSeries ras = chart.getAxisSeries();
     NFRadialAxis axis = (NFRadialAxis)ras.elementAt(0);
     // Set some of the properties on the NFDial
     ...
     ras.setElementAt(axis, 0);
     chart.setAxisSeries(ras);
 

Returns:

axisSeries

setGridSeries

public void setGridSeries(NFVector gridSeries)
                   throws NFParamException

Sets the grid objects for this chart. To set a property on the grid series, you must first retrieve the series, then set the property (properties) and finally set the line series.

         NFRadarchart chart = new NFRadarchart();
         NFVector gridSeries = chart.getGridSeries();
         NFRadialGrid grid = null;
         if (gridSeries == null) {
                 gridSeries = new NFVector();
                 grid = new NFRadialGrid();
         }
         else
                 grid = (NFRadialGrid) gridSeries.elementAt(0);

         // Set some of the properties on the NFRadialGrid
        ...

         gridSeries.setElementAt(grid, 0);
         chart.setGridSeries(gridSeries);
 

Parameters:

gridSeries - Vector of NFRadialGrid objects

Throws:

NFParamException

getGridSeries

public NFVector getGridSeries()

Gets the grid objects for this chart. To set a property on the grid series, you must first retrieve the series, then set the property (properties) and finally set the line series.

         NFRadarchart chart = new NFRadarchart();
         NFVector gridSeries = chart.getGridSeries();
         NFRadialGrid grid = null;
         if (gridSeries == null) {
                 gridSeries = new NFVector();
                 grid = new NFRadialGrid();
         }
         else
                 grid = (NFRadialGrid) gridSeries.elementAt(0);

         // Set some of the properties on the NFRadialGrid
        ...

         gridSeries.setElementAt(grid, 0);
         chart.setGridSeries(gridSeries);
 

Returns:

gridSeries or null if not set.

setRadarSquare

public void setRadarSquare(boolean radarSquare)
                    throws NFParamException

Set radar square

Parameters:

radarSquare - When true, the radar area will always have a consistent width and height. When false, the radar area will attempt to use all available width and height

Throws:

NFParamException

getRadarSquare

public boolean getRadarSquare()

Get radar square

Returns:

radarSquare When true, the radar area will always have a consistent width and height. When false, the radar area will attempt to use all available width and height

setCenterRadius

public void setCenterRadius(double centerRadius)

Sets the gap in the center of the radar chart as a percentage

Parameters:

centerRadius -

getCenterRadius

public double getCenterRadius()

Gets the gap in the center of the radar chart as a percentage

Returns:

centerRadius

setLineSeries

public void setLineSeries(NFRadialLineSeries 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.

     NFRadarchart chart = new NFRadarchart();
     NFRadialLineSeries rls = chart.getLineSeries();
     NFLineSet set = (NFLineSet)rls.elementAt(0);
     // Set some of the properties on the NFLineSet
     ...
     rls.setElementAt(set, 0);
     chart.setLineSeries(rls);
 

Parameters:

lineSeries -

Throws:

NFParamException

getLineSeries

public NFRadialLineSeries 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.

     NFRadarchart chart = new NFRadarchart();
     NFRadialLineSeries rls = chart.getLineSeries();
     NFLineSet set = (NFLineSet)rls.elementAt(0);
     // Set some of the properties on the NFLineSet
     ...
     rls.setElementAt(set, 0);
     chart.setLineSeries(rls);
 

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.

setRadarSize

public void setRadarSize(int minWidth,
                         int minHeight,
                         int maxWidth,
                         int maxHeight)
                  throws NFParamException

Set the minimum and maximum size of the Radarchart. To specify no value, set to -1.

Parameters:

minWidth - The minimum width of the Radarchart.

minHeight - The minimum height of the Radarchart.

maxWidth - The maximum width of the Radarchart.

maxHeight - The maximum height of the Radarchart.

Throws:

NFParamException

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

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 NFGraph

Throws:

java.io.IOException

writeChart

public void writeChart(java.lang.StringBuffer sb)

Writes this chart into a string buffer

Overrides:

writeChart in class NFSizedChart

resetState

public void resetState()

Resets all of the parameter values to their initial state.

Overrides:

resetState in class NFSizedChart