com.imsl.chart

Class Bar

java.lang.Object

com.imsl.chart.AbstractChartNode

com.imsl.chart.ChartNode

com.imsl.chart.Data

com.imsl.chart.Bar

All Implemented Interfaces:

Serializable, Cloneable

Direct Known Subclasses:

ParetoChart

public class Bar
extends Data

A bar chart.

The class Bar has children of class BarItem. The attribute "BarItem" in class Bar is set to the BarItem array of children.

See Also:

Example, BarSet, BarItem, Chart Programmer's Guide: Bar Chart, Chart Programmer's Guide: Histogram, Serialized Form

Field Summary

Fields inherited from class com.imsl.chart.ChartNode

AXIS_X_TOP, AXIS_Y_RIGHT, BAR_TYPE_HORIZONTAL, BAR_TYPE_VERTICAL, DASH_PATTERN_DASH, DASH_PATTERN_DASH_DOT, DASH_PATTERN_DOT, DASH_PATTERN_SOLID, DATA_TYPE_FILL, DATA_TYPE_LINE, DATA_TYPE_MARKER, DATA_TYPE_PICTURE, DATA_TYPE_TUBE, DENDROGRAM_TYPE_HORIZONTAL, DENDROGRAM_TYPE_VERTICAL, FILL_TYPE_GRADIENT, FILL_TYPE_NONE, FILL_TYPE_PAINT, FILL_TYPE_SOLID, LABEL_TYPE_PERCENT, MARKER_TYPE_ASTERISK, MARKER_TYPE_CIRCLE_CIRCLE, MARKER_TYPE_CIRCLE_PLUS, MARKER_TYPE_CIRCLE_X, MARKER_TYPE_DIAMOND_PLUS, MARKER_TYPE_FILLED_CIRCLE, MARKER_TYPE_FILLED_DIAMOND, MARKER_TYPE_FILLED_SQUARE, MARKER_TYPE_FILLED_TRIANGLE, MARKER_TYPE_HOLLOW_CIRCLE, MARKER_TYPE_HOLLOW_DIAMOND, MARKER_TYPE_HOLLOW_SQUARE, MARKER_TYPE_HOLLOW_TRIANGLE, MARKER_TYPE_OCTAGON_PLUS, MARKER_TYPE_OCTAGON_X, MARKER_TYPE_PLUS, MARKER_TYPE_SQUARE_PLUS, MARKER_TYPE_SQUARE_X, MARKER_TYPE_X, TEXT_X_CENTER, TEXT_X_LEFT, TEXT_X_RIGHT, TEXT_Y_BOTTOM, TEXT_Y_CENTER, TEXT_Y_TOP

Fields inherited from class com.imsl.chart.AbstractChartNode

AUTOSCALE_DATA, AUTOSCALE_DENSITY, AUTOSCALE_NUMBER, AUTOSCALE_OFF, AUTOSCALE_WINDOW, AXIS_X, AXIS_Y, AXIS_Z, LABEL_TYPE_NONE, LABEL_TYPE_TITLE, LABEL_TYPE_X, LABEL_TYPE_Y, LABEL_TYPE_Z, TRANSFORM_CUSTOM, TRANSFORM_LINEAR, TRANSFORM_LOG

Constructor Summary

Constructors

Constructor and Description
Bar(AxisXY axis) Constructs a bar chart.
Bar(AxisXY axis, double[] y) Constructs a simple bar chart using supplied y data.
Bar(AxisXY axis, double[][] y) Constructs a grouped bar chart using supplied x and y data.
Bar(AxisXY axis, double[][][] y) Constructs a stacked, grouped bar chart using supplied y data.
Bar(AxisXY axis, double[] x, double[] y) Constructs a simple bar chart using supplied x and y data.
Bar(AxisXY axis, double[] x, double[][] y) Constructs a grouped bar chart using supplied x and y data.
Bar(AxisXY axis, double[] x, double[][][] y) Constructs a stacked, grouped bar chart using supplied x and y data.

