OverviewSingleDeprecated

jsx3.chart

class BarSeries

Object
->jsx3.lang.Object
  ->jsx3.app.Model
    ->jsx3.gui.Painted
      ->jsx3.gui.Block
        ->jsx3.chart.ChartComponent
          ->jsx3.chart.Series
            ->jsx3.chart.BCSeries
              ->jsx3.chart.BarSeries

All Implemented Interfaces:

jsx3.gui.Interactive, jsx3.util.EventDispatcher

class BarSeries
extends jsx3.chart.BCSeries
The data series type for a jsx3.chart.BarChart. Draws horizontal bars between the y axis and an x value determined by the data provider, or between two x values determined by the data provider. A bar series has the following fields:
xField
the attribute of a record to use as the horizontal extent of the bar, required
yField
the attribute of a record to use as the vertical midpoint of the bar, required if the y axis of the chart is a value axis
minField
the attribute of a record to use as the minimum horizontal extent of the bar, optional

Field Summary
static int
DEFAULT_BARHEIGHT
Constructor Summary
void
init(name : String, seriesName : String)
The instance initializer.
Method Summary
int
Returns the barHeight field.
void
setBarHeight(barHeight : int)
Sets the barHeight field.
static String
tooltip(series : jsx3.chart.Series, record : jsx3.xml.Entity)
The default tooltip function for this type of series.
Methods Inherited From jsx3.chart.BCSeries
getMinField, getMinValue, getXField, getXValue, getYField, getYValue, setMinField, setXField, setYField
Methods Inherited From jsx3.chart.Series
getColorFunction, getFill, getFillGradient, getIndex, getLabel, getSeriesName, getStroke, getTooltipFunction, getXAxis, getYAxis, setColorFunction, setFill, setFillGradient, setSeriesName, setStroke, setTooltipFunction
Methods Inherited From jsx3.chart.ChartComponent
getChart
Methods Inherited From jsx3.gui.Block
getBackground, getBackgroundColor, getBorder, getCDFAttribute, getCDFId, getCSSOverride, getClassName, getColor, getCursor, getDimensions, getDisplay, getFontName, getFontSize, getFontWeight, getHeight, getLeft, getMargin, getOverflow, getPadding, getRelativePosition, getTagName, getText, getTextAlign, getTip, getTop, getVisibility, getWidth, getZIndex, hideMask, paint, setBackground, setBackgroundColor, setBorder, setCDFAttribute, setCDFId, setCSSOverride, setClassName, setColor, setCursor, setDimensions, setDisplay, setFontName, setFontSize, setFontWeight, setHeight, setIndex, setLeft, setMargin, setOverflow, setPadding, setRelativePosition, setTagName, setText, setTextAlign, setTip, setTop, setVisibility, setWidth, setZIndex, showMask
Methods Inherited From jsx3.gui.Interactive
doEvent, getCanDrag, getCanDrop, getCanMove, getCanSpy, getEvent, getEvents, getMenu, hasEvent, registerHotKey, removeEvent, removeEvents, setCanDrag, setCanDrop, setCanMove, setCanSpy, setEvent, setMenu, setSpyStyles, showSpy
Methods Inherited From jsx3.gui.Painted
focus, getAbsolutePosition, getAttribute, getAttributes, getDynamicProperty, getRendered, insertHTML, onAfterPaint, onAfterRestoreView, paintChild, paintChildren, recalcBox, removeAttribute, removeAttributes, repaint, setAttribute, setDynamicProperty
Methods Inherited From jsx3.app.Model
adoptChild, doClone, findAncestor, findDescendants, getAncestorOfName, getAncestorOfType, getChild, getChildIndex, getChildren, getDescendantOfName, getDescendantsOfType, getFirstChild, getFirstChildOfType, getHelpId, getId, getLastChild, getLoadType, getMetaValue, getNS, getName, getNextSibling, getParent, getPersistence, getPreviousSibling, getServer, getUriResolver, insertBefore, load, loadAndCache, loadXML, onAfterAssemble, onAfterAttach, onBeforeAssemble, onChangeServer, onDestroy, onRemoveChild, onSetChild, onSetParent, removeChild, removeChildren, setChild, setHelpId, setLoadType, setMetaValue, setName, setPersistence, toString, toXML, toXMLDoc
Methods Inherited From jsx3.util.EventDispatcher
publish, subscribe, unsubscribe, unsubscribeAll
Methods Inherited From jsx3.lang.Object
clone, equals, eval, getClass, getInstanceOf, getInstanceOfClass, getInstanceOfPackage, instanceOf, isInstanceOf, isSubclassOf, jsxmix, jsxsuper, jsxsupermix, setInstanceOf
Field Detail

DEFAULT_BARHEIGHT

static int DEFAULT_BARHEIGHT
Constructor Detail

init

void init(name : String, seriesName : String)
The instance initializer.

Parameters:

namethe GI name of the instance
seriesNamethe name of the Series, will be displayed in the Legend for most chart types
Method Detail

getBarHeight

int getBarHeight()
Returns the barHeight field.

Returns:

barHeight  

setBarHeight

void setBarHeight(barHeight : int)
Sets the barHeight field.

Parameters:

barHeightthe new value for barHeight

tooltip

static String tooltip(series : jsx3.chart.Series, record : jsx3.xml.Entity)
The default tooltip function for this type of series.

Parameters:

series
record

Returns: