OverviewSingleDeprecated

jsx3.chart

class CartesianChart

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

All Implemented Interfaces:

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

Direct Known Subclasses:

jsx3.chart.AreaChart, jsx3.chart.BCChart, jsx3.chart.LineChart, jsx3.chart.PlotChart
abstract class CartesianChart
extends jsx3.chart.Chart
Base chart class for charts that render on a cartesian plane with x and y axes. Currently only supports primary x and y axes, even though there are methods pertaining to secondary axes.

Cartesian charts can have the following additional children:
  1. {0,n} GridLines, will render lines aligned with the axes below or above the data series
  2. {2,n} Axis, required to define the coordinate space of the cartesian plane
Constructor Summary
void
init(name : String, left : int, top : int, width : int, height : int)
The instance initializer.
Method Summary
Array<jsx3.chart.GridLines>
getGridLines()
Returns the array of children GridLines instances.
jsx3.chart.Axis
getPrimaryXAxis()
Returns the primary x axis, if any.
jsx3.chart.Axis
getPrimaryYAxis()
Returns the primary y axis, if any.
Array<Number>
getRangeForAxis(axis : jsx3.chart.Axis)
Returns the range for axis, delegates to getXRange() or getYRange().
static String
getVersion()
Deprecated.
abstract Array<Number>
getXRange(series : Array<jsx3.chart.Series>)
Returns the range of x values in the data provider, subclasses must implement.
abstract Array<Number>
getYRange(series : Array<jsx3.chart.Series>)
Returns the range of y values in the data provider, subclasses must implement.
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, getRecordIds, 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, getCDFAttribute, getCDFId, 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, 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
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

getGridLines

Array<jsx3.chart.GridLines> getGridLines()
Returns the array of children GridLines instances.

Returns:

gridLines  

getPrimaryXAxis

jsx3.chart.Axis getPrimaryXAxis()
Returns the primary x axis, if any.

Returns:

primaryXAxis  

getPrimaryYAxis

jsx3.chart.Axis getPrimaryYAxis()
Returns the primary y axis, if any.

Returns:

primaryYAxis  

getRangeForAxis

Array<Number> getRangeForAxis(axis : jsx3.chart.Axis)
Returns the range for axis, delegates to getXRange() or getYRange().

Parameters:

axis –

Returns:

[min,max] or null if no range can be found  

getVersion

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

Returns:

 

getXRange

abstract Array<Number> getXRange(series : Array<jsx3.chart.Series>)
Returns the range of x values in the data provider, subclasses must implement.

Parameters:

series – the series to consider

Returns:

[min,max] or null if no range can be found  

getYRange

abstract Array<Number> getYRange(series : Array<jsx3.chart.Series>)
Returns the range of y values in the data provider, subclasses must implement.

Parameters:

series – the series to consider

Returns:

[min,max] or null if no range can be found  
Copyright © 2001-2008, TIBCO Software Inc.