Method Summary

Methods

Modifier and Type	Method and Description
void	dataRange(double[] range) Update the data range, range = {xmin,xmax,ymin,ymax}.
double[][][]	getBarData() Returns the "BarData" attribute.
BarSet[][]	getBarSet() Returns the BarSet object.
BarSet	getBarSet(int group) Returns the BarSet object.
BarSet	getBarSet(int stack, int group) Returns the BarSet object.
void	paint(Draw draw) Paints this node and all of its children.
void	setBarData(double[][][] value) Convenience routine to set the "BarData" attribute.
void	setLabels(String[] labels) Sets up an axis with bar labels.
void	setLabels(String[] labels, int type) Sets up an axis with bar labels.

Methods inherited from class com.imsl.chart.Data

formatLabel

Methods inherited from class com.imsl.chart.ChartNode

addPickListener, firePickListeners, getALT, getAxis, getBackground, getBarGap, getBarType, getBarWidth, getChart, getChartTitle, getChildren, getClipData, getComponent, getConcatenatedViewport, getDataType, getDoubleBuffering, getExplode, getFillOutlineColor, getFillOutlineType, getFillPaint, getFillType, getGradient, getHREF, getLegend, getLineDashPattern, getMarkerDashPattern, getMarkerThickness, getMarkerType, getParent, getReference, getScreenAxis, getScreenSize, getScreenViewport, getSize, getSkipWeekends, getTextAngle, getTextColor, getTitle, getToolTip, getViewport, isBitSet, prePaint, removePickListener, setALT, setBarGap, setBarType, setBarWidth, setChartTitle, setClipData, setCustomTransform, setDataType, setDoubleBuffering, setExplode, setFillOutlineColor, setFillOutlineColor, setFillOutlineType, setFillPaint, setFillPaint, setFillPaint, setFillType, setGradient, setGradient, setGradient, setHREF, setImage, setLineDashPattern, setMarkerDashPattern, setMarkerThickness, setMarkerType, setReference, setScreenSize, setSize, setSkipWeekends, setTextAngle, setTextColor, setTextColor, setTitle, setTitle, setToolTip, setViewport, setViewport

Methods inherited from class com.imsl.chart.AbstractChartNode

clone, clone, clone, clone, getAbstractParent, getAttribute, getAutoscaleInput, getAutoscaleMinimumTimeInterval, getAutoscaleOutput, getBooleanAttribute, getChildList, getColorAttribute, getCustomTransform, getDensity, getDoubleAttribute, getFillColor, getFont, getFontName, getFontSize, getFontStyle, getImage, getIntegerAttribute, getLabelType, getLightColor, getLineColor, getLineWidth, getLocale, getMarkerColor, getMarkerSize, getName, getNumber, getPaint, getStringAttribute, getTextFormat, getTickLength, getTransform, getX, getY, isAncestorOf, isAttributeSet, isAttributeSetAtThisNode, parseColor, remove, setAttribute, setAutoscaleInput, setAutoscaleMinimumTimeInterval, setAutoscaleOutput, setDensity, setFillColor, setFillColor, setFont, setFontName, setFontSize, setFontStyle, setImage, setLabelType, setLightColor, setLightColor, setLineColor, setLineColor, setLineWidth, setLocale, setMarkerColor, setMarkerColor, setMarkerSize, setName, setNumber, setPaint, setTextFormat, setTextFormat, setTickLength, setTransform, setX, setY, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

Bar

public Bar(AxisXY axis)

Constructs a bar chart.

Parameters:

axis - the AxisXY parent of this node

Bar

public Bar(AxisXY axis,
   double[] y)

Constructs a simple bar chart using supplied y data.

Parameters:

axis - the AxisXY parent of this node

y - a double array which contains the y data for the simple bar chart

Bar

public Bar(AxisXY axis,
   double[][] y)

Constructs a grouped bar chart using supplied x and y data.

Parameters:

axis - the AxisXY parent of this node

