ilog.views.chart.servlet

Class IlvIMapDefinition

java.lang.Object

ilog.views.chart.servlet.IlvIMapDefinition

Direct Known Subclasses:

IlvDefaultIMapDefinition

public abstract class IlvIMapDefinition
extends Object

Defines how images maps are generated from chart renderers.

Since:

JViews 5.0

Field Summary

Fields

Modifier and Type	Field and Description
static int	DATASET_MAP Indicates that the IlvIMapDefinition object generates map areas with common attributes for all the points of a data set.
static int	POINT_MAP Indicates that the IlvIMapDefinition object generates map areas for specific data points.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	IlvIMapDefinition(int type) Initializes a new IlvIMapDefinition with the specified type.

Method Summary

Modifier and Type	Method and Description
abstract IlvIMapAttributes	getAttributes(IlvDataSetPoint dp) Returns the area attributes for the specified data point.
abstract IlvIMapAttributes	getAttributes(IlvLegendItem item) Returns the area attributes for the specified legend item.
abstract IlvIMapAttributes	getAttributes(IlvTreeListModel model, TreePath path) Returns the area attributes for the specified tree model element.
int	getCircleRadius() Returns the minimum radius used to generate circle map areas.
int	getType() Returns the type of the definition.
boolean	isChartOrigin() Indicates whether the coordinates of the map areas should be expressed in the coordinate system of the chart component.
abstract boolean	mustGenerate(IlvChartRenderer r) Indicates whether areas should be generated for the specified renderer.
void	setChartOrigin(boolean chartOrigin) Specifies whether the coordinates of the map areas should be expressed in the coordinate system of the chart component.
void	setCircleRadius(int radius) Sets the minimum radius used to generate circle map areas.

Methods inherited from class java.lang.Object

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

Field Detail

DATASET_MAP

public static final int DATASET_MAP

Indicates that the IlvIMapDefinition object generates map areas with common attributes for all the points of a data set.

See Also:

getType(), Constant Field Values

POINT_MAP

public static final int POINT_MAP

Indicates that the IlvIMapDefinition object generates map areas for specific data points.

See Also:

getType(), Constant Field Values

Constructor Detail

IlvIMapDefinition

protected IlvIMapDefinition(int type)

Initializes a new IlvIMapDefinition with the specified type.

Parameters:

type - The type of the definition.

See Also:

getType()

Method Detail

getType

public final int getType()

Returns the type of the definition.

Returns:

The type of the definition, which describes whether area attributes are defined for all the points of a data set, or for specific data points.

See Also:

DATASET_MAP, POINT_MAP

setChartOrigin

public void setChartOrigin(boolean chartOrigin)

Specifies whether the coordinates of the map areas should be expressed in the coordinate system of the chart component. The default value of this property is true.

Parameters:

chartOrigin - If true, the coordinates of the map areas should be expressed in the coordinate system of the chart component. If false, the coordinates must be expressed in the coordinate system of the chart area component.

See Also:

IlvChart.getChartArea()

isChartOrigin

public final boolean isChartOrigin()

Indicates whether the coordinates of the map areas should be expressed in the coordinate system of the chart component.

See Also:

setChartOrigin(boolean)

setCircleRadius

public void setCircleRadius(int radius)

Sets the minimum radius used to generate circle map areas.

getCircleRadius

public final int getCircleRadius()

Returns the minimum radius used to generate circle map areas. The default radius value is 5.

mustGenerate

public abstract boolean mustGenerate(IlvChartRenderer r)

Indicates whether areas should be generated for the specified renderer.

getAttributes

public abstract IlvIMapAttributes getAttributes(IlvDataSetPoint dp)

Returns the area attributes for the specified data point.

getAttributes

public abstract IlvIMapAttributes getAttributes(IlvLegendItem item)

Returns the area attributes for the specified legend item.

Since:

JViews 5.5

getAttributes

public abstract IlvIMapAttributes getAttributes(IlvTreeListModel model,
                                                TreePath path)

Returns the area attributes for the specified tree model element.

Parameters:

model - Tree model.

path - A tree path starting at the tree model root and ending at the specific tree model node.

Since:

JViews 7.5