org.icefaces.ace.model.chart
Class CartesianSeries

java.lang.Object
  org.icefaces.ace.model.chart.ChartSeries
      org.icefaces.ace.model.chart.CartesianSeries

public class CartesianSeries
extends ChartSeries

Copyright 2010-2011 ICEsoft Technologies Canada Corp.

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.

See the License for the specific language governing permissions and limitations under the License.

User: Nils Date: 12-05-03 Time: 12:53 PM

Nested Class Summary

static class

CartesianSeries.CartesianType

Nested classes/interfaces inherited from class org.icefaces.ace.model.chart.ChartSeries

ChartSeries.ChartType

Constructor Summary

CartesianSeries()

Method Summary

void	add(java.lang.Object y) Add an point as a y-value with a x-value relative to the position in this series and the value at an accompanying index in a separately determined list of x-axis ticks.
void	add(java.lang.Object x, java.lang.Object y) Add an point as an explicit x and y value pair.
JSONBuilder	getConfigJSON(javax.faces.component.UIComponent component) Used by the ChartRenderer to produce a JSON representation of the data of this series.
JSONBuilder	getDataJSON(javax.faces.component.UIComponent component) Used by the ChartRenderer to produce a JSON representation of the configuration of this series.
ChartSeries.ChartType	getDefaultType()
java.lang.Boolean	getDragable() Get if the points of this series are draggable.
DragConstraintAxis	getDragConstraintAxis() Get the configured axis that dragging of points is confined to.
LinePattern	getLinePattern() Get the pattern of stroke applied to the lines of this series.
java.lang.String[]	getPointLabelList() Get the list of labels for the points of this series.
java.lang.Boolean	getPointLabelStacked() Get if the point labels are to be rendered in a stacked plot.
java.lang.Integer	getPointLabelTolerance() Set the distances that point labels must be from a boundary if they are to be rendered.
java.lang.Boolean	getSmooth() Get if the lines of this series have curves rendered between points rather than straight line segments.
java.lang.Boolean	isHorizontalBar() Determine if this series is bar type, is it horizontal?
java.lang.Boolean	isPointLabels() Get if this series has labels rendered near each point
void	setDragable(java.lang.Boolean dragable) Enable dragging for the points of this series.
void	setDragConstraintAxis(DragConstraintAxis dragConstraintAxis) Set the configured axis that dragging of points is confined to.
void	setHorizontalBar(java.lang.Boolean horizontalBar) Set if this bar series is a horizontal type.
void	setLinePattern(LinePattern linePattern) Set the pattern of stroke applied to the lines of this series.
void	setPointLabelList(java.lang.String[] pointLabelList) Set the list of labels for the points of this series.
void	setPointLabels(java.lang.Boolean pointLabels) Set if this series has labels rendered near each point.
void	setPointLabelStacked(java.lang.Boolean pointLabelStacked) Set if the point labels are to be rendered in a stacked plot.
void	setPointLabelTolerance(java.lang.Integer pointLabelTolerance) Get the distance that point labels must be from a boundary if they are to be rendered,
void	setSmooth(java.lang.Boolean smooth) Set if the lines of this series have curves rendered between points rather than straight line segments.

Methods inherited from class org.icefaces.ace.model.chart.ChartSeries

clear, getData, getFill, getFillToZero, getLabel, getLineCap, getLineJoin, getLineWidth, getShadow, getShadowAlpha, getShadowAngle, getShadowDepth, getShadowOffset, getShow, getShowMarker, getType, getUseNegativeColors, getXAxis, getYAxis, setData, setFill, setFillToZero, setLabel, setLineCap, setLineJoin, setLineWidth, setShadow, setShadowAlpha, setShadowAngle, setShadowDepth, setShadowOffset, setShow, setShowMarker, setType, setUseNegativeColors, setXAxis, setYAxis

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

CartesianSeries

public CartesianSeries()

Method Detail

getDefaultType

public ChartSeries.ChartType getDefaultType()

Specified by:

getDefaultType in class ChartSeries

add

public void add(java.lang.Object y)

Add an point as a y-value with a x-value relative to the position in this series and the value at an accompanying index in a separately determined list of x-axis ticks.

Parameters:

y - the value of the point

add

public void add(java.lang.Object x,
                java.lang.Object y)

Add an point as an explicit x and y value pair.

