NetCharts Pro

netcharts.pro.charts.combo
Class NFCombochart

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
                  extended by netcharts.pro.charts.combo.NFCombochart
All Implemented Interfaces:
java.io.Externalizable, java.io.Serializable, NFDragObserver, NFDwellObserver, NFGraphObserver, NFScrollObserver
Direct Known Subclasses:
NFStockchart

public class NFCombochart
extends NFAbstractLineChart

Represents a combo chart (allowing for both bars and line). Provides the ability to configure the chart via object manipulation or directly from CDL.

See Also:
Serialized Form

Field Summary
static int BAR_ANIMATION_STYLE_FADE
          Bar animation style fade
static int BAR_ANIMATION_STYLE_GROW
          Bar animation style grow
static int BAR_ANIMATION_STYLE_NONE
          No bar animation style
static int BOTTOMUP
          Stack bar sets from the bottom up when barchart type is stack
static java.util.Hashtable connectorTypeMap
          stacked barchart connector type hashtable
static int DRAWBAR
          Draw bar - used in setDrawOrder
static int DRAWFILL
          Draw fill - used in setDrawOrder
static int DRAWLINE
          Draw line - used in setDrawOrder
static java.util.Hashtable drawOrderMap
          draw order hashtable
static int DRAWSTOCK
          Draw stock - used in setDrawOrder.
static int FILL
          Connector type fill
static int GROUP
          Group barchart type
static int GROUPSTACK
          Stacked/Grouped barchart type
static int HORIZONTAL
          Horizontal orientation
static int ITEM
          Discrete value shown on popup when barchart type is stack
static int LINE
          Connector type line
static int OFF
          Connector type off
static int ROWS
          Row barchart type
static int STACK
          Stacked barchart type
static java.util.Hashtable stackDisplayOrderMap
          stack display order hashtable
static int TOPDOWN
          Stack bar sets from the top down when barchart type is stack
static int TOTAL
          Total value shown on popup when barchart type is stack
static int VERTICAL
          Vertical orientation
 
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, MULTIPIE, PARETO, PIE, POLAR, RADAR, STOCK, STRIP, TIME, XY
 
Constructor Summary
NFCombochart()
          Constructs a default chart object.
NFCombochart(javax.swing.JPanel panel)
          Constructs a chart object on the given JPanel.
NFCombochart(javax.swing.JPanel panel, java.util.Properties initProperties)
          Constructs a chart object on the given JPanel.
