Package com.storedobject.chart

Class MarkArea.Block

java.lang.Object

com.storedobject.chart.MarkArea.Block

All Implemented Interfaces:

ComponentProperty

Enclosing class:

MarkArea

public static class MarkArea.Block
extends Object
implements ComponentProperty

A block represents an area of the MarkArea. A block has 2 MarkArea.Block.Sides viz. "the starting side", "the ending side".

A block may be defined along an axis and in that case, it covers an area along that axis with the starting side and ending side based on the starting value and ending value along that axis.

A block may be defined using both the axes (mostly in the case of RectangularCoordinate and in that case, it will have to be specified using 2 values for each axis. The block will be formed from the intersection of the axis values.

There are a few special strings that can be used when specifying the values and when such values are used, it is treated as special cases. The following special strings are currently supported:

     "min": Represents minimum value of the axis
     "max": Represents maximum value of the axis
     "average": The average value when the chart's values (applicable for numeric data)
 

Author:

Syam

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
class	MarkArea.Block.Side	A block has 2 sides, the starting side and an ending side.

Constructor Summary

Constructors

Constructor	Description
Block()

Method Summary

Modifier and Type	Method	Description
void	encodeJSON(StringBuilder sb)	Encode the JSON string with the properties of this.
final MarkArea.Block.Side	getEndingSide()	Get the ending side.
final ItemStyle	getItemStyle(boolean create)	Get item style for this block.
final String	getName()	Get the name of the block.
final MarkArea.Block.Side	getStartingSide()	Get the starting side.
void	setItemStyle(ItemStyle itemStyle)	Set item style.
void	setName(String name)	Set the name of the block.
void	setSides(Axis axis, Object valueFrom, Object valueTo)	Helper method to set sides.
void	setSides(XAxis xAxis, YAxis yAxis, Object xValueFrom, Object yValueFrom, Object xValueTo, Object yValueTo)	Helper method to set sides.

Methods inherited from class java.lang.Object

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

Constructor Details

Block

public Block()

Method Details

encodeJSON

public void encodeJSON(StringBuilder sb)

Description copied from interface: ComponentProperty

Encode the JSON string with the properties of this.

Specified by:

encodeJSON in interface ComponentProperty

Parameters:

sb - Encoded JSON string to be appended to this.

getName

public final String getName()

Get the name of the block.

Returns:

Name.

setName

public void setName(String name)

Set the name of the block.

Parameters:

name - Name.

getStartingSide

public final MarkArea.Block.Side getStartingSide()

Get the starting side.

Returns:

Side.

getEndingSide

public final MarkArea.Block.Side getEndingSide()

Get the ending side.

Returns:

Side.

setSides

public void setSides(Axis axis,
 Object valueFrom,
 Object valueTo)

Helper method to set sides. A value may be defined as a reserved string that has special meaning. The currently supported reserved strings are: "min", "max", "average".

Parameters:

axis - Axis.

valueFrom - Value from. Value should match with the DataType of the chart's axis or one of the reserved strings.

valueTo - Value to. Value should match with the DataType of the chart's axis or one of the reserved strings.

setSides

public void setSides(XAxis xAxis,
 YAxis yAxis,
 Object xValueFrom,
 Object yValueFrom,
 Object xValueTo,
 Object yValueTo)

Helper method to set sides. A value may be defined as a reserved string that has special meaning. The currently supported reserved strings are: "min", "max", "average".

Parameters:

xAxis - X axis.

yAxis - Y axis.

xValueFrom - X value from. Value should match with the DataType of the chart or one of the reserved strings.

yValueFrom - Y value from. Value should match with the DataType of the chart's axis or one of the reserved strings.

xValueTo - X value to. Value should match with the DataType of the chart's axis or one of the reserved strings.

yValueTo - Y value to. Value should match with the DataType of the chart's axis or one of the reserved strings.

getItemStyle

public final ItemStyle getItemStyle(boolean create)

Get item style for this block. (Each block can have its own item style).

Parameters:

create - If passed true, a new style is created if not exists.

Returns:

Item style.

setItemStyle

public void setItemStyle(ItemStyle itemStyle)

Set item style. (Each block can have its own item style).

Parameters:

itemStyle - Style to set.