Parameters:

x - the x coordinate of the point

y - the y coordinate of the point

getDataJSON

public JSONBuilder getDataJSON(javax.faces.component.UIComponent component)

Used by the ChartRenderer to produce a JSON representation of the configuration of this series.

Overrides:

getDataJSON in class ChartSeries

Parameters:

chart -

Returns:

the serialized JSON object

getConfigJSON

public JSONBuilder getConfigJSON(javax.faces.component.UIComponent component)

Used by the ChartRenderer to produce a JSON representation of the data of this series.

Overrides:

getConfigJSON in class ChartSeries

Parameters:

component -

Returns:

the JSON object

isHorizontalBar

public java.lang.Boolean isHorizontalBar()

Determine if this series is bar type, is it horizontal?

Returns:

true if horizontal

setHorizontalBar

public void setHorizontalBar(java.lang.Boolean horizontalBar)

Set if this bar series is a horizontal type.

Parameters:

horizontalBar - bar series horizontal

isPointLabels

public java.lang.Boolean isPointLabels()

Get if this series has labels rendered near each point

Returns:

true if labels are rendered

setPointLabels

public void setPointLabels(java.lang.Boolean pointLabels)

Set if this series has labels rendered near each point.

Parameters:

pointLabels - series point labelling

getPointLabelTolerance

public java.lang.Integer getPointLabelTolerance()

Set the distances that point labels must be from a boundary if they are to be rendered.

Returns:

distance in pixels

setPointLabelTolerance

public void setPointLabelTolerance(java.lang.Integer pointLabelTolerance)

Get the distance that point labels must be from a boundary if they are to be rendered,

Parameters:

pointLabelTolerance - distance in pixels

getPointLabelStacked

public java.lang.Boolean getPointLabelStacked()

Get if the point labels are to be rendered in a stacked plot.

Returns:

true if the point labels are intended for a stacked plot.

setPointLabelStacked

public void setPointLabelStacked(java.lang.Boolean pointLabelStacked)

Set if the point labels are to be rendered in a stacked plot.

Parameters:

pointLabelStacked - if the labels are intended for a stacked plot

getPointLabelList

public java.lang.String[] getPointLabelList()

Get the list of labels for the points of this series.

Returns:

list of labels to be applied to points of associated index.

setPointLabelList

public void setPointLabelList(java.lang.String[] pointLabelList)

Set the list of labels for the points of this series.

Parameters:

pointLabelList - list of labels to be applied to points of associated index

getDragable

public java.lang.Boolean getDragable()

Get if the points of this series are draggable.

Returns:

true, if the points of this series are draggable.

setDragable

public void setDragable(java.lang.Boolean dragable)

Enable dragging for the points of this series. Enables dragStart / dragStop client behaviour events as well as raising PointValueChangeEvents on the on the server. Note that enabling this mode causes several restrictions to be checked (and possibly raised as FacesExceptions) due to the requirements of communicating edits to server model. In particular, the data points of this series must have explicit x values, if this series has a category type axis, the axis must define its own ticks rather than deriving them from the data and the data points of must be sorted ascending in the x axis to prevent reindexing during plotting.

Parameters:

dragable - if the points of this series are dragale.

getDragConstraintAxis

public DragConstraintAxis getDragConstraintAxis()

Get the configured axis that dragging of points is confined to.

Returns:

enum representation of the X, Y, or no axis.

setDragConstraintAxis

public void setDragConstraintAxis(DragConstraintAxis dragConstraintAxis)

Set the configured axis that dragging of points is confined to.

Parameters:

dragConstraintAxis - enum representation of the X, Y, or no axis.

getLinePattern

public LinePattern getLinePattern()

Get the pattern of stroke applied to the lines of this series.

Returns:

the LinePattern object representing the stoke type

setLinePattern

public void setLinePattern(LinePattern linePattern)

Set the pattern of stroke applied to the lines of this series.

Parameters:

linePattern - enum representation of the stroke type

getSmooth

public java.lang.Boolean getSmooth()

Get if the lines of this series have curves rendered between points rather than straight line segments.

Returns:

if the lines of this series are smoothed

setSmooth

public void setSmooth(java.lang.Boolean smooth)

Set if the lines of this series have curves rendered between points rather than straight line segments.

Parameters:

smooth - if the lines of this series are smoothed