NFCombochart(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.
 NFVector getBarActiveLabels()
          Get active labels to be associated with each bar data label.
 int getBarAnimationStyle()
          Get the bar animation style.
 NFLine getBarBorder()
          Get barBorder for this chart
 int getBarchartType()
          Get bar type, either GROUP (default) STACK, GROUPSTACK, or ROWS
 NFCorners getBarCorners()
          Get the corners of the bars
 int getBarDepth()
          Get 3DDepth for bars
 NFDropShadow getBarDropShadow()
          Get the drop shadow for the bars
 NFBarHighlightSeries getBarHighlightSeries()
          Get the bar highlight series.
 NFBarSeries getBarSeries()
          Get the bar series.
 NFSpotlightSeries getBarSpotlightSeries()
          Get the bar spotlight series.
 NFModalLabel getBarValueLabel()
          Get the text style to use for labeling bars.
 NFRegion getBarValueLabelRegion()
          Get the text background style to use for labeling bars in this barset.
 int getBarWidth()
          Get bar width.
 NFVector getBarWidths()
          Get the bar widths.
 NFVector getDataLabels()
          Get the labels to be displayed under each bar.
 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[] getDrawOrder()
          Get the draw order.
 NFVector getGroupStackLabels()
          Get the labels to be displayed under each stack in a GROUPSTACK chart.
 NFVector getGroupStackSegmentLabels()
          Get the labels to be displayed in the legend for segments of a stack in GROUPSTACK mode.
 boolean getLineLabelsEnabled()
          Get whether or not popups over lines are enabled.
 NFLineSeries getLineSeries()
          Get the line series.
 int getOrientation()
          Get graph orientation, either VERTICAL (default) or HORIZONTAL
 boolean getShowGroupStackLabels()
          Get whether the group stack labels should be displayed when in GROUPSTACK mode.
 int getStackDisplayOrder()
          Get barchart stack display order, either BOTTOMUP or TOPDOWN.
 int getStackedBarConnector()
          Get stacked bar connector type, either OFF (default), LINE or FILL.
 int getStackType()
          Get bar stack type, either TOTAL or ITEM.
 int getType()
          Gets the chart type.
 NFModalLabel getZAxisLabels()
          Returns the text style and value to use for labeling the Z Axis.
 boolean isDataLegendEnabled()
          Get whether the data legend is enabled or not.
 void resetState()
          Resets all of the parameter values to their initial state.
 void setBarActiveLabels(NFVector barActiveLabels)
          Set active labels to be associated with each bar data label.
 void setBarAnimationStyle(int style)
          Set the bar animation style.
 void setBarBorder(NFLine barBorder)
          Set border for this chart
 void setBarchartType(int type)
          Set bar type, either GROUP (default) STACK, GROUPSTACK, or ROWS
 void setBarCorners(NFCorners barCorners)
          Set the corners of the bars
 void setBarDepth(int depth)
          Set 3DDepth for bars
 void setBarDropShadow(NFDropShadow barDropShadow)
          Set the drop shadow for the bars
 void setBarHighlightSeries(NFBarHighlightSeries barHighlightSeries)
          Set the bar highlight series.
 void setBarSeries(NFBarSeries barSeries)
          Set the bar series.
 void setBarSpotlightSeries(NFSpotlightSeries barSpotlightSeries)
          Set the bar spotlight series.
 void setBarValueLabel(NFModalLabel barValueLabel)
          Set the text style to use for labeling bars in this barset.
 void setBarValueLabelRegion(NFRegion barValueRegion)
          Set the text background style to use for labeling bars in this barset.
 void setBarWidth(int barWidth)
          Set bar width.
 void setBarWidths(NFVector barWidths)
          Set the bar widths.
 void setDataLabels(NFVector dataLabels)
          Set the labels to be displayed under each bar.
 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 setDrawOrder(int[] drawOrder)
          Set the draw order.
 void setGroupStackLabels(NFVector groupStackLabels)
          Set the labels to be displayed under each stack in a GROUPSTACK chart.
 void setGroupStackSegmentLabels(NFVector groupStackSegmentLabels)
          Set the labels to be displayed in the legend for segments of a stack in GROUPSTACK mode.
 void setLineLabelsEnabled(boolean lineLabelsEnabled)
          Set enable popup labels over lines.
 void setLineSeries(NFLineSeries lineSeries)
          Set the line series.
 void setOrientation(int orientation)
          Set graph orientation, either VERTICAL (default) or HORIZONTAL
 void setShowGroupStackLabels(boolean showGroupStackLabels)
          Set whether the group stack labels should be displayed when in GROUPSTACK mode.
 void setStackDisplayOrder(int stackDisplayOrder)
          Set barchart stack display order, either BOTTOMUP or TOPDOWN.
 void setStackedBarConnector(int type)
          Set stacked bar connector type, either OFF (default), LINE or FILL.
 void setStackType(int stackType)
          Set bar stack type, either TOTAL or ITEM.
 void setZAxisLabels(NFModalLabel zAxisLabel)
          Set the text style and value to use for labeling the Z Axis.
 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
getDepth, getLineAnimationStyle, getLineDropShadow, getLineSymbolAnimationStyle, getLineSymbolSpotlightSeries, getLineValueLabel, getLineValueLabelRegion, getLineZWidth, setDepth, setLineAnimationStyle, setLineDropShadow, 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

OFF

public static final int OFF
Connector type off

See Also:
Constant Field Values

LINE

public static final int LINE
Connector type line

See Also:
Constant Field Values

FILL

public static final int FILL
Connector type fill

See Also:
Constant Field Values

connectorTypeMap

public static java.util.Hashtable connectorTypeMap
stacked barchart connector type hashtable


HORIZONTAL

public static final int HORIZONTAL
Horizontal orientation


VERTICAL

public static final int VERTICAL
Vertical orientation


ROWS

public static final int ROWS
Row barchart type

See Also:
Constant Field Values

STACK

public static final int STACK
Stacked barchart type

See Also:
Constant Field Values

GROUP

public static final int GROUP
Group barchart type

See Also:
Constant Field Values

GROUPSTACK

public static final int GROUPSTACK
Stacked/Grouped barchart type

See Also:
Constant Field Values

TOTAL

public static final int TOTAL
Total value shown on popup when barchart type is stack

See Also:
Constant Field Values

ITEM

public static final int ITEM
Discrete value shown on popup when barchart type is stack

See Also:
Constant Field Values

DRAWBAR

public static final int DRAWBAR
Draw bar - used in setDrawOrder

See Also:
Constant Field Values

DRAWLINE

public static final int DRAWLINE
Draw line - used in setDrawOrder

See Also:
Constant Field Values

DRAWFILL

public static final int DRAWFILL
Draw fill - used in setDrawOrder

See Also:
Constant Field Values

DRAWSTOCK

public static final int DRAWSTOCK
Draw stock - used in setDrawOrder. Use only in NFStockchart implementations.

See Also:
Constant Field Values

BOTTOMUP

public static final int BOTTOMUP
Stack bar sets from the bottom up when barchart type is stack


TOPDOWN

public static final int TOPDOWN
Stack bar sets from the top down when barchart type is stack


stackDisplayOrderMap

public static java.util.Hashtable stackDisplayOrderMap
stack display order hashtable


drawOrderMap

public static java.util.Hashtable drawOrderMap
draw order hashtable


BAR_ANIMATION_STYLE_NONE

public static final int BAR_ANIMATION_STYLE_NONE
No bar animation style

See Also:
Constant Field Values

BAR_ANIMATION_STYLE_GROW

public static final int BAR_ANIMATION_STYLE_GROW
Bar animation style grow

See Also:
Constant Field Values

BAR_ANIMATION_STYLE_FADE

public static final int BAR_ANIMATION_STYLE_FADE
Bar animation style fade

See Also:
Constant Field Values
Constructor Detail

NFCombochart

public NFCombochart()
Constructs a default chart object.


NFCombochart

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

Parameters:
panel - Panel to draw chart on.

NFCombochart

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

NFCombochart

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

setStackDisplayOrder

public void setStackDisplayOrder(int stackDisplayOrder)
Set barchart stack display order, either BOTTOMUP or TOPDOWN. This parameter affects which direction the bars are stacked in STACK mode.

Parameters:
stackDisplayOrder - One of BOTTOMUP, TOPDOWN

getStackDisplayOrder

public int getStackDisplayOrder()
Get barchart stack display order, either BOTTOMUP or TOPDOWN. This parameter affects which direction the bars are stacked in STACK mode.

Returns:
One of BOTTOMUP, TOPDOWN

setShowGroupStackLabels

public void setShowGroupStackLabels(boolean showGroupStackLabels)
Set whether the group stack labels should be displayed when in GROUPSTACK mode.

Parameters:
showGroupStackLabels - true if the labels should be shown

getShowGroupStackLabels

public boolean getShowGroupStackLabels()
Get whether the group stack labels should be displayed when in GROUPSTACK mode.

Returns:
true if the labels should be shown, false otherwise

setBarAnimationStyle

public void setBarAnimationStyle(int style)
Set the bar animation style.

If the value passed is not a valid bar animation style, BAR_ANIMATION_STYLE_NONE will be used.

Parameters:
style - One of BAR_ANIMATION_STYLE_NONE (default), BAR_ANIMATION_STYLE_GROW or BAR_ANIMATION_STYLE_FADE

getBarAnimationStyle

public int getBarAnimationStyle()
Get the bar animation style.

Returns:
type One of BAR_ANIMATION_STYLE_NONE (default), BAR_ANIMATION_STYLE_GROW or BAR_ANIMATION_STYLE_FADE

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.NFGraph.XY

addLineSet

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

Overrides:
addLineSet in class NFAbstractLineChart
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 bs = chart.getLineSeries();
     NFLineSet set = (NFLineSet)ls.elementAt(0);
     // Set some of the properties on the NFLineSet
     ...
     bs.setElementAt(set, 0);
     chart.setLineSeries(bs);
 

Overrides:
setLineSeries in class NFAbstractLineChart
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);
 

