com.softwareag.mobile.runtime.nui.charts

Class nUIBarChart

java.lang.Object

com.softwareag.mobile.runtime.nui.nUIObject

com.softwareag.mobile.runtime.nui.nUIDisplayObject

com.softwareag.mobile.runtime.nui.nUIElementDisplay

com.softwareag.mobile.runtime.nui.nUIImageElement

com.softwareag.mobile.runtime.nui.charts.nUIChartImage

com.softwareag.mobile.runtime.nui.charts.nUITwoAxisChart

com.softwareag.mobile.runtime.nui.charts.nUIBarChart

public class nUIBarChart
extends nUITwoAxisChart

Implements a Bar chart element, either horizontally or vertically. Stacked bar charts allow multiple values in a bar.

Field Summary

Fields

Modifier and Type	Field and Description
static float	DEFAULT_BAR_GROUP_SPACING Default spacing to apply between groups in a grouped bar chart (expressed as a fraction of the space available for a full bar)
static float	DEFAULT_BAR_SIZING Default size of a bar for non-grouped bar charts.
static float	DEFAULT_GROUPED_BAR_SIZING Default size of a bar for grouped bar charts.

Fields inherited from class com.softwareag.mobile.runtime.nui.charts.nUITwoAxisChart

DEFAULT_POINT_MARKER_SIZE, NUM_POINT_MARKERS, POINT_MARKER_BLOCK, POINT_MARKER_CIRCLE, POINT_MARKER_CROSS, POINT_MARKER_DIAMOND, POINT_MARKER_DOT, POINT_MARKER_LINE, POINT_MARKER_NONE, POINT_MARKER_PLUS, POINT_MARKER_SQUARE, POINT_MARKER_TRIANGLE, STACK_ABSOLUTE, STACK_ACCUMULATE

Fields inherited from class com.softwareag.mobile.runtime.nui.charts.nUIChartImage

DEFAULT_BORDER_THICKNESS, NUM_RENDER_STYLES, ORIENTATION_HORIZONTAL, ORIENTATION_VERTICAL, RENDER_STYLE_FLAT, RENDER_STYLE_GRADIENT

Fields inherited from class com.softwareag.mobile.runtime.nui.nUIElementDisplay

Y_IDENTIFIER_PREV_BOTTOM

Fields inherited from class com.softwareag.mobile.runtime.nui.nUIDisplayObject

COLOR_BACKGROUND_NORMAL, COLOR_BLACK, COLOR_FOREGROUND_DARK, COLOR_FOREGROUND_LIGHT, COLOR_FOREGROUND_NORMAL, COLOR_TRANSPARENT, COLOR_WHITE, DIMENSIONS_IDENTIFIER_PARENT_DIMENSIONS

Fields inherited from class com.softwareag.mobile.runtime.nui.nUIObject

event_listener, event_listener_exclusive, first_child, last_child, next_sibling, nuiid, parent, prev_sibling, unlink_children_on_removal_from_parent

Constructor Summary

Constructors

Constructor and Description
nUIBarChart(int nuiid, float[] data) Chart constructor using defaults.
nUIBarChart(int nuiid, float[][] data) Takes an multi-dimensional array of numbers and display them using a vertical bar graph.
nUIBarChart(int nuiid, float[][] data, int stack) Chart constructor for a default stacked chart with accumulated values.
nUIBarChart(int nuiid, float[] data, int stride) Chart constructor for a default stacked chart with accumulated values.
nUIBarChart(int nuiid, float[] data, int stride, int stack) Chart constructor for a stacked chart, but with the option of absolute or accumulated values for each bar.

Method Summary

Methods

Modifier and Type	Method and Description
int	getBarGrouping() Gets the number of bars in a group.
float	getBarGroupSpacing() Gets the current bar group spacing value.
float	getBarSizing() Returns the current bar sizing value.
int	getDefaultNumColors() Gets the default number of colours that would be used to render this chart.
void	renderImage() Render the chart data, creating the image for the nUIImageElement
void	setBarGrouping(int bar_grouping) Bars in a chart can be grouped together so that the there's a different spacing gap between the groups.
void	setBarGroupSpacing(float bar_group_spacing) Similar to the bar sizing value, the bar group spacing value is a fraction (> 0.0) of a standard bar's maximum size that is used as the spacer between groups of bars.
void	setBarSizing(float bar_sizing) Sets the spacing of the bars within the space available for each bar.
void	setDefaults() Sets the defaults for this chart type.

