OverviewSingleDeprecated

jsx3.chart

class AreaSeries

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

All Implemented Interfaces:

jsx3.gui.Interactive, jsx3.util.EventDispatcher
class AreaSeries
extends jsx3.chart.Series
A data series for an area chart. An area series draws a solid polygon between the x-axis and a line defined by the data provider, or between a minimum line and a maximum line both defined by the data provider. An area series has the following properties:
xField
the attribute of a record to use as the x-coordinate of points defining the min and max line of the area, required if the x-axis is a value axis
yField
the attribute of a record to use as the y-coordinate of points defining the max line of the area, required
minField
the attribute of a record to use as the y-coordinate of points defining the min line of the area, optional
form
defines how the area is drawn, one of {'segment','step','reverseStep'}, defaults to 'segment'
The area series can also be painted with points at each data point. See LineSeries for a description of the relevant fields.
Field Summary
static String
FORM_REVSTEP
static String
FORM_SEGMENT
static String
FORM_STEP
Constructor Summary
void
init(name : String, seriesName : String)
The instance initializer.
Method Summary
String
getForm()
Returns the form field.
String
getMinField()
Returns the minField field.
Number
getMinValue(record : jsx3.xml.Entity)
Returns the minimum y-coordinate of a data point in this series for the given record.
String
getPointFill()
Returns the pointFill field.
String
getPointGradient()
Returns the pointGradient field.
int
getPointRadius()
Returns the pointRadius field.
jsx3.chart.PointRenderer
getPointRenderer()
Returns the pointRenderer field.
String
getPointStroke()
Returns the pointStroke field.
static String
getVersion()
Deprecated.
String
getXField()
Returns the xField field.
Number
getXValue(record : jsx3.xml.Entity)
Returns the x-coordinate of a data point in this series for the given record.
String
getYField()
Returns the yField field.
Number
getYValue(record : jsx3.xml.Entity)
Returns the y-coordinate of a data point in this series for the given record.
void
setForm(form : String)
Sets the form field, checks for valid value.
void
setMinField(minField : String)
Sets the minField field.
void
setPointFill(pointFill : String)
Sets the pointFill field, string representation of vector fill.
void
setPointGradient(pointGradient : String)
Sets the pointGradient field, string representation of vector fill gradient.
void
setPointRadius(pointRadius : int)
Sets the pointRadius field.
void
setPointRenderer(pointRenderer : String)
Sets the pointRenderer field.
void
setPointStroke(pointStroke : String)
Sets the pointStroke field, string representation of VectorStroke.
void
setXField(xField : String)
Sets the xField field.
void
setYField(yField : String)
Sets the yField 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.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, 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, 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

FORM_REVSTEP

static final String FORM_REVSTEP

FORM_SEGMENT

static final String FORM_SEGMENT

FORM_STEP

static final String FORM_STEP
Constructor Detail

init

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

Parameters:

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

getForm

String getForm()
Returns the form field.

Returns:

form  

getMinField

String getMinField()
Returns the minField field.

Returns:

minField  

getMinValue

Number getMinValue(record : jsx3.xml.Entity)
Returns the minimum y-coordinate of a data point in this series for the given record.

Parameters:

record – the node

Returns:

 

getPointFill

String getPointFill()
Returns the pointFill field.

Returns:

pointFill  

getPointGradient

String getPointGradient()
Returns the pointGradient field.

Returns:

pointGradient  

getPointRadius

int getPointRadius()
Returns the pointRadius field.

Returns:

pointRadius  

getPointRenderer

jsx3.chart.PointRenderer getPointRenderer()
Returns the pointRenderer field.

Returns:

pointRenderer  

getPointStroke

String getPointStroke()
Returns the pointStroke field.

Returns:

pointStroke  

getVersion

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

Returns:

 

getXField

String getXField()
Returns the xField field.

Returns:

xField  

getXValue

Number getXValue(record : jsx3.xml.Entity)
Returns the x-coordinate of a data point in this series for the given record.

Parameters:

record – the node

Returns:

 

getYField

String getYField()
Returns the yField field.

Returns:

yField  

getYValue

Number getYValue(record : jsx3.xml.Entity)
Returns the y-coordinate of a data point in this series for the given record.

Parameters:

record – the node

Returns:

 

setForm

void setForm(form : String)
Sets the form field, checks for valid value.

Parameters:

form – the new value for form, one of {'segment','step','reverseStep'}

setMinField

void setMinField(minField : String)
Sets the minField field.

Parameters:

minField – the new value for minField

setPointFill

void setPointFill(pointFill : String)
Sets the pointFill field, string representation of vector fill.

Parameters:

pointFill – the new value for pointFill

setPointGradient

void setPointGradient(pointGradient : String)
Sets the pointGradient field, string representation of vector fill gradient.

Parameters:

pointGradient – the new value for pointGradient

setPointRadius

void setPointRadius(pointRadius : int)
Sets the pointRadius field.

Parameters:

pointRadius – the new value for pointRadius

setPointRenderer

void setPointRenderer(pointRenderer : String)
Sets the pointRenderer field.

Parameters:

pointRenderer – the new value for pointRenderer, should eval to an object that implements the renderer interface

setPointStroke

void setPointStroke(pointStroke : String)
Sets the pointStroke field, string representation of VectorStroke.

Parameters:

pointStroke – the new value for pointStroke

setXField

void setXField(xField : String)
Sets the xField field.

Parameters:

xField – the new value for xField

setYField

void setYField(yField : String)
Sets the yField field.

Parameters:

yField – the new value for yField

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:

 
Copyright © 2001-2007, TIBCO Software Inc.