Overrides:
getLineSeries in class NFAbstractLineChart
Returns:
lineSeries

setBarBorder

public void setBarBorder(NFLine barBorder)
Set border for this chart

Parameters:
barBorder - The line style to use for the bar border

getBarBorder

public NFLine getBarBorder()
Get barBorder for this chart

Returns:
barBorder The line style to use for the bar border

setBarDepth

public void setBarDepth(int depth)
Set 3DDepth for bars

Parameters:
depth - 3D shadow depth for bars

getBarDepth

public int getBarDepth()
Get 3DDepth for bars

Returns:
depth 3D shadow depth for bars

setBarWidth

public void setBarWidth(int barWidth)
Set bar width. Defines the relative width of the bar as a percentage of available space. A smaller number results in more space between bars.

Parameters:
barWidth -

setBarWidths

public void setBarWidths(NFVector barWidths)
Set the bar widths. Defines the relative width of the bar as a percentage of available space. A smaller number results in more space between bars.

Parameters:
barWidths -

getBarWidth

public int getBarWidth()
Get bar width. Defines the relative width of the bar as a percentage of available space. A smaller number results in more space between bars.

Returns:
barWidth

getBarWidths

public NFVector getBarWidths()
Get the bar widths. Defines the relative width of the bar as a percentage of available space. A smaller number results in more space between bars.

