OverviewSingleDeprecated

jsx3.chart

class LineSeries

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

All Implemented Interfaces:

jsx3.gui.Interactive, jsx3.util.EventDispatcher

class LineSeries
extends jsx3.chart.Series
A data series for a line chart. An line series draws a set of points connected by a line. A line series has the following properties:
xField
the attribute of a record to use as the x-coordinate of points in the series, required if the x-axis is a value axis
yField
the attribute of a record to use as the y-coordinate of points in the series, required
form
defines how the area is drawn, one of {'segment','step','reverseStep','horizontal','vertical'}, defaults to 'segment'
interpolateValues
if true the the line will be continuous even over missing data points, if false the the line will break over missing data points
pointRadius
the radius of the points to render at each data point on the line, optional
pointRenderer
string that evals to an object that implements the renderer interface, optional
pointFill
string representation of a vector fill for the points
pointStroke
string representation of a VectorStroke for the points
pointGradient
string representation of a vector fill gradient for the points

Field Summary
static String
FORM_HORIZONTAL
static String
FORM_REVSTEP
static String
FORM_SEGMENT
static String
FORM_STEP
static String
FORM_VERTICAL
Constructor Summary
void
init(name : String, seriesName : String)
The instance initializer.
Method Summary
String
Returns the form field.
boolean
Returns the interpolateValues field.
String
Returns the pointFill field.
String
Returns the pointGradient field.
int
Returns the pointRadius field.
jsx3.chart.PointRenderer
Returns the pointRenderer field.
String
Returns the pointStroke field.
static String
Deprecated.
String
Returns the xField field.
String
Returns the yField field.
void
setForm(form : String)
Sets the form field, checks for valid value.
void
setInterpolateValues(interpolateValues : boolean)
Sets the interpolateValues field.
void
setPointFill(pointFill : String)
Sets the pointFill field.
void
setPointGradient(pointGradient : String)
Sets the pointGradient field.
void
setPointRadius(pointRadius : int)
Sets the pointRadius field.
void
setPointRenderer(pointRenderer : String)
Sets the pointRenderer field, should eval to an object that implements the renderer interface.
void
setPointStroke(pointStroke : String)
Sets the pointStroke field.
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_HORIZONTAL

static final String FORM_HORIZONTAL

FORM_REVSTEP

static final String FORM_REVSTEP

FORM_SEGMENT

static final String FORM_SEGMENT

FORM_STEP

static final String FORM_STEP

FORM_VERTICAL

static final String FORM_VERTICAL
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

getForm

String getForm()
Returns the form field.

Returns:

form  

getInterpolateValues

boolean getInterpolateValues()
Returns the interpolateValues field.

Returns:

interpolateValues  

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  

getYField

String getYField()
Returns the yField field.

Returns:

yField  

setForm

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

Parameters:

formthe new value for form, one of {'segment','step','reverseStep','horizontal','vertical'}

setInterpolateValues

void setInterpolateValues(interpolateValues : boolean)
Sets the interpolateValues field.

Parameters:

interpolateValuesthe new value for interpolateValues

setPointFill

void setPointFill(pointFill : String)
Sets the pointFill field.

Parameters:

pointFillthe new value for pointFill

setPointGradient

void setPointGradient(pointGradient : String)
Sets the pointGradient field.

Parameters:

pointGradientthe new value for pointGradient

setPointRadius

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

Parameters:

pointRadiusthe new value for pointRadius

setPointRenderer

void setPointRenderer(pointRenderer : String)
Sets the pointRenderer field, should eval to an object that implements the renderer interface.

Parameters:

pointRendererthe new value for pointRenderer, as a string

setPointStroke

void setPointStroke(pointStroke : String)
Sets the pointStroke field.

Parameters:

pointStrokethe new value for pointStroke

setXField

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

Parameters:

xFieldthe new value for xField

setYField

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

Parameters:

yFieldthe 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: