com.nchart3d.NChart.NChartTooltip Class Reference

The NChartTooltip class provides methods to display the tooltip for the chart's points. More...

Inheritance diagram for com.nchart3d.NChart.NChartTooltip:
com.nchart3d.NChart.NChartLabel com.nchart3d.NChart.NChartPlaced com.nchart3d.NChart.NChartObject com.nchart3d.NChart.NChartCallout

Public Member Functions

void setVisibleAnimated (boolean visible, float duration)
 Change visibility of tooltip animated. More...
 
NChartTooltipVerticalAlignment getVerticalAlignment ()
 Vertical alignment of the tooltip. More...
 
void setVerticalAlignment (NChartTooltipVerticalAlignment verticalAlignment)
 For details see getVerticalAlignment().
 
boolean isAlwaysInPlotArea ()
 Flag determining if the tooltip should always be inside of the chart's plot area. More...
 
void setAlwaysInPlotArea (boolean alwaysInPlotArea)
 For details see isAlwaysInPlotArea().
 
NChartTooltipArrowOrientation getDefaultArrowOrientation ()
 Default orientation of the tooltip's arrow. More...
 
void setDefaultArrowOrientation (NChartTooltipArrowOrientation defaultArrowOrientation)
 For details see getDefaultArrowOrientation().
 
- Public Member Functions inherited from com.nchart3d.NChart.NChartLabel
NChartFont getFont ()
 Font of the label's text.
 
void setFont (NChartFont font)
 For details see getFont().
 
int getTextColor ()
 Color of the label's text.
 
void setTextColor (int textColor)
 For details see getTextColor().
 
String getText ()
 Text to display in the label.
 
void setText (String text)
 For details see getText().
 
NChartLineBreakMode getTextWrapping ()
 Wrapping mode of the label's text.
 
void setTextWrapping (NChartLineBreakMode textWrapping)
 For details see getTextWrapping().
 
float getMaxWidth ()
 Maximal width of the label's text in pixels. More...
 
Paint.Align getTextAlignment ()
 Alignment of the label's text. More...
 
void setTextAlignment (Paint.Align textAlignment)
 For details see getTextAlignment().
 
void setMaxWidth (float maxWidth)
 For details see getMaxWidth().
 
- Public Member Functions inherited from com.nchart3d.NChart.NChartPlaced
NChartBrush getBackground ()
 Brush filling the background of the text container. More...
 
void setBackground (NChartBrush background)
 For details see getBackground().
 
int getBorderColor ()
 Color of the border that is drawn around the text container.
 
void setBorderColor (int borderColor)
 For details see getBorderColor().
 
float getBorderRadius ()
 Corner rounding radius (in pixels) of the border that is drawn around the text container.
 
void setBorderRadius (float borderRadius)
 For details see getBorderRadius().
 
float getBorderThickness ()
 Thickness of the border (in pixels) that is drawn around the text container.
 
void setBorderThickness (float borderThickness)
 For details see getBorderThickness().
 
NChartMargin getMargin ()
 Margin of the text container in pixels (spacing from the bounds of the enclosing area).
 
void setMargin (NChartMargin margin)
 For details see getMargin().
 
NChartMargin getPadding ()
 Padding of the text container in pixels (spacing to sub-areas).
 
void setPadding (NChartMargin padding)
 For details see getPadding().
 
float getOpacity ()
 Opacity of the text container. More...
 
void setOpacity (float opacity)
 For details see getOpacity().
 
- Public Member Functions inherited from com.nchart3d.NChart.NChartObject
boolean isVisible ()
 Flag that determines if the object is visible or not. More...
 
void setVisible (boolean visible)
 For details see isVisible().
 
NChart getChart ()
 Chart the object belongs to. More...
 

Detailed Description

The NChartTooltip class provides methods to display the tooltip for the chart's points.

Member Function Documentation

NChartTooltipArrowOrientation com.nchart3d.NChart.NChartTooltip.getDefaultArrowOrientation ( )
inline

Default orientation of the tooltip's arrow.

The default value is NChartTooltipArrowOrientation.Bottom.

The default arrow orientation is the orientation tooltip uses if it's far from plot area borders. If it's close to border and isAlwaysInPlotArea() is set to true, it's arrow orientation is automatically changed to keep tooltip inside the plot area.

NChartTooltipVerticalAlignment com.nchart3d.NChart.NChartTooltip.getVerticalAlignment ( )
inline

Vertical alignment of the tooltip.

It is used if tooltip has no arrow presented, otherwise it is ignored.

See also
NChartTooltipVerticalAlignment
boolean com.nchart3d.NChart.NChartTooltip.isAlwaysInPlotArea ( )
inline

Flag determining if the tooltip should always be inside of the chart's plot area.

If true, the tooltip may be shifted to fit in the plot area when it's pivot is near the border of the chart's plot area. If false, it is never shifted and can overlap the axis when it's pivot is near the border of the chart's plot area. The default value is true.

void com.nchart3d.NChart.NChartTooltip.setVisibleAnimated ( boolean  visible,
float  duration 
)
inline

Change visibility of tooltip animated.

Parameters
visible- flag of visibility.
duration- duration of animation in seconds.