y - a double array which contains the y data for the grouped bar chart. The first index refers to the group and the second refers to the x position.

Bar

public Bar(AxisXY axis,
   double[][][] y)

Constructs a stacked, grouped bar chart using supplied y data.

Parameters:

axis - the AxisXY parent of this node

y - a double array which contains the y data for the stacked, grouped bar chart. The first index refers to the stack, the second refers to the group and the third refers to the x position.

Bar

public Bar(AxisXY axis,
   double[] x,
   double[] y)

Constructs a simple bar chart using supplied x and y data.

Parameters:

axis - the AxisXY parent of this node

x - a double array which contains the x data for the simple bar chart

y - a double array which contains the y data for the simple bar chart

Bar

public Bar(AxisXY axis,
   double[] x,
   double[][] y)

Constructs a grouped bar chart using supplied x and y data.

Parameters:

axis - the AxisXY parent of this node

x - a double array which contains the x data for the grouped bar chart

y - a double array which contains the y data for the grouped bar chart. The first index refers to the group and the second refers to the x position.

Bar

public Bar(AxisXY axis,
   double[] x,
   double[][][] y)

Constructs a stacked, grouped bar chart using supplied x and y data.

Parameters:

axis - the AxisXY parent of this node

x - a double array which contains the x data for the stacked, grouped bar chart

y - a double array which contains the y data for the stacked, grouped bar chart. The first index refers to the "stack", the second refers to the group and the third refers to the x position.

Method Detail

dataRange

public void dataRange(double[] range)

Update the data range, range = {xmin,xmax,ymin,ymax}. The entries in range are updated to reflect the extent of the data in this node. The argument range is an input/output variable. Its value should be updated only if the data in this node is outside the range already in the array.

Overrides:

dataRange in class Data

Parameters:

range - a double array which contains the updated range, {xmin,xmax,ymin,ymax}

getBarData

public double[][][] getBarData()

Returns the "BarData" attribute.

Returns:

a BarData[][][] value

getBarSet

public BarSet[][] getBarSet()

Returns the BarSet object.

Returns:

a BarSet[][] value

getBarSet

public BarSet getBarSet(int group)

Returns the BarSet object. The group index is assumed to be zero. This method is most useful for charts with only a single group.

Parameters:

group - an int which specifies the group index

Returns:

a BarSet value

getBarSet

public BarSet getBarSet(int stack,
               int group)

Returns the BarSet object.

Parameters:

stack - an int which specifies the stack index

group - an int which specifies the group index

Returns:

a BarSet value

paint

public void paint(Draw draw)

Paints this node and all of its children. This is normally called only by the paint method in this node's parent.

Overrides:

paint in class Data

Parameters:

draw - the Draw object to be painted

setBarData

public void setBarData(double[][][] value)

Convenience routine to set the "BarData" attribute.

Parameters:

value - a BarData[][][] array of objects that make up this bar chart. The first index refers to the "stack", the second refers to the group and the third refers to the x position.

setLabels

public void setLabels(String[] labels)

Sets up an axis with bar labels. This turns off the tick marks and sets the BarType attribute. It also turns off autoscaling for the axis and sets its Window and Number and Ticks attribute as appropriate for a labeled bar chart. The existing value of the BarType attribute is used to determine the axis to be modified.

Parameters:

labels - a String array with which to label the axis. The number of labels must equal the number of items.

setLabels

public void setLabels(String[] labels,
             int type)

Sets up an axis with bar labels. This turns off the tick marks and sets the "BarType" attribute. It also turns off autoscaling for the axis and sets its "Window", "Number" and "Ticks" attributes as appropriate for a labeled bar chart.

Parameters:

labels - a String array with which to label the axis. The number of labels must equal the number of items.

type - an int which specifies the BarType. Legal values are BAR_TYPE_VERTICAL or BAR_TYPE_HORIZONTAL. This determines the axis to be modified.

See Also:

ChartNode.BAR_TYPE_VERTICAL, ChartNode.BAR_TYPE_HORIZONTAL