Package com.storedobject.chart

Class MarkArea

java.lang.Object

com.storedobject.chart.MarkArea

All Implemented Interfaces:

ComponentProperty, HasData

public class MarkArea
extends Object
implements ComponentProperty, HasData

Mark area. Used to define style for one or more individual areas in many charts. use Chart.getMarkArea(boolean) to get the MarkArea of the chart. Examples: LineChart, ScatterChart, PieChart etc.

Author:

Syam

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	MarkArea.Block	A block represents an area of the MarkArea.

Constructor Summary

Constructors

Constructor	Description
MarkArea()

Method Summary

Modifier and Type	Method	Description
void	add(MarkArea.Block... blocks)	Add blocks to this mark area.
void	clear()	Clear all blocks.
void	declareData(Set<AbstractDataProvider<?>> dataSet)	Declare the data set owned by this ComponentPart by adding it to the Set provided.
void	encodeJSON(StringBuilder sb)	Encode the JSON string with the properties of this.
final ItemStyle	getItemStyle(boolean create)	Get item style.
void	remove(MarkArea.Block... blocks)	Remove blocks from this mark area.
void	setItemStyle(ItemStyle itemStyle)	Set item style.

Methods inherited from class java.lang.Object

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

Constructor Details

MarkArea

public MarkArea()

Method Details

declareData

public void declareData(Set<AbstractDataProvider<?>> dataSet)

Description copied from interface: HasData

Declare the data set owned by this ComponentPart by adding it to the Set provided.

Specified by:

declareData in interface HasData

Parameters:

dataSet - Set to which all the data owned by this ComponentPart needs to be added.

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.

getItemStyle

public final ItemStyle getItemStyle(boolean create)

Get 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.

Parameters:

itemStyle - Style to set.

add

public void add(MarkArea.Block... blocks)

Add blocks to this mark area.

Parameters:

blocks - Blocks to add.

remove

public void remove(MarkArea.Block... blocks)

Remove blocks from this mark area.

Parameters:

blocks - Blocks to remove.

clear

public void clear()

Clear all blocks.