OverviewSingleDeprecated

jsx3.chart

class BCChart

Object
->jsx3.lang.Object
  ->jsx3.app.Model
    ->jsx3.gui.Painted
      ->jsx3.gui.Block
        ->jsx3.vector.Block
          ->jsx3.chart.Chart
            ->jsx3.chart.CartesianChart
              ->jsx3.chart.BCChart

All Implemented Interfaces:

jsx3.gui.Interactive, jsx3.util.EventDispatcher, jsx3.xml.CDF, jsx3.xml.Cacheable

Direct Known Subclasses:

jsx3.chart.BarChart, jsx3.chart.ColumnChart
class BCChart
extends jsx3.chart.CartesianChart
Superclass of bar and column chart. Contains all the common functionality, provides template methods to the subclasses so that they can render horizontal bars or vertical columns.

Basically abstracts a bar/column chart into a chart with a parallel dimension and a normal dimension. The parallel dimension is the dimension in which the rows/columns extend.
Field Summary
static String
TYPE_CLUSTERED
static String
TYPE_STACKED
static String
TYPE_STACKED100
Constructor Summary
void
init(name : String, left : int, top : int, width : int, height : int)
The instance initializer.
Method Summary
float
getCategoryCoverage()
Returns the categoryCoverage field, the ratio of the range of a category that is covered by bars/columns.
float
getSeriesOverlap()
Returns the seriesOverlap field, the ratio of a column width/row height that a column/row overlaps with the adjacent column/row.
String
getType()
Returns the type field, corresponds to the variation of chart, one of {'clustered','stacked','stacked100'}.
static String
getVersion()
Deprecated.
void
setCategoryCoverage(categoryCoverage : float)
Sets the categoryCoverage field.
void
setSeriesOverlap(seriesOverlap : float)
Sets the seriesOverlap field.
void
setType(type : String)
Sets the type field.
Methods Inherited From jsx3.chart.CartesianChart
getGridLines, getPrimaryXAxis, getPrimaryYAxis, getRangeForAxis, getXRange, getYRange
Methods Inherited From jsx3.chart.Chart
getAlpha, getBorderAlpha, getBorderColor, getBorderWidth, getChartTitle, getDataPadding, getLegend, getLegendEntryType, getLegendPlacement, getSeries, getSeriesIndex, getTitlePlacement, redrawRecord, setAlpha, setBorderAlpha, setBorderColor, setBorderWidth, setDataPadding, setLegendPlacement, setTitlePlacement
Methods Inherited From jsx3.xml.Cacheable
clearXmlData, getNodeSet, getShareResources, getXML, getXMLId, getXMLString, getXMLTransformers, getXMLURL, getXSL, getXSLId, getXSLParams, getXSLString, getXSLURL, getXmlAsync, getXmlBind, onXmlBinding, removeXSLParam, removeXSLParams, resetCacheData, resetData, resetXmlCacheData, resetXslCacheData, setNodeSet, setShareResources, setSourceXML, setXMLId, setXMLString, setXMLTransformers, setXMLURL, setXSLId, setXSLParam, setXSLString, setXSLURL, setXmlAsync, setXmlBind
Methods Inherited From jsx3.xml.CDF
adoptRecord, adoptRecordBefore, convertProperties, deleteRecord, deleteRecordProperty, getRecord, getRecordNode, insertRecord, insertRecordBefore, insertRecordNode, insertRecordProperty, reloadFromSource
Methods Inherited From jsx3.vector.Block
createCanvas, createVector, getCanvas, paintEventHandler, updateVector
Methods Inherited From jsx3.gui.Block
getBackground, getBackgroundColor, getBorder, getCSSOverride, getClassName, getColor, getCursor, getDimensions, getDisplay, getFontName, getFontSize, getFontWeight, getHeight, getIndex, getLeft, getMargin, getOverflow, getPadding, getRelativePosition, getTagName, getText, getTextAlign, getTip, getTop, getVisibility, getWidth, getZIndex, hideMask, paint, setBackground, setBackgroundColor, setBorder, 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, 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

TYPE_CLUSTERED

static final String TYPE_CLUSTERED

TYPE_STACKED

static final String TYPE_STACKED

TYPE_STACKED100

static final String TYPE_STACKED100
Constructor Detail

init

void init(name : String, left : int, top : int, width : int, height : int)
The instance initializer.

Parameters:

name – the GI name of the instance
left – left position (in pixels) of the chart relative to its parent container
top – top position (in pixels) of the chart relative to its parent container
width – width (in pixels) of the chart
height – height (in pixels) of the chart
Method Detail

getCategoryCoverage

float getCategoryCoverage()
Returns the categoryCoverage field, the ratio of the range of a category that is covered by bars/columns.

Returns:

categoryCoverage  

getSeriesOverlap

float getSeriesOverlap()
Returns the seriesOverlap field, the ratio of a column width/row height that a column/row overlaps with the adjacent column/row.

Returns:

seriesOverlap  

getType

String getType()
Returns the type field, corresponds to the variation of chart, one of {'clustered','stacked','stacked100'}.

Returns:

type  

getVersion

static String getVersion()
Deprecated.
Returns the release/build for the class (i.e., "2.2.00").

Returns:

 

setCategoryCoverage

void setCategoryCoverage(categoryCoverage : float)
Sets the categoryCoverage field.

Parameters:

categoryCoverage – the new value for categoryCoverage, between 0 and 1

setSeriesOverlap

void setSeriesOverlap(seriesOverlap : float)
Sets the seriesOverlap field.

Parameters:

seriesOverlap – the new value for seriesOverlap, usually between -0.5 and 0.5

setType

void setType(type : String)
Sets the type field.

Parameters:

type – the new value for type, one of {'clustered','stacked','stacked100'}
Copyright © 2001-2007, TIBCO Software Inc.