Interface BasicTooltipProvider

All Known Subinterfaces:

TooltipProvider, TooltipProvider.Index, TooltipProvider.Parametric, TooltipProvider.Simplex

All Known Implementing Classes:

ATBT.ATBTMap, Centipede.CentiMap, Distribution, EcoPGG.EcoPGGMap, GenericPop, HistoGraph, LineGraph, Pop2D, Pop3D, S3Map, TraitMap

public interface BasicTooltipProvider

Graphs that provide basic tooltips should implement this interface. The tooltip string may include HTML formatting.

Important

The implementation must be agnostic of GWT or JRE implementations and cannot take advantage of view specific features.

Author:

Christoph Hauert

See Also:

• TooltipProvider

Field Summary

Fields

Modifier and Type	Field	Description
static final String	TABLE_CELL_BULLET	Table cell bullet used to highlight categorical values in tooltips.
static final String	TABLE_CELL_NEXT	Table cell separator for tooltips.
static final String	TABLE_CELL_NEXT_COLOR	Table cell separator for tooltips with color.
static final String	TABLE_END	Table end for tooltips.
static final String	TABLE_ROW_END	Table row end for tooltips.
static final String	TABLE_ROW_START	Table row start for tooltips.
static final String	TABLE_ROW_START_COLOR	Table row start for tooltips, right aligned with color.
static final String	TABLE_ROW_START_RIGHT	Table row start for tooltips, right aligned.
static final String	TABLE_SEPARATOR	Table row separator for tooltips.
static final String	TABLE_STYLE	Table style for tooltips.

Method Summary

Modifier and Type	Method	Description
default String	getTooltipAt(double x, double y)	Get the tooltip at the scaled coordinates (x,y) with the origin in the lower left corner of the graph.
default String	getTooltipAt(int index)	Get the tooltip for the location with index index.

Field Details

TABLE_STYLE

static final String TABLE_STYLE

Table style for tooltips.

See Also:

• Constant Field Values

TABLE_ROW_END

static final String TABLE_ROW_END

Table row end for tooltips.

See Also:

• Constant Field Values

TABLE_END

static final String TABLE_END

Table end for tooltips.

See Also:

• Constant Field Values

TABLE_SEPARATOR

static final String TABLE_SEPARATOR

Table row separator for tooltips.

See Also:

• Constant Field Values

TABLE_ROW_START

static final String TABLE_ROW_START

Table row start for tooltips.

See Also:

• Constant Field Values

TABLE_ROW_START_RIGHT

static final String TABLE_ROW_START_RIGHT

Table row start for tooltips, right aligned.

See Also:

• Constant Field Values

TABLE_ROW_START_COLOR

static final String TABLE_ROW_START_COLOR

Table row start for tooltips, right aligned with color.

See Also:

• Constant Field Values

TABLE_CELL_NEXT

static final String TABLE_CELL_NEXT

Table cell separator for tooltips.

See Also:

• Constant Field Values

TABLE_CELL_NEXT_COLOR

static final String TABLE_CELL_NEXT_COLOR

Table cell separator for tooltips with color.

See Also:

• Constant Field Values

TABLE_CELL_BULLET

static final String TABLE_CELL_BULLET

Table cell bullet used to highlight categorical values in tooltips.

See Also:

• Constant Field Values

Method Details

getTooltipAt

default String getTooltipAt(double x,
 double y)

Get the tooltip at the scaled coordinates (x,y) with the origin in the lower left corner of the graph.

Parameters:

x - the x coordinate

y - the y coordinate

Returns:

the tooltip

getTooltipAt

default String getTooltipAt(int index)

Get the tooltip for the location with index index. The index typically refers to an individual node but may equally refer to a location on a lattice for PDE models or trait distributions.

Parameters:

index - the index of the location

Returns:

the tooltip