ilog.views.chart.servlet

Class IlvChartHitmapDefinition

java.lang.Object

ilog.views.chart.servlet.IlvChartHitmapDefinition

Direct Known Subclasses:

IlvDefaultChartHitmapDefinition

public abstract class IlvChartHitmapDefinition
extends Object

This class defines how a hitmap and the hitmap infos of a chart is constructed. A hitmap encodes possible interactive effects. It can be used to display tooltips, highlights or other effects in the browser.

Since:

JViews 8.7

Constructor Summary

Constructors

Constructor and Description
IlvChartHitmapDefinition()

Method Summary

Modifier and Type	Method and Description
abstract IlvHitmapInfoGenerator	createHitmapInfoGenerator(String infoType, IlvChartHitmap hitmap) Creates a IlvHitmapInfoGenerator instance according to the hitmap information type.
abstract void	drawIntoHitmap(IlvChart chart, IlvChartHitmapAccumulator accumulator) Draws interactive effects for the entire chart into the hitmap.
abstract void	drawIntoHitmap(IlvChart chart, IlvChartRenderer renderer, IlvChartHitmapAccumulator accumulator) Draws interactive effects for a given renderer into the hitmap.
abstract void	drawIntoHitmap(IlvChart chart, IlvScale scale, IlvChartHitmapAccumulator accumulator) Draws interactive effects for a given scale into the hitmap.
abstract void	drawIntoHitmap(IlvLegend legend, IlvChartHitmapAccumulator accumulator) Draws interactive effects for the legend into the hitmap.
abstract IlvIMapAttributes	getAttributes(IlvChart chart, IlvScale scale) Returns the interactive effects attributes for the given scale.
abstract IlvIMapAttributes	getAttributes(IlvChart chart, IlvSingleChartRenderer renderer, IlvDataSet ds) Returns the interactive effects attributes for a series of data points in the given data set.
abstract IlvIMapAttributes	getAttributes(IlvChart chart, IlvSingleChartRenderer renderer, IlvDataSetPoint dp) Returns the interactive effects attributes for the specified data point.
abstract IlvIMapAttributes	getAttributes(IlvChart chart, IlvTreemapChartRenderer renderer, IlvTreeListModel model, TreePath path) Returns the interactive effects attributes for the specified chart element.
abstract IlvIMapAttributes	getAttributes(IlvLegendItem item) Returns the interactive effects attributes for the specified legend item.
abstract String	getToolTipAsHTML(IlvIMapAttributes attributes) Formats the given attributes as a tooltip.

Methods inherited from class java.lang.Object

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

Constructor Detail

IlvChartHitmapDefinition

public IlvChartHitmapDefinition()

Method Detail

drawIntoHitmap

public abstract void drawIntoHitmap(IlvChart chart,
                                    IlvChartHitmapAccumulator accumulator)

Draws interactive effects for the entire chart into the hitmap.

drawIntoHitmap

public abstract void drawIntoHitmap(IlvChart chart,
                                    IlvScale scale,
                                    IlvChartHitmapAccumulator accumulator)

Draws interactive effects for a given scale into the hitmap.

Since:

JViews 8.8

drawIntoHitmap

public abstract void drawIntoHitmap(IlvChart chart,
                                    IlvChartRenderer renderer,
                                    IlvChartHitmapAccumulator accumulator)

Draws interactive effects for a given renderer into the hitmap.

getAttributes

public abstract IlvIMapAttributes getAttributes(IlvChart chart,
                                                IlvScale scale)

Returns the interactive effects attributes for the given scale.

Since:

JViews 8.8

getAttributes

public abstract IlvIMapAttributes getAttributes(IlvChart chart,
                                                IlvSingleChartRenderer renderer,
                                                IlvDataSet ds)

Returns the interactive effects attributes for a series of data points in the given data set.

Since:

JViews 8.8

getAttributes

public abstract IlvIMapAttributes getAttributes(IlvChart chart,
                                                IlvSingleChartRenderer renderer,
                                                IlvDataSetPoint dp)

Returns the interactive effects attributes for the specified data point.

getAttributes

public abstract IlvIMapAttributes getAttributes(IlvChart chart,
                                                IlvTreemapChartRenderer renderer,
                                                IlvTreeListModel model,
                                                TreePath path)

Returns the interactive effects attributes for the specified chart element.

Parameters:

chart - the chart.

renderer - The tree map chart renderer

model - the tree list model

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

drawIntoHitmap

public abstract void drawIntoHitmap(IlvLegend legend,
                                    IlvChartHitmapAccumulator accumulator)

Draws interactive effects for the legend into the hitmap.

Parameters:

legend - The legend of a chart.

accumulator - The object that accumulates objects in the hitmap.

getAttributes

public abstract IlvIMapAttributes getAttributes(IlvLegendItem item)

Returns the interactive effects attributes for the specified legend item.

getToolTipAsHTML

public abstract String getToolTipAsHTML(IlvIMapAttributes attributes)

Formats the given attributes as a tooltip.

createHitmapInfoGenerator

public abstract IlvHitmapInfoGenerator createHitmapInfoGenerator(String infoType,
                                                                 IlvChartHitmap hitmap)

Creates a IlvHitmapInfoGenerator instance according to the hitmap information type.

Parameters:

infoType - The hitmap information type. One of IlvHitmapConstants.TOOLTIP_TYPE, IlvHitmapConstants.NAVIGATION_TYPE, IlvHitmapConstants.CURSOR_TYPE.

hitmap - the chart hitmap

Returns:

a IlvHitmapInfo instance.

Since:

JViews 8.8

See Also:

IlvAbstractChartHitmapInfoGenerator, IlvAbstractChartTooltipInfoGenerator, IlvAbstractChartNavigationInfoGenerator