Methods inherited from class com.softwareag.mobile.runtime.nui.charts.nUITwoAxisChart

getAxes, getAxisColor, getAxisLabelCentering, getAxisLineThickness, getDataPointMarkerSize, getDataPointMarkerSizes, getDataPointMarkerType, getDataPointMarkerTypes, getHorizontalAxis, getMajorGridlineColor, getMajorGridlineThickness, getMinorGridlineColor, getMinorGridlineThickness, getOrientation, getPointMarkerSize, getPointMarkerType, getVerticalAxis, isStacked, renderDataLabels, setAxes, setAxisColor, setAxisLabelCentering, setAxisLineThickness, setDataPointMarkerSizes, setDataPointMarkerTypes, setMajorGridlineColor, setMajorGridlineThickness, setMinorGridlineColor, setMinorGridlineThickness, setOrientation, setPointMarkerSize, setPointMarkerType, setStackType

Methods inherited from class com.softwareag.mobile.runtime.nui.charts.nUIChartImage

clearChartBodyPadding, getAxisLabelTextColor, getBackgroundColor, getBestGuessScale, getBorderColor, getBorderThickness, getData, getDataColor, getDataColors, getHeight, getImage, getNumColors, getOutlineColor, getOutlineThickness, getTickLabelTextColor, getWidth, setAxisLabelTextColor, setBackgroundColor, setBestGuessScale, setBorderColor, setBorderThickness, setChartBodyPadding, setChartBodyPadding, setData, setData, setData, setDataColors, setHeight, setImage, setOutlineColor, setOutlineThickness, setRenderStyle, setSize, setTickLabelTextColor, setWidth, suggestLineThickness

Methods inherited from class com.softwareag.mobile.runtime.nui.nUIImageElement

getAlign, getInnerWidth, getInnerX, setAlign

Methods inherited from class com.softwareag.mobile.runtime.nui.nUIElementDisplay

getY, insertAt

Methods inherited from class com.softwareag.mobile.runtime.nui.nUIDisplayObject

getBackgroundDrawable, getBgcolor, getBottom, getFocus, getFocusable, getGesturable, getInnerHeight, getInnerY, getLeft, getMaxChildX, getMaxChildY, getRight, getScreenInnerX, getScreenInnerY, getScreenX, getScreenY, getTop, getTopLevelParentView, getTopLevelParentWindow, getTriggerable, getX, insertAtInternal, isEnabled, onRemoved, remove, setBackgroundDrawable, setBgcolor, setBottom, setChildFocus, setEnabled, setFocus, setFocusable, setGesturable, setInnerHeight, setInnerWidth, setInnerX, setInnerY, setLeft, setRight, setTop, setTriggerable, setX, setY

Methods inherited from class com.softwareag.mobile.runtime.nui.nUIObject

add, addEventListener, childElementAt, childIndexOf, getTag, insertAfter, insertBefore, outputChildHierarchy, remove, removeEventListener, replace, replace, setTag

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

DEFAULT_BAR_SIZING

public static final float DEFAULT_BAR_SIZING

Default size of a bar for non-grouped bar charts. This determines what percentage of the available space for this bar is actually used to draw the bar.

See Also:

Constant Field Values

DEFAULT_GROUPED_BAR_SIZING

public static final float DEFAULT_GROUPED_BAR_SIZING

Default size of a bar for grouped bar charts. This determines what percentage of the available space for this bar is actually used to draw the bar.

See Also:

Constant Field Values

DEFAULT_BAR_GROUP_SPACING

public static final float DEFAULT_BAR_GROUP_SPACING

Default spacing to apply between groups in a grouped bar chart (expressed as a fraction of the space available for a full bar)

See Also:

Constant Field Values

Constructor Detail

nUIBarChart

public nUIBarChart(int nuiid,
           float[] data)
            throws java.lang.IllegalArgumentException

Chart constructor using defaults. Just takes an array of numbers and will display them using a vertical bar graph. No stacking occurs since there is just one value per bar.