Returns:
barWidths

setOrientation

public void setOrientation(int orientation)
Set graph orientation, either VERTICAL (default) or HORIZONTAL

Parameters:
orientation -

getOrientation

public int getOrientation()
Get graph orientation, either VERTICAL (default) or HORIZONTAL

Returns:
orientation

setBarchartType

public void setBarchartType(int type)
Set bar type, either GROUP (default) STACK, GROUPSTACK, or ROWS

Parameters:
type -

getBarchartType

public int getBarchartType()
Get bar type, either GROUP (default) STACK, GROUPSTACK, or ROWS

Returns:
type

setStackType

public void setStackType(int stackType)
Set bar stack type, either TOTAL or ITEM. This parameter affects how data values will be shown on the bar mouseover popup. When stackType is TOTAL, the total value of the bar will be shown. When stackType is ITEM, the value of the moused over segment will be displayed.

Parameters:
stackType -

getStackType

public int getStackType()
Get bar stack type, either TOTAL or ITEM. This parameter affects how data values will be shown on the bar mouseover popup. When stackType is TOTAL, the total value of the bar will be shown. When stackType is ITEM, the value of the moused over segment will be displayed.

Returns:
stackType

setDataLabels

public void setDataLabels(NFVector dataLabels)
                   throws NFParamException
Set the labels to be displayed under each bar. The vector contains a list of string values.

Throws:
NFParamException

getDataLabels

public NFVector getDataLabels()
Get the labels to be displayed under each bar. The vector contains a list of string values.

Returns:
dataLabels

setGroupStackLabels

public void setGroupStackLabels(NFVector groupStackLabels)
Set the labels to be displayed under each stack in a GROUPSTACK chart. The vector contains a list of string values.


getGroupStackLabels

public NFVector getGroupStackLabels()
Get the labels to be displayed under each stack in a GROUPSTACK chart. The vector contains a list of string values.

Returns:
groupStackLabels

setGroupStackSegmentLabels

public void setGroupStackSegmentLabels(NFVector groupStackSegmentLabels)
Set the labels to be displayed in the legend for segments of a stack in GROUPSTACK mode. The vector contains a list of string values.


getGroupStackSegmentLabels

public NFVector getGroupStackSegmentLabels()
Get the labels to be displayed in the legend for segments of a stack in GROUPSTACK mode. The vector contains a list of string values.

Returns:
groupStackSegmentLabels

setBarActiveLabels

public void setBarActiveLabels(NFVector barActiveLabels)
                        throws NFParamException
Set active labels to be associated with each bar data label.

Parameters:
barActiveLabels - Vector of NFActiveLabels
Throws:
NFParamException

getBarActiveLabels

public NFVector getBarActiveLabels()
Get active labels to be associated with each bar data label.

Returns:
barActiveLabels Vector of NFActiveLabels

setBarSeries

public void setBarSeries(NFBarSeries barSeries)
                  throws NFParamException
Set the bar series. This is a vector of barsets. To set a property on the bar series, you must first retrieve the series, then set the property (properties) and finally set the bar series.
     NFBarchart chart = new NFBarchart();
     NFBarSeries bs = chart.getBarSeries();
     NFBarSet set = (NFBarSet)bs.elementAt(0);
     // Set some of the properties on the NFBarSet
     ...
     bs.setElementAt(set, 0);
     chart.setBarSeries(bs);
 

Parameters:
barSeries -
Throws:
NFParamException

getBarSeries

public NFBarSeries getBarSeries()
Get the bar series. This is a vector of barsets. To set a property on the bar series, you must first retrieve the series, then set the property (properties) and finally set the bar series.
     NFBarchart chart = new NFBarchart();
     NFBarSeries bs = chart.getBarSeries();
     NFBarSet set = (NFBarSet)bs.elementAt(0);
     // Set some of the properties on the NFBarSet
     ...
     bs.setElementAt(set, 0);
     chart.setBarSeries(bs);
 

