OverviewSingleDeprecatedPropertiesEventsXSL Parameters

jsx3.chart

class Series

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

All Implemented Interfaces:

jsx3.gui.Interactive, jsx3.util.EventDispatcher

Direct Known Subclasses:

jsx3.chart.AreaSeries, jsx3.chart.BCSeries, jsx3.chart.LineSeries, jsx3.chart.PieSeries, jsx3.chart.PlotSeries
class Series
extends jsx3.chart.ChartComponent
The base class for all data series classes. In general, a chart is made up of a fixed number of configured series and a variable number of categories. A series is essentially an addressing scheme that defines how to get information out of each category.
Constructor Summary
void
init(name : String, seriesName : String)
The instance initializer.
Method Summary
Function
getColorFunction()
Returns the colorFunction field.
String
getFill()
Returns the fill field.
String
getFillGradient()
Returns the fillGradient field.
int
getIndex()
Returns the index of this series in the list of chart's series.
jsx3.chart.ChartLabel
getLabel()
Returns the optional jsx3.chart.ChartLabel child of this series.
String
getSeriesName()
Returns the seriesName field.
String
getStroke()
Returns the stroke field.
Function
getTooltipFunction()
Returns the function used to render tooltips for each area drawn by this series.
static String
getVersion()
Deprecated.
jsx3.chart.Axis
getXAxis()
Returns the x axis that this series is plotted against.
jsx3.chart.Axis
getYAxis()
Returns the y axis that this series is plotted against.
void
setColorFunction(colorFunction : String | Function)
Sets the colorFunction field.
void
setFill(fill : String)
Sets the fill field, string representation of a vector fill.
void
setFillGradient(fillGradient : String)
Sets the fillGradient field, string representation of a vector fill gradient.
void
setSeriesName(seriesName : String)
Sets the seriesName field, this name is usually displayed in a legend or as a label.
void
setStroke(stroke : String)
Sets the stroke field, string representation of a VectorStroke.
void
setTooltipFunction(tooltipFunction : String | Function)
Sets the function used to render tooltips for each area drawn by this series.
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, getRendered, insertHTML, onAfterPaint, onAfterRestoreView, paintChild, paintChildren, recalcBox, removeAttribute, removeAttributes, repaint, setAttribute
Methods Inherited From jsx3.app.Model
adoptChild, assembleFromXML, doClone, findAncestor, findDescendants, getAncestorOfName, getAncestorOfType, getChild, getChildIndex, getChildren, getDescendantOfName, getDescendantsOfType, getDynamicProperty, getFirstChild, getFirstChildOfType, getHelpId, getId, getLastChild, getLoadType, getMetaValue, getNS, getName, getNextSibling, getParent, getPersistence, getPreviousSibling, getServer, getUriResolver, insertBefore, load, loadAndCache, loadXML, onAfterAssemble, onAfterAttach, onBeforeAssemble, onChangeServer, onChildAdded, onDestroy, onRemoveChild, onSetChild, onSetParent, removeChild, removeChildren, selectDescendants, setChild, setDynamicProperty, setHelpId, setLoadType, setMetaValue, setName, setPersistence, toString, toXML, toXMLDoc, toXMLElm
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, 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

getColorFunction

Function getColorFunction()
Returns the colorFunction field.

Returns:

colorFunction 

Since:

3.1

getFill

String getFill()
Returns the fill field.

Returns:

fill  

getFillGradient

String getFillGradient()
Returns the fillGradient field.

Returns:

fillGradient  

getIndex

int getIndex()
Returns the index of this series in the list of chart's series.

Returns:

index, -1 if not found  

Overrides:

getIndex in jsx3.gui.Block

getLabel

jsx3.chart.ChartLabel getLabel()
Returns the optional jsx3.chart.ChartLabel child of this series.

Returns:

 

getSeriesName

String getSeriesName()
Returns the seriesName field.

Returns:

seriesName  

getStroke

String getStroke()
Returns the stroke field.

Returns:

stroke  

getTooltipFunction

Function getTooltipFunction()
Returns the function used to render tooltips for each area drawn by this series.

Returns:

function(series,record) : string  

getVersion

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

Returns:

 

getXAxis

jsx3.chart.Axis getXAxis()
Returns the x axis that this series is plotted against.

Returns:

the x axis  

getYAxis

jsx3.chart.Axis getYAxis()
Returns the y axis that this series is plotted against.

Returns:

the y axis  

setColorFunction

void setColorFunction(colorFunction : String | Function)
Sets the colorFunction field. The function will be applied to this object when called. Note that passing a function reference to this method will prevent the color function from persisting if this object is serialized.

Parameters:

colorFunction – the new value for colorFunction, a function with the signature function(record : jsx3.xml.Entity, index : Number) : jsx3.vector.Fill.

Since:

3.1

setFill

void setFill(fill : String)
Sets the fill field, string representation of a vector fill.

Parameters:

fill – the new value for fill

setFillGradient

void setFillGradient(fillGradient : String)
Sets the fillGradient field, string representation of a vector fill gradient.

Parameters:

fillGradient – the new value for fillGradient

setSeriesName

void setSeriesName(seriesName : String)
Sets the seriesName field, this name is usually displayed in a legend or as a label.

Parameters:

seriesName – the new value for seriesName

setStroke

void setStroke(stroke : String)
Sets the stroke field, string representation of a VectorStroke.

Parameters:

stroke – the new value for stroke

setTooltipFunction

void setTooltipFunction(tooltipFunction : String | Function)
Sets the function used to render tooltips for each area drawn by this series. The function will be applied to this object when called. Note that passing a function reference to this method will prevent the color function from persisting if this object is serialized.

Parameters:

tooltipFunction – a function with the signature function(s : jsx3.chart.Series, record : jsx3.xml.Entity) : String
Copyright © 2001-2011, TIBCO Software Inc.