Parameters:

nuiid - Unique Native UI ID (or -1 if unidentified)

data - The data used to render this chart

Throws:

java.lang.IllegalArgumentException

nUIBarChart

public nUIBarChart(int nuiid,
           float[][] data)
            throws java.lang.IllegalArgumentException

Takes an multi-dimensional array of numbers and display them using a vertical bar graph. Data is assumed to have a per-series grouping, so an array of {{1,2}, {3,4}, {5,6}} will produce two bars, each with three literal values represented.

Parameters:

nuiid - Unique Native UI ID (or -1 if unidentified)

data - The data used to render this chart

Throws:

java.lang.IllegalArgumentException

nUIBarChart

public nUIBarChart(int nuiid,
           float[] data,
           int stride)
            throws java.lang.IllegalArgumentException

Chart constructor for a default stacked chart with accumulated values. The number of entries per bar is the stride value for the data array.

Parameters:

nuiid - Unique Native UI ID (or -1 if unidentified)

data - The data used to render this chart

stride - The number of data points for each bar element

Throws:

java.lang.IllegalArgumentException

nUIBarChart

public nUIBarChart(int nuiid,
           float[] data,
           int stride,
           int stack)
            throws java.lang.IllegalArgumentException

Chart constructor for a stacked chart, but with the option of absolute or accumulated values for each bar. The number of data points per bar is the stride value for the data array.

Parameters:

nuiid - Unique Native UI ID (or -1 if unidentified)

data - The data used to render this chart

stride - The number of data points for each bar element

stack - Value of either nUITwoAxisChart.STACK_ACCUMULATE (values are added) or nUITwoAxisChart.STACK_ABSOLUTE (values are literal) to control the interpretation of the values

Throws:

java.lang.IllegalArgumentException

nUIBarChart

public nUIBarChart(int nuiid,
           float[][] data,
           int stack)
            throws java.lang.IllegalArgumentException

Chart constructor for a default stacked chart with accumulated values. The number of entries per bar is the stride value for the data array.

Parameters:

nuiid - Unique Native UI ID (or -1 if unidentified)

data - The data used to render this chart

stack - Value of either nUITwoAxisChart.STACK_ACCUMULATE (values are added) or nUITwoAxisChart.STACK_ABSOLUTE (values are literal) to control the interpretation of the values

Throws:

java.lang.IllegalArgumentException

Method Detail

setDefaults

public void setDefaults()

Sets the defaults for this chart type.

Overrides:

setDefaults in class nUITwoAxisChart

setBarSizing

public void setBarSizing(float bar_sizing)

Sets the spacing of the bars within the space available for each bar. The overall graph width is split into equal width segments based on the number of bars. This value is given as a fraction of the maximum possible bar width.

Parameters:

bar_sizing - float parameter between 0.0 and 1.0 as a fraction of the bar width

getBarSizing

public float getBarSizing()

Returns the current bar sizing value. This is expressed as a fraction of the total space the bar could possibly occupy.

setBarGrouping

public void setBarGrouping(int bar_grouping)

Bars in a chart can be grouped together so that the there's a different spacing gap between the groups. Set the number of bars in a group using this method.
When this method is called, the default bar group spacing and sizing is also applied.

Parameters:

bar_grouping - number of bars that will be grouped together. Anything less than 2 is considered no grouping.

getBarGrouping

public int getBarGrouping()

Gets the number of bars in a group.

setBarGroupSpacing

public void setBarGroupSpacing(float bar_group_spacing)

Similar to the bar sizing value, the bar group spacing value is a fraction (> 0.0) of a standard bar's maximum size that is used as the spacer between groups of bars.

Parameters:

bar_group_spacing - fractional value >= 0. A value of 0 means no gaps between groups.

getBarGroupSpacing

public float getBarGroupSpacing()

Gets the current bar group spacing value. This is expressed as a fraction of the maximum available space for a bar.

getDefaultNumColors

public int getDefaultNumColors()

Description copied from class: nUIChartImage

Gets the default number of colours that would be used to render this chart.

Specified by:

getDefaultNumColors in class nUIChartImage

renderImage

public void renderImage()

Render the chart data, creating the image for the nUIImageElement