com.nchart3d.NChart.NChartCallout Class Reference

The NChartCallout class provides methods to display tooltips as callouts. More...

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

Public Member Functions

float getLineThickness ()
 Thickness of the callout line. More...
 
void setLineThickness (float lineThickness)
 For details see getLineThickness().
 
int getLineColor ()
 Color of the callout line. More...
 
void setLineColor (int lineColor)
 For details see getLineColor().
 
NChartCalloutLineToLabelConnectionPos getLineToLabelConnectionPos ()
 Position where the line connects to the label. More...
 
void setLineToLabelConnectionPos (NChartCalloutLineToLabelConnectionPos lineToLabelConnectionPos)
 For details see getLineToLabelConnectionPos().
 
float getDistance ()
 Distance from the chart's point to the callout's tooltip in the autodetected direction (in pixels). More...
 
void setDistance (float distance)
 For details see getDistance().
 
NChartCalloutLineType getLineType ()
 Type of callout line. More...
 
void setLineType (NChartCalloutLineType lineType)
 For details see getLineType().
 
boolean getLocateByOrigin ()
 Flag determining if callout should be located in the position specified by the origin property (true), or according to distance and margin properties (false). More...
 
void setLocateByOrigin (boolean locateByOrigin)
 For details see getLocateByOrigin().
 
PointF getOrigin ()
 Position of the top left corner of callout in pixels based on view's coordinate system, but with zero point shifted to the top left corner of chart plot area. More...
 
void setOrigin (PointF origin)
 For details see getOrigin().
 
- Public Member Functions inherited from com.nchart3d.NChart.NChartTooltip
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 NChartCallout class provides methods to display tooltips as callouts.

Member Function Documentation

float com.nchart3d.NChart.NChartCallout.getDistance ( )
inline

Distance from the chart's point to the callout's tooltip in the autodetected direction (in pixels).

If this property is 0, margin is used to control this distance (and therefore you control the direction yourself). Otherwise, the direction is detected automatically. In case of pie it's median of the corresponding sector. In case of all other charts it's north-east direction. The default value is 0.

int com.nchart3d.NChart.NChartCallout.getLineColor ( )
inline

Color of the callout line.

The default value is black color.

float com.nchart3d.NChart.NChartCallout.getLineThickness ( )
inline

Thickness of the callout line.

The default value is 1.

NChartCalloutLineToLabelConnectionPos com.nchart3d.NChart.NChartCallout.getLineToLabelConnectionPos ( )
inline

Position where the line connects to the label.

The default value is NChartCalloutLineToLabelConnectionPos.Autodetect.

NChartCalloutLineType com.nchart3d.NChart.NChartCallout.getLineType ( )
inline

Type of callout line.

The default value is NChartCalloutLineTypeStraight.

boolean com.nchart3d.NChart.NChartCallout.getLocateByOrigin ( )
inline

Flag determining if callout should be located in the position specified by the origin property (true), or according to distance and margin properties (false).

The default value is false. If this property is set to true, origin has effect, but margin and distance has no effect, and vice versa.

PointF com.nchart3d.NChart.NChartCallout.getOrigin ( )
inline

Position of the top left corner of callout in pixels based on view's coordinate system, but with zero point shifted to the top left corner of chart plot area.

The default value is {0; 0}. This property has effect if locateByOrigin is set to true only.