Returns:
barSeries

setBarValueLabel

public void setBarValueLabel(NFModalLabel barValueLabel)
Set the text style to use for labeling bars in this barset.

Parameters:
barValueLabel - Text style.

getBarValueLabel

public NFModalLabel getBarValueLabel()
Get the text style to use for labeling bars.

Returns:
text style or null if not defined.

setBarValueLabelRegion

public void setBarValueLabelRegion(NFRegion barValueRegion)
Set the text background style to use for labeling bars in this barset.

Parameters:
barValueRegion - Text background style.

getBarValueLabelRegion

public NFRegion getBarValueLabelRegion()
Get the text background style to use for labeling bars in this barset.

Returns:
text background style.

setDrawOrder

public void setDrawOrder(int[] drawOrder)
                  throws NFParamException
Set the draw order. This determines the order in which data elements of this chart will be drawn. The drawOrder is sent in as an int array. Each element is expected to contain one of: NFCombochart.DRAWBAR NFCombochart.DRAWLINE NFCombochart.DRAWFILL NFCombochart.DRAWSTOCK The objects will be drawn according to their position in the list (e.g. the first in the list is drawn first).

Parameters:
drawOrder -
Throws:
NFParamException

getDrawOrder

public int[] getDrawOrder()
Get the draw order. This determines the order in which data elements of this chart will be drawn. The drawOrder is sent in as an int array. Each element is expected to contain one of: NFCombochart.DRAWBAR NFCombochart.DRAWLINE NFCombochart.DRAWFILL NFCombochart.DRAWSTOCK The objects will be drawn according to their position in the list (e.g. the first in the list is drawn first).

Returns:
drawOrder

setZAxisLabels

public void setZAxisLabels(NFModalLabel zAxisLabel)
Set the text style and value to use for labeling the Z Axis.

Parameters:
zAxisLabel - Text style and value

getZAxisLabels

public NFModalLabel getZAxisLabels()
Returns the text style and value to use for labeling the Z Axis.

Returns:
text style or null if not defined

setLineLabelsEnabled

public void setLineLabelsEnabled(boolean lineLabelsEnabled)
Set enable popup labels over lines.

Parameters:
lineLabelsEnabled - When popups will appear over lines of the chart.

getLineLabelsEnabled

public boolean getLineLabelsEnabled()
Get whether or not popups over lines are enabled.

Returns:
lineLabelsEnabled When popups will appear over lines of the chart.

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

setStackedBarConnector

public void setStackedBarConnector(int type)
Set stacked bar connector type, either OFF (default), LINE or FILL.

If the value passed is not a valid barchart type, OFF will be used.

Parameters:
type - One of OFF, LINE or FILL

getStackedBarConnector

public int getStackedBarConnector()
Get stacked bar connector type, either OFF (default), LINE or FILL.

Returns:
type One of OFF, LINE or FILL

setBarHighlightSeries

public void setBarHighlightSeries(NFBarHighlightSeries barHighlightSeries)
Set the bar highlight series.

Parameters:
barHighlightSeries - The series of bar highlights

getBarHighlightSeries

public NFBarHighlightSeries getBarHighlightSeries()
Get the bar highlight series.

Returns:
The series of bar highlights

setBarSpotlightSeries

public void setBarSpotlightSeries(NFSpotlightSeries barSpotlightSeries)
Set the bar spotlight series.

Parameters:
barSpotlightSeries - The series of bar spotlights

getBarSpotlightSeries

public NFSpotlightSeries getBarSpotlightSeries()
Get the bar spotlight series.

Returns:
The series of bar spotlights

setBarDropShadow

public void setBarDropShadow(NFDropShadow barDropShadow)
Set the drop shadow for the bars

Parameters:
barDropShadow - The drop shadow to use under the bars

getBarDropShadow

public NFDropShadow getBarDropShadow()
Get the drop shadow for the bars

Returns:
The drop shadow to use under the bars

setBarCorners

public void setBarCorners(NFCorners barCorners)
Set the corners of the bars

Parameters:
barCorners - The corners of the bars

getBarCorners

public NFCorners getBarCorners()
Get the corners of the bars

Returns:
The corners of the bars

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

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 - 2011
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: Jun 28, 2011